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         $ sudo make install
  40
  41 * Contributing
  42
  43 Bug reports, feature suggestions and especially code contributions are most
  44 welcome. Please send by email to:
  45
  46         tmux-users@googlegroups.com
  47
  48 Or open a GitHub issue or pull request.
  49
  50 * Documentation
  51
  52 For documentation on using tmux, see the tmux.1 manpage. View it from the
  53 source tree with:
  54
  55         $ nroff -mdoc tmux.1|less
  56
  57 A small example configuration is in example_tmux.conf.
  58
  59 Other documentation is available in the wiki:
  60
  61         https://github.com/tmux/tmux/wiki
  62
  63 Also see the tmux FAQ at:
  64
  65         https://github.com/tmux/tmux/wiki/FAQ
  66
  67 A bash(1) completion file is at:
  68
  69         https://github.com/imomaliev/tmux-bash-completion
  70
  71 For debugging, run tmux with -v and -vv to generate server and client log files
  72 in the current directory.
  73
  74 * Support
  75
  76 The tmux mailing list for general discussion and bug reports is:
  77
  78         https://groups.google.com/forum/#!forum/tmux-users
  79
  80 Subscribe by sending an email to:
  81
  82         tmux-users+subscribe@googlegroups.com
  83
  84 * License
  85
  86 This file and the CHANGES files are licensed under the ISC license. All other
  87 files have a license and copyright notice at their start.