tmux source code
C Roff PostScript M4 Awk Shell Makefile
Clone or download
Pull request Compare This branch is 365 commits behind tmux:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
compat
logo
presentations
regress
tools
.gitignore
.mailmap
.travis.yml
CHANGES
CONTRIBUTING
COPYING
ISSUE_TEMPLATE
Makefile.am
README
SYNCING
TODO
alerts.c
arguments.c
attributes.c
autogen.sh
cfg.c
client.c
cmd-attach-session.c
cmd-bind-key.c
cmd-break-pane.c
cmd-capture-pane.c
cmd-choose-tree.c
cmd-command-prompt.c
cmd-confirm-before.c
cmd-copy-mode.c
cmd-detach-client.c
cmd-display-message.c
cmd-display-panes.c
cmd-find-window.c
cmd-find.c
cmd-if-shell.c
cmd-join-pane.c
cmd-kill-pane.c
cmd-kill-server.c
cmd-kill-session.c
cmd-kill-window.c
cmd-list-buffers.c
cmd-list-clients.c
cmd-list-keys.c
cmd-list-panes.c
cmd-list-sessions.c
cmd-list-windows.c
cmd-list.c
cmd-load-buffer.c
cmd-lock-server.c
cmd-move-window.c
cmd-new-session.c
cmd-new-window.c
cmd-paste-buffer.c
cmd-pipe-pane.c
cmd-queue.c
cmd-refresh-client.c
cmd-rename-session.c
cmd-rename-window.c
cmd-resize-pane.c
cmd-respawn-pane.c
cmd-respawn-window.c
cmd-rotate-window.c
cmd-run-shell.c
cmd-save-buffer.c
cmd-select-layout.c
cmd-select-pane.c
cmd-select-window.c
cmd-send-keys.c
cmd-set-buffer.c
cmd-set-environment.c
cmd-set-hook.c
cmd-set-option.c
cmd-show-environment.c
cmd-show-messages.c
cmd-show-options.c
cmd-source-file.c
cmd-split-window.c
cmd-string.c
cmd-swap-pane.c
cmd-swap-window.c
cmd-switch-client.c
cmd-unbind-key.c
cmd-wait-for.c
cmd.c
colour.c
compat.h
configure.ac
control-notify.c
control.c
environ.c
example_tmux.conf
format.c
grid-view.c
grid.c
hooks.c
input-keys.c
input.c
job.c
key-bindings.c
key-string.c
layout-custom.c
layout-set.c
layout.c
log.c
mdoc2man.awk
mode-tree.c
names.c
notify.c
options-table.c
options.c
osdep-aix.c
osdep-cygwin.c
osdep-darwin.c
osdep-dragonfly.c
osdep-freebsd.c
osdep-hpux.c
osdep-linux.c
osdep-netbsd.c
osdep-openbsd.c
osdep-sunos.c
osdep-unknown.c
paste.c
proc.c
resize.c
screen-redraw.c
screen-write.c
screen.c
server-client.c
server-fn.c
server.c
session.c
signal.c
status.c
style.c
tmux.1
tmux.c
tmux.h
tty-acs.c
tty-keys.c
tty-term.c
tty.c
utf8.c
window-buffer.c
window-client.c
window-clock.c
window-copy.c
window-tree.c
window.c
xmalloc.c
xmalloc.h
xterm-keys.c

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, OS X and Solaris.

tmux depends on libevent 2.x. Download it from:

	http://libevent.org

It also depends on ncurses, available from:

	http://invisible-island.net/ncurses/

To build and install tmux from a release tarball, use:

	$ ./configure && make
	$ sudo make install

tmux can use the utempter library to update utmp(5), if it is installed - run
configure with --enable-utempter to enable this.

To get and build the latest from version control:

	$ git clone https://github.com/tmux/tmux.git
	$ cd tmux
	$ sh autogen.sh
	$ ./configure && make

(Note that this requires at least a working C compiler, make, autoconf,
automake, pkg-config as well as libevent and ncurses libraries and headers.)

For more information see http://git-scm.com. Patches should be sent by email to
the mailing list at tmux-users@googlegroups.com.

For documentation on using tmux, see the tmux.1 manpage. It can be viewed from
the source tree with:

	$ nroff -mdoc tmux.1|less

A small example configuration in example_tmux.conf.

A vim(1) syntax file is available at:

	https://github.com/ericpruitt/tmux.vim
	https://raw.githubusercontent.com/ericpruitt/tmux.vim/master/vim/syntax/tmux.vim

And a bash(1) completion file at:

	https://github.com/imomaliev/tmux-bash-completion

For debugging, running tmux with -v or -vv will generate server and client log
files in the current directory.

tmux mailing lists are available. For general discussion and bug reports:

	https://groups.google.com/forum/#!forum/tmux-users

And for Git commit emails:

	https://groups.google.com/forum/#!forum/tmux-git

Subscribe by sending an email to <tmux-users+subscribe@googlegroups.com>.

Bug reports, feature suggestions and especially code contributions are most
welcome. Please send by email to:

	tmux-users@googlegroups.com

This file and the CHANGES, FAQ, SYNCING and TODO files are licensed under the
ISC license. All other files have a license and copyright notice at their start.

-- Nicholas Marriott <nicholas.marriott@gmail.com>