github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-30 22:34:29 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
ae0321778f
fish-shell/doc_src/status.txt

52 lines
2.3 KiB
Plaintext
Raw Normal View History

Fix casing and other minor issues in documentation darcs-hash:20061031152316-ac50b-e68db9853d6e9461a0c054f1ea290704ccfc0a31.gz
2006-10-31 23:23:16 +08:00
\section status status - query fish runtime information
Minor documentation updates darcs-hash:20050920141105-ac50b-339e24a7cc79cbf80e1c1d8eb14f77c57ab6066c.gz
2005-09-20 22:11:05 +08:00
\subsection status-synopsis Synopsis
Simplify styling
2014-08-01 20:25:41 +08:00
\fish{synopsis}
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
status
status is-login
status is-interactive
status is-block
status is-command-substitution
status is-no-job-control
status is-full-job-control
status is-interactive-job-control
status current-filename
status current-line-number
status print-stack-trace
status job-control CONTROL-TYPE
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 10:37:32 +08:00
\endfish
Minor documentation updates darcs-hash:20050920141105-ac50b-339e24a7cc79cbf80e1c1d8eb14f77c57ab6066c.gz
2005-09-20 22:11:05 +08:00
\subsection status-description Description
Make line length, wrapping and spacing consistent
2014-08-19 20:41:23 +08:00
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 10:37:32 +08:00
With no arguments, `status` displays a summary of the current login and job control status of the shell.
status command: improve help text
2013-04-29 13:45:14 +08:00
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
The following operations (sub-commands) are available:
Make line length, wrapping and spacing consistent
2014-08-19 20:41:23 +08:00
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
- `is-command-sub` returns 0 if fish is currently executing a command substitution. Also `-c` or `--is-command-substitution`.
Make line length, wrapping and spacing consistent
2014-08-19 20:41:23 +08:00
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
- `is-block` returns 0 if fish is currently executing a block of code. Also `-b` or `--is-block`.
Make line length, wrapping and spacing consistent
2014-08-19 20:41:23 +08:00
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
- `is-interactive` returns 0 if fish is interactive - that is, connected to a keyboard. Also `-i` or `--is-interactive`.
Make line length, wrapping and spacing consistent
2014-08-19 20:41:23 +08:00
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
- `is-login` returns 0 if fish is a login shell - that is, if fish should perform login tasks such as setting up the PATH. Also `-l` or `--is-login`.
Make line length, wrapping and spacing consistent
2014-08-19 20:41:23 +08:00
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
- `is-full-job-control` returns 0 if full job control is enabled. Also `--is-full-job-control` (no short flag).
Make line length, wrapping and spacing consistent
2014-08-19 20:41:23 +08:00
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
- `is-interactive-job-control` returns 0 if interactive job control is enabled. Also, `--is-interactive-job-control` (no short flag).
Make line length, wrapping and spacing consistent
2014-08-19 20:41:23 +08:00
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
- `is-no-job-control` returns 0 if no job control is enabled. Also `--is-no-job-control` (no short flag).
Make line length, wrapping and spacing consistent
2014-08-19 20:41:23 +08:00
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
- `current-filename` prints the filename of the currently running script. Also `-f` or `--current-filename`.
Make line length, wrapping and spacing consistent
2014-08-19 20:41:23 +08:00
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
- `current-line-number` prints the line number of the currently running script. Also `-n` or `--current-line-number`.
Make line length, wrapping and spacing consistent
2014-08-19 20:41:23 +08:00
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
- `job-control CONTROL-TYPE` sets the job control type, which can be `none`, `full`, or `interactive`. Also `-j CONTROL-TYPE` or `--job-control=CONTROL-TYPE`.
Make line length, wrapping and spacing consistent
2014-08-19 20:41:23 +08:00
make `status` saner vis-a-vis arg parsing The `status` command currently silently allows incompatible flags (i.e., subcommands). Too, using flags to specify subcommands misleads the user into thinking they can specify multiple subcommands. We recently modified the `history` command to deprecate using flags for subcommands. This change does the same for the `status` command. Fixes #3509
2016-11-05 13:32:43 +08:00
- `print-stack-trace` prints a stack trace of all function calls on the call stack. Also `-t` or `--print-stack-trace`.
\subsection status-notes Notes
For backwards compatibility each subcommand can also be specified as a long or short option. For example, rather than `status is-login` you can type `status --is-login`. The flag forms are deprecated and may be removed in a future release (but not before fish 3.0).
You can only specify one subcommand per invocation even if you use the flag form of the subcommand.
Reference in New Issue Copy Permalink