From bdb8691bd0db9fc1df58dc2752ac78b3079bc688 Mon Sep 17 00:00:00 2001 From: "brian m. carlson" Date: Wed, 26 Nov 2014 03:18:49 +0000 Subject: [PATCH] manual: document configuration files. Signed-off-by: brian m. carlson --- doc/manual.adoc | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/manual.adoc b/doc/manual.adoc index b09548f..c03e917 100644 --- a/doc/manual.adoc +++ b/doc/manual.adoc @@ -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+.