pestctrl/newfol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

manual: document configuration files.

Browse source 
Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
This commit is contained in:
brian m. carlson 2014-11-26 03:18:49 +00:00
parent a48ce88ac1
commit bdb8691bd0
No known key found for this signature in database
GPG key ID: BF535D811F52F68B
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/manual.adoc
View file

@ -49,3 +49,17 @@ automatically create a version 0 schema file and upgrade it to the latest
version on start. newfol does not accept schema files that have a newer version
than it currently supports, but it ignores directives it does not understand,
and so can be manually downgraded by editing the `fmt` directive.
=== Configuration File
Configuration files are identical to schema files except that instead of the
text `newfol schema file` in the `fmt` entry, the text `newfol config file` is
substituted. Because newfol parses both files in the same way, any entry that
is valid in a schema file is also valid in a configuration file. That said,
some directives make more sense in a configuration file than others.
Common directives that are useful in a configuration file are transaction
settings, colors, and keybindings.
The default location is +_$XDG_CONFIG_HOME_/newfol/defaults+. If
`$XDG_CONFIG_HOME` is not defined, it defaults to +_$HOME_/.config+.