xref: /netbsd-src/external/bsd/tmux/dist/README (revision 1580a27b92f58fcdcb23fdfbc04a7c2b54a0b7c8)
1Welcome to tmux!
2
3tmux is a "terminal multiplexer", it enables a number of terminals (or windows)
4to be accessed and controlled from a single terminal. tmux is intended to be a
5simple, modern, BSD-licensed alternative to programs such as GNU screen.
6
7This release runs on OpenBSD, FreeBSD, NetBSD, Linux, OS X and Solaris.
8
9tmux depends on libevent 2.x. Download it from:
10
11	http://libevent.org
12
13It also depends on ncurses, available from:
14
15	http://invisible-island.net/ncurses/
16
17To build and install tmux from a release tarball, use:
18
19	$ ./configure && make
20	$ sudo make install
21
22tmux can use the utempter library to update utmp(5), if it is installed - run
23configure with --enable-utempter to enable this.
24
25To get and build the latest from version control:
26
27	$ git clone https://github.com/tmux/tmux.git
28	$ cd tmux
29	$ sh autogen.sh
30	$ ./configure && make
31
32(Note that this requires at least a working C compiler, make, autoconf,
33automake, pkg-config as well as libevent and ncurses libraries and headers.)
34
35For more information see http://git-scm.com. Patches should be sent by email to
36the mailing list at tmux-users@googlegroups.com or submitted through GitHub at
37https://github.com/tmux/tmux/issues.
38
39For documentation on using tmux, see the tmux.1 manpage. It can be viewed from
40the source tree with:
41
42	$ nroff -mdoc tmux.1|less
43
44A small example configuration in example_tmux.conf.
45
46A vim(1) syntax file is available at:
47
48	https://github.com/ericpruitt/tmux.vim
49	https://raw.githubusercontent.com/ericpruitt/tmux.vim/master/vim/syntax/tmux.vim
50
51And a bash(1) completion file at:
52
53	https://github.com/imomaliev/tmux-bash-completion
54
55For debugging, running tmux with -v or -vv will generate server and client log
56files in the current directory.
57
58tmux mailing lists are available. For general discussion and bug reports:
59
60	https://groups.google.com/forum/#!forum/tmux-users
61
62And for Git commit emails:
63
64	https://groups.google.com/forum/#!forum/tmux-git
65
66Subscribe by sending an email to <tmux-users+subscribe@googlegroups.com>.
67
68Bug reports, feature suggestions and especially code contributions are most
69welcome. Please send by email to:
70
71	tmux-users@googlegroups.com
72
73This file and the CHANGES, FAQ, SYNCING and TODO files are licensed under the
74ISC license. All other files have a license and copyright notice at their start.
75
76-- Nicholas Marriott <nicholas.marriott@gmail.com>
77