lnav/docs/source/config.rst

53 lines
1.9 KiB
ReStructuredText
Raw Normal View History

2013-07-27 18:04:43 +00:00
2020-05-07 14:08:59 +00:00
.. _Configuration:
2013-07-27 18:04:43 +00:00
Configuration
=============
2020-05-07 14:08:59 +00:00
The configuration for **lnav** is stored in the following JSON files in
:file:`~/.lnav`:
* :file:`config.json` - Contains local customizations that were done using the
:code:`:config` command.
* :file:`configs/default/*.json` - The default configuration files that are
built into lnav are written to this directory with :file:`.sample` appended.
Removing the :file:`.sample` extension and editing the file will allow you to
do basic customizations.
* :file:`configs/installed/*.json` - Contains configuration files installed
using the :code:`-i` flag (e.g. :code:`$ lnav -i /path/to/config.json`).
* :file:`configs/*/*.json` - Other directories that contain :file:`*.json`
files will be loaded on startup.
Options
-------
The following high-level configuration options are available:
.. jsonschema:: ../../src/internals/config-v1.schema.json#/properties/ui/properties/clock-format
.. jsonschema:: ../../src/internals/config-v1.schema.json#/properties/ui/properties/dim-text
.. jsonschema:: ../../src/internals/config-v1.schema.json#/properties/ui/properties/default-colors
.. jsonschema:: ../../src/internals/config-v1.schema.json#/properties/ui/properties/theme
.. jsonschema:: ../../src/internals/config-v1.schema.json#/properties/ui/properties/keymap
Themes
------
User interface themes are also defined through the JSON configuration files.
.. jsonschema:: ../../src/internals/config-v1.schema.json#/properties/ui/properties/theme-defs/patternProperties/[\w\-]+/properties/vars
.. jsonschema:: ../../src/internals/config-v1.schema.json#/properties/ui/properties/theme-defs/patternProperties/[\w\-]+/properties/styles
.. jsonschema:: ../../src/internals/config-v1.schema.json#/definitions/style
Keymaps
-------
Keymaps in **lnav** map a key sequence to a command to execute.
.. jsonschema:: ../../src/internals/config-v1.schema.json#/properties/ui/properties/keymap-defs/patternProperties/[\w\-]+