Document mode keys

This commit is contained in:
Nicholas Marriott 2008-11-17 17:41:35 +00:00
parent 5ca710d9e3
commit 8524062e56
2 changed files with 46 additions and 62 deletions

4
TODO
View File

@ -34,9 +34,6 @@
- better terminal emulation (identify, insert mode, some other bits) - better terminal emulation (identify, insert mode, some other bits)
- save stack for last window - save stack for last window
- when resizing, use history - when resizing, use history
-- For 0.5 --------------------------------------------------------------------
- audit for leftover/unused code - audit for leftover/unused code
- commands: save-buffer -b number filename - commands: save-buffer -b number filename
load-buffer -b number filename load-buffer -b number filename
@ -54,4 +51,3 @@
- many more info() displays for various things - many more info() displays for various things
- document mode-keys - document mode-keys
- vi half page scroll - vi half page scroll
- document new flags

92
tmux.1
View File

@ -1,4 +1,4 @@
.\" $Id: tmux.1,v 1.50 2008-11-16 13:28:59 nicm Exp $ .\" $Id: tmux.1,v 1.51 2008-11-17 17:41:35 nicm Exp $
.\" .\"
.\" Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net> .\" Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
.\" .\"
@ -78,7 +78,7 @@ where
.Em UID .Em UID
is the uid of the user who invoked is the uid of the user who invoked
.Nm . .Nm .
.If Fl u .It Fl u
Intruct Intruct
.Nm .Nm
that the terminal support UTF-8. that the terminal support UTF-8.
@ -205,72 +205,48 @@ The others are:
This is entered when a command which produces output, such as This is entered when a command which produces output, such as
.Ic list-keys , .Ic list-keys ,
is executed from a key binding. is executed from a key binding.
The
.Ql up ,
.Ql down ,
.Ql page-up
and
.Ql page-down
keys or
.Xr vi 1
style
.Ql j
and
.Ql k
keys may be used to scroll the output up and down.
The
.Ql q
key will exit output mode.
.It Em scroll mode .It Em scroll mode
This is entered with the This is entered with the
.Ic scroll-mode .Ic scroll-mode
command (bound to command (bound to
.Ql = .Ql =
by default) and permits the window history buffer to be inspected. by default) and permits the window history buffer to be inspected.
In addition to the commands supported by output mode, the left and right arrow
keys, or
.Ql h
and
.Ql l ,
will scroll left and right.
.Ql C-u
and
.Ql C-f
may be used to scroll up and down by one screen.
.It Em copy mode .It Em copy mode
This permits a section of a window or its history to be copied to a This permits a section of a window or its history to be copied to a
.Em paste buffer .Em paste buffer
for later insertion into another window. for later insertion into another window.
The navigation keys move the cursor around the window, scrolling as necessary.
In addition,
.Ql C-a
and
.Ql C-e
(or the
.Xr vi 1
style
.Ql 0
and
.Ql $
keys) move to the start and end of the line;
.Ql M-f
or
.Ql w
moves the cursor forward one word;
.Ql M-b
or
.Ql b
moves the cursor backward one word; the space key begins a selection; and the
enter key or
.Ql C-w
creates a new paste buffer from the selection and exits copy mode.
.Pp
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
The keys available depend on whether
.Xr emacs 1
or
.Xr vi 1
mode is selected (see the
.Ic mode-keys
option).
The following keys are supported as appropriate for the mode:
.Bl -column "FunctionXXXXXXXXXXXX" "viXXXXXX" "emacs" -offset indent
.It Sy "Function" Ta Sy "vi" Ta Sy "emacs"
.It Li "Start of line" Ta "0 or ^" Ta "C-a"
.It Li "Clear selection" Ta "Escape" Ta "C-g"
.It Li "Copy selection" Ta "Enter" Ta "M-w"
.It Li "Cursor down" Ta "j" Ta "Down"
.It Li "End of line" Ta "$" Ta "C-e"
.It Li "Cursor left" Ta "h" Ta "Left"
.It Li "Next page" Ta "C-f" Ta "Page down"
.It Li "Next word" Ta "w" Ta "M-f"
.It Li "Previous page" Ta "C-u" Ta "Page up"
.It Li "Previous word" Ta "b" Ta "M-b"
.It Li "Quit mode" Ta "q" Ta "Escape"
.It Li "Cursor right" Ta "l" Ta "Right"
.It Li "Start selection" Ta "Space" Ta "C-Space"
.It Li "Cursor up" Ta "k" Ta "Up"
.El
.Pp
.Sh BUFFERS .Sh BUFFERS
.Nm .Nm
maintains a stack of maintains a stack of
@ -697,6 +673,12 @@ Set the current prefix key.
If this option is on, newly created windows have their If this option is on, newly created windows have their
.Ic remain-on-exit .Ic remain-on-exit
flag set. flag set.
.It Xo Ic utf8-default
.Op Ic on | Ic off
.Xc
If this option is on, newly created windows have their
.Ic utf8
flag set.
.It Xo Ic set-titles .It Xo Ic set-titles
.Op Ic on | Ic off .Op Ic on | Ic off
.Xc .Xc
@ -793,6 +775,12 @@ exits.
The window may be reactivated with the The window may be reactivated with the
.Ic respawn-window .Ic respawn-window
command. command.
.It Xo Ic utf8
.Op Ic on | Ic off
.Xc
Instructs
.Nm
to expect UTF-8 sequences to appear in this window.
.El .El
.It Xo Ic show-buffer .It Xo Ic show-buffer
.Op Fl b Ar buffer-index .Op Fl b Ar buffer-index