doc: foot.1 footclient.1: document exit status

This commit is contained in:
Daniel Eklöf 2021-05-01 10:58:35 +02:00
parent da923100ca
commit 1cbbb62da0
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
2 changed files with 24 additions and 3 deletions

View file

@ -28,7 +28,7 @@ the foot command line
*-C*,*--check-config* *-C*,*--check-config*
Verify configuration and then exit with 0 if ok, otherwise exit Verify configuration and then exit with 0 if ok, otherwise exit
with 1. with 230 (see *EXIT STATUS*).
*-f*,*--font*=_FONT_ *-f*,*--font*=_FONT_
Comma separated list of fonts to use, in fontconfig format (see Comma separated list of fonts to use, in fontconfig format (see
@ -136,6 +136,13 @@ the foot command line
*-v*,*--version* *-v*,*--version*
Show the version number and quit. Show the version number and quit.
# EXIT STATUS
Foot will exit with code 230 if there is a failure in foot itself.
In all other cases, the exit code is that of the client application
(i.e. the shell).
# KEYBOARD SHORTCUTS # KEYBOARD SHORTCUTS
The following keyboard shortcuts are available. The following keyboard shortcuts are available.

View file

@ -17,8 +17,8 @@ mode.
Running it without arguments will open a new terminal window (hosted Running it without arguments will open a new terminal window (hosted
in the foot server), with your default shell. The exit code will be in the foot server), with your default shell. The exit code will be
that of the terminal (thus, *footclient* does not exit until the that of the terminal. I.e *footclient* does not exit until the
terminal has terminated). terminal has terminated.
# OPTIONS # OPTIONS
@ -74,6 +74,20 @@ terminal has terminated).
*-v*,*--version* *-v*,*--version*
Show the version number and quit Show the version number and quit
# EXIT STATUS
Footlient will exit with code 220 if there is a failure in footclient
itself (for example, the server socket does not exist).
If *-N*,*--no-wait* is used, footclient exits with code 0 as soon as
the foot server has been instructed to open a new window.
If not, footclient may also exit with code 230. This indicates a
failure in the foot server.
In all other cases the exit code is that of the client application
(i.e. the shell).
# SEE ALSO # SEE ALSO
*foot*(1) *foot*(1)