Some documentation cleanup

This commit is contained in:
Steven Fackler 2013-04-21 21:13:18 -04:00
parent d215e86662
commit 03c1f2ef5b
5 changed files with 26 additions and 17 deletions

View file

@ -3,9 +3,9 @@
\subsection cd-synopsis Synopsis \subsection cd-synopsis Synopsis
<tt>cd [DIRECTORY]</tt> <tt>cd [DIRECTORY]</tt>
\subsection cd-description Description Changes the current \subsection cd-description Description
directory. If <tt>DIRECTORY</tt> is supplied it will become the new Changes the current directory. If <tt>DIRECTORY</tt> is supplied it will become
directory. If \c DIRECTORY is a relative path, the paths found in the the new directory. If \c DIRECTORY is a relative path, the paths found in the
CDPATH environment variable array will be tried as prefixes for the CDPATH environment variable array will be tried as prefixes for the specified
specified path. If CDPATH is not set, it is assumed to be '.'. If \c path. If CDPATH is not set, it is assumed to be '.'. If \c DIRECTORY is not
DIRECTORY is not specified, \$HOME will be the new directory. specified, \$HOME will be the new directory.

View file

@ -5,10 +5,16 @@
\subsection funced-description Description \subsection funced-description Description
Use the funced command to edit the definition of a Use the funced command to edit the definition of a function. If there is no
function. If there is no function with the name specified, a skeleton function is inserted, if a function exist, the definition will be shown in your editor or on the command line. function with the name specified, a skeleton function is inserted. If the
function exists, its definition will be shown in your editor or on the command
line.
By default, funced edits functions using the text editor in your $EDITOR variable, if set; otherwise it uses the built-in editor. By default, funced edits functions using the text editor in your $EDITOR
variable, if set; otherwise it uses the built-in editor.
- <code>-e command</code> or <code>--editor command</code> Open the function body inside the text editor given by the command (for example, "vi"). The command 'fish' will use the built-in editor. - <code>-e command</code> or <code>--editor command</code> Open the function
- <code>-i</code> or <code>--interactive</code> Open function body in built-in editor. body inside the text editor given by the command (for example, "vi"). The
command 'fish' will use the built-in editor.
- <code>-i</code> or <code>--interactive</code> Open function body in the
built-in editor.

View file

@ -1,4 +1,4 @@
\section funcsave funcsave - save the definition of a function to the users autoload directory \section funcsave funcsave - save the definition of a function to the user's autoload directory
\subsection funcsave-synopsis Synopsis \subsection funcsave-synopsis Synopsis
<tt>funcsave FUNCTION_NAME</tt> <tt>funcsave FUNCTION_NAME</tt>

View file

@ -3,10 +3,13 @@
\subsection isatty-synopsis Synopsis \subsection isatty-synopsis Synopsis
<tt>isatty [FILE DESCRIPTOR]</tt> <tt>isatty [FILE DESCRIPTOR]</tt>
where FILE DESCRIPTOR may be either the number of a file descriptor, or one \subsection isatty-description Description
of the strings stdin, stdout and stderr. The <tt>isatty</tt> command is used to test if a file descriptor is a tty.
If the specified file descriptor is a tty, the exit status of the FILE DESCRIPTOR may be either the number of a file descriptor, or one of the
command is zero, otherwise, it is non-zero. strings stdin, stdout and stderr.
If the specified file descriptor is a tty, the exit status of the command is
zero, otherwise, it is non-zero.

View file

@ -1,6 +1,6 @@
\section jobs jobs - print currently running jobs \section jobs jobs - print currently running jobs
\subsection jobs-synopsis \subsection jobs-synopsis Synopsis
<code>jobs [OPTIONS] [PID]</code> <code>jobs [OPTIONS] [PID]</code>
\subsection jobs-description Description \subsection jobs-description Description