/tmux

Clone of the tmux Git repository. The "master" branch contains the latest unreleased code. Git tags indicate prior versions of tmux. There will be topic branches in this repo which indicate personal development. They may be subject to rebasing at any point so don't base any changes off anything other than "master". DO NOT SEND me pull-requests. Send them to the tmux-users mailing list, please.

Primary LanguageCOtherNOASSERTION

Welcome to tmux!

tmux is a "terminal multiplexer", it enables a number of terminals (or windows)
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.

This release runs on OpenBSD, FreeBSD, NetBSD, Linux and OS X and may still
run on Solaris and AIX (although they haven't been tested in a while).

tmux depends on libevent 2.x. Download it from:

	http://www.monkey.org/~provos/libevent/

To build tmux from a release tarball, do:

	$ ./configure && make
	$ sudo make install

To get and build the latest from version control:

	$ git clone git://git.code.sf.net/p/tmux/tmux-code tmux
	$ cd tmux
	$ sh autogen.sh
	$ ./configure && make

For more information see https://sourceforge.net/scm/?type=git&group_id=200378
and http://git-scm.com. Patches should be sent by email to the mailing list at
tmux-users@lists.sourceforge.net.

For documentation on using tmux, see the tmux.1 manpage. It can be viewed from
the source tree with:

	$ nroff -mdoc tmux.1|less

Some common questions are answered in the FAQ file and a more extensive (but
slightly out of date) guide is available in the OpenBSD FAQ at
http://www.openbsd.org/faq/faq7.html#tmux. A rough todo list is in the TODO
file and some example configurations and a Vim syntax file are in the examples
directory.

For debugging, running tmux with -v or -vv will generate server and client log
files in the current directory.

tmux mailing lists are available. Visit:

	https://sourceforge.net/mail/?group_id=200378

Bug reports, feature suggestions and especially code contributions are most
welcome. Please send by email to:

	tmux-users@lists.sourceforge.net

This file and the CHANGES, FAQ and TODO files are licensed under the ISC
license. Files under examples/ remain copyright their authors unless otherwise
stated in the file but permission has been received to distribute them with
tmux. All other files have a license and copyright notice at their start.

-- Nicholas Marriott <nicm@users.sf.net>

$Id$