2019-03-31 17:05:09 +08:00
.. _cmd-fish_config:
2018-12-17 09:39:33 +08:00
fish_config - start the web-based configuration interface
2019-01-03 12:10:47 +08:00
=========================================================
2018-12-17 09:39:33 +08:00
2019-09-17 17:59:04 +08:00
Synopsis
--------
docs synopsis: add HTML highlighing and automate manpage markup
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
2022-01-09 22:09:46 +08:00
.. synopsis ::
fish_config [browse]
fish_config prompt (choose | list | save | show)
fish_config theme (choose | demo | dump | list | save | show)
2018-12-17 05:08:41 +08:00
2018-12-19 10:44:30 +08:00
Description
2019-01-03 12:10:47 +08:00
-----------
2018-12-17 05:08:41 +08:00
2021-04-23 00:27:25 +08:00
`` fish_config `` is used to configure fish.
2018-12-17 05:08:41 +08:00
2021-04-23 00:27:25 +08:00
Without arguments or with the `` browse `` command it starts the web-based configuration interface. The web interface allows you to view your functions, variables and history, and to make changes to your prompt and color configuration. It starts a local web server and opens a browser window. When you are finished, close the browser window and press the Enter key to terminate the configuration session.
2018-12-17 05:08:41 +08:00
2021-04-23 00:27:25 +08:00
If the `` BROWSER `` environment variable is set, it will be used as the name of the web browser to open instead of the system default.
2018-12-17 05:08:41 +08:00
2021-04-23 00:27:25 +08:00
With the `` prompt `` command `` fish_config `` can be used to view and choose a prompt from fish's sample prompts inside the terminal directly.
2018-12-17 05:08:41 +08:00
2021-04-23 00:27:25 +08:00
Available subcommands for the `` prompt `` command:
2018-12-17 05:08:41 +08:00
2021-04-23 00:27:25 +08:00
- `` choose `` loads a sample prompt in the current session.
- `` list `` lists the names of the available sample prompts.
- `` save `` saves the current prompt to a file (via :ref: `funcsave <cmd-funcsave>` ).
- `` show `` shows what the given sample prompts (or all) would look like.
2018-12-17 05:08:41 +08:00
2021-07-10 16:26:58 +08:00
With the `` theme `` command `` fish_config `` can be used to view and choose a theme (meaning a color scheme) inside the terminal.
Available subcommands for the `` theme `` command:
- `` choose `` loads a sample theme in the current session.
- `` demo `` displays some sample text in the current theme.
- `` dump `` prints the current theme in a loadable format.
- `` list `` lists the names of the available sample themes.
2022-06-17 15:23:21 +08:00
- `` save `` saves the given theme to :ref: `universal variables <variables-universal>` .
2021-07-10 16:26:58 +08:00
- `` show `` shows what the given sample theme (or all) would look like.
The themes are loaded from the theme directory shipped with fish or a `` themes `` directory in the fish configuration directory (typically `` ~/.config/fish/themes `` ).
2022-03-12 00:18:41 +08:00
The **-h** or **--help** option displays help about using this command.
2018-12-19 10:44:30 +08:00
Example
2019-01-03 12:10:47 +08:00
-------
2018-12-17 05:08:41 +08:00
2021-04-23 00:27:25 +08:00
`` fish_config `` or `` fish_config browse `` opens a new web browser window and allows you to configure certain fish settings.
`` fish_config prompt show `` demos the available sample prompts.
2021-05-28 23:21:49 +08:00
`` fish_config prompt choose disco `` makes the disco prompt the prompt for the current session. This can also be used in :ref: `config.fish <configuration>` to set the prompt.
2021-04-23 00:27:25 +08:00
2021-05-02 01:44:15 +08:00
`` fish_config prompt save `` saves the current prompt to an :ref: `autoloaded <syntax-function-autoloading>` file.
2021-04-23 00:27:25 +08:00
`` fish_config prompt save default `` chooses the default prompt and saves it.
