tmux/README

72 lines
2.2 KiB
Plaintext
Raw Normal View History

2007-10-12 17:32:20 +00:00
Welcome to tmux!
2007-10-19 20:43:55 +00:00
tmux is a "terminal multiplexer", it enables a number of terminals (or windows)
2007-10-12 17:32:20 +00:00
to be accessed and controlled from a single terminal. tmux is intended to be a
simple, modern, BSD-licensed alternative to programs such as GNU screen.
2015-06-03 17:57:35 +00:00
This release runs on OpenBSD, FreeBSD, NetBSD, Linux, OS X and Solaris.
2008-11-17 18:35:27 +00:00
2013-12-09 22:53:17 +00:00
tmux depends on libevent 2.x. Download it from:
2016-01-29 10:58:08 +00:00
http://libevent.org
It also depends on ncurses, available from:
http://invisible-island.net/ncurses/
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:
2015-06-04 00:27:47 +00:00
$ git clone https://github.com/tmux/tmux.git
$ cd tmux
$ sh autogen.sh
$ ./configure && make
2017-06-08 13:08:04 +00:00
(Note that this requires at least a working C compiler, make, autoconf,
automake, pkg-config as well as libevent and ncurses libraries and headers.)
2017-06-08 12:40:24 +00:00
2015-06-04 00:27:47 +00:00
For more information see http://git-scm.com. Patches should be sent by email to
2017-08-30 20:49:31 +00:00
the mailing list at tmux-users@googlegroups.com or submitted through GitHub at
https://github.com/tmux/tmux/issues.
For documentation on using tmux, see the tmux.1 manpage. It can be viewed from
the source tree with:
2007-10-12 17:32:20 +00:00
$ nroff -mdoc tmux.1|less
2007-10-12 17:32:20 +00:00
2017-06-08 12:29:36 +00:00
A small example configuration in example_tmux.conf.
And a bash(1) completion file at:
2016-05-31 23:06:02 +00:00
https://github.com/imomaliev/tmux-bash-completion
2007-10-12 17:32:20 +00:00
For debugging, running tmux with -v or -vv will generate server and client log
2007-11-09 16:22:03 +00:00
files in the current directory.
2007-10-12 17:32:20 +00:00
2015-06-03 17:57:35 +00:00
tmux mailing lists are available. For general discussion and bug reports:
2009-04-21 20:06:12 +00:00
2015-06-03 17:57:35 +00:00
https://groups.google.com/forum/#!forum/tmux-users
And for Git commit emails:
https://groups.google.com/forum/#!forum/tmux-git
2009-04-21 20:06:12 +00:00
2016-06-06 08:30:39 +00:00
Subscribe by sending an email to <tmux-users+subscribe@googlegroups.com>.
2007-11-12 16:13:49 +00:00
Bug reports, feature suggestions and especially code contributions are most
2009-04-21 20:06:12 +00:00
welcome. Please send by email to:
2007-10-12 17:32:20 +00:00
2015-06-03 17:57:35 +00:00
tmux-users@googlegroups.com
2007-10-12 17:32:20 +00:00
This file and the CHANGES, FAQ, SYNCING and TODO files are licensed under the
ISC license. All other files have a license and copyright notice at their start.
2015-06-03 17:57:35 +00:00
-- Nicholas Marriott <nicholas.marriott@gmail.com>