Skip to content
100644 83 lines (58 sloc) 3.27 KB
8fade26 Imported Upstream version 1.1
Karl Ferdinand Ebert authored
1 Welcome to tmux!
3 tmux is a "terminal multiplexer", it enables a number of terminals (or windows)
4 to be accessed and controlled from a single terminal. tmux is intended to be a
5 simple, modern, BSD-licensed alternative to programs such as GNU screen.
7 This release runs on OpenBSD, FreeBSD, NetBSD, Linux and OS X and may still
8 run on Solaris and AIX (although they haven't been tested in a while). It is
9 usable, although there remain a number of missing features and some remaining
10 bugs are expected.
798186b @orebokech Import upstream version 1.6
orebokech authored
12 If upgrading from 1.5, PLEASE NOTE:
13 - The word-separators window option is now a session option.
14 - The options used to change the window attributes when an alert occurs were
15 removed. Each kind of alert has its own individual set of options.
16 - The ability to have a list of prefix keys was dropped in favour of two
17 separate options, prefix and prefix2.
7216c39 @kfebert Imported Upstream version 1.5
kfebert authored
19 Since the 1.2 release that tmux depends on libevent. Download it from:
dda8e8e @kfebert Imported Upstream version 1.2
kfebert authored
8fade26 Imported Upstream version 1.1
Karl Ferdinand Ebert authored
b016948 @orebokech Import upstream snapshot from SVN r2608
orebokech authored
23 To build tmux from a release tarball, do:
25 $ ./configure && make
26 $ sudo make install
28 To build from a version control checkout, the configure script must be
29 generated by running:
31 $ sh
8fade26 Imported Upstream version 1.1
Karl Ferdinand Ebert authored
33 tmux consists of a server part and multiple clients. The server is created when
34 required and runs continuously unless killed by the user. Clients access the
35 server through a socket in /tmp. Multiple sessions may be created on a single
36 server and attached to a number of clients. Each session may then have a number
37 of windows and windows may be linked to a number of sessions. Commands are
38 available to create, rename and destroy windows and sessions; to attach and
39 detach sessions from client terminals; to set configuration options; to split
40 windows into several simultaneously displayed panes; and to bind and unbind
41 command keys (invoked preceded by a prefix key, by default ctrl-b). Please see
42 the tmux(1) man page for further information.
44 A more extensive, but rough, todo list is included in the TODO file.
46 tmux also depends on several features of the client terminal (TERM), if these
47 are missing it may refuse to run, or not behave correctly.
49 A Vim syntax file is available in the examples directory. To install it:
51 - Drop the file in the syntax directory in your runtimepath (such as
52 ~/.vim/syntax/tmux.vim).
53 - Make the filetype recognisable by adding the following to filetype.vim
54 in your runtimepath (~/.vim/filetype.vim):
56 augroup filetypedetect
57 au BufNewFile,BufRead .tmux.conf*,tmux.conf* setf tmux
58 augroup END
60 - Switch on syntax highlighting by adding "syntax enable" to your vimrc file.
62 For debugging, running tmux with -v or -vv will generate server and client log
63 files in the current directory.
65 tmux mailing lists are available; visit:
69 Bug reports, feature suggestions and especially code contributions are most
70 welcome. Please send by email to:
74 This file and the CHANGES, FAQ and TODO files are licensed under the ISC
75 license. Files under examples/ remain copyright their authors unless otherwise
76 stated in the file but permission has been received to distribute them with
77 tmux. All other files have a license and copyright notice at their
78 start. Please contact me with any queries.
80 -- Nicholas Marriott <>
798186b @orebokech Import upstream version 1.6
orebokech authored
82 $Id: NOTES 2677 2012-01-23 12:38:05Z tcunha $
Something went wrong with that request. Please try again.