mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-26 21:03:12 +00:00
c0d1e41313
Recent synopsis changes move from literal code blocks to [RST line blocks]. This does not translate well to HTML: it's not rendered in monospace, so aligment is lost. Additionally, we don't get syntax highlighting in HTML, which adds differences to our code samples which are highlighted. We hard-wrap synopsis lines (like code blocks). To align continuation lines in manpages we need [backslashes in weird places]. Combined with the **, *, and `` markup, it's a bit hard to get the alignment right. Fix these by moving synopsis sources back to code blocks and compute HTML syntax highlighting and manpage markup with a custom Sphinx extension. The new Pygments lexer can tokenize a synopsis and assign the various highlighting roles, which closely matches fish's syntax highlighing: - command/keyword (dark blue) - parameter (light blue) - operator like and/or/not/&&/|| (cyan) - grammar metacharacter (black) For manpage output, we don't project the fish syntax highlighting but follow the markup convention in GNU's man(1): bold text type exactly as shown. italic text replace with appropriate argument. To make it easy to separate these two automatically, formalize that (italic) placeholders must be uppercase; while all lowercase text is interpreted literally (so rendered bold). This makes manpages more consistent, see string-join(1) and and(1). Implementation notes: Since we want manpage formatting but Sphinx's Pygments highlighing plugin does not support manpage output, add our custom "synopsis" directive. This directive parses differently when manpage output is specified. This means that the HTML and manpage build processes must not share a cache, because the parsed doctrees are cached. Work around this by using separate cache locations for build targets "sphinx-docs" (which creates HTML) and "sphinx-manpages". A better solution would be to only override Sphinx's ManualPageBuilder but that would take a bit more code (ideally we could override ManualPageWriter but Sphinx 4.3.2 doesn't really support that). --- Alternative solution: stick with line blocks but use roles like :command: or :option: (or custom ones). While this would make it possible to produce HTML that is consistent with code blocks (by adding a bit of CSS), the source would look uglier and is harder to maintain. (Let's say we want to add custom formatting to the [|] metacharacters in HTML. This is much easier with the proposed patch.) --- [RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750
102 lines
4 KiB
ReStructuredText
102 lines
4 KiB
ReStructuredText
.. _cmd-fish:
|
|
.. program::fish
|
|
|
|
fish - the friendly interactive shell
|
|
=====================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. synopsis::
|
|
|
|
fish [OPTIONS] [FILE [ARG ...]]
|
|
fish [OPTIONS] [-c COMMAND [ARG ...]]
|
|
|
|
Description
|
|
-----------
|
|
|
|
:command:`fish` is a command-line shell written mainly with interactive use in mind.
|
|
This page briefly describes the options for invoking :command:`fish`.
|
|
The :ref:`full manual <intro>` is available in HTML by using the :command:`help` command from inside fish, and in the `fish-doc(1)` man page.
|
|
The :ref:`tutorial <tutorial>` is available as HTML via ``help tutorial`` or in `man fish-tutorial`.
|
|
|
|
|
|
The following options are available:
|
|
|
|
**-c** or **--command=COMMAND**
|
|
Evaluate the specified commands instead of reading from the commandline, passing additional positional arguments through ``$argv``.
|
|
|
|
**-C** or **--init-command=COMMANDS**
|
|
Evaluate specified commands after reading the configuration but before executing command specified by **-c** or reading interactive input.
|
|
|
|
**-d** or **--debug=DEBUG_CATEGORIES**
|
|
Enables debug output and specify a pattern for matching debug categories.
|
|
See :ref:`Debugging <debugging-fish>` below for details.
|
|
|
|
**-o** or **--debug-output=DEBUG_FILE**
|
|
Specifies a file path to receive the debug output, including categories and :envvar:`fish_trace`.
|
|
The default is stderr.
|
|
|
|
**-i** or **--interactive**
|
|
The shell is interactive.
|
|
|
|
**-l** or **--login**
|
|
Act as if invoked as a login shell.
|
|
|
|
**-N** or **--no-config**
|
|
Do not read configuration files.
|
|
|
|
**-n** or **--no-execute**
|
|
Do not execute any commands, only perform syntax checking.
|
|
|
|
**-p** or **--profile=PROFILE_FILE**
|
|
when :command:`fish` exits, output timing information on all executed commands to the specified file.
|
|
This excludes time spent starting up and reading the configuration.
|
|
|
|
**--profile-startup=PROFILE_FILE**
|
|
Will write timing for ``fish`` startup to specified file.
|
|
|
|
**-P** or **--private**
|
|
Enables :ref:`private mode <private-mode>`: **fish** will not access old or store new history.
|
|
|
|
**--print-rusage-self**
|
|
When :command:`fish` exits, output stats from getrusage.
|
|
|
|
**--print-debug-categories**
|
|
Print all debug categories, and then exit.
|
|
|
|
**-v** or **--version**
|
|
Print version and exit.
|
|
|
|
**-f** or **--features=FEATURES**
|
|
Enables one or more comma-separated :ref:`feature flags <featureflags>`.
|
|
|
|
The ``fish`` exit status is generally the :ref:`exit status of the last foreground command <variables-status>`.
|
|
|
|
.. _debugging-fish:
|
|
|
|
Debugging
|
|
---------
|
|
|
|
While fish provides extensive support for :ref:`debugging fish scripts <debugging>`, it is also possible to debug and instrument its internals.
|
|
Debugging can be enabled by passing the **--debug** option.
|
|
For example, the following command turns on debugging for background IO thread events, in addition to the default categories, i.e. *debug*, *error*, *warning*, and *warning-path*:
|
|
::
|
|
|
|
> fish --debug=iothread
|
|
|
|
Available categories are listed by ``fish --print-debug-categories``. The **--debug** option accepts a comma-separated list of categories, and supports glob syntax.
|
|
The following command turns on debugging for *complete*, *history*, *history-file*, and *profile-history*, as well as the default categories:
|
|
::
|
|
|
|
> fish --debug='complete,*history*'
|
|
|
|
Debug messages output to stderr by default. Note that if :envvar:`fish_trace` is set, execution tracing also outputs to stderr by default. You can output to a file using the **--debug-output** option:
|
|
::
|
|
|
|
> fish --debug='complete,*history*' --debug-output=/tmp/fish.log --init-command='set fish_trace on'
|
|
|
|
These options can also be changed via the :envvar:`FISH_DEBUG` and :envvar:`FISH_DEBUG_OUTPUT` variables.
|
|
The categories enabled via **--debug** are *added* to the ones enabled by $FISH_DEBUG, so they can be disabled by prefixing them with **-** (**reader-*,-ast*** enables reader debugging and disables ast debugging).
|
|
|
|
The file given in **--debug-output** takes precedence over the file in :envvar:`FISH_DEBUG_OUTPUT`.
|