README

   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 2.x, available from:
  12
  13         https://github.com/libevent/libevent/releases/latest
  14
  15 It also depends on ncurses, available from:
  16
  17         https://invisible-mirror.net/archives/ncurses/
  18
  19 To build tmux, a C compiler (for example gcc or clang), make, pkg-config and a
  20 suitable yacc (yacc or bison) are needed.
  21
  22 * Installation
  23
  24 To build and install tmux from a release tarball, use:
  25
  26         $ ./configure && make
  27         $ sudo make install
  28
  29 tmux can use the utempter library to update utmp(5), if it is installed - run
  30 configure with --enable-utempter to enable this.
  31
  32 To get and build the latest from version control - note that this requires
  33 autoconf, automake and pkg-config:
  34
  35         $ git clone https://github.com/tmux/tmux.git
  36         $ cd tmux
  37         $ sh autogen.sh
  38         $ ./configure && make
  39
  40 * Contributing
  41
  42 Bug reports, feature suggestions and especially code contributions are most
  43 welcome. Please send by email to:
  44
  45         tmux-users@googlegroups.com
  46
  47 Or open a GitHub issue or pull request.
  48
  49 * Documentation
  50
  51 For documentation on using tmux, see the tmux.1 manpage. View it from the
  52 source tree with:
  53
  54         $ nroff -mdoc tmux.1|less
  55
  56 A small example configuration is in example_tmux.conf.
  57
  58 Other documentation is available in the wiki:
  59
  60         https://github.com/tmux/tmux/wiki
  61
  62 Also see the tmux FAQ at:
  63
  64         https://github.com/tmux/tmux/wiki/FAQ
  65
  66 A bash(1) completion file is at:
  67
  68         https://github.com/imomaliev/tmux-bash-completion
  69
  70 For debugging, run tmux with -v and -vv to generate server and client log files
  71 in the current directory.
  72
  73 * Support
  74
  75 The tmux mailing list for general discussion and bug reports is:
  76
  77         https://groups.google.com/forum/#!forum/tmux-users
  78
  79 Subscribe by sending an email to:
  80
  81         tmux-users+subscribe@googlegroups.com
  82
  83 * License
  84
  85 This file and the CHANGES files are licensed under the ISC license. All other
  86 files have a license and copyright notice at their start.