tmux/NOTES

97 lines
4.1 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.
2009-03-31 23:16:14 +00:00
This 0.8 release runs on OpenBSD, FreeBSD, Linux and OS X and may still run on
2009-01-14 22:46:30 +00:00
Solaris (although it hasn't been tested in a while). It is usable, although
there remain a number of missing features and some remaining bugs are expected.
2008-11-17 18:35:27 +00:00
2009-01-17 17:51:54 +00:00
If upgrading from 0.5, PLEASE NOTE the following configuration file changes: it
is now required to pass the -g flag to set-option or set-window-option to set
global options; remain-by-default and utf8-default are now gone, use global
window options (set-window-option -g) instead.
2008-11-17 18:35:27 +00:00
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
2009-04-21 20:06:12 +00:00
of windows and windows may be linked to a number of sessions. Commands are
2008-11-17 18:35:27 +00:00
available to create, rename and destroy windows and sessions; to attach and
2009-04-21 20:06:12 +00:00
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.
2007-10-12 17:32:20 +00:00
The following is a summary of major features implemented in this version:
- Basic multiplexing, window switching, attaching and detaching.
- Window listing and renaming.
- Key binding.
- Handling of client terminal resize.
2009-04-21 20:06:12 +00:00
- Terminal emulation sufficient to handle most curses applications.
2007-10-12 17:32:20 +00:00
- A optional status line (enabled by default).
2007-11-24 14:21:43 +00:00
- Window history and copy and paste.
- Support for VT100 line drawing characters.
2009-01-14 22:46:30 +00:00
- A large command set.
2009-04-21 20:06:12 +00:00
- Vertical window splitting and layout.
2009-01-14 22:46:30 +00:00
- Automatic server locking on inactivity.
- A configuration file.
2009-04-21 20:06:12 +00:00
- UTF-8 support.
2007-10-12 17:32:20 +00:00
And major missing features:
2007-11-12 20:59:33 +00:00
- No support for programs changing termios(4) settings or other tty(4) ioctls.
2007-10-12 17:32:20 +00:00
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
2008-11-17 18:35:27 +00:00
are missing it may refuse to run, or not behave correctly. Known working are
TERM=screen (tmux in screen), xterm, xterm-color and rxvt. Note that TERM=xterm
does not support colour on OpenBSD. screen ignores this, tmux does not: use
xterm-color or rxvt for colour.
2007-10-12 17:32:20 +00:00
2009-01-14 22:46:30 +00:00
tmux supports UTF-8. To use it, the utf8 option must be set on each window;
this may be turned on for all windows by setting it as a global option, see
tmux(1) and the FAQ file. In addition, when starting tmux or attaching to an
existing session from a UTF-8-capable terminal, the -u flag must be specified.
2008-06-16 16:42:33 +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
- Drop the file in the syntax directory in your runtimepath (such as
~/.vim/syntax/tmux.vim).
2009-01-18 15:55:33 +00:00
- Make the filetype recognisable by adding the following to filetype.vim
2009-04-21 20:06:12 +00:00
in your runtimepath (~/.vim/filetype.vim):
2009-01-18 15:55:33 +00:00
augroup filetypedetect
au BufNewFile,BufRead .tmux.conf*,tmux.conf* setf tmux
augroup END
2009-04-21 20:06:12 +00:00
- Switch on syntax highlighting by adding "syntax enable" to your vimrc file.
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
2009-01-14 22:51:24 +00:00
The CVS HEAD version of tmux often has additional features from the release
versions; if interested, testing it is encouraged. It can be obtained by
anonymous CVS from SourceForge:
2009-01-18 17:20:52 +00:00
$ cvs -d:pserver:anoncvs@tmux.cvs.sf.net:/cvsroot/tmux co tmux
2009-01-14 22:51:24 +00:00
If running CVS HEAD, please note it is development code and there may be bugs
and undocumented features; please read the CHANGES file for information.
2009-04-21 20:06:12 +00:00
tmux mailing lists are available; visit:
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
nicm@users.sf.net
-- Nicholas Marriott <nicm@users.sf.net>
2009-04-21 20:57:10 +00:00
$Id: NOTES,v 1.46 2009-04-21 20:57:10 nicm Exp $