Instant Terminal Sharing
Go to file
Thomas Adam fab8ca0737 SYNCING: Make a note about libutils
Don't forget that compat/* needs updating periodically as well.
2014-08-09 20:32:09 +01:00
compat Sync libutil from OpenBSD (imsg) 2014-08-09 20:32:01 +01:00
examples Fix xterm-keys.vim syntax 2014-02-25 20:23:08 +00:00
tools Expand the Id keyword. 2011-07-09 09:42:33 +00:00
www www: Add link to CHANGES file for download tarball 2014-03-03 21:59:22 +00:00
.gitignore Ignore .dirstamp files 2013-10-11 14:36:28 +01:00
.mailmap Sanitise additional .mailmap entries 2012-11-08 21:39:35 +00:00
arguments.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +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 Add compat/fparseln() for non-BSD systems 2014-08-09 20:31:48 +01:00
CHANGES Remove LocalWords. 2014-04-02 18:02:25 +01:00
client.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +01:00
cmd-attach-session.c Merge branch 'obsd-master' 2014-04-05 12:36:14 +01:00
cmd-bind-key.c Merge branch 'obsd-master' 2014-06-20 12:59:43 +01:00
cmd-break-pane.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
cmd-capture-pane.c Merge branch 'obsd-master' 2014-06-20 12:59:43 +01:00
cmd-choose-buffer.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-choose-client.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-choose-tree.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-clear-history.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-clock-mode.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-command-prompt.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-confirm-before.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-copy-mode.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-delete-buffer.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-detach-client.c Merge branch 'obsd-master' 2013-10-15 08:06:56 +01:00
cmd-display-message.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-display-panes.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-find-window.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-has-session.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-if-shell.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-join-pane.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
cmd-kill-pane.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-kill-server.c Merge branch 'obsd-master' 2014-01-31 21:39:56 +00:00
cmd-kill-session.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-kill-window.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-link-window.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-list-buffers.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-list-clients.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-list-commands.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-list-keys.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-list-panes.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-list-sessions.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-list-windows.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-list.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
cmd-load-buffer.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-lock-server.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
cmd-move-window.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-new-session.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-new-window.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-paste-buffer.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-pipe-pane.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-queue.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
cmd-refresh-client.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-rename-session.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-rename-window.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-resize-pane.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-respawn-pane.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-respawn-window.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-rotate-window.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-run-shell.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
cmd-save-buffer.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-select-layout.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
cmd-select-pane.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-select-window.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-send-keys.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-set-buffer.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-set-environment.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-set-option.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
cmd-show-environment.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-show-messages.c Merge branch 'obsd-master' 2014-02-16 23:02:07 +00:00
cmd-show-options.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
cmd-source-file.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-split-window.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
cmd-string.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-suspend-client.c Remove the barely-used and unnecessary command check() function. 2013-08-21 18:01:40 +01:00
cmd-swap-pane.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-swap-window.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-switch-client.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
cmd-unbind-key.c Merge branch 'obsd-master' 2014-06-20 12:59:43 +01:00
cmd-unlink-window.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd-wait-for.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
cmd.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +01:00
colour.c Merge branch 'obsd-master' 2013-04-13 17:05:49 +01:00
compat.h Add compat/fparseln() for non-BSD systems 2014-08-09 20:31:48 +01:00
configure.ac Add compat/fparseln() for non-BSD systems 2014-08-09 20:31:48 +01:00
control-notify.c Differentiate between linked and unlinked window closes and renames, 2014-04-23 10:14:29 +00:00
control.c Merge branch 'obsd-master' into mtemp 2013-10-11 14:33:29 +01:00
COPYING Add a COPYING file, suggested by Dagobert Michelsen. 2013-05-31 12:59:17 +01:00
environ.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
FAQ FAQ: Mention Git before filing bug reports 2014-08-08 01:30:23 +01:00
format.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +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' 2014-04-23 11:26:11 +01:00
grid.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
input-keys.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +01:00
input.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +01:00
job.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
key-bindings.c Merge branch 'obsd-master' 2014-06-20 12:59:43 +01:00
key-string.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +01:00
layout-custom.c Merge branch 'obsd-master' 2013-03-25 14:59:29 +00:00
layout-set.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
layout.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
log.c Linux: Add <time.h> to log.c 2014-05-13 22:01:03 +01:00
Makefile.am Add compat/fparseln() for non-BSD systems 2014-08-09 20:31:48 +01: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' 2014-05-13 21:58:48 +01:00
names.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
notify.c Merge branch 'obsd-master' 2012-09-25 17:05:36 +01:00
options-table.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
options.c Merge branch 'obsd-master' 2014-01-31 21:39:56 +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-cygwin.c Add osdep-cgywin.c as a copy of osdep-linux.c, from J Raynor. 2014-03-08 08:44:24 +00: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 If pgrp fails in osdep_get_cwd, try sid. Fixes eg cat foo|less. From Balazs 2014-04-17 23:48:19 +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' 2014-08-09 20:31:36 +01: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' 2014-08-09 20:31:36 +01:00
README Note libevent version. 2013-12-09 22:53:17 +00:00
resize.c Make session_attached a count and add session_many_attached flag. 2014-03-31 21:37:55 +00:00
screen-redraw.c Having three *clock* files is ridiculous, remove clock.c. 2014-03-31 21:34:08 +00:00
screen-write.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
screen.c Merge branch 'obsd-master' 2014-01-31 21:39:56 +00:00
server-client.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +01:00
server-fn.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
server-window.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
server.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +01:00
session.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
signal.c Expand the Id keyword. 2011-07-09 09:42:33 +00:00
status.c Merge branch 'obsd-master' 2014-04-24 12:59:00 +01:00
style.c Handle colour 8 properly in the 256 colour palette, from Timothy Allen. 2014-05-08 05:53:29 +00:00
SYNCING SYNCING: Make a note about libutils 2014-08-09 20:32:09 +01:00
tmux.1 Merge branch 'obsd-master' 2014-06-20 12:59:43 +01:00
tmux.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
tmux.h Merge branch 'obsd-master' 2014-08-09 20:31:36 +01:00
TODO Notes for better mouse support. 2014-06-21 19:45:52 +01:00
tty-acs.c Merge branch 'obsd-master' 2014-01-31 21:39:56 +00:00
tty-keys.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +01:00
tty-term.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +01:00
tty.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +01:00
utf8.c Merge branch 'obsd-master' 2014-04-23 11:26:11 +01:00
window-choose.c Merge branch 'obsd-master' 2014-05-13 21:58:48 +01:00
window-clock.c Having three *clock* files is ridiculous, remove clock.c. 2014-03-31 21:34:08 +00:00
window-copy.c Merge branch 'obsd-master' 2014-06-20 12:59:43 +01:00
window.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +01:00
xmalloc.c Sync OpenBSD patchset 1150: 2012-07-11 19:34:16 +00:00
xterm-keys.c Merge branch 'obsd-master' 2014-08-09 20:31:36 +01: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).

tmux depends on libevent 2.x. 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$