man pages: use standard NAME format
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Wed, 8 Apr 2015 19:11:41 +0000 (15:11 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Wed, 15 Apr 2015 15:16:21 +0000 (11:16 -0400)
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 \- description

    It 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 something

    Some 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 <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
doc/man/lttng-crash.1
doc/man/lttng-relayd.8
doc/man/lttng-sessiond.8
doc/man/lttng.1

index 4af93f38175e26aa799668dc5ae8f76b43545c31..80971082a714c804d649cd0f6a25d876c669bef7 100644 (file)
@@ -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"
 
index 3a51877a6aaa2a14f24b15c7f0917036cc81fd23..fcde15ef1aa5653dd95283011e052e5db59fe57f 100644 (file)
@@ -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"
 
index 8c29e61ccd69871d9fc4c9c3ec2b34b6f7244cdd..d3ab323d99eaef3b3ef5f08825ef48bdbe96ff9b 100644 (file)
@@ -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"
 
index 564f888f515ab340af45bceb33e5cb8b22921c03..e077b097d1e18e55dd30683119e7b09fe321522e 100644 (file)
@@ -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"
 
This page took 0.036787 seconds and 4 git commands to generate.