.github/README.md

   1 # Welcome to tmux!
   2
   3 tmux is a terminal multiplexer: it enables a number of terminals to be created,
   4 accessed, and controlled from a single screen. tmux may be detached from a
   5 screen and continue running in the background, then later reattached.
   6
   7 This release runs on OpenBSD, FreeBSD, NetBSD, Linux, macOS and Solaris.
   8
   9 ## Dependencies
  10
  11 tmux depends on [libevent](https://libevent.org) 2.x, available from [this
  12 page](https://github.com/libevent/libevent/releases/latest).
  13
  14 It also depends on [ncurses](https://www.gnu.org/software/ncurses/), available
  15 from [this page](https://invisible-mirror.net/archives/ncurses/).
  16
  17 To build tmux, a C compiler (for example gcc or clang), make, pkg-config and a
  18 suitable yacc (yacc or bison) are needed.
  19
  20 ## Installation
  21
  22 ### Binary packages
  23
  24 Some platforms provide binary packages for tmux, although these are sometimes
  25 out of date. Examples are listed on
  26 [this page](https://github.com/tmux/tmux/wiki/Installing).
  27
  28 ### From release tarball
  29
  30 To build and install tmux from a release tarball, use:
  31
  32 ~~~bash
  33 ./configure && make
  34 sudo make install
  35 ~~~
  36
  37 tmux can use the utempter library to update utmp(5), if it is installed - run
  38 configure with `--enable-utempter` to enable this.
  39
  40 For more detailed instructions on building and installing tmux, see
  41 [this page](https://github.com/tmux/tmux/wiki/Installing).
  42
  43 ### From version control
  44
  45 To get and build the latest from version control - note that this requires
  46 `autoconf`, `automake` and `pkg-config`:
  47
  48 ~~~bash
  49 git clone https://github.com/tmux/tmux.git
  50 cd tmux
  51 sh autogen.sh
  52 ./configure && make
  53 ~~~
  54
  55 ## Contributing
  56
  57 Bug reports, feature suggestions and especially code contributions are most
  58 welcome. Please send by email to:
  59
  60 tmux-users@googlegroups.com
  61
  62 Or open a GitHub issue or pull request. **Please read [this
  63 document](CONTRIBUTING.md) before opening an issue.**
  64
  65 There is [a list of suggestions for contributions](https://github.com/tmux/tmux/wiki/Contributing).
  66 Please feel free to ask on the mailing list if you're thinking of working on something or need
  67 further information.
  68
  69 ## Documentation
  70
  71 For documentation on using tmux, see the tmux.1 manpage. View it from the
  72 source tree with:
  73
  74 ~~~bash
  75 nroff -mdoc tmux.1|less
  76 ~~~
  77
  78 A small example configuration is in `example_tmux.conf`.
  79
  80 And a bash(1) completion file at:
  81
  82 https://github.com/imomaliev/tmux-bash-completion
  83
  84 For debugging, run tmux with `-v` or `-vv` to generate server and client log
  85 files in the current directory.
  86
  87 ## Support
  88
  89 The tmux mailing list for general discussion and bug reports is:
  90
  91 https://groups.google.com/forum/#!forum/tmux-users
  92
  93 Subscribe by sending an email to:
  94
  95 tmux-users+subscribe@googlegroups.com