diff options
| author |  Mark Griffiths <mark@thebespokepixel.com> | 2014-08-01 03:37:32 +0100 |
|---|---|---|
| committer | Mark Griffiths <mark@thebespokepixel.com> | 2014-09-03 14:43:24 +0100 |
| commit | d282bc462578a6e47747c78d2d42883530f0d11e (patch) | |
| tree | a6515e908d4fc1c400cb6cebaf79b1590b005804 /doc_src/cd.txt | |
| parent | 1c4223889bd729ee83aa21a3450dc28f92ade641 (diff) | |
Documentation update
Rework for Doxygen >1.8. Moved large parts of the documentation to a
simplified format, making use of Markdown enhancements and fixing bad
long options.
Diffstat (limited to 'doc_src/cd.txt')
| -rw-r--r-- | doc_src/cd.txt | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/doc_src/cd.txt b/doc_src/cd.txt index a1da087a..968333f3 100644 --- a/doc_src/cd.txt +++ b/doc_src/cd.txt @@ -1,25 +1,27 @@ \section cd cd - change directory \subsection cd-synopsis Synopsis -<tt>cd [DIRECTORY]</tt> +\fish{syn} +cd [DIRECTORY] +\endfish \subsection cd-description Description -\c cd changes the current working directory. +`cd` changes the current working directory. -If \c DIRECTORY is supplied, it will become the new directory. If no parameter -is given, the contents of the \c HOME environment variable will be used. +If `DIRECTORY` is supplied, it will become the new directory. If no parameter +is given, the contents of the `HOME` environment variable will be used. -If \c DIRECTORY is a relative path, the paths found in the -\c CDPATH environment variable array will be tried as prefixes for the specified +If `DIRECTORY` is a relative path, the paths found in the +`CDPATH` environment variable array will be tried as prefixes for the specified path. -Note that the shell will attempt to change directory without requiring \c cd -if the name of a directory is provided (starting with '.', '/' or '~', or ending -with '/'). +Note that the shell will attempt to change directory without requiring `cd` +if the name of a directory is provided (starting with '`.`', '`/`' or `~`', or ending +with '`/`'). \subsection cd-example Examples -\c cd changes the working directory to your home directory. +`cd` changes the working directory to your home directory. -<code>cd /usr/src/fish-shell</code> changes the working directory to -<code>/usr/src/fish-shell</code>. +`cd /usr/src/fish-shell` changes the working directory to +`/usr/src/fish-shell`. |