aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src
diff options
context:
space:
mode:
authorGravatar Steven Fackler <sfackler@gmail.com>2013-04-21 21:13:18 -0400
committerGravatar Steven Fackler <sfackler@gmail.com>2013-04-21 21:36:48 -0400
commit03c1f2ef5b1215654cdaff8544be22e5e93ca633 (patch)
tree01dcb9ba52edc91f38d74757bb18779f68049512 /doc_src
parentd215e866623f7ec935eedfe0fc81e950b0d0381e (diff)
Some documentation cleanup
Diffstat (limited to 'doc_src')
-rw-r--r--doc_src/cd.txt12
-rw-r--r--doc_src/funced.txt16
-rw-r--r--doc_src/funcsave.txt2
-rw-r--r--doc_src/isatty.txt11
-rw-r--r--doc_src/jobs.txt2
5 files changed, 26 insertions, 17 deletions
diff --git a/doc_src/cd.txt b/doc_src/cd.txt
index 9bd88a0a..13184e10 100644
--- a/doc_src/cd.txt
+++ b/doc_src/cd.txt
@@ -3,9 +3,9 @@
\subsection cd-synopsis Synopsis
<tt>cd [DIRECTORY]</tt>
-\subsection cd-description Description Changes the current
-directory. If <tt>DIRECTORY</tt> is supplied it will become 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
-specified path. If CDPATH is not set, it is assumed to be '.'. If \c
-DIRECTORY is not specified, \$HOME will be the new directory.
+\subsection cd-description Description
+Changes the current directory. If <tt>DIRECTORY</tt> is supplied it will become
+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 specified
+path. If CDPATH is not set, it is assumed to be '.'. If \c DIRECTORY is not
+specified, \$HOME will be the new directory.
diff --git a/doc_src/funced.txt b/doc_src/funced.txt
index 46594de7..19a12f3b 100644
--- a/doc_src/funced.txt
+++ b/doc_src/funced.txt
@@ -5,10 +5,16 @@
\subsection funced-description Description
-Use the funced command to edit the definition of a
-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.
+Use the funced command to edit the definition of a function. If there is no
+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>-i</code> or <code>--interactive</code> Open function body in 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>-i</code> or <code>--interactive</code> Open function body in the
+ built-in editor.
diff --git a/doc_src/funcsave.txt b/doc_src/funcsave.txt
index 5f178b51..944e699c 100644
--- a/doc_src/funcsave.txt
+++ b/doc_src/funcsave.txt
@@ -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
<tt>funcsave FUNCTION_NAME</tt>
diff --git a/doc_src/isatty.txt b/doc_src/isatty.txt
index f72e9e12..bccf8ab8 100644
--- a/doc_src/isatty.txt
+++ b/doc_src/isatty.txt
@@ -3,10 +3,13 @@
\subsection isatty-synopsis Synopsis
<tt>isatty [FILE DESCRIPTOR]</tt>
-where FILE DESCRIPTOR may be either the number of a file descriptor, or one
-of the strings stdin, stdout and stderr.
+\subsection isatty-description Description
+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
-command is zero, otherwise, it is non-zero.
+FILE DESCRIPTOR may be either the number of a file descriptor, or one of the
+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.
diff --git a/doc_src/jobs.txt b/doc_src/jobs.txt
index 4ed0db9b..d4ea33dd 100644
--- a/doc_src/jobs.txt
+++ b/doc_src/jobs.txt
@@ -1,6 +1,6 @@
\section jobs jobs - print currently running jobs
-\subsection jobs-synopsis
+\subsection jobs-synopsis Synopsis
<code>jobs [OPTIONS] [PID]</code>
\subsection jobs-description Description