mirror of
https://github.com/fish-shell/fish-shell
synced 2024-11-14 17:07:44 +00:00
37 lines
1.7 KiB
ReStructuredText
37 lines
1.7 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.
|
|
|
|
- ``-c`` or ``--check`` do not indent, only return 0 if the code is already indented as fish_indent would, the number of failed files otherwise. Also print the failed filenames if not reading from stdin.
|
|
|
|
- ``-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=DEBUG_CATEGORIES`` enable debug output and specify a pattern for matching debug categories. See :ref:`Debugging <debugging-fish>` in :ref:`fish(1) <cmd-fish>` for details.
|
|
|
|
- ``-o`` or ``--debug-output=DEBUG_FILE`` specify a file path to receive the debug output, including categories and ``fish_trace``. The default is stderr.
|
|
|
|
- ``--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.
|