mirror of
https://github.com/fish-shell/fish-shell.git
synced 2024-11-30 06:03:49 +08:00
02d82dcf85
Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance.
36 lines
1.6 KiB
ReStructuredText
36 lines
1.6 KiB
ReStructuredText
.. _cmd-fish_indent:
|
|
|
|
fish_indent - indenter and prettifier
|
|
=====================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
::
|
|
|
|
fish_indent [OPTIONS] [FILE...]
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
``fish_indent`` is used to indent a piece of fish code. ``fish_indent`` reads commands from standard input or the given filenames and outputs them to standard output or a specified file (if `-w` is given).
|
|
|
|
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=CATEGORY_GLOB`` enables debug output and specifies a glob for matching debug categories (like ``fish -d``). Defaults to empty.
|
|
|
|
- ``-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.
|