Partial tmux.1 update thanks to Will Maier.

This commit is contained in:
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

73
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
@ -159,7 +161,8 @@ 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
@ -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,64 +282,66 @@ 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.
If no
.Ar target-session
is specified, select to the last window of the current session.
.It Xo Ic link-window .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
is linked there.
If 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.
@ -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
@ -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.