mirror of
https://codeberg.org/dnkl/foot.git
synced 2026-04-14 08:21:27 -04:00
man: footclient.1: initial documentation
This commit is contained in:
parent
f63c5a66ac
commit
0c4d43e285
2 changed files with 34 additions and 1 deletions
33
doc/footclient.1.scd
Normal file
33
doc/footclient.1.scd
Normal file
|
|
@ -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)
|
||||||
|
|
@ -3,7 +3,7 @@ sh = find_program('sh', native: true)
|
||||||
scdoc = dependency('scdoc', native: true)
|
scdoc = dependency('scdoc', native: true)
|
||||||
scdoc_prog = find_program(scdoc.get_pkgconfig_variable('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('.')
|
parts = man_src.split('.')
|
||||||
name = parts[-3]
|
name = parts[-3]
|
||||||
section = parts[-2]
|
section = parts[-2]
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue