src/usr.bin/tmux/tmux.1 - diff

Return to tmux.1 CVS log

Up to [local] / src / usr.bin / tmux

Diff for /src/usr.bin/tmux/tmux.1 between version 1.244 and 1.245

-version 1.244, 2011/08/24 10:46:01
+version 1.245, 2011/08/26 10:53:16
 Line 617
 Line 617
 Line 617
  List the syntax of all commands supported by
  .Nm .
  .It Ic list-sessions
+ .Op Fl F Ar format
  .D1 (alias: Ic ls )
  List all sessions managed by the server.
  .It Ic lock-client Op Fl t Ar target-client
-Line 626
+Line 627
 Line 626
 Line 627
  see the
  .Ic lock-server
  command.
+ For the meaning of the
+ .Fl F
+ flag, see the
+ .Sx FORMATS
+ section.
  .It Ic lock-session Op Fl t Ar target-session
  .D1 (alias: Ic locks )
  Lock all clients attached to
-Line 1147
+Line 1153
 Line 1147
 Line 1153
  is given, the newly linked window is not selected.
  .It Xo Ic list-panes
  .Op Fl as
+ .Op Fl F Ar format
  .Op Fl t Ar target
  .Xc
  .D1 (alias: Ic lsp )
-Line 1165
+Line 1172
 Line 1165
 Line 1172
  is a window (or the current window).
  .It Xo Ic list-windows
  .Op Fl a
+ .Op Fl F Ar format
  .Op Fl t Ar target-session
  .Xc
  .D1 (alias: Ic lsw )
-Line 1173
+Line 1181
 Line 1173
 Line 1181
  is given, list all windows on the server.
  Otherwise, list windows in the current session or in
  .Ar target-session .
+ For the meaning of the
+ .Fl F
+ flag, see the
+ .Sx FORMATS
+ section.
  .It Xo Ic move-window
  .Op Fl dk
  .Op Fl s Ar src-window
-Line 2535
+Line 2548
 Line 2535
 Line 2548
  .Fl g
  is used.
  .El
+ .Sh FORMATS
+ The
+ .Ic list-sessions ,
+ .Ic list-windows
+ and
+ .Ic list-panes
+ commands accept the
+ .Fl F
+ flag with a
+ .Ar format
+ argument.
+ This is a string which controls the output format of the command.
+ Special character sequences are replaced as documented under the
+ .Ic status-left
+ option and an additional long form is accepted.
+ Replacement variables are enclosed in
+ .Ql #{
+ and
+ .Ql } ,
+ for example
+ .Ql #{session_name}
+ is equivalent to
+ .Ql #S .
+ Conditionals are also accepted by prefixing with
+ .Ql ?
+ and separating two alternatives with a comma;
+ if the specified variable exists and is not zero, the first alternative
+ is chosen, otherwise the second is used. For example
+ .Ql #{?session_attached,attached,not attached}
+ will include the string
+ .Ql attached
+ if the session is attached and the string
+ .Ql not attached
+ if it is unattached.
+ .Pp
+ The following variables are available, where appropriate:
+ .Bl -column "session_created_string" "Replaced with" -offset indent
+ .It Sy "Variable name" Ta Sy "Replaced with"
+ .It Li "host" Ta "Hostname of local host"
+ .It Li "line" Ta "Line number in the list"
+ .It Li "pane_active" Ta "1 if active pane"
+ .It Li "pane_dead" Ta "1 if pane is dead"
+ .It Li "pane_height" Ta "Height of pane"
+ .It Li "pane_id" Ta "Unique pane id"
+ .It Li "pane_title" Ta "Title of pane"
+ .It Li "pane_width" Ta "Width of pane"
+ .It Li "session_attached" Ta "1 if session attached"
+ .It Li "session_created" Ta "Integer time session created"
+ .It Li "session_created_string" Ta "String time session created"
+ .It Li "session_group" Ta "Number of session group"
+ .It Li "session_grouped" Ta "1 if session in a group"
+ .It Li "session_height" Ta "Height of session"
+ .It Li "session_name" Ta "Name of session"
+ .It Li "session_width" Ta "Width of session"
+ .It Li "session_windows" Ta "Number of windows in session"
+ .It Li "window_active" Ta "1 if window active"
+ .It Li "window_flags" Ta "Window flags"
+ .It Li "window_height" Ta "Height of window"
+ .It Li "window_index" Ta "Index of window"
+ .It Li "window_layout" Ta "Window layout description"
+ .It Li "window_name" Ta "Name of window"
+ .It Li "window_width" Ta "Width of window"
+ .El
+ .Pp
  .Sh ENVIRONMENT
  When the server is started,
  .Nm