summaryrefslogtreecommitdiffstats
path: root/usr.bin/window/window.1
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2004-07-02 22:22:35 +0000
committerru <ru@FreeBSD.org>2004-07-02 22:22:35 +0000
commitfb1d8b3724cde10863de04d2c0884fbc5035eeef (patch)
treeb3cdbab3d24866d3829616606f702cb5cb5d6c97 /usr.bin/window/window.1
parent2334c79a7573e958e33d5cc7301829244e5d216f (diff)
downloadFreeBSD-src-fb1d8b3724cde10863de04d2c0884fbc5035eeef.zip
FreeBSD-src-fb1d8b3724cde10863de04d2c0884fbc5035eeef.tar.gz
Mechanically kill hard sentence breaks.
Diffstat (limited to 'usr.bin/window/window.1')
-rw-r--r--usr.bin/window/window.1341
1 files changed, 230 insertions, 111 deletions
diff --git a/usr.bin/window/window.1 b/usr.bin/window/window.1
index 64d414a..cc5f760 100644
--- a/usr.bin/window/window.1
+++ b/usr.bin/window/window.1
@@ -56,13 +56,17 @@ utility implements a window environment on
terminals.
.Pp
A window is a rectangular portion of the physical terminal
-screen associated with a set of processes. Its size and
-position can be changed by the user at any time. Processes
+screen associated with a set of processes.
+Its size and
+position can be changed by the user at any time.
+Processes
communicate with their window in the same way they normally
interact with a terminal\-through their standard input, output,
-and diagnostic file descriptors. The window program handles the
+and diagnostic file descriptors.
+The window program handles the
details of redirecting input and output to and from the
-windows. At any one time, only one window can receive
+windows.
+At any one time, only one window can receive
input from the keyboard, but all windows can simultaneously send output
to the display.
.Pp
@@ -72,7 +76,8 @@ starts up, the commands (see long commands below)
contained in the file
.Pa .windowrc
in the user's home directory are
-executed. If it does not exist, two equal sized windows spanning
+executed.
+If it does not exist, two equal sized windows spanning
the terminal screen are created by default.
.Pp
The command line options are
@@ -82,7 +87,8 @@ Turn on terse mode (see
.Ic terse
command below).
.It Fl f
-Fast. Don't perform any startup action.
+Fast.
+Don't perform any startup action.
.It Fl d
Ignore
.Pa .windowrc
@@ -105,30 +111,39 @@ as a long command (see below)
before doing anything else.
.El
.Pp
-Windows can overlap and are framed as necessary. Each window
-is named by one of the digits ``1'' to ``9''. This one-character
+Windows can overlap and are framed as necessary.
+Each window
+is named by one of the digits ``1'' to ``9''.
+This one-character
identifier, as well as a user definable label string, are displayed
-with the window on the top edge of its frame. A window can be
+with the window on the top edge of its frame.
+A window can be
designated to be in the
.Ar foreground ,
in which case it will always be
on top of all normal, non-foreground windows, and can be covered
-only by other foreground windows. A window need not be completely
-within the edges of the terminal screen. Thus a large window
+only by other foreground windows.
+A window need not be completely
+within the edges of the terminal screen.
+Thus a large window
(possibly larger than the screen) may be positioned to show only
a portion of its full size.
.Pp
-Each window has a cursor and a set of control functions. Most intelligent
+Each window has a cursor and a set of control functions.
+Most intelligent
terminal operations such as line and
-character deletion and insertion are supported. Display modes
+character deletion and insertion are supported.
+Display modes
such as underlining and reverse video are available if they are
-supported by the terminal. In addition,
+supported by the terminal.
+In addition,
similar to terminals with multiple pages of memory,
each window has a text buffer which can have more lines than the window
itself.
.Ss Process Environment
With each newly created window, a shell program is spawned with its
-process environment tailored to that window. Its standard input,
+process environment tailored to that window.
+Its standard input,
output, and diagnostic file descriptors are bound to one end of either
a pseudo-terminal (see
.Xr pty 4 )
@@ -140,7 +155,8 @@ If a pseudo-terminal is used, then its special
characters and modes (see
.Xr stty 1 )
are copied from the physical
-terminal. A
+terminal.
+A
.Xr termcap 5
entry tailored to this window is created
and passed as environment (see
@@ -151,9 +167,11 @@ The termcap entry contains the window's size and
characteristics as well as information from the physical terminal,
such as the existence of underline, reverse video, and other display
modes, and the codes produced by the terminal's function keys,
-if any. In addition, the window size attributes of the pseudo-terminal
+if any.
+In addition, the window size attributes of the pseudo-terminal
are set to reflect the size of this window, and updated whenever
-it is changed by the user. In particular, the editor
+it is changed by the user.
+In particular, the editor
.Xr vi 1
uses
this information to redraw its display.
@@ -161,11 +179,14 @@ this information to redraw its display.
During normal execution,
.Nm
can be in one of two states:
-conversation mode and command mode. In conversation mode, the
+conversation mode and command mode.
+In conversation mode, the
terminal's real cursor is placed at the cursor position of a particular
window--called the current window--and input from the keyboard is sent
-to the process in that window. The current window is always
-on top of all other windows, except those in foreground. In addition,
+to the process in that window.
+The current window is always
+on top of all other windows, except those in foreground.
+In addition,
it is set apart by highlighting its identifier and label in reverse video.
.Pp
Typing
@@ -173,7 +194,8 @@ Typing
escape character (normally
.Ic ^P )
in conversation
-mode switches it into command mode. In command mode, the top line of
+mode switches it into command mode.
+In command mode, the top line of
the terminal screen becomes the command prompt window, and
.Nm
interprets input from the keyboard as commands to manipulate windows.
@@ -195,7 +217,8 @@ means
.No control\- Ns Ar X ,
where
.Ar X
-is any character. In particular,
+is any character.
+In particular,
.Ic ^^
is
.Li control\-^ .
@@ -214,17 +237,20 @@ Select window
but stay in command mode.
.It Ic ^^
Select the previous window and return to conversation
-mode. This is useful for toggling between two windows.
+mode.
+This is useful for toggling between two windows.
.It Ic escape
Return to conversation mode.
.It Ic ^P
Return to conversation mode and write
.Ic ^P
to the
-current window. Thus, typing two
+current window.
+Thus, typing two
.Ic ^P Ns 's
in conversation
-mode sends one to the current window. If the
+mode sends one to the current window.
+If the
.Nm
escape is changed to some other character, that
character takes the place of
@@ -242,23 +268,30 @@ Confirmation is requested.
Suspend
.Nm .
.It Ic w
-Create a new window. The user is prompted for the positions
+Create a new window.
+The user is prompted for the positions
of the upper left and lower right corners of the window.
The cursor is placed on the screen and the keys ``h'', ``j'',
``k'', and ``l''
move the cursor left, down, up, and right, respectively.
The keys ``H'', ``J'', ``K'', and ``L'' move the cursor to the respective
-limits of the screen. Typing a number before the movement keys
-repeats the movement that number of times. Return enters the cursor position
-as the upper left corner of the window. The lower right corner
-is entered in the same manner. During this process,
+limits of the screen.
+Typing a number before the movement keys
+repeats the movement that number of times.
+Return enters the cursor position
+as the upper left corner of the window.
+The lower right corner
+is entered in the same manner.
+During this process,
the placement of the new window is indicated by a rectangular
box drawn on the screen, corresponding to where the new window
-will be framed. Typing escape at any point
+will be framed.
+Typing escape at any point
cancels this command.
.Pp
This window becomes the current window,
-and is given the first available ID. The default buffer size
+and is given the first available ID.
+The default buffer size
is used (see
.Ar default_nline
command below).
@@ -277,12 +310,14 @@ handle this signal correctly and cause no problems.
.It Ic m Ns Ar #
Move window
.Ar #
-to another location. A box in the shape
+to another location.
+A box in the shape
of the window is drawn on
the screen to indicate the new position of the window, and the same keys as
those for the
.Ic w
-command are used to position the box. The
+command are used to position the box.
+The
window can be moved partially off-screen.
.It Ic M Ns Ar #
Move window
@@ -292,8 +327,10 @@ to its previous position.
Change the size of window
.Ar # .
The user is prompted
-to enter the new lower right corner of the window. A box
-is drawn to indicate the new window size. The same
+to enter the new lower right corner of the window.
+A box
+is drawn to indicate the new window size.
+The same
keys used in
.Ic w
and
@@ -324,11 +361,14 @@ Move the cursor of the current window up by one line.
.It Ic l
Move the cursor of the current window right by one column.
.It Ic y
-Yank. The user is prompted to enter two points within the current
-window. Then the content of the current window between those two points
+Yank.
+The user is prompted to enter two points within the current
+window.
+Then the content of the current window between those two points
is saved in the yank buffer.
.It Ic p
-Put. The content of the yank buffer is written to the current
+Put.
+The content of the yank buffer is written to the current
window as input.
.It Ic ^S
Stop output in the current window.
@@ -343,30 +383,40 @@ are supported.
.Ss Long Commands
Long commands are a sequence of statements
parsed much like a programming language, with a syntax
-similar to that of C. Numeric and string expressions and variables
+similar to that of C.
+Numeric and string expressions and variables
are supported, as well as conditional statements.
.Pp
-There are two data types: string and number. A string is a sequence
-of letters or digits beginning with a letter. ``_'' and ``.'' are
-considered letters. Alternately, non-alphanumeric characters can
+There are two data types: string and number.
+A string is a sequence
+of letters or digits beginning with a letter.
+``_'' and ``.'' are
+considered letters.
+Alternately, non-alphanumeric characters can
be included in strings by quoting them in ``"'' or escaping them
-with ``\\''. In addition, the ``\\'' sequences of C are supported,
+with ``\\''.
+In addition, the ``\\'' sequences of C are supported,
both inside and outside quotes (e.g., ``\\n'' is a new line,
-``\\r'' a carriage return). For example, these are legal strings:
+``\\r'' a carriage return).
+For example, these are legal strings:
abcde01234, "&#$^*&#", ab"$#"cd, ab\\$\\#cd, "/usr/ucb/window".
.Pp
A number is an integer value in one of three forms:
a decimal number, an octal number preceded by ``0'',
-or a hexadecimal number preceded by ``0x'' or ``0X''. The natural
+or a hexadecimal number preceded by ``0x'' or ``0X''.
+The natural
machine integer size is used (i.e., the signed integer type
-of the C compiler). As in C, a non-zero number represents
+of the C compiler).
+As in C, a non-zero number represents
a boolean true.
.Pp
The character ``#'' begins a comment which terminates at the
end of the line.
.Pp
-A statement is either a conditional or an expression. Expression
-statements are terminated with a new line or ``;''. To continue
+A statement is either a conditional or an expression.
+Expression
+statements are terminated with a new line or ``;''.
+To continue
an expression on the next line, terminate the first line with ``\\''.
.Ss Conditional Statement
The
@@ -400,14 +450,18 @@ Expressions in
.Nm
are similar to those in the
C language, with most C operators supported on numeric
-operands. In addition, some are overloaded to operate on strings.
+operands.
+In addition, some are overloaded to operate on strings.
.Pp
When an expression is used as a statement, its value is discarded
-after evaluation. Therefore, only expressions with side
+after evaluation.
+Therefore, only expressions with side
effects (assignments and function calls) are useful as statements.
.Pp
Single valued (no arrays) variables are supported, of both
-numeric and string values. Some variables are predefined. They
+numeric and string values.
+Some variables are predefined.
+They
are listed below.
.Pp
The operators in order of increasing precedence:
@@ -417,7 +471,8 @@ The operators in order of increasing precedence:
.Ic =
.Aq Va expr2
.Xc
-Assignment. The variable of name
+Assignment.
+The variable of name
.Aq Va expr1 ,
which must be string valued,
is assigned the result of
@@ -438,7 +493,8 @@ if
evaluates true
(non-zero numeric value); returns the value of
.Aq Va expr3
-otherwise. Only
+otherwise.
+Only
one of
.Aq Va expr2
and
@@ -452,7 +508,9 @@ be numeric.
.Ic \&|\&|
.Aq Va expr2
.Xc
-Logical or. Numeric values only. Short circuit evaluation is supported
+Logical or.
+Numeric values only.
+Short circuit evaluation is supported
(i.e., if
.Aq Va expr1
evaluates true, then
@@ -463,25 +521,29 @@ is not evaluated).
.Ic \&&\&&
.Aq Va expr2
.Xc
-Logical and with short circuit evaluation. Numeric values only.
+Logical and with short circuit evaluation.
+Numeric values only.
.It Xo
.Aq Va expr1
.Ic \&|
.Aq Va expr2
.Xc
-Bitwise or. Numeric values only.
+Bitwise or.
+Numeric values only.
.It Xo
.Aq Va expr1
.Ic ^
.Aq Va expr2
.Xc
-Bitwise exclusive or. Numeric values only.
+Bitwise exclusive or.
+Numeric values only.
.It Xo
.Aq Va expr1
.Ic \&&
.Aq Va expr2
.Xc
-Bitwise and. Numeric values only.
+Bitwise and.
+Numeric values only.
.It Xo
.Aq Va expr1
.Ic ==
@@ -490,9 +552,12 @@ Bitwise and. Numeric values only.
.Ic !=
.Aq expr2
.Xc
-Comparison (equal and not equal, respectively). The boolean
-result (either 1 or 0) of the comparison is returned. The
-operands can be numeric or string valued. One string operand
+Comparison (equal and not equal, respectively).
+The boolean
+result (either 1 or 0) of the comparison is returned.
+The
+operands can be numeric or string valued.
+One string operand
forces the other to be converted to a string in necessary.
.It Xo
.Aq Va expr1
@@ -506,7 +571,8 @@ forces the other to be converted to a string in necessary.
.Aq Va expr2 ,
.Xc
Less than, greater than, less than or equal to,
-greater than or equal to. Both numeric and string values, with
+greater than or equal to.
+Both numeric and string values, with
automatic conversion as above.
.It Xo
.Aq Va expr1
@@ -521,7 +587,8 @@ If both operands are numbers,
is bit
shifted left (or right) by
.Aq Va expr2
-bits. If
+bits.
+If
.Aq Va expr1
is
a string, then its first (or last)
@@ -539,7 +606,8 @@ in place of its value).
.Ic -
.Aq Va expr2
.Xc
-Addition and subtraction on numbers. For ``+'', if one
+Addition and subtraction on numbers.
+For ``+'', if one
argument is a string, then the other is converted to a string,
and the result is the concatenation of the two strings.
.It Xo
@@ -553,7 +621,8 @@ and the result is the concatenation of the two strings.
.Ic \&%
.Aq Va expr2
.Xc
-Multiplication, division, modulo. Numbers only.
+Multiplication, division, modulo.
+Numbers only.
.It Xo
.Ic \- Ns Aq Va expr ,
.Ic ~ Ns Aq Va expr ,
@@ -562,16 +631,19 @@ Multiplication, division, modulo. Numbers only.
.Ic \&$? Ns Aq Va expr
.Xc
The first three are unary minus, bitwise complement and logical complement
-on numbers only. The operator, ``$'', takes
+on numbers only.
+The operator, ``$'', takes
.Aq Va expr
and returns
-the value of the variable of that name. If
+the value of the variable of that name.
+If
.Aq Va expr
is numeric
with value
.Ar n
and it appears within an alias macro (see below),
-then it refers to the nth argument of the alias invocation. ``$?''
+then it refers to the nth argument of the alias invocation.
+``$?''
tests for the existence of the variable
.Aq Va expr ,
and returns 1
@@ -585,7 +657,8 @@ must be a string that is the unique
prefix of the name of a builtin
.Nm
function
-or the full name of a user defined alias macro. In the case of a builtin
+or the full name of a user defined alias macro.
+In the case of a builtin
function,
.Aq Ar arglist
can be in one of two forms:
@@ -595,28 +668,36 @@ argname1 = <expr1>, argname2 = <expr2>, ...
.Ed
.Pp
The two forms can in fact be intermixed, but the result is
-unpredictable. Most arguments can be omitted; default values will
-be supplied for them. The
+unpredictable.
+Most arguments can be omitted; default values will
+be supplied for them.
+The
.Ar argnames
can be unique prefixes
-of the argument names. The commas separating
+of the argument names.
+The commas separating
arguments are used only to disambiguate, and can usually be omitted.
.Pp
-Only the first argument form is valid for user defined aliases. Aliases
+Only the first argument form is valid for user defined aliases.
+Aliases
are defined using the
.Ic alias
-builtin function (see below). Arguments
+builtin function (see below).
+Arguments
are accessed via a variant of the variable mechanism (see ``$'' operator
above).
.Pp
Most functions return value, but some are used for side effect
-only and so must be used as statements. When a function or an alias is used
+only and so must be used as statements.
+When a function or an alias is used
as a statement, the parentheses surrounding
-the argument list may be omitted. Aliases return no value.
+the argument list may be omitted.
+Aliases return no value.
.El
.Ss Builtin Functions
The arguments are listed by name in their natural
-order. Optional arguments are in square brackets
+order.
+Optional arguments are in square brackets
.Sq Op .
Arguments
that have no names are in angle brackets
@@ -640,14 +721,16 @@ in which case a non-zero value is true.
.Bq Aq Ar string\-list
.Pc
If no argument is given, all currently defined alias macros are
-listed. Otherwise,
+listed.
+Otherwise,
.Aq Ar string
is defined as an alias,
with expansion
.Aq Ar string\-list > .
The previous definition of
.Aq Ar string ,
-if any, is returned. Default for
+if any, is returned.
+Default for
.Aq Ar string\-list
is no change.
.It Ic close Ns Pq Aq Ar window\-list
@@ -657,7 +740,8 @@ If
.Aq Ar window\-list
is the word
.Ar all ,
-than all windows are closed. No value is returned.
+than all windows are closed.
+No value is returned.
.It Ic cursormodes Ns Pq Bq Ar modes
Set the window cursor to
.Ar modes .
@@ -672,8 +756,10 @@ or of the mode bits defined as the variables
(blinking),
and
.Ar m_grp
-(graphics, terminal dependent). Return
-value is the previous modes. Default is no change.
+(graphics, terminal dependent).
+Return
+value is the previous modes.
+Default is no change.
For example,
.Li cursor($m_rev$m_blk)
sets the window cursors to blinking
@@ -682,14 +768,19 @@ reverse video.
Set the default buffer size to
.Ar nline .
Initially, it is
-48 lines. Returns the old default buffer size. Default is
-no change. Using a very large buffer can slow the program down
+48 lines.
+Returns the old default buffer size.
+Default is
+no change.
+Using a very large buffer can slow the program down
considerably.
.It Ic default_shell Ns Pq Bq Aq Ar string\-list
Set the default window shell program to
.Aq Ar string\-list .
Returns
-the first string in the old shell setting. Default is no change. Initially,
+the first string in the old shell setting.
+Default is no change.
+Initially,
the default shell is taken from the environment variable
.Ev SHELL .
.It Ic default_smooth Ns Pq Bq Ar flag
@@ -698,7 +789,8 @@ Set the default value of the
argument
to the command
.Nm
-(see below). The argument
+(see below).
+The argument
is a boolean flag (one of
.Ar on ,
.Ar off ,
@@ -707,7 +799,8 @@ is a boolean flag (one of
.Ar true ,
.Ar false ,
or a number,
-as described above). Default is no change.
+as described above).
+Default is no change.
The old value (as a number) is returned.
The initial value is 1 (true).
.It Xo
@@ -719,17 +812,21 @@ Write the list of strings,
to
.Nm ,
separated
-by spaces and terminated with a new line. The strings are only
+by spaces and terminated with a new line.
+The strings are only
displayed in the window, the processes in the window are not
involved (see
.Ic write
-below). No value is returned. Default
+below).
+No value is returned.
+Default
is the current window.
.It Ic escape Ns Pq Bq Ar escapec
Set the escape character to
.Ar escape-char .
Returns the old
-escape character as a one-character string. Default is no
+escape character as a one-character string.
+Default is no
change.
.Ar Escapec
can be a string of a single character, or
@@ -745,8 +842,10 @@ Move
.Nm
in or out of foreground.
.Ar Flag
-is a boolean value. The old foreground flag
-is returned. Default for
+is a boolean value.
+The old foreground flag
+is returned.
+Default for
.Nm
is the current window,
default for
@@ -761,21 +860,27 @@ Set the label of
to
.Ar label .
Returns the old
-label as a string. Default for
+label as a string.
+Default for
.Nm
is the current
window, default for
.Ar label
-is no change. To turn
+is no change.
+To turn
off a label, set it to an empty string ("").
.It Ic list Ns Pq
-No arguments. List the identifiers and labels of all windows. No
+No arguments.
+List the identifiers and labels of all windows.
+No
value is returned.
.It Ic select Ns Pq Bq Ar window
Make
.Nm
-the current window. The previous current window
-is returned. Default is no change.
+the current window.
+The previous current window
+is returned.
+Default is no change.
.It Ic source Ns Pq Ar filename
Read and execute the long commands in
.Ar filename .
@@ -790,7 +895,8 @@ sounding the terminal's bell.
can take on the same
values as in
.Ar foreground
-above. Returns the old terse flag.
+above.
+Returns the old terse flag.
Default is no change.
.It Ic unalias Ns Pq Ar alias
Undefine
@@ -807,7 +913,9 @@ Returns -1 if
does not exist,
0 otherwise.
.It Ic variables Ns Pq
-No arguments. List all variables. No value is returned.
+No arguments.
+List all variables.
+No value is returned.
.It Xo
.Ic window Ns ( Bq Ar row ,
.Bq Ar column ,
@@ -831,8 +939,10 @@ and size
If
.Ar nline
is specified,
-then that many lines are allocated for the text buffer. Otherwise,
-the default buffer size is used. Default values for
+then that many lines are allocated for the text buffer.
+Otherwise,
+the default buffer size is used.
+Default values for
.Ar row ,
.Ar column ,
.Ar nrow ,
@@ -856,10 +966,12 @@ allocate pseudo-terminal for this window rather than socketpair (default
true), and map new line characters in this window to carriage return
and line feed (default true if socketpair is used, false otherwise).
Normally, a window is automatically closed when its process
-exits. Setting
+exits.
+Setting
.Ar keepopen
to true (default false) prevents this
-action. When
+action.
+When
.Ar smooth
is true, the screen is updated more frequently
(for this window) to produce a more terminal-like behavior.
@@ -873,7 +985,8 @@ is a list of strings that will be used as the shell
program to place in the window (default is the program specified
by
.Ar default_shell ,
-see above). The created window's identifier
+see above).
+The created window's identifier
is returned as a number.
.It Xo
.Ic write Ns ( Bq Ar window ,
@@ -884,12 +997,16 @@ Send the list of strings,
to
.Nm ,
separated
-by spaces but not terminated with a new line. The strings are actually
-given to the window as input. No value is returned. Default
+by spaces but not terminated with a new line.
+The strings are actually
+given to the window as input.
+No value is returned.
+Default
is the current window.
.El
.Ss Predefined Variables
-These variables are for information only. Redefining them does
+These variables are for information only.
+Redefining them does
not affect the internal operation of
.Nm .
.Bl -tag -width modes
@@ -897,7 +1014,8 @@ not affect the internal operation of
The baud rate as a number between 50 and 38400.
.It Ar modes
The display modes (reverse video, underline, blinking, graphics)
-supported by the physical terminal. The value of
+supported by the physical terminal.
+The value of
.Ar modes
is the bitwise or of some of the one bit values,
.Ar m_blk ,
@@ -923,7 +1041,8 @@ The number of columns on the physical screen.
.It Ar nrow
The number of rows on the physical screen.
.It Ar term
-The terminal type. The standard name, found in the second name
+The terminal type.
+The standard name, found in the second name
field of the terminal's
.Ev TERMCAP
entry, is used.
OpenPOWER on IntegriCloud