aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2019-11-03 12:47:19 +0000
committerDaniel Eklöf <daniel@ekloef.se>2019-11-03 12:47:19 +0000
commit0c4d43e28582581c554b1b742460cca7e9fe7656 (patch)
tree8cec7ab5a9a9ce118307bfa11e17d56e1b999282
parentman: foot.1: add a DESCRIPTION (diff)
man: footclient.1: initial documentation
-rw-r--r--doc/footclient.1.scd33
-rw-r--r--doc/meson.build2
2 files changed, 34 insertions, 1 deletions
diff --git a/doc/footclient.1.scd b/doc/footclient.1.scd
new file mode 100644
index 00000000..40ead1cd
--- /dev/null
+++ b/doc/footclient.1.scd
@@ -0,0 +1,33 @@
+footclient(1)
+
+# NAME
+footclient - start new terminals in a foot server
+
+# SYNOPSIS
+*foot* [_OPTIONS_]++
+*foot* [_OPTIONS_] -- <command>
+
+All trailing (non-option) arguments are treated as a command to
+execute (instead of the shell).
+
+# OPTIONS
+
+*-t*,*--term*=_TERM_
+ Value to set the environment variable _TERM_ to. Default: _foot_.
+
+*-v*,*--version*
+ Show the version number and quit
+
+# DESCRIPTION
+
+*footclient* is used together with *foot*(1) in *--server*
+mode.
+
+Running it without arguments will open a new terminal window (hosted
+in the foot server), with your default shell. The exit code will be
+that of the terminal (thus, *footclient* does not exit until the
+terminal has terminated).
+
+# SEE ALSO
+
+*foot*(1)
diff --git a/doc/meson.build b/doc/meson.build
index 66a9b183..6d3219dc 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -3,7 +3,7 @@ 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', 'foot.5.scd']
+foreach man_src : ['foot.1.scd', 'foot.5.scd', 'footclient.1.scd']
parts = man_src.split('.')
name = parts[-3]
section = parts[-2]