386BSD 0.1 development
authorWilliam F. Jolitz <wjolitz@soda.berkeley.edu>
Fri, 7 Jun 1991 18:14:05 +0000 (10:14 -0800)
committerWilliam F. Jolitz <wjolitz@soda.berkeley.edu>
Fri, 7 Jun 1991 18:14:05 +0000 (10:14 -0800)
Work on file usr/src/bin/csh/csh.1

Co-Authored-By: Lynne Greer Jolitz <ljolitz@cardio.ucsf.edu>
Synthesized-from: 386BSD-0.1

usr/src/bin/csh/csh.1 [new file with mode: 0644]

diff --git a/usr/src/bin/csh/csh.1 b/usr/src/bin/csh/csh.1
new file mode 100644 (file)
index 0000000..1222e61
--- /dev/null
@@ -0,0 +1,2139 @@
+.\" Copyright (c) 1980, 1990 The Regents of the University of California.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)csh.1      6.17 (Berkeley) 6/7/91
+.\"
+.Dd June 7, 1991
+.Dt CSH 1
+.Os BSD 4
+.Sh NAME
+.Nm csh
+.Nd a shell (command interpreter) with C-like syntax
+.Sh SYNOPSIS
+.Nm csh
+.Op Fl bcefinstvVxX
+.Op arg ...
+.Sh DESCRIPTION
+The
+.Nm Csh
+is a command language interpreter
+incorporating a history mechanism (see
+.Nm History Substitutions ) ,
+job control facilities (see
+.Nm Jobs ) ,
+interactive file name
+and user name completion (see
+.Nm File Name Completion ) ,
+and a C-like syntax. It is used both as an interactive
+login shell and a shell script command processor.
+.Ss Argument list processing
+If the first argument (argument 0) to the shell is
+.Ql Fl
+then this
+is a login shell.
+The flag arguments are interpreted as follows:
+.Bl -tag -width 5n
+.It Fl b
+This flag forces a ``break'' from option processing, causing any further
+shell arguments to be treated as non-option arguments.
+The remaining arguments will not be interpreted as shell options.
+This may be used to pass options to a shell script without confusion
+or possible subterfuge.
+The shell will not run a set-user ID script without this option.
+.It Fl c
+Commands are read from the (single) following argument which must
+be present.
+Any remaining arguments are placed in
+.Ar argv .
+.It Fl e
+The shell exits if any invoked command terminates abnormally
+or yields a non-zero exit status.
+.It Fl f
+The shell will start faster, because it will neither search for nor
+execute commands from the file
+.Pa \&.cshrc
+in the invoker's home directory.
+.It Fl i
+The shell is interactive and prompts for its top-level input,
+even if it appears to not be a terminal.
+Shells are interactive without this option if their inputs
+and outputs are terminals.
+.It Fl n
+Commands are parsed, but not executed.
+This aids in syntactic checking of shell scripts.
+.It Fl s
+Command input is taken from the standard input.
+.It Fl t
+A single line of input is read and executed.
+A
+.Ql \e
+may be used to escape the newline at the end of this
+line and continue onto another line.
+.It Fl v
+Causes the
+.Ar verbose
+variable to be set, with the effect
+that command input is echoed after history substitution.
+.It Fl x
+Causes the
+.Ar echo
+variable to be set, so that commands are echoed immediately before execution.
+.It Fl V
+Causes the
+.Ar verbose
+variable to be set even before
+.Pa .cshrc
+is executed.
+.It Fl X
+Is to
+.Fl x
+as
+.Fl V
+is to
+.Fl v .
+.El
+.Pp
+After processing of flag arguments, if arguments remain but none of the
+.Fl c ,
+.Fl i ,
+.Fl s ,
+or
+.Fl t
+options were given, the first argument is taken as the name of a file of
+commands to be executed.
+The shell opens this file, and saves its name for possible resubstitution
+by `$0'.
+Since many systems use either the standard version 6 or version 7 shells
+whose shell scripts are not compatible with this shell, the shell will
+execute such a `standard' shell if the first character of a script
+is not a `#', i.e. if the script does not start with a comment.
+Remaining arguments initialize the variable
+.Ar argv .
+.Pp
+An instance of
+.Nm csh
+begins by executing commands from the file
+.Pa /etc/csh.cshrc
+and,
+if this is a login shell,
+.Pa \&/etc/csh.login .
+It then executes
+commands from
+.Pa \&.cshrc
+in the
+.Ar home
+directory of the invoker, and, if this is a login shell, the file
+.Pa \&.login
+in the same location.
+It is typical for users on crt's to put the command ``stty crt''
+in their
+.Pa \&.login
+file, and to also invoke
+.Xr tset  1
+there.
+.Pp
+In the normal case, the shell will begin reading commands from the
+terminal, prompting with `% '.
+Processing of arguments and the use of the shell to process files
+containing command scripts will be described later.
+.Pp
+The shell repeatedly performs the following actions:
+a line of command input is read and broken into
+.Ar words  .
+This sequence of words is placed on the command history list and parsed.
+Finally each command in the current line is executed.
+.Pp
+When a login shell terminates it executes commands from the files
+.Pa .logout
+in the user's
+.Ar home
+directory and
+.Pa /etc/csh.logout .
+.Ss Lexical structure
+The shell splits input lines into words at blanks and tabs with the
+following exceptions.
+The characters
+`&' `\&|' `;' `<' `>' `(' `)'
+form separate words.
+If doubled in `&&', `\&|\&|', `<<' or `>>' these pairs form single words.
+These parser metacharacters may be made part of other words, or prevented their
+special meaning, by preceding them with `\e'.
+A newline preceded by a `\e' is equivalent to a blank.
+.Pp
+Strings enclosed in matched pairs of quotations,
+`\*(aa', `\*(ga' or `"',
+form parts of a word; metacharacters in these strings, including blanks
+and tabs, do not form separate words.
+These quotations have semantics to be described subsequently.
+Within pairs of `\'' or `"' characters a newline preceded by a `\e' gives
+a true newline character.
+.Pp
+When the shell's input is not a terminal,
+the character `#' introduces a comment which continues to the end of the
+input line.
+It is prevented this special meaning when preceded by `\e'
+and in quotations using `\`', `\'', and `"'.
+.Ss Commands
+A simple command is a sequence of words, the first of which
+specifies the command to be executed.
+A simple command or
+a sequence of simple commands separated by `\&|' characters
+forms a pipeline.
+The output of each command in a pipeline is connected to the input of the next.
+Sequences of pipelines may be separated by `;', and are then executed
+sequentially.
+A sequence of pipelines may be executed without immediately
+waiting for it to terminate by following it with an `&'.
+.Pp
+Any of the above may be placed in `(' `)' to form a simple command (which
+may be a component of a pipeline, etc.)
+It is also possible to separate pipelines with `\&|\&|' or `&&' indicating,
+as in the C language,
+that the second is to be executed only if the first fails or succeeds
+respectively. (See
+.Em Expressions . )
+.Ss Jobs
+The shell associates a
+.Ar job
+with each pipeline.  It keeps
+a table of current jobs, printed by the
+.Ar jobs
+command, and assigns them small integer numbers.  When
+a job is started asynchronously with `&', the shell prints a line which looks
+like:
+.Bd -filled -offset indent
+.Op 1
+1234
+.Ed
+.Pp
+indicating that the job which was started asynchronously was job number
+1 and had one (top-level) process, whose process id was 1234.
+.Pp
+If you are running a job and wish to do something else you may hit the key
+.Nm ^Z
+(control-Z) which sends a STOP signal to the current job.
+The shell will then normally indicate that the job has been `Stopped',
+and print another prompt.  You can then manipulate the state of this job,
+putting it in the
+.Em background
+with the
+.Ar bg
+command, or run some other
+commands and then eventually bring the job back into the foreground with
+the
+.Em foreground
+command
+.Ar fg  .
+A
+.Nm ^Z
+takes effect immediately and
+is like an interrupt in that pending output and unread input are discarded
+when it is typed.  There is another special key
+.Nm ^Y
+which does
+not generate a STOP signal until a program attempts to
+.Xr read  2
+it.
+This can usefully be typed ahead when you have prepared some commands
+for a job which you wish to stop after it has read them.
+.Pp
+A job being run in the background will stop if it tries to read
+from the terminal.  Background jobs are normally allowed to produce output,
+but this can be disabled by giving the command ``stty tostop''.
+If you set this
+tty option, then background jobs will stop when they try to produce
+output like they do when they try to read input.
+.Pp
+There are several ways to refer to jobs in the shell.  The character
+`%' introduces a job name.  If you wish to refer to job number 1, you can
+name it as `%1'.  Just naming a job brings it to the foreground; thus
+`%1' is a synonym for `fg %1', bringing job 1 back into the foreground.
+Similarly saying `%1 &' resumes job 1 in the background.
+Jobs can also be named by prefixes of the string typed in to start them,
+if these prefixes are unambiguous, thus `%ex' would normally restart
+a suspended
+.Xr ex  1
+job, if there were only one suspended job whose name began with
+the string `ex'.  It is also possible to say `%?string'
+which specifies a job whose text contains
+.Ar string ,
+if there is only one such job.
+.Pp
+The shell maintains a notion of the current and previous jobs.
+In output pertaining to jobs, the current job is marked with a `+'
+and the previous job with a `\-'.  The abbreviation `%+' refers
+to the current job and `%\-' refers to the previous job.  For close
+analogy with the syntax of the
+.Ar history
+mechanism (described below),
+`%%' is also a synonym for the current job.
+.Pp
+The job control mechanism requires that the
+.Xr stty 1
+option
+.Ic new
+be set. It is an artifact from a
+.Em new
+implementation
+of the
+tty driver which allows generation of interrupt characters from
+the keyboard to tell jobs to stop.  See stty(1) for details
+on setting options in the new tty driver.
+.Ss Status reporting
+This shell learns immediately whenever a process changes state.
+It normally informs you whenever a job becomes blocked so that
+no further progress is possible, but only just before it prints
+a prompt.  This is done so that it does not otherwise disturb your work.
+If, however, you set the shell variable
+.Ar notify ,
+the shell will notify you immediately of changes of status in background
+jobs.
+There is also a shell command
+.Ar notify
+which marks a single process so that its status changes will be immediately
+reported.  By default
+.Ar notify
+marks the current process;
+simply say `notify' after starting a background job to mark it.
+.Pp
+When you try to leave the shell while jobs are stopped, you will
+be warned that `You have stopped jobs.'  You may use the
+.Ar jobs
+command to see what they are.  If you do this or immediately try to
+exit again, the shell will not warn you a second time, and the suspended
+jobs will be terminated.
+.Ss File Name Completion
+When the file name completion feature is enabled by setting
+the shell variable
+.Ar filec
+(see
+.Ic set ) ,
+.Nm csh
+will
+interactively complete file names and user names from unique
+prefixes, when they are input from the terminal followed by
+the escape character (the escape key, or control-[)
+For example,
+if the current directory looks like
+.Bd -literal -offset indent
+DSC.OLD  bin      cmd      lib      xmpl.c
+DSC.NEW  chaosnet cmtest   mail     xmpl.o
+bench    class    dev      mbox     xmpl.out
+.Ed
+.Pp
+and the input is
+.Pp
+.Dl % vi ch<escape>
+.Pp
+.Nm csh
+will complete the prefix ``ch''
+to the only matching file name ``chaosnet'', changing the input
+line to
+.Pp
+.Dl % vi chaosnet
+.Pp
+However, given
+.Pp
+.Dl % vi D<escape>
+.Pp
+.Nm csh
+will only expand the input to
+.Pp
+.Dl % vi DSC.
+.Pp
+and will sound the terminal bell to indicate that the expansion is
+incomplete, since there are two file names matching the prefix ``D''.
+.Pp
+If a partial file name is followed by the end-of-file character
+(usually control-D), then, instead of completing the name,
+.Nm csh
+will list all file names matching the prefix.  For example,
+the input
+.Pp
+.Dl % vi D<control-D>
+.Pp
+causes all files beginning with ``D'' to be listed:
+.Pp
+.Dl DSC.NEW    DSC.OLD
+.Pp
+while the input line remains unchanged.
+.Pp
+The same system of escape and end-of-file can also be used to
+expand partial user names, if the word to be completed
+(or listed) begins with the character ``~''.  For example,
+typing
+.Pp
+.Dl cd ~ro<escape>
+.Pp
+may produce the expansion
+.Pp
+.Dl cd ~root
+.Pp
+The use of the terminal bell to signal errors or multiple matches
+can be inhibited by setting the variable
+.Ar nobeep  .
+.Pp
+Normally, all files in the particular directory are candidates
+for name completion.  Files with certain suffixes can be excluded
+from consideration by setting the variable
+.Ar fignore
+to the
+list of suffixes to be ignored.  Thus, if
+.Ar fignore
+is set by
+the command
+.Pp
+.Dl % set fignore = (.o .out)
+.Pp
+then typing
+.Pp
+.Dl % vi x<escape>
+.Pp
+would result in the completion to
+.Pp
+.Dl % vi xmpl.c
+.Pp
+ignoring the files "xmpl.o" and "xmpl.out".
+However, if the only completion possible requires not ignoring these
+suffixes, then they are not ignored.  In addition,
+.Ar fignore
+does not affect the listing of file names by control-D.  All files
+are listed regardless of their suffixes.
+.Ss Substitutions
+We now describe the various transformations the shell performs on the
+input in the order in which they occur.
+.Ss History substitutions
+History substitutions place words from previous command input as portions
+of new commands, making it easy to repeat commands, repeat arguments
+of a previous command in the current command, or fix spelling mistakes
+in the previous command with little typing and a high degree of confidence.
+History substitutions begin with the character `!' and may begin
+.Ar anywhere
+in the input stream (with the proviso that they
+.Nm "do not"
+nest.)
+This `!' may be preceded by an `\e' to prevent its special meaning; for
+convenience, a `!' is passed unchanged when it is followed by a blank,
+tab, newline, `=' or `('.
+(History substitutions also occur when an input line begins with `\*(ua'.
+This special abbreviation will be described later.)
+Any input line which contains history substitution is echoed on the terminal
+before it is executed as it could have been typed without history substitution.
+.Pp
+Commands input from the terminal which consist of one or more words
+are saved on the history list.
+The history substitutions reintroduce sequences of words from these
+saved commands into the input stream.
+The size of which is controlled by the
+.Ar history
+variable; the previous command is always retained, regardless of its value.
+Commands are numbered sequentially from 1.
+.Pp
+For definiteness, consider the following output from the
+.Ar history
+command:
+.Bd -literal -offset indent
+\09  write michael
+10  ex write.c
+11  cat oldwrite.c
+12  diff *write.c
+.Ed
+.Pp
+The commands are shown with their event numbers.
+It is not usually necessary to use event numbers, but the current event
+number can be made part of the
+.Ar prompt
+by placing an `!' in the prompt string.
+.Pp
+With the current event 13 we can refer to previous events by event
+number `!11', relatively as in `!\-2' (referring to the same event),
+by a prefix of a command word
+as in `!d' for event 12 or `!wri' for event 9, or by a string contained in
+a word in the command as in `!?mic?' also referring to event 9.
+These forms, without further modification, simply reintroduce the words
+of the specified events, each separated by a single blank.
+As a special case `!!' refers to the previous command; thus `!!'
+alone is essentially a
+.Ar redo .
+.Pp
+To select words from an event we can follow the event specification by
+a `:' and a designator for the desired words.
+The words of an input line are numbered from 0,
+the first (usually command) word being 0, the second word (first argument)
+being 1, etc.
+The basic word designators are:
+.Pp
+.Bl -tag -width Ds -compact -offset indent
+.It \&0
+first (command) word
+.It Ar n
+.Ar n Ns \'th
+argument
+.It \*(ua
+first argument,  i.e. `1'
+.It $
+last argument
+.It %
+word matched by (immediately preceding)
+.No \&? Ns Ar s Ns \?
+search
+.It Ar \&x\-y
+range of words
+.It Ar \&\-y
+abbreviates
+.Ar `\&0\-y\'
+.It *
+abbreviates `\*(ua\-$', or nothing if only 1 word in event
+.It Ar x*
+abbreviates
+.Ar `x\-$\'
+.It Ar x\-
+like
+.Ar `x*\'
+but omitting word `$'
+.El
+.Pp
+The `:' separating the event specification from the word designator
+can be omitted if the argument selector begins with a `\*(ua', `$', `*'
+`\-' or `%'.
+After the optional word designator can be
+placed a sequence of modifiers, each preceded by a `:'.
+The following modifiers are defined:
+.Pp
+.Bl -tag -width Ds -compact -offset indent
+.It h
+Remove a trailing pathname component, leaving the head.
+.It r
+Remove a trailing `.xxx' component, leaving the root name.
+.It e
+Remove all but the extension `.xxx' part.
+.It s Ns Ar /l/r/
+Substitute
+.Ar l
+for
+.Ar r
+.It t
+Remove all leading pathname components, leaving the tail.
+.It \&&
+Repeat the previous substitution.
+.It g
+Apply the change globally, prefixing the above, e.g. `g&'.
+.It p
+Print the new command line but do not execute it.
+.It q
+Quote the substituted words, preventing further substitutions.
+.It x
+Like q, but break into words at blanks, tabs and newlines.
+.El
+.Pp
+Unless preceded by a `g' the modification is applied only to the first
+modifiable word.  With substitutions, it is an error for no word to be
+applicable.
+.Pp
+The left hand side of substitutions are not regular expressions in the sense
+of the editors, but rather strings.
+Any character may be used as the delimiter in place of `/';
+a `\e' quotes the delimiter into the
+.Ar l  " "
+and
+.Ar r  " "
+strings.
+The character `&' in the right hand side is replaced by the text from
+the left.
+A `\e' quotes `&' also.
+A null
+.Ar l
+(" ")
+uses the previous string either from a
+.Ar l
+or from a
+contextual scan string
+.Ar s
+in `!?
+.Ar s
+\?'.
+The trailing delimiter in the substitution may be omitted if a newline
+follows immediately as may the trailing `?' in a contextual scan.
+.Pp
+A history reference may be given without an event specification, e.g. `!$'.
+In this case the reference is to the previous command unless a previous
+history reference occurred on the same line in which case this form repeats
+the previous reference.
+Thus `!?foo?\*(ua !$' gives the first and last arguments
+from the command matching `?foo?'.
+.Pp
+A special abbreviation of a history reference occurs when the first
+non-blank character of an input line is a `\*(ua'.
+This is equivalent to `!:s\*(ua' providing a convenient shorthand for substitutions
+on the text of the previous line.
+Thus `\*(ualb\*(ualib' fixes the spelling of
+`lib'
+in the previous command.
+Finally, a history substitution may be surrounded with `{' and `}'
+if necessary to insulate it from the characters which follow.
+Thus, after `ls \-ld ~paul' we might do `!{l}a' to do `ls \-ld ~paula',
+while `!la' would look for a command starting `la'.
+.Pp
+.Ss Quotations with \' and \&"
+The quotation of strings by `\'' and `"' can be used
+to prevent all or some of the remaining substitutions.
+Strings enclosed in `\'' are prevented any further interpretation.
+Strings enclosed in `"' may be expanded as described below.
+.Pp
+In both cases the resulting text becomes (all or part of) a single word;
+only in one special case (see
+.Em Command Substitition
+below) does a `"' quoted string yield parts of more than one word;
+`\'' quoted strings never do.
+.Ss Alias substitution
+The shell maintains a list of aliases which can be established, displayed
+and modified by the
+.Ar alias
+and
+.Ar unalias
+commands.
+After a command line is scanned, it is parsed into distinct commands and
+the first word of each command, left-to-right, is checked to see if it
+has an alias.
+If it does, then the text which is the alias for that command is reread
+with the history mechanism available
+as though that command were the previous input line.
+The resulting words replace the
+command and argument list.
+If no reference is made to the history list, then the argument list is
+left unchanged.
+.Pp
+Thus if the alias for `ls' is `ls \-l' the command `ls /usr' would map to
+`ls \-l /usr', the argument list here being undisturbed.
+Similarly if the alias for `lookup' was `grep !\*(ua /etc/passwd' then
+`lookup bill' would map to `grep bill /etc/passwd'.
+.Pp
+If an alias is found, the word transformation of the input text
+is performed and the aliasing process begins again on the reformed input line.
+Looping is prevented if the first word of the new text is the same as the old
+by flagging it to prevent further aliasing.
+Other loops are detected and cause an error.
+.Pp
+Note that the mechanism allows aliases to introduce parser metasyntax.
+Thus we can `alias print \'pr \e!* \&| lpr\'' to make a command which
+.Ar pr \'s
+its arguments to the line printer.
+.Ss Variable substitution
+The shell maintains a set of variables, each of which has as value a list
+of zero or more words.
+Some of these variables are set by the shell or referred to by it.
+For instance, the
+.Ar argv
+variable is an image of the shell's argument list, and words of this
+variable's value are referred to in special ways.
+.Pp
+The values of variables may be displayed and changed by using the
+.Ar set
+and
+.Ar unset
+commands.
+Of the variables referred to by the shell a number are toggles;
+the shell does not care what their value is,
+only whether they are set or not.
+For instance, the
+.Ar verbose
+variable is a toggle which causes command input to be echoed.
+The setting of this variable results from the
+.Fl v
+command line option.
+.Pp
+Other operations treat variables numerically.
+The `@' command permits numeric calculations to be performed and the result
+assigned to a variable.
+Variable values are, however, always represented as (zero or more) strings.
+For the purposes of numeric operations, the null string is considered to be
+zero, and the second and subsequent words of multiword values are ignored.
+.Pp
+After the input line is aliased and parsed, and before each command
+is executed, variable substitution
+is performed keyed by `$' characters.
+This expansion can be prevented by preceding the `$' with a `\e' except
+within `"'s where it
+.Em always
+occurs, and within `\''s where it
+.Em never
+occurs.
+Strings quoted by `\*(ga' are interpreted later (see
+.Nm "Command substitution"
+below) so `$' substitution does not occur there until later, if at all.
+A `$' is passed unchanged if followed by a blank, tab, or end-of-line.
+.Pp
+Input/output redirections are recognized before variable expansion,
+and are variable expanded separately.
+Otherwise, the command name and entire argument list are expanded together.
+It is thus possible for the first (command) word to this point to generate
+more than one word, the first of which becomes the command name,
+and the rest of which become arguments.
+.Pp
+Unless enclosed in `"' or given the `:q' modifier the results of variable
+substitution may eventually be command and filename substituted.
+Within `"', a variable whose value consists of multiple words expands to a
+(portion of) a single word, with the words of the variables value
+separated by blanks.
+When the `:q' modifier is applied to a substitution
+the variable will expand to multiple words with each word separated
+by a blank and quoted to prevent later command or filename substitution.
+.Pp
+The following metasequences are provided for introducing variable values into
+the shell input.
+Except as noted, it is an error to reference a variable which is not set.
+.Pp
+.Bl -tag -width Ds -compact -offset indent
+.It $name
+.It ${name}
+Are replaced by the words of the value of variable
+.Ar name ,
+each separated by a blank.
+Braces insulate
+.Ar name
+from following characters which would otherwise be part of it.
+Shell variables have names consisting of up to 20 letters and digits
+starting with a letter.  The underscore character is considered a letter.
+.br
+If
+.Ar name
+is not a shell variable, but is set in the environment, then
+that value is returned (but
+.Nm :
+modifiers and the other forms
+given below are not available in this case).
+.It $name Ns Op selector
+.It ${name Ns Op selector Ns }
+May be used to select only some of the words from the value of
+.Ar name .
+The selector is subjected to `$' substitution and may consist of a single
+number or two numbers separated by a `\-'.
+The first word of a variables value is numbered `1'.
+If the first number of a range is omitted it defaults to `1'.
+If the last member of a range is omitted it defaults to `$#name'.
+The selector `*' selects all words.
+It is not an error for a range to be empty if the second argument is omitted
+or in range.
+.It $#name
+.It ${#name}
+Gives the number of words in the variable.
+This is useful for later use in a
+`$argv[selector]'.
+.It $0
+Substitutes the name of the file from which command input is being read.
+An error occurs if the name is not known.
+.It $number
+.It ${number}
+Equivalent to
+`$argv[number]'.
+.It $*
+Equivalent to
+`$argv[*]'.
+The modifiers `:e', `:h', `:t', `:r', `:q' and `:x' may be applied to
+the substitutions above as may `:gh', `:gt' and `:gr'.
+If braces `{' '}' appear in the command form then the modifiers
+must appear within the braces.
+The current implementation allows only one `:' modifier on each `$' expansion.
+.El
+.Pp
+The following substitutions may not be modified with `:' modifiers.
+.Bl -tag -width Ds -compact -offset indent
+.It $?name
+.It ${?name}
+Substitutes the string `1' if name is set, `0' if it is not.
+.It $?0
+Substitutes `1' if the current input filename is known, `0' if it is not.
+.It $$
+Substitute the (decimal) process number of the (parent) shell.
+.It $<
+Substitutes a line from the standard
+input, with no further interpretation thereafter.  It can be used
+to read from the keyboard in a shell script.
+.El
+.Ss Command and filename substitution
+The remaining substitutions, command and filename substitution,
+are applied selectively to the arguments of builtin commands.
+This means that portions of expressions which are not evaluated are
+not subjected to these expansions.
+For commands which are not internal to the shell, the command
+name is substituted separately from the argument list.
+This occurs very late,
+after input-output redirection is performed, and in a child
+of the main shell.
+.Ss Command substitution
+Command substitution is indicated by a command enclosed in `\*(ga'.
+The output from such a command is normally broken into separate words
+at blanks, tabs and newlines, with null words being discarded,
+this text then replacing the original string.
+Within `"'s, only newlines force new words; blanks and tabs are preserved.
+.Pp
+In any case, the single final newline does not force a new word.
+Note that it is thus possible for a command substitution to yield
+only part of a word, even if the command outputs a complete line.
+.Ss Filename substitution
+If a word contains any of the characters `*', `?', `[' or `{'
+or begins with the character `~', then that word is a candidate for
+filename substitution, also known as `globbing'.
+This word is then regarded as a pattern, and replaced with an alphabetically
+sorted list of file names which match the pattern.
+In a list of words specifying filename substitution it is an error for
+no pattern to match an existing file name, but it is not required
+for each pattern to match.
+Only the metacharacters `*', `?' and `[' imply pattern matching,
+the characters `~' and `{' being more akin to abbreviations.
+.Pp
+In matching filenames, the character `.' at the beginning of a filename
+or immediately following a `/', as well as the character `/' must
+be matched explicitly.
+The character `*' matches any string of characters, including the null
+string.
+The character `?' matches any single character.
+The sequence
+.Sq Op ...
+matches any one of the characters enclosed.
+Within
+.Sq Op ... ,
+a pair of characters separated by `\-' matches any character lexically between
+the two.
+.Pp
+The character `~' at the beginning of a filename is used to refer to home
+directories.
+Standing alone, i.e. `~' it expands to the invokers home directory as reflected
+in the value of the variable
+.Ar home .
+When followed by a name consisting of letters, digits and `\-' characters
+the shell searches for a user with that name and substitutes their
+home directory;  thus `~ken' might expand to `/usr/ken' and `~ken/chmach'
+to `/usr/ken/chmach'.
+If the character `~' is followed by a character other than a letter or `/'
+or appears not at the beginning of a word,
+it is left undisturbed.
+.Pp
+The metanotation `a{b,c,d}e' is a shorthand for `abe ace ade'.
+Left to right order is preserved, with results of matches being sorted
+separately at a low level to preserve this order.
+This construct may be nested.
+Thus `~source/s1/{oldls,ls}.c' expands to
+`/usr/source/s1/oldls.c /usr/source/s1/ls.c'
+whether or not these files exist without any chance of error
+if the home directory for `source' is `/usr/source'.
+Similarly `../{memo,*box}' might expand to `../memo ../box ../mbox'.
+(Note that `memo' was not sorted with the results of matching `*box'.)
+As a special case `{', `}' and `{}' are passed undisturbed.
+.Ss Input/output
+The standard input and standard output of a command may be redirected
+with the following syntax:
+.Pp
+.Bl -tag -width Ds -compact -offset indent
+.It < name
+Open file
+.Ar name
+(which is first variable, command and filename expanded) as the standard
+input.
+.It << word
+Read the shell input up to a line which is identical to
+.Ar word .
+.Ar Word
+is not subjected to variable, filename or command substitution,
+and each input line is compared to
+.Ar word
+before any substitutions are done on this input line.
+Unless a quoting `\e', `"', `\*(aa' or `\*(ga' appears in
+.Ar word
+variable and command substitution is performed on the intervening lines,
+allowing `\e' to quote `$', `\e' and `\*(ga'.
+Commands which are substituted have all blanks, tabs, and newlines
+preserved, except for the final newline which is dropped.
+The resultant text is placed in an anonymous temporary file which
+is given to the command as standard input.
+.It > name
+.It >! name
+.It >& name
+.It >&! name
+The file
+.Ar name
+is used as standard output.
+If the file does not exist then it is created;
+if the file exists, its is truncated, its previous contents being lost.
+.Pp
+If the variable
+.Ar noclobber
+is set, then the file must not exist or be a character special file (e.g. a
+terminal or `/dev/null') or an error results.
+This helps prevent accidental destruction of files.
+In this case the `!' forms can be used and suppress this check.
+.Pp
+The forms involving `&' route the diagnostic output into the specified
+file as well as the standard output.
+.Ar Name
+is expanded in the same way as `<' input filenames are.
+.It >> name
+.It >>& name
+.It >>! name
+.It >>&! name
+Uses file
+.Ar name
+as standard output like `>' but places output at the end of the file.
+If the variable
+.Ar noclobber
+is set, then it is an error for the file not to exist unless
+one of the `!' forms is given.
+Otherwise similar to `>'.
+.El
+.Pp
+A command receives the environment in which the shell was
+invoked as modified by the input-output parameters and
+the presence of the command in a pipeline.
+Thus, unlike some previous shells, commands run from a file of shell commands
+have no access to the text of the commands by default; rather
+they receive the original standard input of the shell.
+The `<<' mechanism should be used to present inline data.
+This permits shell command scripts to function as components of pipelines
+and allows the shell to block read its input.
+Note that the default standard input for a command run detached is
+.Ar not
+modified to be the empty file
+.Pa /dev/null ;
+rather the standard input
+remains as the original standard input of the shell.  If this is a terminal
+and if the process attempts to read from the terminal, then the process
+will block and the user will be notified (see
+.Sx Jobs
+above).
+.Pp
+Diagnostic output may be directed through a pipe with the standard output.
+Simply use the form `\&|&' rather than just `\&|'.
+.Ss Expressions
+A number of the builtin commands (to be described subsequently)
+take expressions, in which the operators are similar to those of C, with
+the same precedence.
+These expressions appear in the
+.Nm @,
+.Ar exit ,
+.Ar if ,
+and
+.Ar while
+commands.
+The following operators are available:
+.Bd -ragged -offset indent
+\&|\&|  &&  \&| *(ua  &  ==  !=  =~  !~  <=  >=
+<  > <<  >>  +  \-  *  /  %  !  ~  (  )
+.Ed
+.Pp
+Here the precedence increases to the right,
+`==' `!=' `=~' and `!~', `<=' `>=' `<' and `>', `<<' and `>>', `+' and `\-',
+`*' `/' and `%' being, in groups, at the same level.
+The `==' `!=' `=~' and `!~' operators compare their arguments as strings;
+all others operate on numbers.
+The operators `=~' and `!~' are like `!=' and `==' except that the right
+hand side is a
+.Ar pattern
+(containing, e.g. `*'s, `?'s and instances of
+`[...]'
+against which the left hand operand is matched.  This reduces the
+need for use of the
+.Ar switch
+statement in shell scripts when all that is really needed is pattern matching.
+.Pp
+Strings which begin with `0' are considered octal numbers.
+Null or missing arguments are considered `0'.
+The result of all expressions are strings,
+which represent decimal numbers.
+It is important to note that no two components of an expression can appear
+in the same word; except when adjacent to components of expressions which
+are syntactically significant to the parser (`&' `\&|' `<' `>' `(' `)')
+they should be surrounded by spaces.
+.Pp
+Also available in expressions as primitive operands are command executions
+enclosed in `{' and `}'
+and file enquiries of the form
+.Fl l
+.Ar name
+where
+.Ic l
+is one of:
+.Bd -ragged -offset indent
+r      read access
+w      write access
+x      execute access
+e      existence
+o      ownership
+z      zero size
+f      plain file
+d      directory
+.Ed
+.Pp
+The specified name is command and filename expanded and then tested
+to see if it has the specified relationship to the real user.
+If the file does not exist or is inaccessible then all enquiries return
+false, i.e. `0'.
+Command executions succeed, returning true, i.e. `1',
+if the command exits with status 0, otherwise they fail, returning
+false, i.e. `0'.
+If more detailed status information is required then the command
+should be executed outside of an expression and the variable
+.Ar status
+examined.
+.Ss Control flow
+The shell contains a number of commands which can be used to regulate the
+flow of control in command files (shell scripts) and
+(in limited but useful ways) from terminal input.
+These commands all operate by forcing the shell to reread or skip in its
+input and, due to the implementation, restrict the placement of some
+of the commands.
+.Pp
+The
+.Ic foreach ,
+.Ic switch ,
+and
+.Ic while
+statements, as well as the
+.Ic if\-then\-else
+form of the
+.Ic if
+statement require that the major keywords appear in a single simple command
+on an input line as shown below.
+.Pp
+If the shell's input is not seekable,
+the shell buffers up input whenever a loop is being read
+and performs seeks in this internal buffer to accomplish the rereading
+implied by the loop.
+(To the extent that this allows, backward goto's will succeed on
+non-seekable inputs.)
+.Ss Builtin commands
+Builtin commands are executed within the shell.
+If a builtin command occurs as any component of a pipeline
+except the last then it is executed in a subshell.
+.Pp
+.Bl -tag -width Ds -compact -offset indent
+.It Ic alias
+.It Ic alias Ar name
+.It Ic alias Ar name wordlist
+The first form prints all aliases.
+The second form prints the alias for name.
+The final form assigns the specified
+.Ar wordlist
+as the alias of
+.Ar name ;
+.Ar wordlist
+is command and filename substituted.
+.Ar Name
+is not allowed to be
+.Ar alias
+or
+.Ar unalias .
+.Pp
+.It Ic alloc
+Shows the amount of dynamic memory acquired, broken down into used and
+free memory.
+With an argument shows the number of free and used blocks in each size
+category.  The categories start at size 8 and double at each step.
+This command's output may vary across system types, since
+systems other than the VAX may use a different memory allocator.
+.Pp
+.It Ic bg
+.It Ic bg \&% Ns Ar job ...
+Puts the current or specified jobs into the background, continuing them
+if they were stopped.
+.Pp
+.It Ic break
+Causes execution to resume after the
+.Ic end
+of the nearest enclosing
+.Ic foreach
+or
+.Ic while .
+The remaining commands on the current line are executed.
+Multi-level breaks are thus possible by writing them all on one line.
+.Pp
+.It Ic breaksw
+Causes a break from a
+.Ic switch ,
+resuming after the
+.Ic endsw .
+.Pp
+.It Ic case Ar label :
+A label in a
+.Ic switch
+statement as discussed below.
+.Pp
+.It Ic cd
+.It Ic cd Ar name
+.It Ic chdir
+.It Ic chdir Ar name
+Change the shell's working directory to directory
+.Ar name .
+If no argument is given then change to the home directory of the user.
+If
+.Ar name
+is not found as a subdirectory of the current directory (and does not begin
+with `/', `./' or `../'), then each
+component of the variable
+.Ic cdpath
+is checked to see if it has a subdirectory
+.Ar name .
+Finally, if all else fails but
+.Ar name
+is a shell variable whose value begins with `/', then this
+is tried to see if it is a directory.
+.Pp
+.It Ic continue
+Continue execution of the nearest enclosing
+.Ic while
+or
+.Ic foreach .
+The rest of the commands on the current line are executed.
+.Pp
+.It Ic default :
+Labels the default case in a
+.Ic switch
+statement.
+The default should come after all
+.Ic case
+labels.
+.Pp
+.It Ic dirs
+Prints the directory stack; the top of the stack is at the left,
+the first directory in the stack being the current directory.
+.Pp
+.It Ic echo Ar  wordlist
+.It Ic echo Fl n Ar wordlist
+The specified words are written to the shells standard output, separated
+by spaces, and terminated with a newline unless the
+.Fl n
+option is specified.
+.Pp
+.It Ic else
+.It Ic end
+.It Ic endif
+.It Ic endsw
+See the description of the
+.Ic foreach ,
+.Ic if ,
+.Ic switch ,
+and
+.Ic while
+statements below.
+.Pp
+.It Ic eval Ar arg ...
+(As in
+.Xr sh  1  . )
+The arguments are read as input to the shell and the resulting
+command(s) executed in the context of the current shell.
+This is usually used to execute commands
+generated as the result of command or variable substitution, since
+parsing occurs before these substitutions.  See
+.Xr tset  1
+for an example of using
+.Ic eval .
+.Pp
+.It Ic exec Ar command
+The specified command is executed in place of the current shell.
+.Pp
+.It Ic exit
+.It Ic exit Ar (expr )
+The shell exits either with the value of the
+.Ic status
+variable (first form) or with the value of the specified
+.Ic expr
+(second form).
+.Pp
+.It Ic fg
+.It Ic fg \&% Ar job ...
+Brings the current or specified jobs into the foreground, continuing them if
+they were stopped.
+.Pp
+.It Ic foreach Ar name (wordlist)
+.It ...
+.It Ic end
+The variable
+.Ic name
+is successively set to each member of
+.Ic wordlist
+and the sequence of commands between this command and the matching
+.Ic end
+are executed.
+(Both
+.Ic foreach
+and
+.Ic end
+must appear alone on separate lines.)
+The builtin command
+.Ic continue
+may be used to continue the loop prematurely and the builtin
+command
+.Ic break
+to terminate it prematurely.
+When this command is read from the terminal, the loop is read up once
+prompting with `?' before any statements in the loop are executed.
+If you make a mistake typing in a loop at the terminal you can rub it out.
+.Pp
+.It Ic glob Ar wordlist
+Like
+.Ic echo
+but no `\e' escapes are recognized and words are delimited
+by null characters in the output.
+Useful for programs which wish to use the shell to filename expand a list
+of words.
+.Pp
+.It Ic goto Ar word
+The specified
+.Ic word
+is filename and command expanded to yield a string of the form `label'.
+The shell rewinds its input as much as possible
+and searches for a line of the form `label:'
+possibly preceded by blanks or tabs.
+Execution continues after the specified line.
+.Pp
+.It Ic hashstat
+Print a statistics line indicating how effective the internal hash
+table has been at locating commands (and avoiding
+.Ic exec Ns \'s ) .
+An
+.Ic exec
+is attempted for each component of the
+.Em path
+where the hash function indicates a possible hit, and in each component
+which does not begin with a `/'.
+.Pp
+.It Ic history
+.It Ic history Ar n
+.It Ic history Fl r Ar n
+.It Ic history Fl h Ar n
+Displays the history event list; if
+.Ar n
+is given only the
+.Ar n
+most recent events are printed.
+The
+.Fl r
+option reverses the order of printout to be most recent first
+rather than oldest first.
+The
+.Fl h
+option causes the history list to be printed without leading numbers.
+This is used to produce files suitable for sourceing using the \-h
+option to
+.Ic source  .
+.Pp
+.It Ic if Pq Ar expr No command
+If the specified expression evaluates true, then the single
+.Ar command
+with arguments is executed.
+Variable substitution on
+.Ar command
+happens early, at the same
+time it does for the rest of the
+.Ic if
+command.
+.Ar Command
+must be a simple command, not
+a pipeline, a command list, or a parenthesized command list.
+Input/output redirection occurs even if
+.Ar expr
+is false, when command is
+.Sy not
+executed (this is a bug).
+.Pp
+.It Ic if ( Ar expr ) Ic then
+.It ...
+.It Ic else if ( Ar expr2 ) Ic then
+.It ...
+.It Ic else
+.It ...
+.It Ic endif
+If the specified
+.Ar expr
+is true then the commands to the first
+.Ic else
+are executed; otherwise if
+.Ar expr2
+is true then the commands to the
+second
+.Ic else
+are executed, etc.
+Any number of
+.Ic else-if
+pairs are possible; only one
+.Ic endif
+is needed.
+The
+.Ic else
+part is likewise optional.
+(The words
+.Ic else
+and
+.Ic endif
+must appear at the beginning of input lines;
+the
+.Ic if
+must appear alone on its input line or after an
+.Ic else . )
+.Pp
+.It Ic jobs
+.It Ic jobs Fl l
+Lists the active jobs; given the
+.Fl l
+options lists process id's in addition to the normal information.
+.Pp
+.It Ic kill % Ar job
+.It Ic kill Ar pid
+.It Ic kill Fl sig Ar pid ...
+.It Ic kill Fl l
+Sends either the TERM (terminate) signal or the
+specified signal to the specified jobs or processes.
+Signals are either given by number or by names (as given in
+.Pa /usr/include/signal.h,
+stripped of the prefix ``SIG'').
+The signal names are listed by ``kill \-l''.
+There is no default, saying just `kill' does not
+send a signal to the current job.
+If the signal being sent is TERM (terminate) or HUP (hangup),
+then the job or process will be sent a CONT (continue) signal as well.
+.Pp
+.It Ic limit
+.It Ic limit Ar resource
+.It Ic limit Ar resource maximum-use
+.It Ic limit Fl h
+.It Ic limit Fl h Ar resource
+.It Ic limit Fl h Ar resource maximum-use
+Limits the consumption by the current process and each process
+it creates to not individually exceed
+.Ar maximum-use
+on the
+specified
+.Ar resource  .
+If no
+.Ar maximum-use
+is given, then
+the current limit is printed; if no
+.Ar resource
+is given, then
+all limitations are given.  If the
+.Fl h
+flag is given, the hard limits are used instead of the current
+limits.  The hard limits impose a ceiling on the values of
+the current limits.  Only the super-user may raise the hard limits,
+but a user may lower or raise the current limits within the legal range.
+.Pp
+Resources controllable currently include
+.Ar cputime
+(the maximum
+number of cpu-seconds to be used by each process),
+.Ar filesize
+(the largest single file which can be created),
+.Ar datasize
+(the maximum growth of the data+stack region via
+.Xr sbrk  2
+beyond the end of the program text),
+.Ar stacksize
+(the maximum
+size of the automatically-extended stack region), and
+.Ar coredumpsize
+(the size of the largest core dump that will be created).
+.Pp
+The
+.Ar maximum-use
+may be given as a (floating point or integer)
+number followed by a scale factor.  For all limits other than
+.Ar cputime
+the default scale is `k' or `kilobytes' (1024 bytes);
+a scale factor of `m' or `megabytes' may also be used.
+For
+.Ar cputime
+the default scaling is `seconds', while `m' for minutes
+or `h' for hours, or a time of the form `mm:ss' giving minutes
+and seconds may be used.
+.Pp
+For both
+.Ar resource
+names and scale factors, unambiguous prefixes
+of the names suffice.
+.Pp
+.It Ic login
+Terminate a login shell, replacing it with an instance of
+.Pa /bin/login.
+This is one way to log off, included for compatibility with
+.Xr sh  1  .
+.Pp
+.It Ic logout
+Terminate a login shell.
+Especially useful if
+.Ic ignoreeof
+is set.
+.Pp
+.It Ic nice
+.It Ic nice Ar +number
+.It Ic nice Ar command
+.It Ic nice Ar +number command
+The first form sets the
+scheduling priority
+for this shell to 4.
+The second form sets the
+priority
+to the given
+.Ar number .
+The final two forms run command at priority 4 and
+.Ar number
+respectively.
+The greater the number, the less cpu the process will get.
+The super-user may specify negative priority by using `nice \-number ...'.
+Command is always executed in a sub-shell, and the restrictions
+placed on commands in simple
+.Ic if
+statements apply.
+.Pp
+.It Ic nohup
+.It Ic nohup Ar command
+The first form can be used in shell scripts to cause hangups to be
+ignored for the remainder of the script.
+The second form causes the specified command to be run with hangups
+ignored.
+All processes detached with `&' are effectively
+.Ic nohup Ns \'ed .
+.Pp
+.It Ic notify
+.It Ic notify % Ar job ...
+Causes the shell to notify the user asynchronously when the status of the
+current or specified jobs changes; normally notification is presented
+before a prompt.  This is automatic if the shell variable
+.Ic notify
+is set.
+.Pp
+.It Ic onintr
+.It Ic onintr Fl
+.It Ic onintr Ar label
+Control the action of the shell on interrupts.
+The first form restores the default action of the shell on interrupts
+which is to terminate shell scripts or to return to the terminal command
+input level.
+The second form `onintr \-' causes all interrupts to be ignored.
+The final form causes the shell to execute a `goto label' when
+an interrupt is received or a child process terminates because
+it was interrupted.
+.Pp
+In any case, if the shell is running detached and interrupts are
+being ignored, all forms of
+.Ic onintr
+have no meaning and interrupts
+continue to be ignored by the shell and all invoked commands.
+.Pp
+.It Ic popd
+.It Ic popd Ar +n
+Pops the directory stack, returning to the new top directory.
+With an argument
+.Ns \`+ Ar n Ns \'
+discards the
+.Ar n Ns \'th
+entry in the stack.
+The elements of the directory stack are numbered from 0 starting at the top.
+.Pp
+.It Ic pushd
+.It Ic pushd Ar name
+.It Ic pushd Ar n
+With no arguments,
+.Ic pushd
+exchanges the top two elements of the directory stack.
+Given a
+.Ar name
+argument,
+.Ic pushd
+changes to the new directory (ala
+.Ic cd )
+and pushes the old current working directory
+(as in
+.Ic csw )
+onto the directory stack.
+With a numeric argument, rotates the
+.Ar n Ns \'th
+argument of the directory
+stack around to be the top element and changes to it.  The members
+of the directory stack are numbered from the top starting at 0.
+.Pp
+.It Ic rehash
+Causes the internal hash table of the contents of the directories in
+the
+.Ic path
+variable to be recomputed.  This is needed if new commands are added
+to directories in the
+.Ic path
+while you are logged in.  This should only be necessary if you add
+commands to one of your own directories, or if a systems programmer
+changes the contents of one of the system directories.
+.Pp
+.It Ic repeat Ar count command
+The specified
+.Ar command
+which is subject to the same restrictions
+as the
+.Ar command
+in the one line
+.Ic if
+statement above,
+is executed
+.Ar count
+times.
+I/O redirections occur exactly once, even if
+.Ar count
+is 0.
+.Pp
+.It Ic set
+.It Ic set Ar name
+.It Ic set Ar name Ns =word
+.It Ic set Ar name[index] Ns =word
+.It Ic set Ar name Ns =(wordlist)
+The first form of the command shows the value of all shell variables.
+Variables which have other than a single word as value print as a parenthesized
+word list.
+The second form sets
+.Ic name
+to the null string.
+The third form sets
+.Ic name
+to the single
+.Ic word .
+The fourth form sets
+the
+.Ar index Ns 'th
+component of name to word;
+this component must already exist.
+The final form sets
+.Ar name
+to the list of words in
+.Ar wordlist .
+In all cases the value is command and filename expanded.
+.Pp
+These arguments may be repeated to set multiple values in a single set command.
+Note however, that variable expansion happens for all arguments before any
+setting occurs.
+.Pp
+.It Ic setenv
+.It Ic setenv Ar name value
+.It Ic setenv Ar name
+The first form lists all current environment variables.
+The last form sets the value of environment variable
+.Ar name
+to be
+.Ar value ,
+a single string.  The second form sets
+.Ar name
+to an empty string.
+The most commonly used environment variable
+.Ev USER ,
+.Ev TERM ,
+and
+.Ev PATH
+are automatically imported to and exported from the
+.Nm csh
+variables
+.Ar user ,
+.Op Ar term ,
+and
+.Ar path ;
+there is no need to use
+.Ic setenv
+for these.
+.Pp
+.It Ic shift
+.It Ic shift Ar variable
+The members of
+.Ic argv
+are shifted to the left, discarding
+.Ic argv Bq 1 .
+It is an error for
+.Ic argv
+not to be set or to have less than one word as value.
+The second form performs the same function on the specified variable.
+.Pp
+.It Ic source Ar name
+.It Ic source Fl h Ar name
+The shell reads commands from
+.Ic name .
+.Ic Source
+commands may be nested; if they are nested too deeply the shell may
+run out of file descriptors.
+An error in a
+.Ic source
+at any level terminates all nested
+.Ic source
+commands.
+Normally input during
+.Ic source
+commands is not placed on the history list;
+the \-h option causes the commands to be placed in the
+history list without being executed.
+.Pp
+.It Ic stop
+.It Ic stop % Ns Ar job ...
+Stops the current or specified job which is executing in the background.
+.Pp
+.It Ic suspend
+Causes the shell to stop in its tracks, much as if it had been sent a stop
+signal with
+.Ic ^Z .
+This is most often used to stop shells started by
+.Xr su  1 .
+.Pp
+.It Ic switch Ar (string)
+.It Ic case Ar str1 :
+.It \ \ \ \ \&...
+.It Ic \ \ \ \ breaksw
+.It \ \ \ \ \&...
+.It Ic default :
+.It \ \ \ \ \&...
+.It Ic \ \ \ \ breaksw
+.It Ic endsw
+Each case label is successively matched, against the specified
+.Ar string
+which is first command and filename expanded.
+The file metacharacters `*', `?' and `[...]'
+may be used in the case labels,
+which are variable expanded.
+If none of the labels match before a `default' label is found, then
+the execution begins after the default label.
+Each case label and the default label must appear at the beginning of a line.
+The command
+.Ic breaksw
+causes execution to continue after the
+.Ic endsw .
+Otherwise control may fall through case labels and default labels as in C.
+If no label matches and there is no default, execution continues after
+the
+.Ic endsw .
+.Pp
+.It Ic time
+.It Ic time Ar command
+With no argument, a summary of time used by this shell and its children
+is printed.
+If arguments are given
+the specified simple command is timed and a time summary
+as described under the
+.Ic time
+variable is printed.  If necessary, an extra shell is created to print the time
+statistic when the command completes.
+.Pp
+.It Ic umask
+.It Ic umask Ar value
+The file creation mask is displayed (first form) or set to the specified
+value (second form).  The mask is given in octal.  Common values for
+the mask are 002 giving all access to the group and read and execute
+access to others or 022 giving all access except no write access for
+users in the group or others.
+.Pp
+.It Ic unalias Ar pattern
+All aliases whose names match the specified pattern are discarded.
+Thus all aliases are removed by `unalias *'.
+It is not an error for nothing to be
+.Ic unaliased .
+.Pp
+.It Ic unhash
+Use of the internal hash table to speed location of executed programs
+is disabled.
+.Pp
+.It Ic unlimit
+.It Ic unlimit Ar  resource
+.It Ic unlimit Fl h
+.It Ic unlimit Fl h Ar resource
+Removes the limitation on
+.Ar resource  .
+If no
+.Ar resource
+is specified, then all
+.Ar resource
+limitations are removed.  If
+.Fl h
+is given, the corresponding hard limits are removed.  Only the
+super-user may do this.
+.Pp
+.It Ic unset Ar pattern
+All variables whose names match the specified pattern are removed.
+Thus all variables are removed by `unset *'; this has noticeably
+distasteful side-effects.
+It is not an error for nothing to be
+.Ic unset .
+.Pp
+.It Ic unsetenv Ar pattern
+Removes all variables whose name match the specified pattern from the
+environment.  See also the
+.Ic setenv
+command above and
+.Xr printenv  1  .
+.Pp
+.It Ic wait
+All background jobs are waited for.
+It the shell is interactive, then an interrupt can disrupt the wait,
+at which time the shell prints names and job numbers of all jobs
+known to be outstanding.
+.Pp
+.It Ic while Ar (expr)
+.It \&...
+.It Ic end
+While the specified expression evaluates non-zero, the commands between
+the
+.Ic while
+and the matching end are evaluated.
+.Ic Break
+and
+.Ic continue
+may be used to terminate or continue the loop prematurely.
+(The
+.Ic while
+and
+.Ic end
+must appear alone on their input lines.)
+Prompting occurs here the first time through the loop as for the
+.Ic foreach
+statement if the input is a terminal.
+.Pp
+.It Ic % Ar job
+Brings the specified job into the foreground.
+.Pp
+.It Ic % Ar job Ic &
+Continues the specified job in the background.
+.Pp
+.It Ic @
+.It Ic @ Ns Ar name Ns = expr
+.It Ic @ Ns Ar name[index] Ns = expr
+The first form prints the values of all the shell variables.
+The second form sets the specified
+.Ar name
+to the value of
+.Ar expr .
+If the expression contains `<', `>', `&' or `' then at least
+this part of the expression must be placed within `(' `)'.
+The third form assigns the value of
+.Ar expr
+to the
+.Ar index Ns 'th
+argument of
+.Ar name .
+Both
+.Ar name
+and its
+.Ar index Ns 'th
+component must already exist.
+.El
+.Pp
+The operators `*=', `+=', etc are available as in C.
+The space separating the name from the assignment operator is optional.
+Spaces are, however, mandatory in separating components of
+.Ar expr
+which would otherwise be single words.
+.Pp
+Special postfix `++' and `\-\-' operators increment and decrement
+.Ar name
+respectively, i.e. `@  i++'.
+.Ss Pre-defined and environment variables
+The following variables have special meaning to the shell.
+Of these,
+.Ar argv ,
+.Ar cwd,
+.Ar home ,
+.Ar path,
+.Ar prompt ,
+.Ar shell
+and
+.Ar status
+are always set by the shell.
+Except for
+.Ar cwd
+and
+.Ar status
+this setting occurs only at initialization;
+these variables will not then be modified unless this is done
+explicitly by the user.
+.Pp
+This shell copies the environment variable
+.Ev USER
+into the variable
+.Ar user ,
+.Ev TERM
+into
+.Ar term ,
+and
+.Ev HOME
+into
+.Ar home ,
+and copies these back into the environment whenever the normal
+shell variables are reset.
+The environment variable
+.Ev PATH
+is likewise handled; it is not
+necessary to worry about its setting other than in the file
+.Ar \&.cshrc
+as inferior
+.Nm csh
+processes will import the definition of
+.Ar path
+from the environment, and re-export it if you then change it.
+.Bl -tag -width histchars
+.It Ic argv
+Set to the arguments to the shell, it is from this variable that
+positional parameters are substituted, i.e. `$1' is replaced by
+`$argv[1]',
+etc.
+.It Ic cdpath
+Gives a list of alternate directories searched to find subdirectories
+in
+.Ar chdir
+commands.
+.It Ic cwd
+The full pathname of the current directory.
+.It Ic echo
+Set when the
+.Fl x
+command line option is given.
+Causes each command and its arguments
+to be echoed just before it is executed.
+For non-builtin commands all expansions occur before echoing.
+Builtin commands are echoed before command and filename substitution,
+since these substitutions are then done selectively.
+.It Ic filec
+Enable file name completion.
+.It Ic histchars
+Can be given a string value to change the characters used in history
+substitution.  The first character of its value is used as the
+history substitution character, replacing the default character `!'.
+The second character of its value replaces the character `\(ua' in
+quick substitutions.
+.It Ic history
+Can be given a numeric value to control the size of the history list.
+Any command which has been referenced in this many events will not be
+discarded.
+Too large values of
+.Ar history
+may run the shell out of memory.
+The last executed command is always saved on the history list.
+.It Ic home
+The home directory of the invoker, initialized from the environment.
+The filename expansion of
+.Sq Pa ~
+refers to this variable.
+.It Ic ignoreeof
+If set the shell ignores
+end-of-file from input devices which are terminals.
+This prevents shells from accidentally being killed by control-D's.
+.It Ic mail
+The files where the shell checks for mail.
+This is done after each command completion which will result in a prompt,
+if a specified interval has elapsed.
+The shell says `You have new mail.'
+if the file exists with an access time not greater than its modify time.
+.Pp
+If the first word of the value of
+.Ar mail
+is numeric it specifies a different mail checking interval, in seconds,
+than the default, which is 10 minutes.
+.Pp
+If multiple mail files are specified, then the shell says
+`New mail in
+.Ar name Ns '
+when there is mail in the file
+.Ar name .
+.It Ic noclobber
+As described in the section on
+.Sx Input/output ,
+restrictions are placed on output redirection to insure that
+files are not accidentally destroyed, and that `>>' redirections
+refer to existing files.
+.It Ic noglob
+If set, filename expansion is inhibited.
+This is most useful in shell scripts which are not dealing with filenames,
+or after a list of filenames has been obtained and further expansions
+are not desirable.
+.It Ic nonomatch
+If set, it is not an error for a filename expansion to not match any
+existing files; rather the primitive pattern is returned.
+It is still an error for the primitive pattern to be malformed, i.e.
+`echo ['
+still gives an error.
+.It Ic notify
+If set, the shell notifies asynchronously of job completions.  The
+default is to rather present job completions just before printing
+a prompt.
+.It Ic path
+Each word of the path variable specifies a directory in which
+commands are to be sought for execution.
+A null word specifies the current directory.
+If there is no
+.Ar path
+variable then only full path names will execute.
+The usual search path is `.', `/bin' and `/usr/bin', but this
+may vary from system to system.
+For the super-user the default search path is `/etc', `/bin' and `/usr/bin'.
+A shell which is given neither the
+.Fl c
+nor the
+.Fl t
+option will normally hash the contents of the directories in the
+.Ar path
+variable after reading
+.Ar \&.cshrc ,
+and each time the
+.Ar path
+variable is reset.  If new commands are added to these directories
+while the shell is active, it may be necessary to do a
+.Ic rehash
+or the commands may not be found.
+.It Ic prompt
+The string which is printed before each command is read from
+an interactive terminal input.
+If a `!' appears in the string it will be replaced by the current event number
+unless a preceding `\e' is given.
+Default is `% ', or `# ' for the super-user.
+.It Ic savehist
+Is given a numeric value to control the number of entries of the
+history list that are saved in ~/.history when the user logs out.
+Any command which has been referenced in this many events will be saved.
+During start up the shell sources ~/.history into the history list
+enabling history to be saved across logins.
+Too large values of
+.Ar savehist
+will slow down the shell during start up.
+.It Ic shell
+The file in which the shell resides.
+This is used in forking shells to interpret files which have execute
+bits set, but which are not executable by the system.
+(See the description of
+.Sx Non-builtin Command Execution
+below.)
+Initialized to the (system-dependent) home of the shell.
+.It Ic status
+The status returned by the last command.
+If it terminated abnormally, then 0200 is added to the status.
+Builtin commands which fail return exit status `1',
+all other builtin commands set status `0'.
+.It Ic time
+Controls automatic timing of commands.
+If set, then any command which takes more than this many cpu seconds
+will cause a line giving user, system, and real times and a utilization
+percentage which is the ratio of user plus system times to real time
+to be printed when it terminates.
+.It Ic verbose
+Set by the
+.Fl v
+command line option, causes the words of each command to be printed
+after history substitution.
+.El
+.Ss Non-builtin command execution
+When a command to be executed is found to not be a builtin command
+the shell attempts to execute the command via
+.Xr execve  2  .
+Each word in the variable
+.Ar path
+names a directory from which the shell will attempt to execute the command.
+If it is given neither a
+.Fl c
+nor a
+.Fl t
+option, the shell will hash the names in these directories into an internal
+table so that it will only try an
+.Ic exec
+in a directory if there is a possibility that the command resides there.
+This greatly speeds command location when a large number of directories
+are present in the search path.
+If this mechanism has been turned off (via
+.Ic unhash ) ,
+or if the shell was given a
+.Fl c
+or
+.Fl t
+argument, and in any case for each directory component of
+.Ar path
+which does not begin with a `/',
+the shell concatenates with the given command name to form a path name
+of a file which it then attempts to execute.
+.Pp
+Parenthesized commands are always executed in a subshell.
+Thus
+.Pp
+.Dl (cd ; pwd) ; pwd
+.Pp
+prints the
+.Ar home
+directory; leaving you where you were (printing this after the home directory),
+while
+.Pp
+.Dl cd ; pwd
+.Pp
+leaves you in the
+.Ar home
+directory.
+Parenthesized commands are most often used to prevent
+.Ic chdir
+from affecting the current shell.
+.Pp
+If the file has execute permissions but is not an
+executable binary to the system, then it is assumed to be a
+file containing shell commands and a new shell is spawned to read it.
+.Pp
+If there is an
+.Ic alias
+for
+.Ic shell
+then the words of the alias will be prepended to the argument list to form
+the shell command.
+The first word of the
+.Ic alias
+should be the full path name of the shell
+(e.g. `$shell').
+Note that this is a special, late occurring, case of
+.Ic alias
+substitution,
+and only allows words to be prepended to the argument list without modification.
+.Ss Signal handling
+The shell normally ignores
+.Ar quit
+signals.
+Jobs running detached (either by
+.Ic \&&
+or the
+.Ic bg
+or
+.Ic %... &
+commands) are immune to signals generated from the keyboard, including
+hangups.
+Other signals have the values which the shell inherited from its parent.
+The shell's handling of interrupts and terminate signals
+in shell scripts can be controlled by
+.Ic onintr .
+Login shells catch the
+.Ar terminate
+signal; otherwise this signal is passed on to children from the state in the
+shell's parent.
+In no case are interrupts allowed when a login shell is reading the file
+.Pa \&.logout .
+.Sh AUTHOR
+William Joy.
+Job control and directory stack features first implemented by J.E. Kulp of
+IIASA, Laxenburg, Austria,
+with different syntax than that used now.
+File name completion code written by Ken Greer, HP Labs.
+Eight-bit implementation Christos S. Zoulas, Cornell University.
+.Sh FILES
+.Bl -tag -width /etc/passwd -compact
+.It Pa ~/.cshrc
+Read at beginning of execution by each shell.
+.It Pa ~/.login
+Read by login shell, after `.cshrc' at login.
+.It Pa ~/.logout
+Read by login shell, at logout.
+.It Pa /bin/sh
+Standard shell, for shell scripts not starting with a `#'.
+.It Pa /tmp/sh*
+Temporary file for `<<'.
+.It Pa /etc/passwd
+Source of home directories for `~name'.
+.El
+.Sh LIMITATIONS
+Word lengths \-
+Words can be no longer than 1024 characters.
+The system limits argument lists to 10240 characters.
+The number of arguments to a command which involves filename expansion
+is limited to 1/6'th the number of characters allowed in an argument list.
+Command substitutions may substitute no more characters than are
+allowed in an argument list.
+To detect looping, the shell restricts the number of
+.Ic alias
+substitutions on a single line to 20.
+.Sh SEE ALSO
+.Xr sh 1 ,
+.Xr access 2 ,
+.Xr execve 2 ,
+.Xr fork 2 ,
+.Xr killpg 2 ,
+.Xr pipe 2 ,
+.Xr sigvec 2 ,
+.Xr umask 2 ,
+.Xr setrlimit 2 ,
+.Xr wait 2 ,
+.Xr tty 4 ,
+.Xr a.out 5 ,
+.Xr environ 7 ,
+.br
+.Em An introduction to the C shell
+.Sh HISTORY
+.Nm Csh
+appeared in
+.Bx 3 .
+It
+was a first implementation of a command language interpreter
+incorporating a history mechanism (see
+.Sx History Substitutions ) ,
+job control facilities (see
+.Sx Jobs ) ,
+interactive file name
+and user name completion (see
+.Sx File Name Completion ) ,
+and a C-like syntax.
+There are now many shells which also have these mechanisms, plus
+a few more (and maybe some bugs too), which are available thru the
+usenet, or with
+.Bx
+as contributed software like the
+.Xr ksh korn\ shell .
+.Sh BUGS
+When a command is restarted from a stop,
+the shell prints the directory it started in if this is different
+from the current directory; this can be misleading (i.e. wrong)
+as the job may have changed directories internally.
+.Pp
+Shell builtin functions are not stoppable/restartable.
+Command sequences of the form `a ; b ; c' are also not handled gracefully
+when stopping is attempted.  If you suspend `b', the shell will then
+immediately execute `c'.  This is especially noticeable if this
+expansion results from an
+.Ar alias .
+It suffices to place the sequence of commands in ()'s to force it to
+a subshell, i.e. `( a ; b ; c )'.
+.Pp
+Control over tty output after processes are started is primitive;
+perhaps this will inspire someone to work on a good virtual
+terminal interface.  In a virtual terminal interface much more
+interesting things could be done with output control.
+.Pp
+Alias substitution is most often used to clumsily simulate shell procedures;
+shell procedures should be provided rather than aliases.
+.Pp
+Commands within loops, prompted for by `?', are not placed in the
+.Ic history
+list.
+Control structure should be parsed rather than being recognized as built-in
+commands.  This would allow control commands to be placed anywhere,
+to be combined with `\&|', and to be used with `&' and `;' metasyntax.
+.Pp
+It should be possible to use the `:' modifiers on the output of command
+substitutions.
+All and more than one `:' modifier should be allowed on `$' substitutions.
+.Pp
+The way the
+.Ic filec
+facility is implemented is ugly and expensive.