circlecloud/tmux
1
0
Fork 0
mirror of https://github.com/tmux/tmux.git synced 2025-03-25 23:38:48 +00:00
Code Issues Projects Releases Wiki Activity
10,471 Commits 3 Branches 37 Tags 43 MiB
C 87.5%
Roff 7.1%
Shell 2.6%
Yacc 1.4%
M4 0.8%
Other 0.5%
ce7603ce87
Go to file
Julian Prein ce7603ce87
Improve documentation on the type of options 
To be more close to the implementation, use 'scope' for what was
previously called 'type', and improve the documentation on the actual
option types (i.e. flag, choices, ...).

Rephrase the sentence before {set,show}-options commands to be similar
to the one in the HOOKS section, since show-options does not actually
set options.

Co-authored-by: Julian Prein <julian@druck.dev>
2025-03-21 00:12:59 +01:00
.github Remove old issue template. 2025-01-20 13:06:03 +00:00
compat Remove endian.h. 2024-11-27 10:31:51 +00:00
fuzz Typo from Bastian Venthur. 2024-09-06 13:09:43 +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 Fix up regression tests. 2024-10-01 13:40:42 +01:00
tools Merge SIXEL branch. 2023-08-22 08:43:35 +01:00
.gitignore Add .swp, from Nikola Tadic. 2025-02-20 13:31:07 +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' 2025-02-10 10:01:11 +00:00
arguments.c Merge branch 'obsd-master' 2024-05-13 14:01:10 +01: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' 2023-09-15 10:01:11 +01:00
CHANGES tmux 3.5. 2024-09-27 08:56:39 +01:00
client.c Merge branch 'obsd-master' 2025-02-26 10:01:14 +00:00
cmd-attach-session.c Show config errors on attach if they were not shown when the session 2022-07-06 08:40:52 +00:00
cmd-bind-key.c Fix documentation around optional arguments 2025-03-20 23:06:20 +01:00
cmd-break-pane.c Add mode 2031 support to automatically report dark or light theme. tmux 2025-03-04 08:45:04 +00:00
cmd-capture-pane.c Add a -M flag to capture-pane to use the copy mode screen, GitHub issue 2025-02-20 13:39:58 +00:00
cmd-choose-tree.c Add -y flag to disable confirmation prompts in modes, GitHub issue 4152. 2024-10-04 19:16:13 +00:00
cmd-command-prompt.c Fixes for memory leaks reported by Lu Ming Yin, fixes from Howard Chu. 2024-04-15 08:19:55 +00:00
cmd-confirm-before.c Enter is now sent from single prompt as \r not empty string. 2024-11-26 15:51:48 +00:00
cmd-copy-mode.c Mouse support on the scrollbars, from Michael Grant. 2024-11-12 09:32:56 +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 Fix documentation around optional arguments 2025-03-20 23:06:20 +01:00
cmd-display-message.c Add display-message -C flag to update pane while message is displayed, 2025-02-10 08:14:32 +00:00
cmd-display-panes.c Do not notify window-layout-changed if the window is about to be 2024-03-21 11:30:42 +00:00
cmd-find-window.c Only wrap pattern in *s if using a regular expression. 2023-12-27 20:42:01 +00:00
cmd-find.c Merge branch 'obsd-master' 2023-07-10 12:01:12 +01:00
cmd-if-shell.c Add display-message -C flag to update pane while message is displayed, 2025-02-10 08:14:32 +00:00
cmd-join-pane.c Merge branch 'obsd-master' 2025-03-04 10:01:15 +00: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 -f to list-clients like the other list commands, from Andy Walker in 2023-02-06 09:20:30 +00:00
cmd-list-keys.c Add display-message -C flag to update pane while message is displayed, 2025-02-10 08:14:32 +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 If an application gives the first parameter to OSC 52, validate and pass 2022-06-09 09:12:55 +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 Fix documentation around optional arguments 2025-03-20 23:06:20 +01:00
cmd-new-window.c Fix documentation around optional arguments 2025-03-20 23:06:20 +01:00
cmd-parse.y Count line numbers correctly inside strings, reported by Pedro Navarro 2025-01-13 08:58:34 +00:00
cmd-paste-buffer.c Merge branch 'obsd-master' 2024-02-13 10:01:10 +00:00
cmd-pipe-pane.c Merge branch 'obsd-master' 2024-02-13 10:01:10 +00:00
cmd-queue.c Merge branch 'obsd-master' 2025-02-10 10:01:11 +00:00
cmd-refresh-client.c Add a way (refresh-client -r) for control mode clients to provide OSC 10 2024-06-24 08:30:50 +00: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 Do not notify window-layout-changed if the window is about to be 2024-03-21 11:30:42 +00:00
cmd-resize-window.c Get rid of some warnings with GCC 10, from Thomas Klausner. 2023-06-30 13:19:32 +00:00
cmd-respawn-pane.c Fix documentation around optional arguments 2025-03-20 23:06:20 +01:00
cmd-respawn-window.c Fix documentation around optional arguments 2025-03-20 23:06:20 +01: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 Fix run-shell's maximum argument count 2025-03-20 23:06:21 +01:00
cmd-save-buffer.c Merge branch 'obsd-master' 2024-11-22 14:01:11 +00:00
cmd-select-layout.c Better error reporting when applying custom layouts. 2022-05-30 12:52:02 +00:00
cmd-select-pane.c Add mode 2031 support to automatically report dark or light theme. tmux 2025-03-04 08:45:04 +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 Fix documentation around optional arguments 2025-03-20 23:06:20 +01:00
cmd-server-access.c Add a missing space. 2022-05-31 16:13:43 +00:00
cmd-set-buffer.c Fix documentation around optional arguments 2025-03-20 23:06:20 +01: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 Fix documentation around optional arguments 2025-03-20 23:06:20 +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' 2024-12-16 12:01:12 +00:00
cmd-split-window.c Fix documentation around optional arguments 2025-03-20 23:06:20 +01:00
cmd-swap-pane.c Add mode 2031 support to automatically report dark or light theme. tmux 2025-03-04 08:45:04 +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' 2025-01-27 12:01:13 +00:00
colour.c Add mode 2031 support to automatically report dark or light theme. tmux 2025-03-04 08:45:04 +00:00
compat.h Use evbuffer_readline if readln is not available. It doesn't work properly but 2024-11-27 10:37:45 +00:00
configure.ac Look for imsg_add not _init now. 2025-02-13 16:24:33 +00:00
control-notify.c Add paste-buffer-deleted notification and fix name of paste-buffer-changed. 2022-10-28 13:00:02 +00:00
control.c Merge branch 'obsd-master' 2022-08-24 10:01:13 +01:00
COPYING There is no examples directory anymore. 2019-03-26 15:10:05 +00:00
environ.c If built with systemd, remove some environment variables it uses. From Ciprian 2024-08-04 09:58:13 +01:00
example_tmux.conf Use terminal-features instead of terminal-overrides to enable truecolor support 2024-08-04 09:59:18 +01:00
file.c Merge branch 'obsd-master' 2023-04-27 19:16:08 +01:00
format-draw.c Add a session, pane and user mouse range types for the status line and 2023-08-17 14:10:28 +00:00
format.c Merge branch 'obsd-master' 2025-03-04 10:01:15 +00:00
grid-reader.c Fix word navigation on lines with tabs, from Alexander Arch. 2024-11-20 20:54:02 +00:00
grid-view.c Add a -T flag to capture-pane to stop at the last used cell instead of 2022-09-28 07:55:29 +00:00
grid.c Fix word navigation on lines with tabs, from Alexander Arch. 2024-11-20 20:54:02 +00:00
hyperlinks.c Merge branch 'obsd-master' 2024-08-28 10:27:21 +01:00
image-sixel.c Optimize sixel_print. Previously, the algorithm scanned each pixel several 2024-10-14 11:05:59 +01:00
image.c Merge SIXEL branch. 2023-08-22 08:43:35 +01:00
input-keys.c Merge branch 'obsd-master' 2025-03-04 10:01:15 +00:00
input.c Merge branch 'obsd-master' 2025-03-04 10:01:15 +00:00
job.c Merge branch 'obsd-master' 2024-09-30 12:01:11 +01:00
key-bindings.c Mouse support on the scrollbars, from Michael Grant. 2024-11-12 09:32:56 +00:00
key-string.c Ignore internal function keys if they have not got an entry in the key 2024-08-23 13:25:39 +00:00
layout-custom.c Fixes for memory leaks reported by Lu Ming Yin, fixes from Howard Chu. 2024-04-15 08:19:55 +00:00
layout-set.c Check for exact match for layout name before looking for a prefix match. 2024-08-23 10:19:06 +00:00
layout.c Assign excess space more evenly when spreading out cells, from Torbjorn 2024-12-17 08:40:24 +00:00
log.c Spacing/style nits. 2022-05-30 12:55:25 +00:00
Makefile.am Add -Wno-macro-redefined for macOS. 2024-10-31 12:57:40 +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
menu.c Allow attributes in menu style, from Japin Li in GitHub issue 4194. 2024-10-17 17:10:41 +00:00
mode-tree.c Align index numbers in trees, from David Mandelberg, GitHub issue 4360. 2025-02-10 08:18:23 +00:00
names.c Remove stray spaces after function names. 2021-08-20 17:50:42 +00:00
notify.c Merge branch 'obsd-master' 2023-06-30 16:01:10 +01:00
options-table.c Merge branch 'obsd-master' 2025-03-04 10:01:15 +00:00
options.c Add mode 2031 support to automatically report dark or light theme. tmux 2025-03-04 08:45:04 +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 Remove unnecessary declarations. 2022-04-06 14:19:50 +01:00
osdep-openbsd.c Use PATH_MAX instead of MAXPATHLEN. 2022-04-06 14:19:50 +01: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 Merge branch 'obsd-master' 2024-10-12 12:01:09 +01:00
popup.c Merge branch 'obsd-master' 2025-01-12 16:01:11 +00:00
proc.c Update imsg and remove workaround. 2024-11-27 10:30:52 +00:00
README Add install step. 2024-10-04 23:29:36 +01:00
README.ja OS X -> macOS, from J Lewis Muir. 2021-11-11 09:18:04 +00:00
regsub.c Change a few types to fix warnings, from Thomas Klausner. 2023-06-30 21:55:08 +00:00
resize.c Do not check for latest client in callback since the type may be latest 2024-11-27 10:12:20 +00:00
screen-redraw.c Merge branch 'obsd-master' 2025-02-26 10:01:14 +00:00
screen-write.c Merge branch 'obsd-master' 2024-11-16 18:01:08 +00:00
screen.c Merge branch 'obsd-master' 2024-11-15 10:01:11 +00:00
server-acl.c Spacing/style nits. 2022-05-30 12:55:25 +00:00
server-client.c Merge branch 'obsd-master' 2025-03-04 10:01:15 +00:00
server-fn.c Merge branch 'obsd-master' 2024-11-15 16:01:11 +00:00
server.c Merge branch 'obsd-master' 2025-01-01 18:01:10 +00:00
session.c Merge branch 'obsd-master' 2025-03-04 10:01:15 +00:00
spawn.c Merge branch 'obsd-master' 2023-07-10 12:01:12 +01:00
status.c Add display-message -C flag to update pane while message is displayed, 2025-02-10 08:14:32 +00:00
style.c Add two new style parameters, width and pad, which apply to scrollbars. 2024-11-15 13:12:20 +00:00
SYNCING Minor cleanups, GitHub issue 2824. 2021-08-14 18:39:56 +01:00
tmux-protocol.h If a pane is killed, cancel reading from the file. GitHub issue 3422. 2023-01-06 07:09:27 +00:00
tmux.1 Improve documentation on the type of options 2025-03-21 00:12:59 +01:00
tmux.c Merge branch 'obsd-master' 2024-10-02 14:01:10 +01:00
tmux.h Merge branch 'obsd-master' 2025-03-04 10:01:15 +00:00
tty-acs.c Fix a couple of rounded border characters, from Alexis Hildebrandt. 2023-08-08 07:19:48 +00:00
tty-features.c Merge branch 'obsd-master' 2024-11-28 10:01:11 +00:00
tty-keys.c If there is an active query, set escape time temporarily to a higher 2025-03-17 20:43:29 +00:00
tty-term.c Merge branch 'obsd-master' 2024-08-28 10:27:21 +01:00
tty.c Merge branch 'obsd-master' 2025-03-04 10:01:15 +00:00
utf8-combined.c Add an option allowing users to override the width of individual Unicode 2025-01-01 15:17:36 +00:00
utf8.c Merge branch 'obsd-master' 2025-01-01 18:01:10 +00:00
window-buffer.c Merge branch 'obsd-master' 2024-08-04 12:01:09 +01:00
window-client.c Extend the menu drawing function to support custom characters and 2023-08-08 07:41:04 +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 Handle padding cells correctly for regular expression searching, GitHub issue 4399 from 2025-03-17 20:33:20 +00:00
window-customize.c Add display-message -C flag to update pane while message is displayed, 2025-02-10 08:14:32 +00:00
window-tree.c Merge branch 'obsd-master' 2024-10-04 22:01:09 +01:00
window.c Merge branch 'obsd-master' 2025-03-11 10:01:12 +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

README 

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
	$ sudo make install

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