doc: add foot.1 man page

This commit is contained in:
Daniel Eklöf 2019-08-11 20:54:28 +02:00
parent 1060c8e892
commit d405c7022f
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
3 changed files with 49 additions and 0 deletions

29
doc/foot.1.scd Normal file
View file

@ -0,0 +1,29 @@
foot(1)
# NAME
foot - Wayland terminal emulator
# SYNOPSIS
*foot* [_OPTIONS_]...
# OPTIONS
*-f*,*--font*=_FONT_
Font and style to use, in fontconfig format. See *FONT
FORMAT*. Default: _monospace_.
*-t*,*--term*=_TERM_
Value to set the environment variable _TERM_ to. Default: _foot_.
*-v*,*--version*
Show the version number and quit
# FONT FORMAT
The font is specified in FontConfig syntax. That is, a colon-separated
list of font name and font options.
_Examples_:
- Dina:weight=bold:slant=italic
- Arial:size=12

18
doc/meson.build Normal file
View file

@ -0,0 +1,18 @@
scdoc = dependency('scdoc', native: true)
scdoc_prog = find_program(scdoc.get_pkgconfig_variable('scdoc'), native: true)
foreach man_src : ['foot.1.scd']
parts = man_src.split('.')
name = parts[-3]
section = parts[-2]
out = '@0@.@1@'.format(name, section)
custom_target(
out,
output: out,
input: man_src,
command: [sh, '-c', '@0@ < @INPUT@'.format(scdoc_prog.path())],
capture: true,
install: true,
install_dir: join_paths(get_option('mandir'), 'man@0@'.format(section)))
endforeach

View file

@ -110,3 +110,5 @@ custom_target(
install_dir: join_paths(get_option('datadir'), 'terminfo'))
install_data('foot.desktop', install_dir: join_paths(get_option('datadir'), 'applications'))
subdir('doc')