JehanneOS/mksh
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

some manpage improvements, mostly from OpenBSD

Browse Source
This commit is contained in:
tg 2004-12-13 18:24:34 +00:00
parent 85a62c2ea2
commit f4b8bc819c
2 changed files with 117 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

193
ksh.1tbl
View File

@ -1,6 +1,6 @@
.\" $MirBSD: src/bin/ksh/ksh.1tbl,v 2.1 2004/12/10 18:09:41 tg Exp $ .\" $MirBSD: src/bin/ksh/ksh.1tbl,v 2.2 2004/12/13 18:24:33 tg Exp $
.\" $OpenBSD: ksh.1tbl,v 1.79 2004/12/04 07:05:13 jaredy Exp $ .\" $OpenBSD: ksh.1tbl,v 1.79 2004/12/04 07:05:13 jaredy Exp $
.\" $OpenBSD: sh.1tbl,v 1.52 2004/11/09 21:56:54 jmc Exp $ .\" $OpenBSD: sh.1tbl,v 1.53 2004/12/10 01:56:56 jaredy Exp $
.\" .\"
.\" Copyright (c) 1980, 1990, 1993 .\" Copyright (c) 1980, 1990, 1993
.\" The Regents of the University of California. All rights reserved. .\" The Regents of the University of California. All rights reserved.
@ -120,7 +120,7 @@ If there are no non-option
arguments, the shell reads commands from the standard input. arguments, the shell reads commands from the standard input.
The name of The name of
the shell (i.e., the contents of the shell (i.e., the contents of
.Va $0 ) .Ic $0 )
is determined as follows: if the is determined as follows: if the
.Fl c .Fl c
option is used and there is a non-option argument, it is used as the name; option is used and there is a non-option argument, it is used as the name;
@ -133,8 +133,8 @@ A shell is
.Dq interactive .Dq interactive
if the if the
.Fl i .Fl i
option is used or if both standard input and standard error are attached option is used or if both standard input and standard error are attached to a
to a tty. .Xr tty 4 .
An interactive shell has job control enabled (if available), ignores the An interactive shell has job control enabled (if available), ignores the
.Dv SIGINT , .Dv SIGINT ,
.Dv SIGQUIT .Dv SIGQUIT
@ -347,7 +347,7 @@ The first three of these are the above mentioned quoting characters (see
.Sx Quoting .Sx Quoting
below); below);
.Ql # , .Ql # ,
if used at the beginning of a word, introduces a comment -- everything after if used at the beginning of a word, introduces a comment \(em everything after
the the
.Ql # .Ql #
up to the nearest newline is ignored; up to the nearest newline is ignored;
@ -450,7 +450,7 @@ only if the exit status of
.Ar cmd1 .Ar cmd1
is zero; is zero;
.Ql || .Ql ||
is the opposite -- is the opposite \(em
.Ar cmd2 .Ar cmd2
is executed only if the exit status of is executed only if the exit status of
.Ar cmd1 .Ar cmd1
@ -545,14 +545,14 @@ In the following compound command descriptions, command lists (denoted as
that are followed by reserved words must end with a semicolon, a newline, or that are followed by reserved words must end with a semicolon, a newline, or
a (syntactically correct) reserved word. a (syntactically correct) reserved word.
For example, For example,
.Bd -unfilled -offset -indent .Bd -unfilled -offset indent
.Ic { echo foo; echo bar; } .Ic { echo foo; echo bar; }
.Ic { echo foo; echo bar<newline> } .Ic { echo foo; echo bar<newline> }
.Ic { { echo foo; echo bar; } } .Ic { { echo foo; echo bar; } }
.Ed .Ed
.Pp .Pp
are all valid, but are all valid, but
.Bd -unfilled -offset -indent .Bd -unfilled -offset indent
.Ic { echo foo; echo bar } .Ic { echo foo; echo bar }
.Ed .Ed
.Pp .Pp
@ -630,7 +630,7 @@ If
.Ic in .Ic in
is not used to specify a word list, the positional parameters is not used to specify a word list, the positional parameters
.Po .Po
.Va $1 , $2 , .Ic $1 , $2 ,
etc.\& etc.\&
.Pc .Pc
are used instead. are used instead.
@ -721,7 +721,7 @@ statement is executed inside the loop.
If If
.Ic in Ar word ...\& .Ic in Ar word ...\&
is omitted, the positional parameters are used (i.e., is omitted, the positional parameters are used (i.e.,
.Va $1 , $2 , .Ic $1 , $2 ,
etc.). etc.).
For historical reasons, open and close braces may be used instead of For historical reasons, open and close braces may be used instead of
.Ic do .Ic do
@ -1017,8 +1017,8 @@ As a special case, leading and trailing
.Ev IFS .Ev IFS
whitespace and trailing whitespace and trailing
.Ev IFS .Ev IFS
non-whitespace is stripped (i.e., no leading or trailing non-whitespace are stripped (i.e., no leading or trailing
empty field is created by it); leading or trailing empty field is created by it); leading
.Pf non- Ev IFS .Pf non- Ev IFS
whitespace does create an empty field. whitespace does create an empty field.
.Pp .Pp
@ -1312,7 +1312,7 @@ Process ID of the last background process started.
If no background processes have been started, the parameter is not set. If no background processes have been started, the parameter is not set.
.It Ev \&# .It Ev \&#
The number of positional parameters (i.e., The number of positional parameters (i.e.,
.Va $1 , $2 , .Ic $1 , $2 ,
etc.). etc.).
.It Ev \&$ .It Ev \&$
The process ID of the shell, or the The process ID of the shell, or the
@ -1356,7 +1356,7 @@ Further positional parameters may be accessed using
.Ic ${ Ns Ar number Ns Ic \&} . .Ic ${ Ns Ar number Ns Ic \&} .
.It Ev \&* .It Ev \&*
All positional parameters (except parameter 0); i.e., All positional parameters (except parameter 0); i.e.,
.Va $1 , $2 , $3 , .Ic $1 , $2 , $3 ,
\&... \&...
If used If used
outside of double quotes, parameters are separate words (which are subjected outside of double quotes, parameters are separate words (which are subjected
@ -2028,7 +2028,7 @@ any redirections must appear at the end.
Redirections are processed after Redirections are processed after
pipelines are created and in the order they are given, so pipelines are created and in the order they are given, so
.Pp .Pp
.Ic cat /foo/bar 2\&>&1 \&> /dev/null \&| cat -n .Dl Ic cat /foo/bar 2\*(Gt&1 \*(Gt /dev/null \&| cat -n
.Pp .Pp
will print an error with a line number prepended to it. will print an error with a line number prepended to it.
.Ss Arithmetic expressions .Ss Arithmetic expressions
@ -2262,7 +2262,7 @@ in that they are executed in the current environment.
However, unlike However, unlike
.Li .-scripts , .Li .-scripts ,
shell arguments (i.e., positional parameters shell arguments (i.e., positional parameters
.Va $1 , $2 , .Ic $1 , $2 ,
etc.) are never visible etc.) are never visible
inside them. inside them.
When the shell is determining the location of a command, functions When the shell is determining the location of a command, functions
@ -2321,7 +2321,9 @@ assignments made inside functions are visible after the function completes.
If this is not the desired effect, the If this is not the desired effect, the
.Ic typeset .Ic typeset
command can be used inside a function to create a local parameter. command can be used inside a function to create a local parameter.
Note that special parameters (e.g., $$, $\&!) can't be scoped in this way. Note that special parameters (e.g.
.Ic \&$$ , $\&! )
can't be scoped in this way.
.Pp .Pp
The exit status of a function is that of the last command executed in the The exit status of a function is that of the last command executed in the
function. function.
@ -2337,8 +2339,11 @@ defined with the
notation: notation:
.Bl -bullet .Bl -bullet
.It .It
The $0 parameter is set to the name of the function (Bourne-style functions The
leave $0 untouched). .Ic $0
parameter is set to the name of the function (Bourne-style functions leave
.Ic $0
untouched).
.It .It
Parameter assignments preceding function calls are not kept in the shell Parameter assignments preceding function calls are not kept in the shell
environment (executing Bourne-style functions will keep assignments). environment (executing Bourne-style functions will keep assignments).
@ -2438,7 +2443,7 @@ mode, signal names are listed one per line; in
.Pf non- Tn POSIX .Pf non- Tn POSIX
mode, mode,
signal numbers, names, and descriptions are printed in columns. signal numbers, names, and descriptions are printed in columns.
In future, a new option In the future, a new option
.Po Fl v .Po Fl v
\ perhaps \ perhaps
.Pc .Pc
@ -2596,7 +2601,9 @@ mode, the expression
.Sq Ic \&! .Sq Ic \&!
arguments) is always true as it is a non-zero length string; in arguments) is always true as it is a non-zero length string; in
.Pf non- Tn POSIX .Pf non- Tn POSIX
mode, it tests if file descriptor 1 is a tty (i.e., the mode, it tests if file descriptor 1 is a
.Xr tty 4
(i.e., the
.Ar fd .Ar fd
argument to the argument to the
.Fl t .Fl t
@ -2640,7 +2647,9 @@ special commands
.Ic readonly , return , set , shift , .Ic readonly , return , set , shift ,
.Ic trap , unset .Ic trap , unset
.Pp .Pp
Additional ksh special commands Additional
.Nm
special commands
.Pp .Pp
.Ic builtin , times , typeset .Ic builtin , times , typeset
.Pp .Pp
@ -2657,12 +2666,16 @@ regular commands
.Ic jobs , kill , read , true , .Ic jobs , kill , read , true ,
.Ic umask , unalias , wait .Ic umask , unalias , wait
.Pp .Pp
Additional ksh regular commands Additional
.Nm
regular commands
.Pp .Pp
.Ic \&[ , echo , let , print , .Ic \&[ , echo , let , print ,
.Ic pwd , test , ulimit , whence .Ic pwd , test , ulimit , whence
.Pp .Pp
In the future, the additional ksh special and regular commands may be treated In the future, the additional
.Nm
special and regular commands may be treated
differently from the differently from the
.Tn POSIX .Tn POSIX
special and regular commands. special and regular commands.
@ -2693,8 +2706,7 @@ Exit status is set to zero.
.Op Ic +- .Op Ic +-
.Oo Ar name .Oo Ar name
.Op Ns = Ns Ar value .Op Ns = Ns Ar value
.Ar ... .Ar ... Oc
.Oc
.Xc .Xc
Without arguments, Without arguments,
.Ic alias .Ic alias
@ -2944,7 +2956,7 @@ The shell exits with the specified exit status.
If If
.Ar status .Ar status
is not specified, the exit status is the current value of the is not specified, the exit status is the current value of the
.Ic \&? .Ic $\&?
parameter. parameter.
.It Xo Ic export Op Fl p .It Xo Ic export Op Fl p
.Op Ar parameter Ns Op \&= Ns Ar value .Op Ar parameter Ns Op \&= Ns Ar value
@ -3118,10 +3130,10 @@ below for the format of
.Ar job .Ar job
and the displayed job. and the displayed job.
.It Xo Ic kill .It Xo Ic kill
.Oo Fl s Ar signame No \&| .Oo Fl s Ar signame \*(Ba
.Fl signum No \&| Fl signame Oc { .Fl Ar signum | Fl Ar signame Oc {
.Ar job No \&| .Ar job |
.Ar pid No \&| .Ar pid |
.Ar pgrp No } Ar ... .Ar pgrp No } Ar ...
.Xc .Xc
Send the specified signal to the specified jobs, process IDs, or process Send the specified signal to the specified jobs, process IDs, or process
@ -3153,7 +3165,7 @@ Since expressions may need to be quoted,
is syntactic sugar for is syntactic sugar for
.Ic let \&" Ns Ar expr Ns Ic \&" . .Ic let \&" Ns Ar expr Ns Ic \&" .
.It Xo Ic print .It Xo Ic print
.Oo Fl nprsu Ns Ar n No \&| .Oo Fl nprsu Ns Ar n \*(Ba
.Fl R Op Fl en Oc .Fl R Op Fl en Oc
.Op Ar argument ... .Op Ar argument ...
.Xc .Xc
@ -3205,7 +3217,7 @@ The
.Fl R .Fl R
option is used to emulate, to some degree, the option is used to emulate, to some degree, the
.Bx .Bx
.Xr echo .Xr echo 1
command, which does not process command, which does not process
.Ql \e .Ql \e
sequences unless the sequences unless the
@ -3258,7 +3270,9 @@ exits with a non-zero status.
.Pp .Pp
The first parameter may have a question mark and a string appended to it, in The first parameter may have a question mark and a string appended to it, in
which case the string is used as a prompt (printed to standard error before which case the string is used as a prompt (printed to standard error before
any input is read) if the input is a tty (e.g., any input is read) if the input is a
.Xr tty 4
(e.g.,
.Ic read nfoo?'number of foos: ' ) . .Ic read nfoo?'number of foos: ' ) .
.Pp .Pp
The The
@ -3517,7 +3531,9 @@ Enable vi-like command-line editing (interactive shells only).
No effect. No effect.
In the original Korn shell, unless In the original Korn shell, unless
.Ic viraw .Ic viraw
was set, the vi command-line mode would let the tty driver do the work until was set, the vi command-line mode would let the
.Xr tty 4
driver do the work until
.Tn ESC .Tn ESC
(^[) was entered. (^[) was entered.
.Nm pdksh .Nm pdksh
@ -3547,7 +3563,7 @@ will print the long names of all options that are currently on.
.Pp .Pp
Remaining arguments, if any, are positional parameters and are assigned, in Remaining arguments, if any, are positional parameters and are assigned, in
order, to the positional parameters (i.e. order, to the positional parameters (i.e.
.Va $1 , $2 , .Ic $1 , $2 ,
etc.). etc.).
If options end with If options end with
.Ql -- .Ql --
@ -3555,7 +3571,7 @@ and there are no remaining arguments, all positional parameters are cleared.
If no options or arguments are given, the values of all names are printed. If no options or arguments are given, the values of all names are printed.
For unknown historical reasons, a lone For unknown historical reasons, a lone
.Ql - .Ql -
option is treated specially -- it clears both the option is treated specially \(em it clears both the
.Fl x .Fl x
and and
.Fl v .Fl v
@ -3674,35 +3690,24 @@ doesn't exist (thus
returns true if and only if option returns true if and only if option
.Ar foo .Ar foo
exists). exists).
.It Ar file Fl nt Ar file .It Ar file1 Fl nt Ar file2
first .Ar file1
.Ar file is newer than
is newer than second .Ar file2 .
.Ar file .It Ar file1 Fl ot Ar file2
or first .Ar file1
.Ar file is older than
exists and the second .Ar file2 .
.Ar file .It Ar file1 Fl ef Ar file2
does not. .Ar file1
.It Ar file Fl ot Ar file is the same file as
first .Ar file2 .
.Ar file
is older than second
.Ar file
or second
.Ar file
exists and the first
.Ar file
does not.
.It Ar file Fl ef Ar file
first
.Ar file
is the same file as second
.Ar file .
.It Fl t Op Ar fd .It Fl t Op Ar fd
File descriptor File descriptor
.Ar fd .Ar fd
is a tty device. is a
.Xr tty 4
device.
If the If the
.Ic posix .Ic posix
option is not set, option is not set,
@ -3713,7 +3718,24 @@ to the special
rules described below). rules described below).
.It Ar string .It Ar string
.Ar string .Ar string
is not empty. is not empty (has non-zero length).
Note that there is the potential for problems if
.Ar string
turns out to be an operator (e.g.,
.Fl r ) .
It is generally better to use a test like
.Sm off
.Ic \&[\ X\&" Ar string Ic \&" Ic \ \&]
.Sm on
or (on
.Nm ksh
only)
.Sm off
.Ic \&[\&[ Fl n Ar string Ic \ \&]\&]
.Sm on
instead (double quotes are used in case
.Ar string
contains spaces or file globbing characters).
.It Fl z Ar string .It Fl z Ar string
.Ar string .Ar string
is empty. is empty.
@ -3846,8 +3868,8 @@ but those of the second command do.
Print the accumulated user and system times used by the shell and by processes Print the accumulated user and system times used by the shell and by processes
which have exited that the shell started. which have exited that the shell started.
.It Ic trap Op Ar handler signal ... .It Ic trap Op Ar handler signal ...
Sets trap handler that is to be executed when any of the specified signals are Sets a trap handler that is to be executed when any of the
received. specified signals are received.
.Ar handler .Ar handler
is either a is either a
.Dv NULL .Dv NULL
@ -3894,7 +3916,7 @@ commands, the current state of the traps that have been set since the shell
started. started.
Note that the output of Note that the output of
.Ic trap .Ic trap
can not be usefully piped to another process (an artifact of the fact that cannot be usefully piped to another process (an artifact of the fact that
traps are cleared when subprocesses are created). traps are cleared when subprocesses are created).
.Pp .Pp
The original Korn shell's The original Korn shell's
@ -4019,7 +4041,7 @@ This is the default action (option exists for ksh93 compatibility).
.It Fl r .It Fl r
Read-only attribute. Read-only attribute.
Parameters with this attribute may not be assigned to or unset. Parameters with this attribute may not be assigned to or unset.
Once this attribute is set, it can not be turned off. Once this attribute is set, it cannot be turned off.
.It Fl t .It Fl t
Tag attribute. Tag attribute.
Has no meaning to the shell; provided for application use. Has no meaning to the shell; provided for application use.
@ -4071,7 +4093,7 @@ limit is imposed.
Note that some systems may not allow limits to be increased Note that some systems may not allow limits to be increased
once they are set. once they are set.
Also note that the types of limits available are system Also note that the types of limits available are system
dependent -- some systems have only the dependent \(em some systems have only the
.Fl f .Fl f
limit. limit.
.Bl -tag -width 5n .Bl -tag -width 5n
@ -4287,8 +4309,9 @@ A job may be referred to in the
and and
.Ic wait .Ic wait
commands either by the process ID of the last process in the command pipeline commands either by the process ID of the last process in the command pipeline
(as stored in the $! parameter) or by prefixing the job number with a percent (as stored in the
sign .Ic $\&!
parameter) or by prefixing the job number with a percent sign
.Pq Sq % . .Pq Sq % .
Other percent sequences can also be used to refer to jobs: Other percent sequences can also be used to refer to jobs:
.Bl -tag -width 10n .Bl -tag -width 10n
@ -4317,8 +4340,9 @@ The job starting with string
.Pp .Pp
When a job changes state (e.g., a background job finishes or foreground job is When a job changes state (e.g., a background job finishes or foreground job is
stopped), the shell prints the following status information: stopped), the shell prints the following status information:
.Pp .Bd -unfilled -offset indent
.Ic \&[ Ar number Ic \&] Ar flag status command .Ic \&[ Ar number Ic \&] Ar flag status command
.Ed
.Pp .Pp
where where
.Bl -tag -width "status" .Bl -tag -width "status"
@ -4340,7 +4364,7 @@ indicates the current state of the job and can be:
The job has neither stopped nor exited (note that running does not necessarily The job has neither stopped nor exited (note that running does not necessarily
mean consuming mean consuming
.Tn CPU .Tn CPU
time -- the process could be blocked waiting for some time \(em the process could be blocked waiting for some
event). event).
.It Cm Done Op Ar number .It Cm Done Op Ar number
The job exited. The job exited.
@ -4384,15 +4408,18 @@ is immediately made to exit the shell, the running jobs are sent a
.Dv SIGHUP .Dv SIGHUP
signal and the shell exits. signal and the shell exits.
.Ss Interactive input line editing .Ss Interactive input line editing
The shell supports three modes of reading command lines from a tty in an The shell supports three modes of reading command lines from a
interactive session, which is controlled by the .Xr tty 4
in an interactive session, which is controlled by the
.Ic emacs , .Ic emacs ,
.Ic gmacs .Ic gmacs
and and
.Ic vi .Ic vi
options (at most one of these can be set at once). options (at most one of these can be set at once).
If none of these options are enabled, the shell simply reads lines using the If none of these options are enabled, the shell simply
normal tty driver. reads lines using the normal
.Xr tty 4
driver.
If the If the
.Ic emacs .Ic emacs
or or
@ -4503,7 +4530,9 @@ Furthermore, many editing commands are useful only on terminals with
a visible cursor. a visible cursor.
The default bindings were chosen to resemble corresponding The default bindings were chosen to resemble corresponding
Emacs key bindings. Emacs key bindings.
The users' tty characters (e.g., The users'
.Xr tty 4
characters (e.g.,
.Dv ERASE ) .Dv ERASE )
are bound to are bound to
reasonable substitutes and override the default bindings. reasonable substitutes and override the default bindings.
@ -4793,8 +4822,9 @@ mode.
In insert mode, most characters are simply put in the buffer at the In insert mode, most characters are simply put in the buffer at the
current cursor position as they are typed; however, some characters are current cursor position as they are typed; however, some characters are
treated specially. treated specially.
In particular, the following characters are taken from In particular, the following characters are taken from current
current tty settings (see .Xr tty 4
settings (see
.Xr tty 1 ) .Xr tty 1 )
and have their usual meaning (normal values are in parentheses): kill (^U), and have their usual meaning (normal values are in parentheses): kill (^U),
erase (^?), werase (^W), eof (^D), intr (^C), and quit (^\e). erase (^?), werase (^W), eof (^D), intr (^C), and quit (^\e).
@ -5219,6 +5249,7 @@ deleted and a new prompt to be printed.
.Xr srand 3 , .Xr srand 3 ,
.Xr srandom 3 , .Xr srandom 3 ,
.Xr system 3 , .Xr system 3 ,
.Xr tty 4 ,
.Xr environ 7 .Xr environ 7
.Pp .Pp
.Pa http://docsrv.sco.com:507/en/man/html.C/sh.C.html .Pa http://docsrv.sco.com:507/en/man/html.C/sh.C.html

29
sh.1tbl
View File

@ -1,4 +1,4 @@
.\" $MirBSD: src/bin/ksh/sh.1tbl,v 2.1 2004/12/10 18:09:42 tg Exp $ .\" $MirBSD: src/bin/ksh/sh.1tbl,v 2.2 2004/12/13 18:24:34 tg Exp $
.\" _MirBSD: src/bin/ksh/ksh.1tbl,v 1.41 2004/11/10 17:18:29 tg Exp $ .\" _MirBSD: src/bin/ksh/ksh.1tbl,v 1.41 2004/11/10 17:18:29 tg Exp $
.\" $OpenBSD: ksh.1tbl,v 1.78 2004/11/08 23:42:02 jmc Exp $ .\" $OpenBSD: ksh.1tbl,v 1.78 2004/11/08 23:42:02 jmc Exp $
.\" $OpenBSD: sh.1tbl,v 1.52 2004/11/09 21:56:54 jmc Exp $ .\" $OpenBSD: sh.1tbl,v 1.52 2004/11/09 21:56:54 jmc Exp $
@ -2333,15 +2333,6 @@ is assumed.
This command is only available on systems which support job control (see This command is only available on systems which support job control (see
.Sx Job control .Sx Job control
below for more information). below for more information).
.It Xo
.Ic bind Op Fl m
.Oo Ar key
.Op Ns = Ns Ar editing-command
.Ar ... Oc
.Xc
Set or view the current emacs command editing key bindings/macros.
.Nm
should now have the emacs mode according to the Bourne shell documentation.
.It Ic break Op Ar level .It Ic break Op Ar level
Exit the Exit the
.Ar level Ns th .Ar level Ns th
@ -3075,20 +3066,6 @@ and
statements. statements.
The following basic expressions are available: The following basic expressions are available:
.Bl -tag -width 17n .Bl -tag -width 17n
.It Ar str
.Ar str
has non-zero length.
Note that there is the potential for problems if
.Ar str
turns out to be an operator (e.g.,
.Fl r ) .
It is generally better to use a test like
.Sm off
.Ic \&[\ X\&" Ar str Ic \&" Ic \ \&]
.Sm on
instead (double quotes are used in case
.Ar str
contains spaces or file globbing characters).
.It Fl r Ar file .It Fl r Ar file
.Ar file .Ar file
exists and is readable. exists and is readable.
@ -3334,6 +3311,10 @@ lists, as a series of
.Ic trap .Ic trap
commands, the current state of the traps that have been set since the shell commands, the current state of the traps that have been set since the shell
started. started.
Note that the output of
.Ic trap
cannot be usefully piped to another process (an artifact of the fact that
traps are cleared when subprocesses are created).
.Pp .Pp
The original Korn shell's The original Korn shell's
.Dv DEBUG .Dv DEBUG