mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-06-08 14:18:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document the comments syntax for config files

Browse Source 
Fixes #1503
This commit is contained in:
Kovid Goyal
2019-03-28 08:08:21 +05:30
parent e7099cc771
commit 00a2126152
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/conf.rst
View File

@@ -20,6 +20,10 @@ You can also display the current configuration by running ``kitty
:option:`kitty --config` option or use the ``KITTY_CONFIG_DIRECTORY`` :option:`kitty --config` option or use the ``KITTY_CONFIG_DIRECTORY``
environment variable. See the :option:`kitty --config` option for full details. environment variable. See the :option:`kitty --config` option for full details.
Comments can be added to the config file as lines starting with the ``#``
character. This works only if the ``#`` character is the first character
in the line.
You can include secondary config files via the :code:`include` directive. If You can include secondary config files via the :code:`include` directive. If
you use a relative path for include, it is resolved with respect to the you use a relative path for include, it is resolved with respect to the
location of the current config file. Note that environment variables are location of the current config file. Note that environment variables are