man pages: use standard NAME format
A message that is not in the archive (sent off-list or not yet received): [email protected]
Jérémie Galarneau
AppliedMerged, thanks!
Jérémie
Quoted 96 lines · Philippe Proulx
As per man(7):
The only mandatory heading is NAME, which should be the first section and be followed on the next line by a one-line description of the program:
.SH NAME
item \- descriptionIt is extremely important that this format is followed, and that there is a backslash before the single dash which follows the item name. This syntax is used by the mandb(8) program to create a database of short descriptions for the whatis(1) and apropos(1) commands.
Furthermore (lexgrog(1)):
When using the traditional man macro set, a correct NAME section looks something like this:
.SH NAME
foo \- program to do somethingSome manual pagers require the ‘\-’ to be exactly as shown; mandb is more tolerant, but for compatibility with other systems it is nevertheless a good idea to retain the backslash.
Signed-off-by Philippe Proulx <[email protected]>--- doc/man/lttng-crash.1 | 2 +- doc/man/lttng-relayd.8 | 2 +- doc/man/lttng-sessiond.8 | 2 +- doc/man/lttng.1 | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-)doc/man/lttng-crash.1 +1
-1@@ -1,7 +1,7 @@ .TH "LTTNG-CRASH" "1" "March 26th, 2015" "" "" .SH "NAME" -lttng-crash \(em LTTng Crash Trace Viewer +lttng-crash \- LTTng Crash Trace Viewer .SH "SYNOPSIS"doc/man/lttng-relayd.8 +1
-1@@ -1,7 +1,7 @@ .TH "LTTNG-RELAYD" "8" "July 15, 2012" "" "" .SH "NAME" -lttng-relayd \(em LTTng remote trace collection daemon +lttng-relayd \- LTTng remote trace collection daemon .SH "SYNOPSIS"doc/man/lttng-sessiond.8 +1
-1@@ -1,7 +1,7 @@ .TH "LTTNG-SESSIOND" "8" "January 31, 2012" "" "" .SH "NAME" -lttng-sessiond \(em LTTng 2.x central tracing registry session daemon. +lttng-sessiond \- LTTng 2.x central tracing registry session daemon. .SH "SYNOPSIS"doc/man/lttng.1 +1
-2@@ -1,7 +1,7 @@ .TH "LTTNG" "1" "May 13th, 2014" "" "" .SH "NAME" -lttng \(em LTTng 2.x tracer control command line tool +lttng \- LTTng 2.x tracer control command line tool .SH "SYNOPSIS" --2.2.1
_______________________________________________
lttng-dev mailing list
[email protected]
http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev
Signature · 8 lines
Jérémie Galarneau EfficiOS Inc. http://www.efficios.com _______________________________________________ lttng-dev mailing list [email protected] http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev