bug-coreutils
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: add return codes to man pages


From: Jim Meyering
Subject: Re: add return codes to man pages
Date: Sat, 10 May 2003 08:29:19 +0200

> add return codes to rm etc. man pages, perhaps.

Thank you for the suggestion.
There is already a section in the texinfo manual (info coreutils)
on `exit status':

  Exit status
  ===========

     Nearly every command invocation yields an integral "exit status"
  that can be used to change how other commands work.  For the vast
  majority of commands, an exit status of zero indicates success, and a
  value of `1' indicates failure.  However, some of the programs
  documented here do produce other exit status values and a few associate
  different meanings with the values `0' and `1'.  Here are some of the
  exceptions: `expr', `false', `nohup', `printenv', `sort', `test',
  `true', `tty'.

Is that what you were looking for?

I'd be happy to accept patches that better document
the above exceptions in their respective usage (--help)
messages.  Any such changes would then appear automatically in
the `man' documentation.  For example, tty --help
doesn't mention this:

   Exit status:

     0 if standard input is a terminal
     1 if standard input is not a terminal
     2 if given incorrect arguments
     3 if a write error occurs




reply via email to

[Prev in Thread] Current Thread [Next in Thread]