aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2019-08-11 18:54:28 +0000
committerDaniel Eklöf <daniel@ekloef.se>2019-08-11 18:54:28 +0000
commitd405c7022fa949a6f0336096d32af41b44c8d6a0 (patch)
tree1ff4f2340ad3b2bab436ef557198fc1f61aa587b /doc
parentmain: add -h,--help and -v,--version command line options (diff)
doc: add foot.1 man page
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.1.scd29
-rw-r--r--doc/meson.build18
2 files changed, 47 insertions, 0 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd
new file mode 100644
index 00000000..9b02571f
--- /dev/null
+++ b/doc/foot.1.scd
@@ -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
diff --git a/doc/meson.build b/doc/meson.build
new file mode 100644
index 00000000..b61adbc1
--- /dev/null
+++ b/doc/meson.build
@@ -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