Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-12-25 20:33:08 +00:00
Code Issues Projects Releases Packages Wiki Activity
fish-shell/doc_src/history.txt

69 lines
5.1 KiB
Text
Raw Normal View History

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.
2013-05-12 07:56:01 +00:00
\section history history - Show and manipulate command history
Adding history builtin
2012-06-05 04:24:42 +00:00
\subsection history-synopsis Synopsis
Simplify styling
2014-08-01 12:25:41 +00:00
\fish{synopsis}
handle multiline commands in history search output Fixes #31
2016-10-17 03:33:33 +00:00
history search [ --show-time ] [ --case-sensitive ] [ --exact | --prefix | --contains ] [ --max=n ] [ --null ] [ "search string"... ]
make history searching case insensitive by default Fixes #3236
2016-09-24 03:12:15 +00:00
history delete [ --show-time ] [ --case-sensitive ] [ --exact | --prefix | --contains ] "search string"...
alter history sub-command handling This deprecates the use of long options for history sub-commands (e.g., `history --delete`) in favor of proper sub-commands (e.g., `history delete`). It also eliminates the short options for those sub-commands. Also change option processing to allow options anywhere on the command line to match how the vast majority of fish builtins handle flags. Replace --with-time with --show-time. Fixes #3367
2016-09-11 03:42:52 +00:00
history merge
history save
history clear
fix the history function and man page The previous commit to add a `--with-timestamp` flag to the `history` command caused me to notice the history function didn't recognize the new long option. Neither did it recognize the short options for the builtin command. This change fixes both of those issues.
2016-06-29 05:22:40 +00:00
history ( -h | --help )
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.
2014-08-01 02:37:32 +00:00
\endfish
Adding history builtin
2012-06-05 04:24:42 +00:00
\subsection history-description Description
alter history sub-command handling This deprecates the use of long options for history sub-commands (e.g., `history --delete`) in favor of proper sub-commands (e.g., `history delete`). It also eliminates the short options for those sub-commands. Also change option processing to allow options anywhere on the command line to match how the vast majority of fish builtins handle flags. Replace --with-time with --show-time. Fixes #3367
2016-09-11 03:42:52 +00:00
`history` is used to search, delete, and otherwise manipulate the history of interactive commands.
Adding history builtin
2012-06-05 04:24:42 +00:00
alter history sub-command handling This deprecates the use of long options for history sub-commands (e.g., `history --delete`) in favor of proper sub-commands (e.g., `history delete`). It also eliminates the short options for those sub-commands. Also change option processing to allow options anywhere on the command line to match how the vast majority of fish builtins handle flags. Replace --with-time with --show-time. Fixes #3367
2016-09-11 03:42:52 +00:00
Note that for backwards compatibility each subcommand can also be specified as a long option. For example, rather than `history search` you can type `history --search`. Those long options are deprecated and will be removed in a future release.
correct handling of `history` args This fixes several problems with how the builtin `history` command handles arguments. It now complains and refuses to do anything if the user specifies incompatible actions (e.g., `--search` and `--clear`). It also fixes a regression introduced by previous changes with regard to invocations that don't explicitly specify `--search` or a search term. Enhances the history man page to clarify the behavior of various options. This change is already far larger than I like so unit tests will be added in a separate commit. Fixes #3224. Note: This fixes only a couple problems with the interactive `history --delete` command in the `history` function. The main problem will be dealt with via issue #31.
2016-07-14 05:33:50 +00:00
alter history sub-command handling This deprecates the use of long options for history sub-commands (e.g., `history --delete`) in favor of proper sub-commands (e.g., `history delete`). It also eliminates the short options for those sub-commands. Also change option processing to allow options anywhere on the command line to match how the vast majority of fish builtins handle flags. Replace --with-time with --show-time. Fixes #3367
2016-09-11 03:42:52 +00:00
The following operations (sub-commands) are available:
fix the history function and man page The previous commit to add a `--with-timestamp` flag to the `history` command caused me to notice the history function didn't recognize the new long option. Neither did it recognize the short options for the builtin command. This change fixes both of those issues.
2016-06-29 05:22:40 +00:00
alter history sub-command handling This deprecates the use of long options for history sub-commands (e.g., `history --delete`) in favor of proper sub-commands (e.g., `history delete`). It also eliminates the short options for those sub-commands. Also change option processing to allow options anywhere on the command line to match how the vast majority of fish builtins handle flags. Replace --with-time with --show-time. Fixes #3367
2016-09-11 03:42:52 +00:00
- `search` returns history items matching the search string. If no search string is provided it returns all history items. This is the default operation if no other operation is specified. You only have to explicitly say `history search` if you wish to search for one of the subcommands. The `--contains` search option will be used if you don't specify a different search option. Entries are ordered newest to oldest. If stdout is attached to a tty the output will be piped through your pager by the history function. The history builtin simply writes the results to stdout.
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
make history searching case insensitive by default Fixes #3236
2016-09-24 03:12:15 +00:00
- `delete` deletes history items. Without the `--prefix` or `--contains` options, the exact match of the specified text will be deleted. If you don't specify `--exact` a prompt will be displayed before any items are deleted asking you which entries are to be deleted. You can enter the word "all" to delete all matching entries. You can enter a single ID (the number in square brackets) to delete just that single entry. You can enter more than one ID separated by a space to delete multiple entries. Just press [enter] to not delete anything. Note that the interactive delete behavior is a feature of the history function. The history builtin only supports `--exact --case-sensitive` deletion.
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
alter history sub-command handling This deprecates the use of long options for history sub-commands (e.g., `history --delete`) in favor of proper sub-commands (e.g., `history delete`). It also eliminates the short options for those sub-commands. Also change option processing to allow options anywhere on the command line to match how the vast majority of fish builtins handle flags. Replace --with-time with --show-time. Fixes #3367
2016-09-11 03:42:52 +00:00
- `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.
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
alter history sub-command handling This deprecates the use of long options for history sub-commands (e.g., `history --delete`) in favor of proper sub-commands (e.g., `history delete`). It also eliminates the short options for those sub-commands. Also change option processing to allow options anywhere on the command line to match how the vast majority of fish builtins handle flags. Replace --with-time with --show-time. Fixes #3367
2016-09-11 03:42:52 +00:00
- `save` immediately writes all changes to the history file. The shell automatically saves the history file; this option is provided for internal use and should not normally need to be used by the user.
- `clear` clears the history file. A prompt is displayed before the history is erased asking you to confirm you really want to clear all history unless `builtin history` is used.
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
correct handling of `history` args This fixes several problems with how the builtin `history` command handles arguments. It now complains and refuses to do anything if the user specifies incompatible actions (e.g., `--search` and `--clear`). It also fixes a regression introduced by previous changes with regard to invocations that don't explicitly specify `--search` or a search term. Enhances the history man page to clarify the behavior of various options. This change is already far larger than I like so unit tests will be added in a separate commit. Fixes #3224. Note: This fixes only a couple problems with the interactive `history --delete` command in the `history` function. The main problem will be dealt with via issue #31.
2016-07-14 05:33:50 +00:00
The following options are available:
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
add a flag to limit history search results This adds a flag to the `history search` command to limit the number of matching entries to the first "n". The default is unlimited. This is mostly useful in conjunction with aliases (i.e., functions) that are intended to report the "n" most recent matching history entries without piping the result through the user's pager. Fixes #3244
2016-09-21 05:32:38 +00:00
These flags can appear before or immediately after one of the sub-commands listed above.
alter history sub-command handling This deprecates the use of long options for history sub-commands (e.g., `history --delete`) in favor of proper sub-commands (e.g., `history delete`). It also eliminates the short options for those sub-commands. Also change option processing to allow options anywhere on the command line to match how the vast majority of fish builtins handle flags. Replace --with-time with --show-time. Fixes #3367
2016-09-11 03:42:52 +00:00
make history searching case insensitive by default Fixes #3236
2016-09-24 03:12:15 +00:00
- `-C` or `--case-sensitive` does a case-sensitive search. The default is case-insensitive. Note that prior to fish 2.4.0 the default was case-sensitive.
fix history --delete regression The recent change to reconcile the history builtin command and function broke an undocumented behavior of `history --delete`. This change reinstates that behavior. It also adds an explicit `--exact` search mode for the `--search` and `--delete` subcommands. Fixes #3270
2016-07-30 04:24:26 +00:00
- `-c` or `--contains` searches or deletes items in the history that contain the specified text string. This is the default for the `--search` flag. This is not currently supported by the `--delete` flag.
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
make history searching case insensitive by default Fixes #3236
2016-09-24 03:12:15 +00:00
- `-e` or `--exact` searches or deletes items in the history that exactly match the specified text string. This is the default for the `--delete` flag. Note that the match is case-insensitive by default. If you really want an exact match, including letter case, you must use the `-C` or `--case-sensitive` flag.
fix history --delete regression The recent change to reconcile the history builtin command and function broke an undocumented behavior of `history --delete`. This change reinstates that behavior. It also adds an explicit `--exact` search mode for the `--search` and `--delete` subcommands. Fixes #3270
2016-07-30 04:24:26 +00:00
- `-p` or `--prefix` searches or deletes items in the history that begin with the specified text string. This is not currently supported by the `--delete` flag.
Adding history builtin
2012-06-05 04:24:42 +00:00
allow customizing `history --show-time` format It would make fish more friendly if we allowed the user to specify the format of the history entry timestamps. Fixes #3361
2016-09-19 03:21:27 +00:00
- `-t` or `--show-time` prepends each history entry with the date and time the entry was recorded . By default it uses the strftime format `# %c%n`. You can specify another format; e.g., `--show-time='%Y-%m-%d %H:%M:%S '` or `--show-time='%a%I%p'`. The short option, `-t` doesn't accept a stftime format string; it only uses the default format. Any strftime format is allowed, including `%s` to get the raw UNIX seconds since the epoch. Note that `--with-time` is also allowed but is deprecated and will be removed at a future date.
alter history sub-command handling This deprecates the use of long options for history sub-commands (e.g., `history --delete`) in favor of proper sub-commands (e.g., `history delete`). It also eliminates the short options for those sub-commands. Also change option processing to allow options anywhere on the command line to match how the vast majority of fish builtins handle flags. Replace --with-time with --show-time. Fixes #3367
2016-09-11 03:42:52 +00:00
handle multiline commands in history search output Fixes #31
2016-10-17 03:33:33 +00:00
- `-z` or `--null` causes history entries written by the search operations to be terminated by a NUL character rather than a newline. This allows the output to be processed by `read -z` to correctly handle multiline history entries.
add a flag to limit history search results This adds a flag to the `history search` command to limit the number of matching entries to the first "n". The default is unlimited. This is mostly useful in conjunction with aliases (i.e., functions) that are intended to report the "n" most recent matching history entries without piping the result through the user's pager. Fixes #3244
2016-09-21 05:32:38 +00:00
- `-<number>` `-n <number>` or `--max=<number>` limits the matched history items to the first "n" matching entries. This is only valid for `history search`.
alter history sub-command handling This deprecates the use of long options for history sub-commands (e.g., `history --delete`) in favor of proper sub-commands (e.g., `history delete`). It also eliminates the short options for those sub-commands. Also change option processing to allow options anywhere on the command line to match how the vast majority of fish builtins handle flags. Replace --with-time with --show-time. Fixes #3367
2016-09-11 03:42:52 +00:00
- `-h` or `--help` display help for this command.
fix the history function and man page The previous commit to add a `--with-timestamp` flag to the `history` command caused me to notice the history function didn't recognize the new long option. Neither did it recognize the short options for the builtin command. This change fixes both of those issues.
2016-06-29 05:22:40 +00:00
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.
2013-05-12 07:56:01 +00:00
\subsection history-examples Example
Adding history builtin
2012-06-05 04:24:42 +00:00
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
\fish
history --clear
# Deletes all history items
Adding history builtin
2012-06-05 04:24:42 +00:00
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
history --search --contains "foo"
# Outputs a list of all previous commands containing the string "foo".
Adding history builtin
2012-06-05 04:24:42 +00:00
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
history --delete --prefix "foo"
correct handling of `history` args This fixes several problems with how the builtin `history` command handles arguments. It now complains and refuses to do anything if the user specifies incompatible actions (e.g., `--search` and `--clear`). It also fixes a regression introduced by previous changes with regard to invocations that don't explicitly specify `--search` or a search term. Enhances the history man page to clarify the behavior of various options. This change is already far larger than I like so unit tests will be added in a separate commit. Fixes #3224. Note: This fixes only a couple problems with the interactive `history --delete` command in the `history` function. The main problem will be dealt with via issue #31.
2016-07-14 05:33:50 +00:00
# Interactively deletes commands which start with "foo" from the history.
# You can select more than one entry by entering their IDs seperated by a space.
\subsection history-notes Notes
If you specify both `--prefix` and `--contains` the last flag seen is used.
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
\endfish
Reference in a new issue Copy permalink