summaryrefslogtreecommitdiff
path: root/bin/ksh/ksh.1tbl
diff options
context:
space:
mode:
authorAaron Campbell <aaron@cvs.openbsd.org>1999-07-05 19:50:54 +0000
committerAaron Campbell <aaron@cvs.openbsd.org>1999-07-05 19:50:54 +0000
commit7a6ba954e72649baf6b772099c5b3d169f268c9e (patch)
treeaf903ddc5f2fa897d6284beea7c3b279d40aaaa4 /bin/ksh/ksh.1tbl
parent6eaa264018035f4ce726a520837b9588e31c7b76 (diff)
mdoc'ify syntax of the more complicated commands; when I converted this man
page originally, I didn't know how to do such funky things
Diffstat (limited to 'bin/ksh/ksh.1tbl')
-rw-r--r--bin/ksh/ksh.1tbl99
1 files changed, 66 insertions, 33 deletions
diff --git a/bin/ksh/ksh.1tbl b/bin/ksh/ksh.1tbl
index efd2d8a0b72..a2b546607cd 100644
--- a/bin/ksh/ksh.1tbl
+++ b/bin/ksh/ksh.1tbl
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ksh.1tbl,v 1.22 1999/07/01 17:48:29 aaron Exp $
+.\" $OpenBSD: ksh.1tbl,v 1.23 1999/07/05 19:50:53 aaron Exp $
.\"
.\" Copyright (c) 1980, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -35,13 +35,13 @@
.\"
.Dd August 19, 1996
.Dt KSH 1
-.Os BSD 4
+.Os
.Sh NAME
.Nm ksh
.Nd public domain Korn shell
.Sh SYNOPSIS
.Nm ksh
-.Op Fl +abCefhikmnprsuvxX
+.Op Fl +abCefhiklmnprsuvxX
.Op Fl +o Ar option
.Oo [ Fl c Ar command-string [
.Xo Ar command-name ] No \&| Fl s No \&|
@@ -138,7 +138,7 @@ command is disabled.
.It
The
.Ev SHELL ,
-.Ev ENV
+.Ev ENV ,
and
.Ev PATH
parameters cannot be changed.
@@ -530,8 +530,8 @@ statement is that of the executed
if no
.Ar list
is executed, the exit status is zero.
-.It Xo Ic for Ar name \&[
-.Ic in Ar word Ar ... Ar term \&]
+.It Xo Ic for Ar name No [
+.Ic in Ar word Ar ... term Ns No ]
.Ic do Ar list Ic done
.Xc
For each
@@ -589,8 +589,8 @@ statement is that of non-conditional
that is executed; if no non-conditional
.Ar list
is executed, the exit status is zero.
-.It Xo Ic select Ar name \&[
-.Ic in Ar word Ar ... Ar term \&]
+.It Xo Ic select Ar name No [
+.Ic in Ar word Ar ... term Ns No ]
.Ic do Ar list Ic done
.Xc
The
@@ -697,9 +697,11 @@ Field splitting and file name generation are not performed on arguments.
.It
The
.Fl a
-(and) and
+.Pq Tn AND
+and
.Fl o
-(or) operators are replaced with
+.Pq Tn OR
+operators are replaced with
.Ql &&
and
.Ql || ,
@@ -1249,7 +1251,7 @@ value as reported by
if that value is non-zero. This parameter is used by the interactive line
editing modes, and by
.Ic select ,
-.Ic set Fl o
+.Ic set Fl o ,
and
.Ic kill -l
commands to format information columns.
@@ -1490,7 +1492,8 @@ if any, are assumed to be a login name. If the login name is empty,
or
.Ql - ,
the value of the
-.Ev HOME , PWD
+.Ev HOME ,
+.Ev PWD ,
or
.Ev OLDPWD
parameter is substituted, respectively. Otherwise, the password file is
@@ -2407,10 +2410,14 @@ is being executed. If no arguments are given, the positional parameters are
those of the environment the command is used in.
.It Ic \&: Op Ar ...
The null command. Exit status is set to zero.
-.It Xo Ic alias No [\ -d\ |\ +-t\ [-r]\ ]\ [+-px]\ [+-]
-.Sm off
-.Op Ar name1 No [= Ar value1 No \&]\ \&.\&.\&.
-.Sm on
+.It Xo Ic alias
+.Op Fl d | Ic +-t Op Fl r
+.Op Ic +-px
+.Op Ic +-
+.Oo Ar name
+.Op Ns = Ns Ar value
+.Ar ...
+.Oc
.Xc
Without arguments,
.Ic alias
@@ -2465,11 +2472,12 @@ is assumed. This command is only available on systems which support job
control (see
.Sx Job control
below for more information).
-.It Xo Ic bind [ \&-m ]
-.Sm off
-.Oo Ar key No [= Ar editing-command No ]\ ... Oc
+.It Xo Ic bind Op Fl m
+.Oo Ar key
+.Op Ns = Ns Ar editing-command
+.Ar ...
+.Oc
.Xc
-.Sm on
Set or view the current emacs command editing key bindings/macros (see
.Sx Emacs interactive input line editing
below for a complete description).
@@ -2658,7 +2666,10 @@ option is used, in which case
commands defining all exported parameters, including their values, are printed.
.It Ic false
A command that exits with a non-zero status.
-.It Xo Ic fc No [-e\ editor\ |\ -l\ [-n]]\ [-r]
+.It Xo Ic fc
+.Oo Fl e Ar editor No \&|
+.Fl l Op Fl n Oc
+.Op Fl r
.Op Ar first Op Ar last
.Xc
.Ar first
@@ -2682,7 +2693,10 @@ is specified, the editor specified by the
parameter (if this parameter is not set,
.Pa /bin/ed
is used), and then executed by the shell.
-.It Xo Ic fc No [-e\ -\ |\ -s]\ [-g]\ [old=new]\&
+.It Xo Ic fc
+.Oo Fl e No \&- \&| Fl s Oc
+.Op Fl g
+.Op Ar old Ns No = Ns Ar new
.Op Ar prefix
.Xc
Re-execute the selected command (the previous command by default) after
@@ -2791,8 +2805,12 @@ option causes only the process group of each job to be printed. See
below for the format of
.Ar job
and the displayed job.
-.It Xo Ic kill No [-s\ signame\ |\ -signum\ |\ -signame\ ]\ {\ job\ |\ pid\ |
-.No -pgrp\ }\ \&.\&.\&.
+.It Xo Ic kill
+.Oo Fl s Ar signame No \&|
+.Fl signum No \&| Fl signame Oc {
+.Ar job No \&|
+.Ar pid No \&|
+.Ar pgrp No } Ar ...
.Xc
Send the specified signal to the specified jobs, process IDs, or process
groups. If no signal is specified, the
@@ -2818,8 +2836,10 @@ Since expressions may need to be quoted,
.Ic (( Ar expr Ic ))
is syntactic sugar for
.Ic let \&" Ns Ar expr Ns Ic \&" .
-.It Xo Ic print Oo Fl nprsu Ns Ar n
-.Li | Fl R No [-en] Oc [argument\ ...]
+.It Xo Ic print
+.Oo Fl nprsu Ns Ar n No \&|
+.Fl R No Op Fl en Oc
+.Op Ar argument ...
.Xc
.Ic print
prints its arguments on the standard output, separated by spaces and
@@ -2929,9 +2949,9 @@ above for comments on this), respectively. If the
.Fl s
option is used, input is saved to the history file.
.It Xo Ic readonly Op Fl p
-.Sm off
-.Oo Ar parameter Op = Ar value Oc \ ...
-.Sm on
+.Oo Ar parameter
+.Op Ns = Ns Ar value
+.Ar ... Oc
.Xc
Sets the read-only attribute of the named parameters. If values are given,
parameters are set to them before setting the attribute. Once a parameter is
@@ -2965,7 +2985,10 @@ files as
scripts, while the original Korn shell only treats profiles as
.Ic \&.
scripts.
-.It Xo Ic set No [+-abCefhkmnpsuvxX]\ [+-o\ [option]]\ [+-A\ name]\ [--]\&
+.It Xo Ic set Op Ic +-abCefhkmnpsuvxX
+.Op Ic +-o Ar option
+.Op Ic +-A Ar name
+.Op Fl \&-
.Op Ar arg ...
.Xc
The set command can be used to set
@@ -3475,8 +3498,16 @@ and
traps in functions are not yet implemented.
.It Ic true
A command that exits with a zero value.
-.It Xo Ic typeset No [[+-Ulprtux]\ [-L[n]]\ [-R[n]]\ [-Z[n]]\ [-i[n]]\ |\ -f\&
-.Li [-tux]]\ [name[=value]\ ...]
+.It Xo Ic typeset
+.Oo Op Ic +-Ulprtux
+.Op Fl L Ns Op Ar n
+.Op Fl R Ns Op Ar n
+.Op Fl Z Ns Op Ar n
+.Op Fl i Ns Op Ar n
+.No \&| Fl f Op Fl tux Oc
+.Oo Ar name
+.Op Ns = Ns Ar value
+.Ar ... Oc
.Xc
Display or set parameter attributes. With no
.Ar name
@@ -3980,7 +4011,9 @@ the
.Ic bind
command. Furthermore, many editing commands are useful only on terminals with
a visible cursor. The default bindings were chosen to resemble corresponding
-Emacs key bindings. The users' tty characters (e.g., ERASE) are bound to
+Emacs key bindings. The users' tty characters (e.g.,
+.Dv ERASE )
+are bound to
reasonable substitutes and override the default bindings.
.Bl -tag -width Ds
.It Ic abort ^G