Go to file
Nicholas Marriott c7a121cfc0 Focus events can cause trouble if left on and they can't be turned off
during idle periods (like the other states are) because we'd miss
events. So add a server option to control them. Defaults to off.
2013-06-28 20:55:16 +01:00
compat +strings.h in compat/. 2013-06-25 09:57:49 +01:00
examples Add wait-for to tmux.vim from Ben Boeckel. 2013-04-10 13:04:19 +01:00
tools Expand the Id keyword. 2011-07-09 09:42:33 +00:00
www www Project Page -> SourceForge Page 2013-02-23 14:51:56 +00:00
.gitignore Amend tmux.1 handling in .gitignore 2013-06-01 10:58:39 +01:00
.mailmap Sanitise additional .mailmap entries 2012-11-08 21:39:35 +00:00
CHANGES Trivial typo fixes in changes. 2013-03-27 23:37:05 +00:00
COPYING Add a COPYING file, suggested by Dagobert Michelsen. 2013-05-31 12:59:17 +01:00
FAQ Remove a couple of FAQ bits that are out of date and not frequent. 2013-02-22 14:53:00 +00:00
Makefile.am Use _XPG6 on Solaris with GCC because the headers are insane and don't like GCC 2013-06-25 09:35:42 +01:00
README The visit -> Visit 2013-02-23 15:15:20 +00:00
SYNCING Move NOTES->README, move Vim syntax file documentation to the file itself and 2013-02-19 23:31:04 +00:00
TODO TODO tweaks. 2013-04-11 22:45:05 +01:00
arguments.c Merge branch 'obsd-master' 2013-05-31 21:44:42 +01:00
array.h Sync OpenBSD patchset 1150: 2012-07-11 19:34:16 +00:00
attributes.c Sync OpenBSD patchset 1067: 2012-03-18 02:17:20 +00:00
autogen.sh Only set AUTO{MAKE,CONF}_VERSION on OpenBSD 2013-01-31 00:14:59 +00:00
cfg.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
client.c Merge branch 'obsd-master' 2013-04-23 08:26:04 +01:00
clock.c Merge branch 'obsd-master' 2013-04-13 17:05:49 +01:00
cmd-attach-session.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-bind-key.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-break-pane.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-capture-pane.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-choose-buffer.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-choose-client.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-choose-list.c Add a command queue to standardize and simplify commands that call other 2013-03-24 09:54:10 +00:00
cmd-choose-tree.c Merge branch 'obsd-master' 2013-04-23 08:26:04 +01:00
cmd-clear-history.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-clock-mode.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-command-prompt.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-confirm-before.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-copy-mode.c Merge branch 'obsd-master' 2013-04-13 17:05:49 +01:00
cmd-delete-buffer.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-detach-client.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-display-message.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-display-panes.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-find-window.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-has-session.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-if-shell.c Merge branch 'obsd-master' 2013-03-25 16:30:37 +00:00
cmd-join-pane.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-kill-pane.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-kill-server.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-kill-session.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-kill-window.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-link-window.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-list-buffers.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-list-clients.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-list-commands.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-list-keys.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-list-panes.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-list-sessions.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-list-windows.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-list.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-load-buffer.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-lock-server.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-move-window.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-new-session.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-new-window.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-paste-buffer.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-pipe-pane.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-queue.c Mark control commands specially so the client can identify them, based 2013-06-28 20:55:16 +01:00
cmd-refresh-client.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-rename-session.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-rename-window.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-resize-pane.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-respawn-pane.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-respawn-window.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-rotate-window.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-run-shell.c Merge branch 'obsd-master' 2013-03-25 16:30:37 +00:00
cmd-save-buffer.c Remove compat/vis.h from cmd-save-buffer. 2013-03-25 16:09:34 +00:00
cmd-select-layout.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-select-pane.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-select-window.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-send-keys.c Merge branch 'obsd-master' 2013-05-31 21:44:42 +01:00
cmd-server-info.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-set-buffer.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-set-environment.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-set-option.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-show-environment.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-show-messages.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-show-options.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-source-file.c Merge branch 'obsd-master' 2013-04-13 17:05:49 +01:00
cmd-split-window.c Merge branch 'obsd-master' 2013-03-25 16:30:37 +00:00
cmd-start-server.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-string.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-suspend-client.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-swap-pane.c Merge branch 'obsd-master' 2013-04-13 17:05:49 +01:00
cmd-swap-window.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-switch-client.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-unbind-key.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-unlink-window.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
cmd-wait-for.c Add wait-for -L and -U for lock and unlock, from Thiago Padilha. 2013-03-25 10:09:35 +00:00
cmd.c Merge branch 'obsd-master' 2013-05-25 11:48:12 +01:00
colour.c Merge branch 'obsd-master' 2013-04-13 17:05:49 +01:00
compat.h Add compat for cfmakeraw, from Dagobert Michelsen. 2013-04-22 09:44:15 +01:00
configure.ac Use sysconfdir for the location of global tmux.conf (but default it to /etc), 2013-04-24 10:57:03 +01:00
control-notify.c Fix compiler warnings, missing #include. From Thomas Adam. 2013-03-26 10:54:48 +00:00
control.c Mark control commands specially so the client can identify them, based 2013-06-28 20:55:16 +01:00
environ.c Sync OpenBSD patchset 1150: 2012-07-11 19:34:16 +00:00
format.c Merge branch 'obsd-master' 2013-05-31 21:44:42 +01:00
grid-cell.c Rather than having two grids for each pane, one for ASCII and one for 2013-01-18 02:16:21 +00:00
grid-view.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
grid.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
input-keys.c Merge branch 'obsd-master' 2013-05-25 11:48:12 +01:00
input.c Always push a focus event when the application turns it on, prompted by 2013-06-28 20:55:16 +01:00
job.c Merge branch 'obsd-master' 2013-04-23 08:26:04 +01:00
key-bindings.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
key-string.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
layout-custom.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
layout-set.c Sync OpenBSD patchset 978: 2011-11-10 21:41:37 +00:00
layout.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
log.c Do not use stderr for log file and don't call log_close when not needed. 2012-05-30 15:01:57 +00:00
mdoc2man.awk Generate tmux.1 using mdoc2man.awk on Solaris, issue brought up and changes 2013-04-16 11:33:53 +01:00
mode-key.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
names.c Merge branch 'obsd-master' 2013-03-25 16:30:37 +00:00
notify.c Merge branch 'obsd-master' 2012-09-25 17:05:36 +01:00
options-table.c Focus events can cause trouble if left on and they can't be turned off 2013-06-28 20:55:16 +01:00
options.c Sync OpenBSD patchset 1150: 2012-07-11 19:34:16 +00:00
osdep-aix.c Use pgrp of pty fd not pid of immediate child when recovering current working 2012-09-24 14:05:38 +01:00
osdep-darwin.c Use proc_bsdinfo which works on older OS X versions, from OZAKI Kiichi. 2013-04-10 12:46:29 +01:00
osdep-dragonfly.c Use pgrp of pty fd not pid of immediate child when recovering current working 2012-09-24 14:05:38 +01:00
osdep-freebsd.c Use pgrp of pty fd not pid of immediate child when recovering current working 2012-09-24 14:05:38 +01:00
osdep-hpux.c Use pgrp of pty fd not pid of immediate child when recovering current working 2012-09-24 14:05:38 +01:00
osdep-linux.c Use pgrp of pty fd not pid of immediate child when recovering current working 2012-09-24 14:05:38 +01:00
osdep-netbsd.c Use pgrp of pty fd not pid of immediate child when recovering current working 2012-09-24 14:05:38 +01:00
osdep-openbsd.c Merge branch 'obsd-master' 2012-12-31 18:50:37 +00:00
osdep-sunos.c Use pgrp of pty fd not pid of immediate child when recovering current working 2012-09-24 14:05:38 +01:00
osdep-unknown.c Use pgrp of pty fd not pid of immediate child when recovering current working 2012-09-24 14:05:38 +01:00
paste.c Merge branch 'obsd-master' 2012-11-27 22:24:00 +00:00
resize.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
screen-redraw.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
screen-write.c Merge branch 'obsd-master' 2013-05-25 11:48:12 +01:00
screen.c Merge branch 'obsd-master' 2013-05-25 11:48:12 +01:00
server-client.c Focus events can cause trouble if left on and they can't be turned off 2013-06-28 20:55:16 +01:00
server-fn.c Merge branch 'obsd-master' 2013-04-23 08:26:04 +01:00
server-window.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
server.c Rename global configuration define. 2013-04-24 10:01:32 +00:00
session.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
signal.c Expand the Id keyword. 2011-07-09 09:42:33 +00:00
status.c Merge branch 'obsd-master' 2013-05-31 21:44:42 +01:00
tmux.1 Focus events can cause trouble if left on and they can't be turned off 2013-06-28 20:55:16 +01:00
tmux.c Rename global configuration define. 2013-04-24 10:01:32 +00:00
tmux.h Focus events can cause trouble if left on and they can't be turned off 2013-06-28 20:55:16 +01:00
tty-acs.c Expand the Id keyword. 2011-07-09 09:42:33 +00:00
tty-keys.c Merge branch 'obsd-master' 2013-03-26 16:59:37 +00:00
tty-term.c Merge branch 'obsd-master' 2013-06-13 18:12:49 +01:00
tty.c Focus events can cause trouble if left on and they can't be turned off 2013-06-28 20:55:16 +01:00
utf8.c Merge branch 'obsd-master' 2013-04-13 17:05:49 +01:00
window-choose.c Merge branch 'obsd-master' 2013-04-23 08:26:04 +01:00
window-clock.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
window-copy.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
window.c Merge branch 'obsd-master' 2013-03-26 16:59:37 +00:00
xmalloc.c Sync OpenBSD patchset 1150: 2012-07-11 19:34:16 +00:00
xterm-keys.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00

README

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).

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 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$