Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

.Nd entries in man pages are not correct for some man pages #43

Closed
rodrigc opened this issue Jun 17, 2015 · 3 comments
Closed

.Nd entries in man pages are not correct for some man pages #43

rodrigc opened this issue Jun 17, 2015 · 3 comments

Comments

@rodrigc
Copy link

rodrigc commented Jun 17, 2015

According to mdoc(7), the ".Nd" macro is:
A one line description of the manual's content.

It looks like the .Nd macro has been cut and paste across several man pages
and is wrong.

./xo_create.3:.Nd emit formatted output based on format string and arguments
./xo_set_flags.3:.Nd emit formatted output based on format string and arguments
./xo_attr.3:.Nd emit formatted output based on format string and arguments
./xo_set_style.3:.Nd emit formatted output based on format string and arguments
./xo_set_info.3:.Nd emit formatted output based on format string and arguments
./xo_set_allocator.3:.Nd emit formatted output based on format string and arguments
./xo_flush.3:.Nd emit formatted output based on format string and arguments
./xo_open_list.3:.Nd emit formatted output based on format string and arguments
./xo_finish.3:.Nd emit formatted output based on format string and arguments
./xo_set_writer.3:.Nd emit formatted output based on format string and arguments
./xo_open_container.3:.Nd emit formatted output based on format string and arguments
./xo_emit.3:.Nd emit formatted output based on format string and arguments

@philshafer
Copy link
Contributor

Hmmm…. In contrib/mdocml/mdoc.7, I see:

Nd
A one line description of the manual’s content. This is the mandatory
last macro of the NAME section and not appropriate for other sections.

 Examples:
       .Nd mdoc language reference
       .Nd format and display UNIX manuals

 The Nd macro technically accepts child macros and terminates with a sub‐
 sequent Sh invocation.  Do not assume this behaviour: some whatis(1)
 database generators are not smart enough to parse more than the line
 arguments and will display macros verbatim.

 See also Nm.

grepping .Nd in various man files should similar usage.

Thanks,
Phil

On Jun 17, 2015, at 4:25 PM, Craig Rodrigues notifications@github.com wrote:

According to mdoc(7), the ".Nd" macro is:
A one line description of the manual's content.

It looks like the .Nd macro has been cut and paste across several man pages
and is wrong.

./xo_create.3:.Nd emit formatted output based on format string and arguments
./xo_set_flags.3:.Nd emit formatted output based on format string and arguments
./xo_attr.3:.Nd emit formatted output based on format string and arguments
./xo_set_style.3:.Nd emit formatted output based on format string and arguments
./xo_set_info.3:.Nd emit formatted output based on format string and arguments
./xo_set_allocator.3:.Nd emit formatted output based on format string and arguments
./xo_flush.3:.Nd emit formatted output based on format string and arguments
./xo_open_list.3:.Nd emit formatted output based on format string and arguments
./xo_finish.3:.Nd emit formatted output based on format string and arguments
./xo_set_writer.3:.Nd emit formatted output based on format string and arguments
./xo_open_container.3:.Nd emit formatted output based on format string and arguments
./xo_emit.3:.Nd emit formatted output based on format string and arguments


Reply to this email directly or view it on GitHub #43.

@philshafer
Copy link
Contributor

Fixed in new release; also fixed multiple .Nd lines per file

Thanks,
Phil

@rodrigc
Copy link
Author

rodrigc commented Jul 19, 2015

Thanks, Phil!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants