[lttng-dev] [PATCH lttng-tools] man pages: use standard NAME format

[lttng-dev] [PATCH lttng-tools] man pages: use standard NAME format

[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 \- 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 at gmail.com>
---
 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(-)

diff --git a/doc/man/lttng-crash.1 b/doc/man/lttng-crash.1
index 4af93f3..8097108 100644
--- a/doc/man/lttng-crash.1
+++ b/doc/man/lttng-crash.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"
 
diff --git a/doc/man/lttng-relayd.8 b/doc/man/lttng-relayd.8
index 3a51877..fcde15e 100644
--- a/doc/man/lttng-relayd.8
+++ b/doc/man/lttng-relayd.8
@@ -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"
 
diff --git a/doc/man/lttng-sessiond.8 b/doc/man/lttng-sessiond.8
index 8c29e61..d3ab323 100644
--- a/doc/man/lttng-sessiond.8
+++ b/doc/man/lttng-sessiond.8
@@ -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"
 
diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index 564f888..e077b09 100644
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -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] [PATCH lttng-tools] man pages: use standard NAME format

[Jérémie Galarneau]

Merged, thanks!

J?r?mie

On Wed, Apr 8, 2015 at 3:11 PM, Philippe Proulx <eeppeliteloop at gmail.com> wrote:
> 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 at gmail.com>
> ---
>  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(-)
>
> diff --git a/doc/man/lttng-crash.1 b/doc/man/lttng-crash.1
> index 4af93f3..8097108 100644
> --- a/doc/man/lttng-crash.1
> +++ b/doc/man/lttng-crash.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"
>
> diff --git a/doc/man/lttng-relayd.8 b/doc/man/lttng-relayd.8
> index 3a51877..fcde15e 100644
> --- a/doc/man/lttng-relayd.8
> +++ b/doc/man/lttng-relayd.8
> @@ -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"
>
> diff --git a/doc/man/lttng-sessiond.8 b/doc/man/lttng-sessiond.8
> index 8c29e61..d3ab323 100644
> --- a/doc/man/lttng-sessiond.8
> +++ b/doc/man/lttng-sessiond.8
> @@ -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"
>
> diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
> index 564f888..e077b09 100644
> --- a/doc/man/lttng.1
> +++ b/doc/man/lttng.1
> @@ -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
> lttng-dev at lists.lttng.org
> http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev



-- 
J?r?mie Galarneau
EfficiOS Inc.
http://www.efficios.com