diff options
| author | Daniel Eklöf <daniel@ekloef.se> | 2021-05-01 08:58:35 +0000 |
|---|---|---|
| committer | Daniel Eklöf <daniel@ekloef.se> | 2021-05-04 08:41:23 +0000 |
| commit | 1cbbb62da04d8d600292166818e6356a38cc765c (patch) | |
| tree | f55b4ea4973aa2e05e97bc742e7518a40aa5e57e /doc/footclient.1.scd | |
| parent | main/client: change exit code (diff) | |
doc: foot.1 footclient.1: document exit status
Diffstat (limited to 'doc/footclient.1.scd')
| -rw-r--r-- | doc/footclient.1.scd | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/doc/footclient.1.scd b/doc/footclient.1.scd index 900668a2..fcd2f5d1 100644 --- a/doc/footclient.1.scd +++ b/doc/footclient.1.scd @@ -17,8 +17,8 @@ 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). +that of the terminal. I.e *footclient* does not exit until the +terminal has terminated. # OPTIONS @@ -74,6 +74,20 @@ terminal has terminated). *-v*,*--version* 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 *foot*(1) |
