Bug 223517 - The man(1) manual page has no mention about the exit status of the command
Summary: The man(1) manual page has no mention about the exit status of the command
Status: Closed FIXED
Alias: None
Product: Base System
Classification: Unclassified
Component: bin (show other bugs)
Version: CURRENT
Hardware: Any Any
: --- Affects Only Me
Assignee: Eitan Adler
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2017-11-08 10:22 UTC by Wolfram Schneider
Modified: 2018-01-07 00:36 UTC (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Wolfram Schneider freebsd_committer freebsd_triage 2017-11-08 10:22:11 UTC 
The man(1) manual page has no mention about the exit status of the command. Nothing.

Here is an copy of the debian man(1) page section, and I wish we would have something similar in our documentation:

https://www.freebsd.org/cgi/man.cgi?query=man&apropos=0&sektion=0&manpath=Debian+8.1.0&arch=default&format=html#EXIT_STATUS

EXIT STATUS
       0      Successful program execution.
       1      Usage, syntax or configuration file error.
       2      Operational error.
       3      A child process returned a non-zero exit status.
       16     At least one of the pages/files/keywords didn't exist or wasn't matched.
Comment 1 Wolfram Schneider freebsd_committer freebsd_triage 2017-12-05 19:16:01 UTC 
the POSIX man(1) page

http://pubs.opengroup.org/onlinepubs/9699919799/utilities/man.html

EXIT STATUS

    The following exit values shall be returned:
     0
        Successful completion.
    >0
        An error occurred.
Comment 2 commit-hook freebsd_committer freebsd_triage 2017-12-31 00:36:16 UTC 
A commit references this bug:

Author: eadler
Date: Sun Dec 31 00:35:12 UTC 2017
New revision: 327396
URL: https://svnweb.freebsd.org/changeset/base/327396

Log:
  man(1): document exit code

  man(1) uses standard exit codes, document that.

  PR:		223517
  Reported by:	wosch
  MFC after:	1 week

Changes:
  head/usr.bin/man/man.1
Comment 3 commit-hook freebsd_committer freebsd_triage 2018-01-07 00:36:49 UTC 
A commit references this bug:

Author: eadler
Date: Sun Jan  7 00:35:53 UTC 2018
New revision: 327660
URL: https://svnweb.freebsd.org/changeset/base/327660

Log:
  MFC r327396:

  man(1): document exit code

  man(1) uses standard exit codes, document that.

  PR:		223517
  Reported by:	wosch

Changes:
_U  stable/11/
  stable/11/usr.bin/man/man.1