Go to file
nicm 4893edd5d6 Add a window-resized hook which is fired when the window is actually
resized which may be later than the client resize, GitHub issue 2995.
2022-04-06 14:19:49 +01:00
.github OS X -> macOS, from J Lewis Muir. 2021-11-11 09:18:04 +00:00
compat Remove compat.h again. 2021-03-08 08:59:13 +00:00
fuzz Needs fcntl.h. 2021-08-16 13:51:55 +01:00
logo Icons, from someone on GitHub in issue 2870. 2021-09-10 15:00:58 +01:00
presentations Add a couple of presentations I wrote a few years ago. One for the ill-fated 2015-06-04 08:23:40 +01:00
regress Regress conf from https://raw.githubusercontent.com/lacygoill/config/master/.config/tmux/tmux.conf. 2021-08-30 08:24:43 +01:00
tools Spelling, from someone in GitHub issue 2958. 2021-10-29 08:37:06 +01:00
.gitignore Scaffold for oss-fuzz, from Sergey Nizovtsev. 2020-11-09 16:44:39 +00:00
.mailmap Add to .mailmap. 2016-07-19 10:42:44 +01:00
.travis.yml Add FreeBSD CI, from Jan Beich. 2020-05-19 12:34:34 +01:00
alerts.c Merge branch 'obsd-master' into master 2021-04-12 12:01:32 +01:00
arguments.c Merge branch 'obsd-master' into master 2021-11-02 14:01:11 +00:00
attributes.c Add an attribute for ACS. 2020-04-23 07:15:17 +01:00
autogen.sh Bump automake and autoconf versions. 2017-03-22 08:45:53 +00:00
cfg.c Merge branch 'obsd-master' into master 2021-08-21 20:01:22 +01:00
CHANGES Update CHANGES. 2022-02-03 07:50:06 +00:00
client.c Merge branch 'obsd-master' into master 2021-08-27 20:01:11 +01:00
cmd-attach-session.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-bind-key.c Replace %% in command lists (by copying them) for template arguments , 2021-08-27 17:25:55 +00:00
cmd-break-pane.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-capture-pane.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-choose-tree.c Replace %% in command lists (by copying them) for template arguments , 2021-08-27 17:25:55 +00:00
cmd-command-prompt.c Fix command prompt with multiple prompts (add the result onto the list 2021-09-22 15:21:44 +00:00
cmd-confirm-before.c Expand command as a format, GitHub issue 2920. 2021-10-28 18:39:15 +00:00
cmd-copy-mode.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-detach-client.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-display-menu.c Merge branch 'obsd-master' into master 2021-10-25 12:01:11 +01:00
cmd-display-message.c Handle splitw -I correctly when used from an attached client, GitHub 2021-10-07 07:52:13 +00:00
cmd-display-panes.c Validate command argument types (string or command list) and give more 2021-08-25 08:51:55 +00:00
cmd-find-window.c Preserve argument type in command and convert to string on demand. 2021-08-21 20:46:43 +00:00
cmd-find.c Add a client flag 'active-pane' which stores the active pane in the 2020-05-16 16:20:59 +00:00
cmd-if-shell.c Add -e flag to set environment for popup, from Alexis Hildebrandt in 2021-10-11 10:55:30 +00:00
cmd-join-pane.c Merge branch 'obsd-master' into master 2021-08-21 12:01:41 +01:00
cmd-kill-pane.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-kill-server.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-kill-session.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-kill-window.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-list-buffers.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-list-clients.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-list-keys.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-list-panes.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-list-sessions.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-list-windows.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-load-buffer.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-lock-server.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-move-window.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-new-session.c Replace %% in command lists (by copying them) for template arguments , 2021-08-27 17:25:55 +00:00
cmd-new-window.c Replace %% in command lists (by copying them) for template arguments , 2021-08-27 17:25:55 +00:00
cmd-parse.y Disable aliases inside aliases for the moment. 2021-09-10 08:52:46 +00:00
cmd-paste-buffer.c Merge branch 'obsd-master' into master 2021-08-21 12:01:41 +01:00
cmd-pipe-pane.c Merge branch 'obsd-master' into master 2021-10-25 00:01:11 +01:00
cmd-queue.c Stop caring about empty commands, just treat as a null command. 2021-08-21 17:25:32 +00:00
cmd-refresh-client.c Do not create a buffer from an OSC 52 response if we have not sent a 2022-04-06 14:19:49 +01:00
cmd-rename-session.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-rename-window.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-resize-pane.c Adjust size given to resize-pane for pane status line, GitHub issue 2022-04-06 14:19:49 +01:00
cmd-resize-window.c Allow control mode clients to set a hard limit on the window width and 2021-08-27 17:15:57 +00:00
cmd-respawn-pane.c Replace %% in command lists (by copying them) for template arguments , 2021-08-27 17:25:55 +00:00
cmd-respawn-window.c Replace %% in command lists (by copying them) for template arguments , 2021-08-27 17:25:55 +00:00
cmd-rotate-window.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-run-shell.c Add -e flag to set environment for popup, from Alexis Hildebrandt in 2021-10-11 10:55:30 +00:00
cmd-save-buffer.c Merge branch 'obsd-master' into master 2021-08-21 12:01:41 +01:00
cmd-select-layout.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-select-pane.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-select-window.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-send-keys.c Same as -N, don't send if 0 arguments and -R. 2021-10-19 12:51:43 +00:00
cmd-set-buffer.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-set-environment.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-set-option.c Validate command argument types (string or command list) and give more 2021-08-25 08:51:55 +00:00
cmd-show-environment.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-show-messages.c Merge branch 'obsd-master' into master 2021-08-21 12:01:41 +01:00
cmd-show-options.c Do not return error with -q, GitHub issue 3065. 2022-04-06 14:19:49 +01:00
cmd-show-prompt-history.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-source-file.c Merge branch 'obsd-master' into master 2021-08-23 16:06:46 +01:00
cmd-split-window.c Merge branch 'obsd-master' into master 2021-10-07 10:01:10 +01:00
cmd-swap-pane.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-swap-window.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-switch-client.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-unbind-key.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd-wait-for.c Add args parsing callback for some future work, currently unused. 2021-08-21 10:22:38 +00:00
cmd.c Merge branch 'obsd-master' into master 2021-09-10 02:01:12 +01:00
colour.c Fix a comparison, from Ben Boeckel, and a crash when opening completion 2021-11-01 07:48:04 +00:00
compat.h Add compat clock_gettime for older macOS. GitHub issue 2555. 2021-02-05 11:01:21 +00:00
configure.ac No not allow static linking on macOS. 2022-04-06 14:19:49 +01:00
control-notify.c Add client-detached notification in control mode, from Mohsin Kaleem. 2021-03-16 09:14:58 +00:00
control.c Merge branch 'obsd-master' into master 2021-08-25 10:01:10 +01:00
COPYING There is no examples directory anymore. 2019-03-26 15:10:05 +00:00
environ.c Allow fnmatch(3) wildcards in update-environment, GitHub issue 2397. 2020-10-07 08:23:55 +00:00
example_tmux.conf Minor cleanups, GitHub issue 2824. 2021-08-14 18:39:56 +01:00
file.c Merge branch 'obsd-master' into master 2021-08-22 16:01:19 +01:00
format-draw.c Do not allow inline styles to replace mode-style for the selected item, 2021-10-26 12:22:23 +00:00
format.c Merge branch 'obsd-master' into master 2021-10-26 00:01:13 +01:00
grid-reader.c back-to-indentation fixes, from Anindya Mukherjee. 2021-06-10 09:20:42 +01:00
grid-view.c Move the code to set up a padding cell into grid.c. 2020-06-02 20:51:46 +00:00
grid.c Support underscore style with capture-pane -e, GitHub issue 2928. 2021-12-21 14:57:28 +00:00
input-keys.c Support more mouse buttons when the terminal sends them, GitHub issue 2022-04-06 14:19:49 +01:00
input.c Add an option (default off) to control the passthrough escape sequence. 2022-04-06 14:19:49 +01:00
job.c Merge branch 'obsd-master' into master 2022-02-01 14:01:11 +00:00
key-bindings.c Add a key in copy mode to toggle position indicator. 2022-02-03 07:26:43 +00:00
key-string.c Support more mouse buttons when the terminal sends them, GitHub issue 2022-04-06 14:19:49 +01:00
layout-custom.c Add split-window -Z to start the pane zoomed, GitHub issue 2591. 2021-03-11 06:31:05 +00:00
layout-set.c Add split-window -Z to start the pane zoomed, GitHub issue 2591. 2021-03-11 06:31:05 +00:00
layout.c Add split-window -Z to start the pane zoomed, GitHub issue 2591. 2021-03-11 06:31:05 +00:00
log.c Merge branch 'obsd-master' into master 2021-09-10 18:01:11 +01:00
Makefile.am Next is 3.4. 2021-09-15 14:07:42 +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
menu.c Support more mouse buttons when the terminal sends them, GitHub issue 2022-04-06 14:19:49 +01:00
mode-tree.c A menu must be shown on a client, so always give the client when adding 2022-02-01 18:12:20 +00:00
names.c Remove stray spaces after function names. 2021-08-20 17:50:42 +00:00
notify.c Merge branch 'obsd-master' into master 2021-08-12 10:01:22 +01:00
options-table.c Add a window-resized hook which is fired when the window is actually 2022-04-06 14:19:49 +01:00
options.c Add a cursor-style option, from Alexis Hildebrandt in GitHub issue 2960. 2021-11-03 13:37:17 +00:00
osdep-aix.c Update my email address. 2016-01-19 18:07:25 +00:00
osdep-cygwin.c Look for libevent2 differently from libevent for platforms with both. 2021-01-17 17:21:51 +00:00
osdep-darwin.c +compat.h 2021-01-17 17:52:10 +00:00
osdep-dragonfly.c Look for libevent2 differently from libevent for platforms with both. 2021-01-17 17:21:51 +00:00
osdep-freebsd.c Look for libevent2 differently from libevent for platforms with both. 2021-01-17 17:21:51 +00:00
osdep-haiku.c Look for libevent2 differently from libevent for platforms with both. 2021-01-17 17:21:51 +00:00
osdep-hpux.c Look for libevent2 differently from libevent for platforms with both. 2021-01-17 17:21:51 +00:00
osdep-linux.c Look for libevent2 differently from libevent for platforms with both. 2021-01-17 17:21:51 +00:00
osdep-netbsd.c Look for libevent2 differently from libevent for platforms with both. 2021-01-17 17:21:51 +00:00
osdep-openbsd.c Merge branch 'obsd-master' into master 2021-12-07 09:52:59 +00:00
osdep-sunos.c Looks like evports on SunOS are broken also, disable them. GitHub issue 2702. 2021-06-10 09:23:03 +01:00
osdep-unknown.c Look for libevent2 differently from libevent for platforms with both. 2021-01-17 17:21:51 +00:00
paste.c Use VIS_CSTYLE for paste buffers also. 2020-05-16 15:35:19 +00:00
popup.c Support more mouse buttons when the terminal sends them, GitHub issue 2022-04-06 14:19:49 +01:00
proc.c Remove queue.h, from Simon Holesch. 2021-03-28 10:16:17 +01:00
README OS X -> macOS, from J Lewis Muir. 2021-11-11 09:18:04 +00:00
README.ja OS X -> macOS, from J Lewis Muir. 2021-11-11 09:18:04 +00:00
regsub.c Some minor style nits. 2020-04-09 14:23:34 +00:00
resize.c Add a window-resized hook which is fired when the window is actually 2022-04-06 14:19:49 +01:00
screen-redraw.c Use ACS for pane border indicators so they work with different line 2022-04-06 14:19:49 +01:00
screen-write.c Do not allow inline styles to replace mode-style for the selected item, 2021-10-26 12:22:23 +00:00
screen.c Merge branch 'obsd-master' into master 2021-11-03 16:01:14 +00:00
server-client.c Support more mouse buttons when the terminal sends them, GitHub issue 2022-04-06 14:19:49 +01:00
server-fn.c Merge branch 'obsd-master' into master 2021-08-17 18:01:16 +01:00
server.c Fix warnings, from Jan Tache in GitHub issue 2692. 2021-06-10 09:22:39 +01:00
session.c Merge branch 'obsd-master' into master 2021-09-17 10:01:10 +01:00
spawn.c Merge branch 'obsd-master' into master 2021-08-23 16:06:46 +01:00
status.c Use format_draw for command prompt prefix to allow styles, GitHub issue 2022-02-03 10:07:11 +00:00
style.c Make newline a style delimiter as well so they can cross multiple lines 2021-08-12 20:46:30 +00:00
SYNCING Minor cleanups, GitHub issue 2824. 2021-08-14 18:39:56 +01:00
tmux-protocol.h Break message type stuff out into its own header. 2021-08-13 07:37:58 +00:00
tmux.1 Add an option (default off) to control the passthrough escape sequence. 2022-04-06 14:19:49 +01:00
tmux.c Merge branch 'obsd-master' into master 2021-08-23 16:06:46 +01:00
tmux.h Support more mouse buttons when the terminal sends them, GitHub issue 2022-04-06 14:19:49 +01:00
tty-acs.c Spacing fixes from Alexis Hildebrandt. 2021-10-18 09:15:56 +00:00
tty-features.c Support underscore style with capture-pane -e, GitHub issue 2928. 2021-12-21 14:57:28 +00:00
tty-keys.c Support more mouse buttons when the terminal sends them, GitHub issue 2022-04-06 14:19:49 +01:00
tty-term.c Merge branch 'obsd-master' into master 2021-08-25 10:01:10 +01:00
tty.c Do not create a buffer from an OSC 52 response if we have not sent a 2022-04-06 14:19:49 +01:00
utf8.c Remove fallback for wcwidth failure, GitHub issue 3003. 2021-12-06 10:17:34 +00:00
window-buffer.c Merge branch 'obsd-master' into master 2021-08-20 22:01:46 +01:00
window-client.c Hide struct args behind a couple of accessor functions. 2021-08-20 19:50:16 +00:00
window-clock.c Do not hoke into struct window_pane from the tty code and instead set 2020-05-01 17:01:36 +01:00
window-copy.c Add a key in copy mode to toggle position indicator. 2022-02-03 07:26:43 +00:00
window-customize.c Fix user option lookup ordering. 2021-11-29 11:01:51 +00:00
window-tree.c Merge branch 'obsd-master' into master 2021-10-20 14:01:15 +01:00
window.c Merge branch 'obsd-master' into master 2022-02-03 10:01:10 +00:00
xmalloc.c Add xrecallocarray. 2019-11-28 09:51:58 +00:00
xmalloc.h Merge branch 'obsd-master' into master 2021-08-25 10:01:10 +01:00

Welcome to tmux!

tmux is a terminal multiplexer: it enables a number of terminals to be created,
accessed, and controlled from a single screen. tmux may be detached from a
screen and continue running in the background, then later reattached.

This release runs on OpenBSD, FreeBSD, NetBSD, Linux, macOS and Solaris.

* Dependencies

tmux depends on libevent 2.x, available from:

	https://github.com/libevent/libevent/releases/latest

It also depends on ncurses, available from:

	https://invisible-mirror.net/archives/ncurses/

To build tmux, a C compiler (for example gcc or clang), make, pkg-config and a
suitable yacc (yacc or bison) are needed.

* Installation

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 - note that this requires
autoconf, automake and pkg-config:

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

* Contributing

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

	tmux-users@googlegroups.com

Or open a GitHub issue or pull request.

* Documentation

For documentation on using tmux, see the tmux.1 manpage. View it from the
source tree with:

	$ nroff -mdoc tmux.1|less

A small example configuration is in example_tmux.conf.

Other documentation is available in the wiki:

	https://github.com/tmux/tmux/wiki

Also see the tmux FAQ at:

	https://github.com/tmux/tmux/wiki/FAQ

A bash(1) completion file is at:

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

For debugging, run tmux with -v and -vv to generate server and client log files
in the current directory.

* Support

The tmux mailing list for general discussion and bug reports is:

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

Subscribe by sending an email to:

	tmux-users+subscribe@googlegroups.com

* License

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