Partial tmux.1 update thanks to Will Maier.

pull/1/head
Nicholas Marriott 2008-06-06 20:07:56 +00:00
parent 367e002bc2
commit 29e2253611
2 changed files with 65 additions and 57 deletions

1
TODO
View File

@ -82,3 +82,4 @@
- fix occasion start server problems - fix occasion start server problems
- key binding bug: random changes? - key binding bug: random changes?
- test and fix wsvt25 - test and fix wsvt25
- activity/bell should be per-window not per-link

121
tmux.1
View File

@ -1,4 +1,4 @@
.\" $Id: tmux.1,v 1.30 2008-06-06 15:23:44 nicm Exp $ .\" $Id: tmux.1,v 1.31 2008-06-06 20:07:56 nicm Exp $
.\" .\"
.\" Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net> .\" Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
.\" .\"
@ -34,12 +34,13 @@ is a terminal multiplexer; it enables a number of terminals (or windows) to be
accessed and controlled from a single terminal. accessed and controlled from a single terminal.
.Pp .Pp
.Nm .Nm
runs as a server-client system. A server is created automatically when runs as a server-client system.
necessary and holds a number of A server is created automatically when necessary and holds a number of
.Em sessions , .Em sessions ,
each of which may have a number of each of which may have a number of
.Em windows .Em windows
linked to it. Any number of linked to it.
Any number of
.Em clients .Em clients
may connect to a session, or the server may connect to a session, or the server
may be controlled by issuing commands with may be controlled by issuing commands with
@ -62,7 +63,8 @@ is the pid of the server or client process.
.It Fl V .It Fl V
Print program version. Print program version.
.It Fl f Ar file .It Fl f Ar file
Specify an alternative configuration file. By default, Specify an alternative configuration file.
By default,
.Nm .Nm
will look for a config file at ~/.tmux.conf. will look for a config file at ~/.tmux.conf.
.It Fl S Ar socket-path .It Fl S Ar socket-path
@ -89,7 +91,7 @@ To create a new tmux session running
.Dl $ tmux new-session vi .Dl $ tmux new-session vi
.Pp .Pp
Most commands have a shorter form, known as an alias. Most commands have a shorter form, known as an alias.
For new-session, this is For new-session, this is
.Ic new : .Ic new :
.Pp .Pp
.Dl $ tmux new vi .Dl $ tmux new vi
@ -109,7 +111,7 @@ followed by the
.Ql c .Ql c
key. key.
.Pp .Pp
Windows may be navigated with: Windows may be navigated with:
.Ql ^B 0 .Ql ^B 0
(to select window 0), (to select window 0),
.Ql ^B 1 .Ql ^B 1
@ -125,7 +127,7 @@ and reattached with:
.Pp .Pp
.Dl $ tmux attach-session .Dl $ tmux attach-session
.Pp .Pp
Typing Typing
.Ql ^B \&? .Ql ^B \&?
lists the current key bindings in the current window; up and down may be used lists the current key bindings in the current window; up and down may be used
to navigate the list or to navigate the list or
@ -134,7 +136,7 @@ to exit from it.
.Sh KEY BINDINGS .Sh KEY BINDINGS
.Nm .Nm
may be controlled from an attached client by using a key combination of a may be controlled from an attached client by using a key combination of a
prefix, prefix,
.Ql ^B .Ql ^B
(ctrl-B) by default, followed by a command key. (ctrl-B) by default, followed by a command key.
.Pp .Pp
@ -158,8 +160,9 @@ List current key bindings.
A complete list may be obtained with the A complete list may be obtained with the
.Ic list-keys .Ic list-keys
command (bound to command (bound to
.Ql \&? .Ql \&?
by default). Key bindings may be changed with the by default).
Key bindings may be changed with the
.Ic bind-key .Ic bind-key
and and
.Ic unbind-key .Ic unbind-key
@ -187,7 +190,7 @@ The
.Ql up , .Ql up ,
.Ql down , .Ql down ,
.Ql page-up .Ql page-up
and and
.Ql page-down .Ql page-down
keys or keys or
.Xr vi 1 .Xr vi 1
@ -220,13 +223,13 @@ In addition,
.Ql ^A .Ql ^A
and and
.Ql ^E .Ql ^E
(or the (or the
.Xr vi 1 .Xr vi 1
style style
.Ql 0 .Ql 0
and and
.Ql $ .Ql $
keys) move to the start and end of the line; the space key begins a selection; keys) move to the start and end of the line; the space key begins a selection;
and the enter key or and the enter key or
.Ql ^W .Ql ^W
copies the selection to the paste buffer and exits copy mode. copies the selection to the paste buffer and exits copy mode.
@ -234,7 +237,7 @@ copies the selection to the paste buffer and exits copy mode.
This mode is entered with the This mode is entered with the
.Ic copy-mode .Ic copy-mode
command, bound to command, bound to
.Ql [ .Ql [
by default. by default.
.El .El
.Sh COMMANDS .Sh COMMANDS
@ -263,7 +266,7 @@ The following commands are available:
.Bl -tag -width Ds .Bl -tag -width Ds
.It Xo Ic attach-session .It Xo Ic attach-session
.Op Fl d .Op Fl d
.Op Fl s Ar session-name .Op Fl t Ar target-session
.Xc .Xc
.D1 (alias: Ic attach ) .D1 (alias: Ic attach )
Create a new client in the current terminal and attach it to a session. Create a new client in the current terminal and attach it to a session.
@ -279,76 +282,78 @@ Bind key
to to
.Ar command . .Ar command .
.It Xo Ic copy-mode .It Xo Ic copy-mode
.Op Fl s Ar session-name .Op Fl t Ar target-window
.Xc .Xc
Enter copy mode. Enter copy mode.
.It Xo Ic detach-client .It Xo Ic detach-client
.Op Fl c Ar client-tty .Op Fl t Ar target-client
.Xc .Xc
.D1 (alias: Ic detach ) .D1 (alias: Ic detach )
Detach the current client if bound to a key, or the specified client with Detach the current client if bound to a key, or the specified client with
.Fl c . .Fl t .
.It Xo Ic has-session .It Xo Ic has-session
.Op Fl s Ar session-name .Op Fl t Ar target-session
.Xc .Xc
.D1 (alias: Ic has ) .D1 (alias: Ic has )
Report an error and exit with 1 if the specified session does not exist. If it Report an error and exit with 1 if the specified session does not exist.
does exist, exit with 0. If it does exist, exit with 0.
.It Xo Ic kill-server .It Xo Ic kill-server
.Xc .Xc
Kill the Kill the
.Nm .Nm
server and clients and destroy all sessions. server and clients and destroy all sessions.
.It Xo Ic kill-session .It Xo Ic kill-session
.Op Fl s Ar session-name .Op Fl t Ar target-session
.Xc .Xc
Destroy the given session, closing any windows linked to it and no other Destroy the given session, closing any windows linked to it and no other
sessions, and detaching all clients attached to it. sessions, and detaching all clients attached to it.
.It Xo Ic kill-window .It Xo Ic kill-window
.Op Fl i Ar index .Op Fl t Ar target-window
.Op Fl s Ar session-name
.Xc .Xc
.D1 (alias: Ic killw ) .D1 (alias: Ic killw )
Kill the current window or the window at Kill the current window or the window at
.Ar index , .Ar target-window ,
removing it from any sessions to which it is linked. removing it from any sessions to which it is linked.
.It Xo Ic last-window .It Xo Ic last-window
.Op Fl s Ar session-name .Op Fl t Ar target-session
.Xc .Xc
.D1 (alias: Ic last ) .D1 (alias: Ic last )
Select the last (previously selected) window. Select the last (previously selected) window.
.It Xo Ic link-window If no
.Ar target-session
is specified, select to the last window of the current session.
.It Xo Ic link-window
.Op Fl dk .Op Fl dk
.Op Fl i Ar index .Op Fl s Ar src-window
.Op Fl s Ar session-name .Op Fl t Ar dst-window
.Ar source-name Ar source-index
.Xc .Xc
.D1 (alias: Ic linkw ) .D1 (alias: Ic linkw )
Link the window at Link the window at
.Ar source-index .Ar src-window
in session to the specified
.Ar source-name .Ar dst-window .
into the specified session. If If
.Ar index .Ar dst-window
is specified and no window exists with that index, the window is linked at is specified and no such window exists, the
that index. .Ar src-window
If is linked there.
If
.Fl k .Fl k
is given and a window exists at is given and
.Ar index , .Ar dst-window
it is killed, otherwise an error is generated. exists, it is killed, otherwise an error is generated.
If If
.Fl d .Fl d
is given, the newly linked window is not selected. is given, the newly linked window is not selected.
.It Xo Ic list-clients .It Xo Ic list-clients
.Xc .Xc
.D1 (alias: Ic lsc ) .D1 (alias: Ic lsc )
List all clients attached to the server. List all clients attached to the server.
.It Xo Ic list-keys .It Xo Ic list-keys
.Xc .Xc
.D1 (alias: Ic lsk ) .D1 (alias: Ic lsk )
List all key bindings. List all key bindings.
.It Xo Ic list-sessions .It Xo Ic list-sessions
.Xc .Xc
.D1 (alias: Ic ls ) .D1 (alias: Ic ls )
List all sessions managed by the server. List all sessions managed by the server.
@ -373,7 +378,7 @@ is given.
and and
.Ar command .Ar command
are the name of and command to execute in the initial window. are the name of and command to execute in the initial window.
.It Xo Ic new-window .It Xo Ic new-window
.Op Fl d .Op Fl d
.Op Fl i Ar index .Op Fl i Ar index
.Op Fl n Ar name .Op Fl n Ar name
@ -381,7 +386,8 @@ are the name of and command to execute in the initial window.
.Op Ar command .Op Ar command
.Xc .Xc
.D1 (alias: Ic neww ) .D1 (alias: Ic neww )
Create a new window. If Create a new window.
If
.Fl d .Fl d
is given, the session does not make the new window the current window. is given, the session does not make the new window the current window.
.Ar index .Ar index
@ -419,7 +425,7 @@ Move to the next window in the session.
.D1 (alias: Ic paste ) .D1 (alias: Ic paste )
Insert the contents of the paste buffer into the current window. Insert the contents of the paste buffer into the current window.
Ignored unless executed via a key binding. Ignored unless executed via a key binding.
.It Xo Ic previous-window .It Xo Ic previous-window
.Op Fl s Ar session-name .Op Fl s Ar session-name
.Xc .Xc
.D1 (alias: Ic prev ) .D1 (alias: Ic prev )
@ -452,14 +458,14 @@ if specifed, to
.Op Fl s Ar session-name .Op Fl s Ar session-name
.Xc .Xc
Enter scroll mode. Enter scroll mode.
.It Xo Ic select-window .It Xo Ic select-window
.Op Fl s Ar session-name .Op Fl s Ar session-name
.Op Fl i Ar index .Op Fl i Ar index
.Xc .Xc
.D1 (alias: Ic selectw ) .D1 (alias: Ic selectw )
Select the window at Select the window at
.Ar index . .Ar index .
.It Xo Ic send-keys .It Xo Ic send-keys
.Op Fl c Ar client-tty .Op Fl c Ar client-tty
.Ar key Ar ... .Ar key Ar ...
.Xc .Xc
@ -481,7 +487,8 @@ Send the prefix key to a window as if it was pressed.
.Ar option Ar value .Ar option Ar value
.Xc .Xc
.D1 (alias: Ic set ) .D1 (alias: Ic set )
Set an option. Possible options are: Set an option.
Possible options are:
.Bl -tag -width Ds .Bl -tag -width Ds
.It Ic prefix Ar key .It Ic prefix Ar key
Set the current prefix key. Set the current prefix key.
@ -489,7 +496,7 @@ Set the current prefix key.
Set the maximum number of lines held in window history. Set the maximum number of lines held in window history.
This setting applies only to new windows - existing window histories are not This setting applies only to new windows - existing window histories are not
resized and retain the limit at the point they were created. resized and retain the limit at the point they were created.
.It Xo Ic status .It Xo Ic status
.Op Ic on | Ic off .Op Ic on | Ic off
.Xc .Xc
Show or hide the status line. Show or hide the status line.
@ -532,7 +539,7 @@ The default is
Start the Start the
.Nm .Nm
server, if not already running, without creating any sessions. server, if not already running, without creating any sessions.
.It Xo Ic swap-window .It Xo Ic swap-window
.Op Fl i Ar index .Op Fl i Ar index
.Op Fl s Ar session-name .Op Fl s Ar session-name
.Ar source-name Ar source-index .Ar source-name Ar source-index