CODEWITHSUNDEEP
freebsdmanpage
Good Person
Good Person

Reputation: 1443

What does .Er mean in a man page?

in a man page I'm editing I see the following:

.Er ENOENT ENOENT

what exactly does that mean? I looked in the man(1) man page but don't see anything about how to read the raw files.

Upvotes: 2

Views: 208

Answers (2)

Roland Smith
Roland Smith

Reputation: 43505

For the specifics about .Er, see mdoc(7):

The ‘.Er’ errno macro specifies the error return value for section 2, 3, and 9 library routines. The second example below shows ‘.Er’ used with the ‘.Bq’ general text domain macro, as it would be used in a section two manual page.

       Usage: .Er ⟨errno type⟩ ...

                .Er ENOENT      ENOENT
                .Er ENOENT ) ;  ENOENT);
                .Bq Er ENOTDIR  [ENOTDIR]

 The default width is 17n.

In general, see groff_mdoc(7) on how to write manual pages.

Upvotes: 3

pah
pah

Reputation: 4778

Take a look at HPUX man(5):

.ER errorname punctuation

  • errorname is an error name that corresponds to a value assigned to errno by a function and described in the ERRORS section of a manpage. It is displayed in roman, enclosed in square brackets. For example, .ER EIO . is displayed as [EIO].

Upvotes: 2

Related Questions