Initial checkin of man pages for some of the gsh builtin commands.

Not all builtins are represented here.  Some information (such as
a dependancy on the 31/ prefix) is probably out of date, too.
This commit is contained in:
gdr-ftp 1998-04-28 05:18:13 +00:00
parent cf2e1b8db9
commit d2efd0151f
4 changed files with 106 additions and 0 deletions

45
bin/gsh/man/alias.1 Normal file
View File

@ -0,0 +1,45 @@
.TH ALIAS 1 "31 August 1996" GNO "Commands and Applications"
.SH NAME
.LP
alias - define alternate command name (gsh builtin)
.SH SYNOPSIS
.LP
.B alias
[ name command ]
.SH DESCRIPTION
.LP
The shell maintains a list of aliases that you can create, display,
and modify using the
.B alias
and
.B unalias
commands.
The shell checks the first word in each command to see if it matches
the name of an existing alias.
If it does, the command is reprocessed
with the alias definition replacing its name; the history
substitution mechanism is made available as though that command
were the previous input line.
This allows history substitutions,
escaped with a backslash in the definition, to be replaced with
actual command-line arguments when the alias is used.
If no
history substitution is called for, the arguments remain unchanged.
.LP
Aliases can be nested.
That is, an alias definition can contain
the name of another alias.
Nested aliases are expanded before any
history substitutions is applied.
This is useful in pipelines such as
.IP
alias lm "ls \-l | more"
.LP
which when called, pipes the output of
.BR ls (1)
through
.BR more (1).
.LP
Except for the first word, the name of the alias may not appear in its
definition, nor in any alias referred to by its definition.
Such loops are detected, and cause an error message.

26
bin/gsh/man/cd.1 Normal file
View File

@ -0,0 +1,26 @@
.TH CD 1 "31 August 1996" GNO "Commands and Applications"
.SH NAME
.LP
cd \- change working directory (gsh builtin)
.SH SYNOPSIS
.LP
.B cd
[
.I directory
]
.SH DESCRIPTION
.LP
.I directory
becomes the new working directory.
If
.B cd
is used without arguments, it returns you
to your $HOME directory.
.LP
Because a new process is created to execute each command,
.B cd
would be ineffective if it were written as a normal command. It is therefore
recognized and executed by the shells.
.SH "SEE ALSO"
.LP
.BR pwd (1)

18
bin/gsh/man/clear.1 Normal file
View File

@ -0,0 +1,18 @@
.TH CLEAR 1 "31 August 1996" GNO "Commands and Applications"
.SH NAME
.LP
clear \- clear the terminal screen (gsh builtin)
.SH SYNOPSIS
.LP
.B clear
.SH DESCRIPTION
.LP
.B clear
clears your screen if this is possible.
It looks in the environment for the terminal type and then in
.B 31/etc/termcap
to figure out how to clear the screen.
.SH FILES
.LP
.B 31/etc/termcap
terminal capability data base

17
bin/gsh/man/exit.1 Normal file
View File

@ -0,0 +1,17 @@
.TH EXIT 1 "31 August 1996" GNO "Commands and Applications"
.SH NAME
.LP
exit \- terminate process (gsh builtin)
.SH SYNOPSIS
.LP
exit
.SH DESCRIPTION
.LP
.B exit
causes the current shell to terminate.
.LP
If you receive the message
.B "You have stopped jobs."
You have attempted to exit the shell with stopped jobs under job control.
An immediate second attempt to exit will succeed, terminating
the stopped jobs.