Instant Terminal Sharing
Go to file
Nicholas Marriott f1aa5f6a1d Add to TODO.
2013-02-23 15:43:13 +00:00
compat Return error for --foo when using compat/getopt.c. 2013-02-12 20:36:22 +00:00
examples Move NOTES->README, move Vim syntax file documentation to the file itself and 2013-02-19 23:31:04 +00: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 Minor update to .gitignore 2013-02-09 10:26:57 +00:00
.mailmap Sanitise additional .mailmap entries 2012-11-08 21:39:35 +00:00
arguments.c Sync OpenBSD patchset 1150: 2012-07-11 19:34:16 +00: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 Need to set clients in context before changing their reference count. 2013-02-20 10:25:15 +00:00
CHANGES Update NOTES, CHANGES, configure.ac for 1.7 release 2012-10-13 11:56:14 +01:00
client.c No more lint means no more ARGSUSED. 2013-02-17 23:15:38 +00:00
clock.c Expand the Id keyword. 2011-07-09 09:42:33 +00:00
cmd-attach-session.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-bind-key.c Add copy-pipe mode command to copy selection and also pipe to a command. 2013-02-19 17:49:53 +00:00
cmd-break-pane.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-capture-pane.c Add -C and -J to capture pane to escape control sequences and to join wrapped 2013-02-21 09:35:01 +00:00
cmd-choose-buffer.c Allow choose commands to be used outside tmux, so long as at least one client 2013-02-10 17:52:51 +00:00
cmd-choose-client.c Allow choose commands to be used outside tmux, so long as at least one client 2013-02-10 17:52:51 +00:00
cmd-choose-list.c Allow choose commands to be used outside tmux, so long as at least one client 2013-02-10 17:52:51 +00:00
cmd-choose-tree.c Make choose-tree actually work again. 2013-02-15 12:57:13 +00:00
cmd-clear-history.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-clock-mode.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-command-prompt.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-confirm-before.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-copy-mode.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-delete-buffer.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-detach-client.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-display-message.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-display-panes.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-find-window.c Allow choose commands to be used outside tmux, so long as at least one client 2013-02-10 17:52:51 +00:00
cmd-has-session.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-if-shell.c Add functions to allocate and free command contexts rather than doing it all on 2013-02-18 23:20:21 +00:00
cmd-join-pane.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-kill-pane.c Add a patch missed during a merge sometime to use 2012-08-14 08:15:00 +00:00
cmd-kill-server.c No more lint means no more ARGSUSED. 2013-02-17 23:15:38 +00:00
cmd-kill-session.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-kill-window.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-link-window.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-list-buffers.c No more lint means no more ARGSUSED. 2013-02-17 23:15:38 +00:00
cmd-list-clients.c No more lint means no more ARGSUSED. 2013-02-17 23:15:38 +00:00
cmd-list-commands.c No more lint means no more ARGSUSED. 2013-02-17 23:15:38 +00:00
cmd-list-keys.c Add copy-pipe mode command to copy selection and also pipe to a command. 2013-02-19 17:49:53 +00:00
cmd-list-panes.c Merge branch 'obsd-master' 2012-12-31 18:50:37 +00:00
cmd-list-sessions.c Sync OpenBSD patchset 1162: 2012-08-31 09:18:50 +00:00
cmd-list-windows.c Merge branch 'obsd-master' 2012-10-25 23:32:14 +01:00
cmd-list.c Add functions to allocate and free command contexts rather than doing it all on 2013-02-18 23:20:21 +00:00
cmd-load-buffer.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-lock-server.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-move-window.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-new-session.c Merge branch 'obsd-master' 2012-12-31 18:50:37 +00:00
cmd-new-window.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-paste-buffer.c Merge branch 'obsd-master' 2012-12-31 18:50:37 +00:00
cmd-pipe-pane.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-refresh-client.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-rename-session.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-rename-window.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-resize-pane.c Add resize-pane -x and -y for absolute pane size. 2013-02-18 17:00:35 +00:00
cmd-respawn-pane.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-respawn-window.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-rotate-window.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-run-shell.c evbuffer_readline returns allocated storage, don't leak it. 2013-02-20 23:15:21 +00:00
cmd-save-buffer.c Merge show-buffer into save-buffer. 2013-02-23 14:23:35 +00:00
cmd-select-layout.c Merge branch 'obsd-master' 2013-02-07 12:08:55 +00:00
cmd-select-pane.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-select-window.c Merge branch 'obsd-master' 2012-12-31 18:50:37 +00:00
cmd-send-keys.c Merge send-prefix into send-keys. 2013-02-23 14:41:07 +00:00
cmd-server-info.c No more lint means no more ARGSUSED. 2013-02-17 23:15:38 +00:00
cmd-set-buffer.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-set-environment.c Merge branch 'obsd-master' 2012-11-04 01:27:57 +00:00
cmd-set-option.c Add user options, prefixed with @. May be set to any arbitrary string. 2013-02-13 09:54:24 +00:00
cmd-show-environment.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-show-messages.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-show-options.c Add user options, prefixed with @. May be set to any arbitrary string. 2013-02-13 09:54:24 +00:00
cmd-source-file.c Merge branch 'obsd-master' 2012-11-27 18:12:04 +00:00
cmd-split-window.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-start-server.c No more lint means no more ARGSUSED. 2013-02-17 23:15:38 +00:00
cmd-string.c Merge branch 'obsd-master' 2012-12-08 20:29:37 +00:00
cmd-suspend-client.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-swap-pane.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-swap-window.c Merge branch 'obsd-master' 2012-10-16 18:30:36 +01:00
cmd-switch-client.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
cmd-unbind-key.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd-unlink-window.c Sync OpenBSD patchset 1151: 2012-07-11 19:37:32 +00:00
cmd.c Fix error reporting for client commands by adding a flag to cmd_find_client to 2013-02-22 23:04:53 +00:00
colour.c Sync OpenBSD patchset 1006: 2012-01-21 19:33:45 +00:00
compat.h Typo. 2011-07-22 15:10:24 +00:00
configure.ac Working on 1.8 2012-10-13 12:12:43 +01:00
control-notify.c Add notification for input from a pane, from George Nachman. 2012-09-25 07:41:22 +00:00
control.c Need to set clients in context before changing their reference count. 2013-02-20 10:25:15 +00:00
environ.c Sync OpenBSD patchset 1150: 2012-07-11 19:34:16 +00:00
FAQ Remove a couple of FAQ bits that are out of date and not frequent. 2013-02-22 14:53:00 +00:00
format.c Add pane_tags format to format_window_pane based on code from George Nachman. 2013-02-23 13:02:52 +00: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 Add -C and -J to capture pane to escape control sequences and to join wrapped 2013-02-21 09:35:01 +00:00
grid.c Add -C and -J to capture pane to escape control sequences and to join wrapped 2013-02-21 09:35:01 +00:00
input-keys.c Support the latest theory for mouse input, this is enabled/disabled with SM/RM 2013-02-18 14:52:27 +00:00
input.c Add support for focus notifications when tmux pane changes, based on work by 2013-02-22 07:23:11 +00:00
job.c No more lint means no more ARGSUSED. 2013-02-17 23:15:38 +00:00
key-bindings.c Need to set clients in context before changing their reference count. 2013-02-20 10:25:15 +00:00
key-string.c In terminals with XT, turn on modifyOtherKeys=1 with the escape sequence and 2013-02-17 22:56:12 +00:00
layout-custom.c Sync OpenBSD patchset 1069: 2012-03-18 02:22:09 +00:00
layout-set.c Sync OpenBSD patchset 978: 2011-11-10 21:41:37 +00:00
layout.c Add resize-pane -x and -y for absolute pane size. 2013-02-18 17:00:35 +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
Makefile.am Merge send-prefix into send-keys. 2013-02-23 14:41:07 +00:00
mode-key.c Add copy-pipe mode command to copy selection and also pipe to a command. 2013-02-19 17:49:53 +00:00
names.c Add option command-prefix which is automatically prepended to any command 2013-02-22 14:31:38 +00:00
notify.c Merge branch 'obsd-master' 2012-09-25 17:05:36 +01:00
options-table.c Add option command-prefix which is automatically prepended to any command 2013-02-22 14:31:38 +00: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_pidinfo on Darwin for process name too, from OZAKI Kiichi. 2013-02-12 09:40:22 +00: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
README The visit -> Visit 2013-02-23 15:15:20 +00:00
resize.c Do not include status line in size calculations in control mode. 2013-02-17 10:04:26 +00:00
screen-redraw.c Sync OpenBSD patchset 1122: 2012-05-30 13:41:58 +00:00
screen-write.c Unbreak line wrapping. 2013-02-18 23:31:23 +00:00
screen.c Rework reflow code so it does not do so much allocation which should be faster 2013-02-10 18:15:30 +00:00
server-client.c Handle focus events from the terminal, from Aaron Jensen. 2013-02-23 10:01:34 +00:00
server-fn.c Prevent lock on control clients, not on others. 2013-02-19 21:11:32 +00:00
server-window.c Add various checks to turn off bits that can't work in control mode (such as 2013-02-17 10:12:55 +00:00
server.c No more lint means no more ARGSUSED. 2013-02-17 23:15:38 +00:00
session.c Add session_set_current helper function, extracted from a diff from Aaron 2013-02-21 16:54:13 +00:00
signal.c Expand the Id keyword. 2011-07-09 09:42:33 +00:00
status.c evbuffer_readline returns allocated storage, don't leak it. 2013-02-20 23:15:21 +00:00
SYNCING Move NOTES->README, move Vim syntax file documentation to the file itself and 2013-02-19 23:31:04 +00:00
tmux.1 Add pane_tags format to format_window_pane based on code from George Nachman. 2013-02-23 13:02:52 +00:00
tmux.c Merge branch 'obsd-master' 2012-11-27 18:12:04 +00:00
tmux.h Handle focus events from the terminal, from Aaron Jensen. 2013-02-23 10:01:34 +00:00
TODO Add to TODO. 2013-02-23 15:43:13 +00:00
tty-acs.c Expand the Id keyword. 2011-07-09 09:42:33 +00:00
tty-keys.c Handle focus events from the terminal, from Aaron Jensen. 2013-02-23 10:01:34 +00:00
tty-term.c Merge branch 'obsd-master' 2013-01-17 01:38:21 +00:00
tty.c Handle focus events from the terminal, from Aaron Jensen. 2013-02-23 10:01:34 +00:00
utf8.c Fix some UTF-8 Japanese issue on OS X, SF bug 3566884. 2012-09-24 13:56:32 +01:00
window-choose.c Need to set clients in context before changing their reference count. 2013-02-20 10:25:15 +00:00
window-clock.c No more lint means no more ARGSUSED. 2013-02-17 23:15:38 +00:00
window-copy.c Add copy-pipe mode command to copy selection and also pipe to a command. 2013-02-19 17:49:53 +00:00
window.c Do pane resize ioctls once at the end of the server loop rather than 2013-02-22 21:35:29 +00:00
xmalloc.c Sync OpenBSD patchset 1150: 2012-07-11 19:34:16 +00:00
xterm-keys.c In terminals with XT, turn on modifyOtherKeys=1 with the escape sequence and 2013-02-17 22:56:12 +00:00

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$