aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-08-27 18:02:30 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-08-27 18:02:30 +0000
commit5c4af880fc62ee509015c28eb0b4c395b956081d (patch)
tree08d84bfad0301cff61ba4f9097f5e8015984ce28 /doc
parentreadme: update references to the configuration file (diff)
doc: rename footrc.5 to foot.ini.5, and update references
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.1.scd9
-rw-r--r--doc/foot.ini.5.scd (renamed from doc/footrc.5.scd)7
-rw-r--r--doc/meson.build11
3 files changed, 16 insertions, 11 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd
index eb2213d6..19e1b0ee 100644
--- a/doc/foot.1.scd
+++ b/doc/foot.1.scd
@@ -23,7 +23,8 @@ the foot command line
# OPTIONS
*-c*,*--config*=_PATH_
- Path to configuration file. Default: *$XDG_CONFIG_HOME/footrc*.
+ Path to configuration file. Default:
+ *$XDG_CONFIG_HOME/foot/foot.ini*.
*--check-config*
Verify configuration and then exit with 0 if ok, otherwise exit
@@ -131,7 +132,7 @@ The following keyboard shortcuts are available.
## NORMAL MODE
Note that these are just the defaults; they can be changed in
-*footrc*, see *footrc*(5).
+*foot.ini*, see *foot.ini*(5).
*shift*+*page up*/*page down*
Scroll up/down in history
@@ -253,7 +254,7 @@ Finally, pressing *alt* will prefix the transmitted byte with ESC.
# CONFIGURATION
-See *footrc*(5)
+See *foot.ini*(5)
# BUGS
@@ -270,4 +271,4 @@ The report should contain the following:
# SEE ALSO
-*footrc*(5), *footclient*(1)
+*foot.ini*(5), *footclient*(1)
diff --git a/doc/footrc.5.scd b/doc/foot.ini.5.scd
index 1c974d41..cede6e26 100644
--- a/doc/footrc.5.scd
+++ b/doc/foot.ini.5.scd
@@ -1,7 +1,7 @@
-footrc(5)
+foot.ini(5)
# NAME
-footrc - configuration file
+foot.ini - configuration file
# DESCRIPTION
@@ -12,8 +12,11 @@ with a _[section]_).
foot will search for a configuration file in the following locations,
in this order:
+- _XDG_CONFIG_HOME/foot/foot.ini_
+- _~/.config/foot/foot.ini_
- _XDG_CONFIG_HOME/footrc_
- _~/.config/footrc_
+- _XDG_CONFIG_DIRS/foot/foot.init_
# SECTION: default
diff --git a/doc/meson.build b/doc/meson.build
index 39697496..18cff552 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -3,16 +3,17 @@ sh = find_program('sh', native: true)
scdoc = dependency('scdoc', native: true)
scdoc_prog = find_program(scdoc.get_pkgconfig_variable('scdoc'), native: true)
-foreach man_src : ['foot.1.scd', 'footrc.5.scd', 'footclient.1.scd']
- parts = man_src.split('.')
- name = parts[-3]
- section = parts[-2]
+foreach man_src : [{'name': 'foot', 'section' : 1},
+ {'name': 'foot.ini', 'section': 5},
+ {'name': 'footclient', 'section': 1}]
+ name = man_src['name']
+ section = man_src['section']
out = '@0@.@1@'.format(name, section)
custom_target(
out,
output: out,
- input: man_src,
+ input: '@0@.@01@.scd'.format(name, section),
command: [sh, '-c', '@0@ < @INPUT@'.format(scdoc_prog.path())],
capture: true,
install: true,