fish-shell/sphinx_doc_src/cmds/fish_config.rst

.. _cmd-fish_config:

fish_config - start the web-based configuration interface
=========================================================

Synopsis
--------

::

    fish_config [TAB]

Description
-----------

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

``fish_config`` starts a local web server and then opens a web browser window; when you have finished, close the browser window and then press the Enter key to terminate the configuration session.

``fish_config`` optionally accepts name of the initial configuration tab. For e.g. ``fish_config history`` will start configuration interface with history tab.

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.


Example
-------

``fish_config`` opens a new web browser window and allows you to configure certain fish settings.
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 17:05:09 +08:00			`.. _cmd-fish_config:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`fish_config - start the web-based configuration interface`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`=========================================================`
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00
docs: update all command synopsis formatting 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. 2019-09-17 17:59:04 +08:00			`Synopsis`
			`--------`

			`::`

			`fish_config [TAB]`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Description`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			``fish_config`` starts the web-based configuration interface.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`The web interface allows you to view your functions, variables and history, and to make changes to your prompt and color configuration.`

Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			``fish_config`` starts a local web server and then opens a web browser window; when you have finished, close the browser window and then press the Enter key to terminate the configuration session.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			``fish_config`` optionally accepts name of the initial configuration tab. For e.g. ``fish_config history`` will start configuration interface with history tab.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +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.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00

Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Example`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			``fish_config`` opens a new web browser window and allows you to configure certain fish settings.