doc: timeout: document the exit status when run with "-s KILL"
authorRodrigo Campos <rodrigo@sdfg.com.ar>
Wed, 29 Feb 2012 14:36:18 +0000 (11:36 -0300)
committerPádraig Brady <P@draigBrady.com>
Wed, 29 Feb 2012 15:41:15 +0000 (15:41 +0000)
* src/timeout.c (usage): Document the exit status for this case,
in --help and thus in the man page.  Word so that it covers
both the -s9 and -k options.
* doc/coreutils.texi (timeout invocation): Document the exit
status for this case.

doc/coreutils.texi
src/timeout.c

index 0d252fc..4a4cadb 100644 (file)
@@ -15940,6 +15940,7 @@ Exit status:
 125 if @command{timeout} itself fails
 126 if @var{command} is found but cannot be invoked
 127 if @var{command} cannot be found
+137 if @var{command} is sent the KILL(9) signal (128+9)
 the exit status of @var{command} otherwise
 @end display
 
index 73367c4..c0a2527 100644 (file)
@@ -236,7 +236,8 @@ If the command times out, then exit with status 124.  Otherwise, exit\n\
 with the status of COMMAND.  If no signal is specified, send the TERM\n\
 signal upon timeout.  The TERM signal kills any process that does not\n\
 block or catch that signal.  For other processes, it may be necessary to\n\
-use the KILL (9) signal, since this signal cannot be caught.\n"), stdout);
+use the KILL (9) signal, since this signal cannot be caught.  If the\n\
+KILL (9) signal is sent, the exit status is 128+9 rather than 124.\n"), stdout);
       emit_ancillary_info ();
     }
   exit (status);