diff options
author | David Adam (zanchey) <zanchey@ucc.gu.uwa.edu.au> | 2013-05-12 15:56:01 +0800 |
---|---|---|
committer | ridiculousfish <corydoras@ridiculousfish.com> | 2013-05-13 01:48:20 -0700 |
commit | 1287b9d82382bf22e16edda67eae755f07397f2e (patch) | |
tree | 811814b029d65ac11a193e616ca4a71d216dbe0c /doc_src/history.txt | |
parent | 91aab03b90a6b583a3c0ecff5b015c6066d34f28 (diff) |
Help cleanup
Large list of changes, including formatting and typos for most commands.
More substantive changes have been made to alias, bind, block, break,
builtin, case, cd, commandline, count, else, emit, fish_config, funced,
function, functions, history, math, mimedb, nextd, not, popd, prevd,
pushd, pwd, random, read, set, set_color, switch, test, trap, type,
ulimit, umask, and while.
Diffstat (limited to 'doc_src/history.txt')
-rw-r--r-- | doc_src/history.txt | 46 |
1 files changed, 27 insertions, 19 deletions
diff --git a/doc_src/history.txt b/doc_src/history.txt index 8f7b6916..33ee4d66 100644 --- a/doc_src/history.txt +++ b/doc_src/history.txt @@ -1,4 +1,4 @@ -\section history history - Show and manipulate user's command history +\section history history - Show and manipulate command history \subsection history-synopsis Synopsis <pre> @@ -8,29 +8,37 @@ history (--search | --delete ) (--prefix "prefix string" | --contains "search st \subsection history-description Description -history is used to list, search and delete user's command history +\c history is used to list, search and delete the history of commands used. -\subsection history-examples Example +The following options are available: -<pre> -history --save -Save all changes in history file +- \c --save saves all changes in the history file. The shell automatically +saves the history file; this option is provided for internal use. +- \c --clear clears the history file. A prompt is displayed before the history +is erased. +- \c --search returns history items in keeping with the \c --prefix or +\c --contains options. +- \c --delete deletes history items. +- \c --prefix searches or deletes items in the history that begin with the +specified text string. +- \c --contains searches or deletes items in the history that contain the +specified text string. -history --clear -Delete all history items +If \c --search is specified without \c --contains or <code>--prefix</code>, +\c --contains will be assumed. -history --search --contains "foo" -Searches commands containing "foo" string +If \c --delete is specified without \c --contains or <code>--prefix</code>, +only a history item which exactly matches the parameter will be erased. No +prompt will be given. If \c --delete is specified with either of these +parameters, an interactive prompt will be displayed before any items are +deleted. -history --search --prefix "foo" -Searches for commands with prefix "foo" +\subsection history-examples Example -history --delete --contains "foo" -Interactively delete commands containing string "foo" +<code>history --clear</code> deletes all history items -history --delete --prefix "foo" -Interactively delete commands with prefix "foo" +<code>history --search --contains "foo"</code> outputs a list of all previous +commands containing the string "foo". -history --delete "foo" -Delete command "foo" from history -</pre> +<code>history --delete --prefix "foo"</code> interactively deletes the record +of previous commands which start with "foo". |