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.
|
|
|
|
|
|
2009-11-05 12:35:47 +00:00
|
|
|
This release runs on OpenBSD, FreeBSD, NetBSD, Linux and OS X and may still
|
2012-10-05 08:05:44 +00:00
|
|
|
run on Solaris and AIX (although they haven't been tested in a while).
|
2008-11-17 18:35:27 +00:00
|
|
|
|
2012-01-23 12:38:05 +00:00
|
|
|
If upgrading from 1.5, PLEASE NOTE:
|
|
|
|
|
- The word-separators window option is now a session option.
|
|
|
|
|
- The options used to change the window attributes when an alert occurs were
|
|
|
|
|
removed. Each kind of alert has its own individual set of options.
|
|
|
|
|
- The ability to have a list of prefix keys was dropped in favour of two
|
|
|
|
|
separate options, prefix and prefix2.
|
|
|
|
|
|
2012-05-23 20:08:14 +00:00
|
|
|
Since the 1.2 release tmux depends on libevent. Download it from:
|
2009-11-08 22:51:34 +00:00
|
|
|
|
|
|
|
|
http://www.monkey.org/~provos/libevent/
|
|
|
|
|
|
2011-09-15 12:58:39 +00:00
|
|
|
To build tmux from a release tarball, do:
|
|
|
|
|
|
|
|
|
|
$ ./configure && make
|
|
|
|
|
$ sudo make install
|
|
|
|
|
|
2012-10-05 08:05:44 +00:00
|
|
|
To get and build the latest version control checkout:
|
2011-09-15 12:58:39 +00:00
|
|
|
|
2012-10-05 08:05:44 +00:00
|
|
|
$ git clone git://tmux.git.sourceforge.net/gitroot/tmux/tmux
|
|
|
|
|
$ cd tmux
|
2011-09-15 12:58:39 +00:00
|
|
|
$ sh autogen.sh
|
2012-10-05 08:05:44 +00:00
|
|
|
$ ./configure && make
|
|
|
|
|
|
|
|
|
|
For more information see https://sourceforge.net/scm/?type=git&group_id=200378
|
|
|
|
|
and http://git-scm.com.
|
2011-09-15 12:58:39 +00:00
|
|
|
|
2012-10-05 08:05:44 +00:00
|
|
|
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
|
|
|
|
2012-10-05 08:05:44 +00:00
|
|
|
$ nroff -mdoc tmux.1|less
|
2007-10-12 17:32:20 +00:00
|
|
|
|
2012-10-05 08:05:44 +00:00
|
|
|
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.
|
2007-10-12 17:32:20 +00:00
|
|
|
|
2009-01-18 15:55:33 +00:00
|
|
|
A Vim syntax file is available in the examples directory. To install it:
|
2009-04-21 20:06:12 +00:00
|
|
|
|
2012-10-05 08:05:44 +00:00
|
|
|
- Drop the file in the syntax directory into runtimepath (such as
|
2009-04-21 20:06:12 +00:00
|
|
|
~/.vim/syntax/tmux.vim).
|
2009-01-18 15:55:33 +00:00
|
|
|
- Make the filetype recognisable by adding the following to filetype.vim
|
2012-10-05 08:05:44 +00:00
|
|
|
(~/.vim/filetype.vim):
|
2009-01-18 15:55:33 +00:00
|
|
|
|
|
|
|
|
augroup filetypedetect
|
|
|
|
|
au BufNewFile,BufRead .tmux.conf*,tmux.conf* setf tmux
|
|
|
|
|
augroup END
|
|
|
|
|
|
2012-10-05 08:05:44 +00:00
|
|
|
- Switch on syntax highlighting by adding "syntax enable" to .vimrc.
|
2009-01-18 15:55:33 +00:00
|
|
|
|
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
|
|
|
|
2012-10-05 08:05:44 +00:00
|
|
|
tmux mailing lists are available. The visit:
|
2009-04-21 20:06:12 +00:00
|
|
|
|
|
|
|
|
https://sourceforge.net/mail/?group_id=200378
|
|
|
|
|
|
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
|
|
|
|
2012-10-05 08:05:44 +00:00
|
|
|
tmux-users@lists.sourceforge.net
|
2007-10-12 17:32:20 +00:00
|
|
|
|
2009-10-25 21:45:26 +00:00
|
|
|
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
|
2012-10-05 08:05:44 +00:00
|
|
|
start.
|
2009-10-25 21:45:26 +00:00
|
|
|
|
2007-10-12 17:32:20 +00:00
|
|
|
-- Nicholas Marriott <nicm@users.sf.net>
|
2008-05-31 20:04:15 +00:00
|
|
|
|
2011-07-09 09:42:33 +00:00
|
|
|
$Id$
|
