2019-03-31 17:05:09 +08:00
.. _cmd-status:
2018-12-17 09:39:33 +08:00
status - query fish runtime information
2019-01-03 12:10:47 +08:00
=======================================
2018-12-17 09:39:33 +08:00
2018-12-18 09:58:24 +08:00
Synopsis
--------
2018-12-17 05:08:41 +08:00
2019-09-17 17:59:04 +08:00
::
status
status is-login
status is-interactive
status is-block
status is-breakpoint
status is-command-substitution
status is-no-job-control
status is-full-job-control
status is-interactive-job-control
status current-command
status filename
status fish-path
status function
status line-number
status stack-trace
status job-control CONTROL-TYPE
status features
status test-feature FEATURE
2018-12-17 05:08:41 +08:00
2018-12-19 10:44:30 +08:00
Description
2019-01-03 12:10:47 +08:00
-----------
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
With no arguments, `` status `` displays a summary of the current login and job control status of the shell.
2018-12-17 05:08:41 +08:00
The following operations (sub-commands) are available:
2019-02-25 07:01:16 +08:00
- `` is-command-substitution `` returns 0 if fish is currently executing a command substitution. Also `` -c `` or `` --is-command-substitution `` .
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
- `` is-block `` returns 0 if fish is currently executing a block of code. Also `` -b `` or `` --is-block `` .
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
- `` is-breakpoint `` returns 0 if fish is currently showing a prompt in the context of a `` breakpoint `` command. See also the `` fish_breakpoint_prompt `` function.
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
- `` is-interactive `` returns 0 if fish is interactive - that is, connected to a keyboard. Also `` -i `` or `` --is-interactive `` .
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +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 `` .
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
- `` is-full-job-control `` returns 0 if full job control is enabled. Also `` --is-full-job-control `` (no short flag).
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
- `` is-interactive-job-control `` returns 0 if interactive job control is enabled. Also, `` --is-interactive-job-control `` (no short flag).
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
- `` is-no-job-control `` returns 0 if no job control is enabled. Also `` --is-no-job-control `` (no short flag).
2018-12-17 05:08:41 +08:00
2019-02-25 07:01:16 +08:00
- `` current-command `` prints the name of the currently-running function or command, like the deprecated `` _ `` variable.
2018-12-20 04:02:45 +08:00
- `` filename `` prints the filename of the currently running script. Also `` current-filename `` , `` -f `` or `` --current-filename `` .
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
- `` fish-path `` prints the absolute path to the currently executing instance of fish.
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
- `` function `` prints the name of the currently called function if able, when missing displays "Not a
function" (or equivalent translated string). Also `` current-function `` , `` -u `` or `` --current-function `` .
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
- `` line-number `` prints the line number of the currently running script. Also `` current-line-number `` , `` -n `` or `` --current-line-number `` .
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
- `` stack-trace `` prints a stack trace of all function calls on the call stack. Also `` print-stack-trace `` , `` -t `` or `` --print-stack-trace `` .
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +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 `` .
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
- `` features `` lists all available feature flags.
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
- `` test-feature FEATURE `` returns 0 when FEATURE is enabled, 1 if it is disabled, and 2 if it is not recognized.
2018-12-17 05:08:41 +08:00
2018-12-19 10:44:30 +08:00
Notes
2019-01-03 12:10:47 +08:00
-----
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
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).
2018-12-17 05:08:41 +08:00
You can only specify one subcommand per invocation even if you use the flag form of the subcommand.