diff options
Diffstat (limited to 'NOTES')
| -rw-r--r-- | NOTES | 82 |
1 files changed, 82 insertions, 0 deletions
@@ -0,0 +1,82 @@ +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). It is +usable, although there remain a number of missing features and some remaining +bugs are expected. + +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. + +Since the 1.2 release tmux depends on libevent. Download it from: + + http://www.monkey.org/~provos/libevent/ + +To build tmux from a release tarball, do: + + $ ./configure && make + $ sudo make install + +To build from a version control checkout, the configure script must be +generated by running: + + $ sh autogen.sh + +tmux consists of a server part and multiple clients. The server is created when +required and runs continuously unless killed by the user. Clients access the +server through a socket in /tmp. Multiple sessions may be created on a single +server and attached to a number of clients. Each session may then have a number +of windows and windows may be linked to a number of sessions. Commands are +available to create, rename and destroy windows and sessions; to attach and +detach sessions from client terminals; to set configuration options; to split +windows into several simultaneously displayed panes; and to bind and unbind +command keys (invoked preceded by a prefix key, by default ctrl-b). Please see +the tmux(1) man page for further information. + +A more extensive, but rough, todo list is included in the TODO file. + +tmux also depends on several features of the client terminal (TERM), if these +are missing it may refuse to run, or not behave correctly. + +A Vim syntax file is available in the examples directory. To install it: + +- Drop the file in the syntax directory in your runtimepath (such as + ~/.vim/syntax/tmux.vim). +- Make the filetype recognisable by adding the following to filetype.vim + in your runtimepath (~/.vim/filetype.vim): + + augroup filetypedetect + au BufNewFile,BufRead .tmux.conf*,tmux.conf* setf tmux + augroup END + +- Switch on syntax highlighting by adding "syntax enable" to your vimrc file. + +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: + + nicm@users.sf.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. Please contact me with any queries. + +-- Nicholas Marriott <nicm@users.sf.net> + +$Id$ |