fish-shell/doc_src/status.txt

\section status status - query fish runtime information

\subsection status-synopsis Synopsis
\fish{synopsis}
status [OPTION]
\endfish

\subsection status-description Description

With no arguments, `status` displays a summary of the current login and job control status of the shell.

The following options are available:

- `-c` or `--is-command-substitution` returns 0 if fish is currently executing a command substitution.

- `-b` or `--is-block` returns 0 if fish is currently executing a block of code.

- `-i` or `--is-interactive` returns 0 if fish is interactive - that is, connected to a keyboard.

- `-l` or `--is-login` returns 0 if fish is a login shell - that is, if fish should perform login tasks such as setting up the PATH.

- `--is-full-job-control` returns 0 if full job control is enabled.

- `--is-interactive-job-control` returns 0 if interactive job control is enabled.

- `--is-no-job-control` returns 0 if no job control is enabled.

- `-f` or `--current-filename` prints the filename of the currently running script.

- `-n` or `--current-line-number` prints the line number of the currently running script.

- `-j CONTROLTYPE` or `--job-control=CONTROLTYPE` sets the job control type, which can be `none`, `full`, or `interactive`.

- `-t` or `--print-stack-trace` prints a stack trace of all function calls on the call stack.
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}`
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			`status [OPTION]`
			`\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
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 15:56:01 +08:00			`The following options are available:`
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			- `-c` or `--is-command-substitution` returns 0 if fish is currently executing a command substitution.
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			- `-b` or `--is-block` returns 0 if fish is currently executing a block of code.
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			- `-i` or `--is-interactive` returns 0 if fish is interactive - that is, connected to a keyboard.
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			- `-l` or `--is-login` returns 0 if fish is a login shell - that is, if fish should perform login tasks such as setting up the PATH.
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			- `--is-full-job-control` returns 0 if full job control is enabled.
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			- `--is-interactive-job-control` returns 0 if interactive job control is enabled.
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			- `--is-no-job-control` returns 0 if no job control is enabled.
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			- `-f` or `--current-filename` prints the filename of the currently running script.
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			- `-n` or `--current-line-number` prints the line number of the currently running script.
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			- `-j CONTROLTYPE` or `--job-control=CONTROLTYPE` sets the job control type, which can be `none`, `full`, or `interactive`.
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			- `-t` or `--print-stack-trace` prints a stack trace of all function calls on the call stack.