fish-shell/doc_src/fish.txt

\section fish fish - the friendly interactive shell

\subsection fish-synopsis Synopsis
\fish{synopsis}
fish [OPTIONS] [-c command] [FILE [ARGUMENTS...]]
\endfish

\subsection fish-description Description

`fish` is a command-line shell written mainly with interactive use in mind. The full manual is available <a href='index.html'>in HTML</a> by using the <a href='#help'>help</a> command from inside fish.

The following options are available:

- `-c` or `--command=COMMANDS` evaluate the specified commands instead of reading from the commandline

- `-d` or `--debug-level=DEBUG_LEVEL` specify the verbosity level of fish. A higher number means higher verbosity. The default level is 1.

- `-i` or `--interactive` specify that fish is to run in interactive mode

- `-l` or `--login` specify that fish is to run as a login shell

- `-n` or `--no-execute` do not execute any commands, only perform syntax checking

- `-p` or `--profile=PROFILE_FILE` when fish exits, output timing information on all executed commands to the specified file

- `-v` or `--version` display version and exit

- `-D` or `--debug-stack-frames=DEBUG_LEVEL` specify how many stack frames to display when debug messages are written. The default is zero. A value of 3 or 4 is usually sufficient to gain insight into how a given debug call was reached but you can specify a value up to 128.

The fish exit status is generally the exit status of the last foreground command. If fish is exiting because of a parse error, the exit status is 127.
Fix casing and other minor issues in documentation darcs-hash:20061031152316-ac50b-e68db9853d6e9461a0c054f1ea290704ccfc0a31.gz 2006-10-31 23:23:16 +08:00			`\section fish fish - the friendly interactive shell`
Make the fish manpage in Doxygen and add it to the main fish documentation darcs-hash:20061026102059-ac50b-2a7956bb4651b5ffe867e7c6eb26a29e2f15ad24.gz 2006-10-26 18:20:59 +08:00
			`\subsection fish-synopsis Synopsis`
Simplify styling 2014-08-01 20:25:41 +08:00			`\fish{synopsis}`
Tutorial auto colouring, Man page and Make fixes Completely fixes #1557 and the underlying Doxygen changes that caused it. Should make fish docs simpler and more robust, more consistent and generally prettier. todo: - trap unmarked text as arguments in context - test & fix sed portability - see in particular. (so far tested on BSD (Mac) and GNU sed). - test Makefile changes - last round of aesthetic changes and getting that ascii fish in there… 2014-08-08 10:44:37 +08:00			`fish [OPTIONS] [-c command] [FILE [ARGUMENTS...]]`
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`
Make the fish manpage in Doxygen and add it to the main fish documentation darcs-hash:20061026102059-ac50b-2a7956bb4651b5ffe867e7c6eb26a29e2f15ad24.gz 2006-10-26 18:20:59 +08:00
			`\subsection fish-description Description`

Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00			`fish` is a command-line shell written mainly with interactive use in mind. The full manual is available <a href='index.html'>in HTML</a> by using the <a href='#help'>help</a> command from inside fish.
Make the fish manpage in Doxygen and add it to the main fish documentation darcs-hash:20061026102059-ac50b-2a7956bb4651b5ffe867e7c6eb26a29e2f15ad24.gz 2006-10-26 18:20:59 +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:`

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 `--command=COMMANDS` evaluate the specified commands instead of reading from the commandline
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			- `-d` or `--debug-level=DEBUG_LEVEL` specify the verbosity level of fish. A higher number means higher verbosity. The default level is 1.
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 `--interactive` specify that fish is to run in interactive mode
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 `--login` specify that fish is to run as a login shell
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 `--no-execute` do not execute any commands, only perform syntax checking
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			- `-p` or `--profile=PROFILE_FILE` when fish exits, output timing information on all executed commands to the specified file
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			- `-v` or `--version` display version and exit
Make the fish manpage in Doxygen and add it to the main fish documentation darcs-hash:20061026102059-ac50b-2a7956bb4651b5ffe867e7c6eb26a29e2f15ad24.gz 2006-10-26 18:20:59 +08:00
make debug() output more useful This change does several things. First, and most important, it allows dumping the "n" most recent stack frames on each debug() call. Second, it demangles the C++ symbols. Third, it prepends each debug() message with the debug level. Unrelated to the above I've replaced all `assert(!is_forked_child());` statements with `ASSERT_IS_NOT_FORKED_CHILD()` for consistency. 2016-05-16 10:45:02 +08:00			- `-D` or `--debug-stack-frames=DEBUG_LEVEL` specify how many stack frames to display when debug messages are written. The default is zero. A value of 3 or 4 is usually sufficient to gain insight into how a given debug call was reached but you can specify a value up to 128.

Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00			`The fish exit status is generally the exit status of the last foreground command. If fish is exiting because of a parse error, the exit status is 127.`