diff options
Diffstat (limited to 'doc_src/history.txt')
| -rw-r--r-- | doc_src/history.txt | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/doc_src/history.txt b/doc_src/history.txt index 33ee4d66..1bdcdf1e 100644 --- a/doc_src/history.txt +++ b/doc_src/history.txt @@ -1,44 +1,44 @@ \section history history - Show and manipulate command history \subsection history-synopsis Synopsis -<pre> -history (--save | --clear) -history (--search | --delete ) (--prefix "prefix string" | --contains "search string") -</pre> +\fish{synopsis} +history ( --merge | --save | --clear ) +history ( --search | --delete ) [ --prefix "prefix string" | --contains "search string" ] +\endfish \subsection history-description Description -\c history is used to list, search and delete the history of commands used. +`history` is used to list, search and delete the history of commands used. The following options are available: +- `--merge` immediately incorporates history changes from other sessions. Ordinarily `fish` ignores history changes from sessions started after the current one. This command applies those changes immediately. + +- `--save` saves all changes in the history file. The shell automatically saves the history file; this option is provided for internal use. + +- `--clear` clears the history file. A prompt is displayed before the history is erased. + +- `--search` returns history items in keeping with the `--prefix` or `--contains` options. + +- `--delete` deletes history items. + +- `--prefix` searches or deletes items in the history that begin with the specified text string. + +- `--contains` searches or deletes items in the history that contain the specified text string. + +If `--search` is specified without `--contains` or `--prefix`, `--contains` will be assumed. + +If `--delete` is specified without `--contains` or `--prefix`, only a history item which exactly matches the parameter will be erased. No prompt will be given. If `--delete` is specified with either of these parameters, an interactive prompt will be displayed before any items are deleted. -- \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. - -If \c --search is specified without \c --contains or <code>--prefix</code>, -\c --contains will be assumed. - -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. \subsection history-examples Example -<code>history --clear</code> deletes all history items +\fish +history --clear +# Deletes all history items -<code>history --search --contains "foo"</code> outputs a list of all previous -commands containing the string "foo". +history --search --contains "foo" +# Outputs a list of all previous commands containing the string "foo". -<code>history --delete --prefix "foo"</code> interactively deletes the record -of previous commands which start with "foo". +history --delete --prefix "foo" +# Interactively deletes the record of previous commands which start with "foo". +\endfish |