]> eyrie.org Git - kerberos/kstart.git/commitdiff
Improve exit status documentation
authorRuss Allbery <eagle@eyrie.org>
Sun, 29 Aug 2021 20:56:56 +0000 (13:56 -0700)
committerRuss Allbery <eagle@eyrie.org>
Sun, 29 Aug 2021 20:56:56 +0000 (13:56 -0700)
Change the man page section title and document the behavior when
the command is killed with a signal.

docs/k5start.pod
docs/krenew.pod

index d286425d33fe9fa9681decc82b1a4dccf64e0d8a..e3a10829e2e5f135370802c4d4a492fa0ff82606 100644 (file)
@@ -360,11 +360,14 @@ With this option, B<k5start> will instead exit.
 
 =back
 
-=head1 RETURN VALUES
+=head1 EXIT STATUS
 
 The program exits with status 0 if it successfully gets a ticket or has a
 happy ticket (see B<-H>).  If B<k5start> runs aklog or some other program
-B<k5start> returns the exit status of that program.
+B<k5start> returns the exit status of that program if it exits normally.
+If the program exits abnormally due to a signal, B<k5start> will exit with
+a status of 128 plus the signal number.  (This matches the behavior of
+B<bash>.)
 
 =head1 EXAMPLE
 
index 7bb11bf24af288e324218caf5c71780734086d21..85fa8341a8f1b99f80213da8c7750f7d345517d0 100644 (file)
@@ -252,11 +252,13 @@ this option, B<krenew> will instead exit.
 
 =back
 
-=head1 RETURN VALUES
+=head1 EXIT STATUS
 
 The program normally exits with status 0 if it successfully renews a
 ticket.  If B<krenew> runs aklog or some other program B<krenew> returns
-the exit status of that program.
+the exit status of that program if it exits normally.  If the program
+exits abnormally due to a signal, B<krenew> will exit with a status of 128
+plus the signal number.  (This matches the behavior of B<bash>.).
 
 =head1 EXAMPLES