fish-shell/doc_src/fish_indent.txt

\section fish_indent fish_indent - indenter and prettifier

\subsection fish_indent-synopsis Synopsis
\fish{synopsis}
fish_indent [OPTIONS]
\endfish

\subsection fish_indent-description Description

`fish_indent` is used to indent a piece of fish code. `fish_indent` reads commands from standard input and outputs them to standard output or a specified file.

The following options are available:

- `-w` or `--write` indents a specified file and immediately writes to that file.

- `-i` or `--no-indent` do not indent commands; only reformat to one job per line.

- `-v` or `--version` displays the current fish version and then exits.

- `--ansi` colorizes the output using ANSI escape sequences, appropriate for the current $TERM, using the colors defined in the environment (such as `$fish_color_command`).

- `--html` outputs HTML, which supports syntax highlighting if the appropriate CSS is defined. The CSS class names are the same as the variable names, such as `fish_color_command`.

- `-d` or `--debug-level=DEBUG_LEVEL` enables debug output and specifies a verbosity level (like `fish -d`). Defaults to 0.

- `-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.

- `--dump-parse-tree` dumps information about the parsed statements to stderr. This is likely to be of interest only to people working on the fish source code.
Fix some spelling mistakes Fix spelling mistakes in various bits of the documentation. Signed-off-by: James Vega <jamessan@debian.org> Signed-off-by: Grissiom <chaos.proton@gmail.com> 2010-11-23 15:45:30 +00:00			`\section fish_indent fish_indent - indenter and prettifier`
Add source code prettyfier program called fish_indent darcs-hash:20070422100312-ac50b-a073999b7dc172259c8200f3e740c921647222a0.gz 2007-04-22 10:03:12 +00:00
			`\subsection fish_indent-synopsis Synopsis`
Simplify styling 2014-08-01 12:25:41 +00: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 02:44:37 +00:00			`fish_indent [OPTIONS]`
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 02:37:32 +00:00			`\endfish`
Add source code prettyfier program called fish_indent darcs-hash:20070422100312-ac50b-a073999b7dc172259c8200f3e740c921647222a0.gz 2007-04-22 10:03:12 +00:00
			`\subsection fish_indent-description Description`

add option to modify script being restyled This change allows the user to specify the script name on the CLI in addition to being redirected from stdin. It also adds a `-w` flag to write the modified script to the original file. 2016-05-18 15:37:13 +00:00			`fish_indent` is used to indent a piece of fish code. `fish_indent` reads commands from standard input and outputs them to standard output or a specified file.
Add source code prettyfier program called fish_indent darcs-hash:20070422100312-ac50b-a073999b7dc172259c8200f3e740c921647222a0.gz 2007-04-22 10:03:12 +00: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 07:56:01 +00:00			`The following options are available:`
Add source code prettyfier program called fish_indent darcs-hash:20070422100312-ac50b-a073999b7dc172259c8200f3e740c921647222a0.gz 2007-04-22 10:03:12 +00:00
make fish_indent options consistent with fish Make `fish_indent`, `fish_key_reader` and `fish` recognize and assign the same meaning to the `-d` and `-D` flags. Also, fix some errors and stylistic issues in the associated man pages. Fixes #3191 2016-07-06 03:22:44 +00:00			- `-w` or `--write` indents a specified file and immediately writes to that file.
change how redirections are formatted Modify `fish_indent` to emit redirections without a space before the target of the redirection; e.g., "2>&1" rather than "2>& 1" as the former is clearer to humans. Fixes #2899 2016-04-05 22:43:24 +00:00
make fish_indent options consistent with fish Make `fish_indent`, `fish_key_reader` and `fish` recognize and assign the same meaning to the `-d` and `-D` flags. Also, fix some errors and stylistic issues in the associated man pages. Fixes #3191 2016-07-06 03:22:44 +00:00			- `-i` or `--no-indent` do not indent commands; only reformat to one job per line.
add option to modify script being restyled This change allows the user to specify the script name on the CLI in addition to being redirected from stdin. It also adds a `-w` flag to write the modified script to the original file. 2016-05-18 15:37:13 +00:00
make fish_indent options consistent with fish Make `fish_indent`, `fish_key_reader` and `fish` recognize and assign the same meaning to the `-d` and `-D` flags. Also, fix some errors and stylistic issues in the associated man pages. Fixes #3191 2016-07-06 03:22:44 +00:00			- `-v` or `--version` displays the current fish version and then exits.
Add source code prettyfier program called fish_indent darcs-hash:20070422100312-ac50b-a073999b7dc172259c8200f3e740c921647222a0.gz 2007-04-22 10:03:12 +00:00
Clarify some documentation regarding fish_indent 2014-12-24 21:05:31 +00:00			- `--ansi` colorizes the output using ANSI escape sequences, appropriate for the current $TERM, using the colors defined in the environment (such as `$fish_color_command`).
Document new flags to fish_indent 2014-12-24 01:21:54 +00:00
make fish_indent options consistent with fish Make `fish_indent`, `fish_key_reader` and `fish` recognize and assign the same meaning to the `-d` and `-D` flags. Also, fix some errors and stylistic issues in the associated man pages. Fixes #3191 2016-07-06 03:22:44 +00:00			- `--html` outputs HTML, which supports syntax highlighting if the appropriate CSS is defined. The CSS class names are the same as the variable names, such as `fish_color_command`.

			- `-d` or `--debug-level=DEBUG_LEVEL` enables debug output and specifies a verbosity level (like `fish -d`). Defaults to 0.

			- `-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.

			- `--dump-parse-tree` dumps information about the parsed statements to stderr. This is likely to be of interest only to people working on the fish source code.