| Welcome to tmux! |
| |
| tmux is a terminal multiplexer: it enables a number of terminals to be created, |
| accessed, and controlled from a single screen. tmux may be detached from a |
| screen and continue running in the background, then later reattached. |
| |
| This release runs on OpenBSD, FreeBSD, NetBSD, Linux, OS X and Solaris. |
| |
| * Dependencies |
| |
| tmux depends on libevent 2.x, available from: |
| |
| https://github.com/libevent/libevent/releases/latest |
| |
| It also depends on ncurses, available from: |
| |
| https://invisible-mirror.net/archives/ncurses/ |
| |
| To build tmux, a C compiler (for example gcc or clang), make, pkg-config and a |
| suitable yacc (yacc or bison) are needed. |
| |
| * Installation |
| |
| To build and install tmux from a release tarball, use: |
| |
| $ ./configure && make |
| $ sudo make install |
| |
| tmux can use the utempter library to update utmp(5), if it is installed - run |
| configure with --enable-utempter to enable this. |
| |
| To get and build the latest from version control - note that this requires |
| autoconf, automake and pkg-config: |
| |
| $ git clone https://github.com/tmux/tmux.git |
| $ cd tmux |
| $ sh autogen.sh |
| $ ./configure && make |
| |
| * Contributing |
| |
| Bug reports, feature suggestions and especially code contributions are most |
| welcome. Please send by email to: |
| |
| tmux-users@googlegroups.com |
| |
| Or open a GitHub issue or pull request. |
| |
| * Documentation |
| |
| For documentation on using tmux, see the tmux.1 manpage. View it from the |
| source tree with: |
| |
| $ nroff -mdoc tmux.1|less |
| |
| A small example configuration is in example_tmux.conf. |
| |
| Other documentation is available in the wiki: |
| |
| https://github.com/tmux/tmux/wiki |
| |
| Also see the tmux FAQ at: |
| |
| https://github.com/tmux/tmux/wiki/FAQ |
| |
| A bash(1) completion file is at: |
| |
| https://github.com/imomaliev/tmux-bash-completion |
| |
| For debugging, run tmux with -v and -vv to generate server and client log files |
| in the current directory. |
| |
| * Support |
| |
| The tmux mailing list for general discussion and bug reports is: |
| |
| https://groups.google.com/forum/#!forum/tmux-users |
| |
| Subscribe by sending an email to: |
| |
| tmux-users+subscribe@googlegroups.com |
| |
| * License |
| |
| This file and the CHANGES files are licensed under the ISC license. All other |
| files have a license and copyright notice at their start. |