History docs: Move descriptions to the corresponding options

This should clarify `--delete`s behavior without `--prefix` or
`--contains` a bit.

Fixes #3054.
This commit is contained in:
Fabian Homborg 2016-05-28 14:22:16 +02:00 committed by Kurtis Rader
parent db0176b884
commit 7e56d6385e

View file

@ -17,19 +17,14 @@ The following options are available:
- `--clear` clears the history file. A prompt is displayed before the history is erased. - `--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. - `--search` returns history items in keeping with the `--prefix` or `--contains` options. Without either, `--contains` will be assumed.
- `--delete` deletes history items. - `--delete` deletes history items. Without the `--prefix` or `--contains` options, the exact match will be deleted. With either of these options, a prompt will be displayed before any items are deleted.
- `--prefix` searches or deletes items in the history that begin with the specified text string. - `--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. - `--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.
\subsection history-examples Example \subsection history-examples Example
\fish \fish