diff options
| author |  Mark Griffiths <mark@thebespokepixel.com> | 2014-08-01 03:37:32 +0100 |
|---|---|---|
| committer | Mark Griffiths <mark@thebespokepixel.com> | 2014-09-03 14:43:24 +0100 |
| commit | d282bc462578a6e47747c78d2d42883530f0d11e (patch) | |
| tree | a6515e908d4fc1c400cb6cebaf79b1590b005804 /doc_src/status.txt | |
| parent | 1c4223889bd729ee83aa21a3450dc28f92ade641 (diff) | |
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.
Diffstat (limited to 'doc_src/status.txt')
| -rw-r--r-- | doc_src/status.txt | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/doc_src/status.txt b/doc_src/status.txt index d6238ae3..5cf8d98a 100644 --- a/doc_src/status.txt +++ b/doc_src/status.txt @@ -1,21 +1,23 @@ \section status status - query fish runtime information \subsection status-synopsis Synopsis - <tt>status [OPTION]</tt> +\fish{syn} +status [OPTION] +\endfish \subsection status-description Description -With no arguments, <tt>status</tt> displays a summary of the current login and job control status of the shell. +With no arguments, `status` displays a summary of the current login and job control status of the shell. The following options are available: -- <tt>-c</tt> or <tt>--is-command-substitution</tt> returns 0 if fish is currently executing a command substitution. -- <tt>-b</tt> or <tt>--is-block</tt> returns 0 if fish is currently executing a block of code. -- <tt>-i</tt> or <tt>--is-interactive</tt> returns 0 if fish is interactive - that is, connected to a keyboard. -- <tt>-l</tt> or <tt>--is-login</tt> returns 0 if fish is a login shell - that is, if fish should perform login tasks such as setting up the PATH. -- <tt>--is-full-job-control</tt> returns 0 if full job control is enabled. -- <tt>--is-interactive-job-control</tt> returns 0 if interactive job control is enabled. -- <tt>--is-no-job-control</tt> returns 0 if no job control is enabled. -- <tt>-f</tt> or <tt>--current-filename</tt> prints the filename of the currently running script. -- <tt>-n</tt> or <tt>--current-line-number</tt> prints the line number of the currently running script. -- <tt>-j CONTROLTYPE</tt> or <tt>--job-control=CONTROLTYPE</tt> sets the job control type, which can be <tt>none</tt>, <tt>full</tt>, or <tt>interactive</tt>. -- <tt>-t</tt> or <tt>--print-stack-trace</tt> prints a stack trace of all function calls on the call stack. -- <tt>-h</tt> or <tt>--help</tt> displays a help message and exit. +- `-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. +- `-h` or `--help` displays a help message and exit. |