From 1cbbb62da04d8d600292166818e6356a38cc765c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= <daniel@ekloef.se>
Date: Sat, 1 May 2021 10:58:35 +0200
Subject: [PATCH] doc: foot.1 footclient.1: document exit status

---
 doc/foot.1.scd       |  9 ++++++++-
 doc/footclient.1.scd | 18 ++++++++++++++++--
 2 files changed, 24 insertions(+), 3 deletions(-)

diff --git a/doc/foot.1.scd b/doc/foot.1.scd
index 9b5079b8..8c7bf901 100644
--- a/doc/foot.1.scd
+++ b/doc/foot.1.scd
@@ -28,7 +28,7 @@ the foot command line
 
 *-C*,*--check-config*
 	Verify configuration and then exit with 0 if ok, otherwise exit
-	with 1.
+	with 230 (see *EXIT STATUS*).
 
 *-f*,*--font*=_FONT_
 	Comma separated list of fonts to use, in fontconfig format (see
@@ -136,6 +136,13 @@ the foot command line
 *-v*,*--version*
 	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
 
 The following keyboard shortcuts are available.
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)