doc: rename footrc.5 to foot.ini.5, and update references

This commit is contained in:
Daniel Eklöf 2020-08-27 20:02:30 +02:00
parent f7c2940880
commit 5c4af880fc
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
4 changed files with 17 additions and 12 deletions

View file

@ -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)

View file

@ -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

View file

@ -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,

View file

@ -163,7 +163,7 @@ install_data(
install_data(
'foot.desktop', 'foot-server.desktop',
install_dir: join_paths(get_option('datadir'), 'applications'))
install_data('footrc', install_dir: join_paths(get_option('datadir'), 'foot'))
install_data('foot.ini', install_dir: join_paths(get_option('datadir'), 'foot'))
subdir('completions')
subdir('doc')