groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 17/20: man pages: Fix up style in lexgrog/mandb areas.


From: G. Branden Robinson
Subject: [groff] 17/20: man pages: Fix up style in lexgrog/mandb areas.
Date: Fri, 9 Nov 2018 18:39:42 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit a5d04efe35558c9e9cebec469ce6fb1494441aaa
Author: G. Branden Robinson <address@hidden>
Date:   Fri Nov 9 17:41:34 2018 -0500

    man pages: Fix up style in lexgrog/mandb areas.
    
        * contrib/glilypond/glilypond.1.man:
        * contrib/gperl/gperl.1.man:
        * contrib/gpinyin/gpinyin.1.man:
        * contrib/groff_filenames/groff_filenames.5.man:
        * contrib/groffer/groffer.1.man:
        * contrib/mom/groff_mom.7.man:
        * src/roff/grog/grog.1.man:
          Remove comment about why "this .SH" (the Name section heading)
          "was moved to this place".  All of the in-tree man pages place
          it immediately after the .TH call without such commentary.
    
        * man/groff_char.7.man:
          Similar; this comment is just as vague but not copy-and-pasted
          from the foregoing.
    
        * contrib/gpinyin/gpinyin.1.man:
          Revert unnecessary relocation of Synopsis .SH call as well.
          Uncomment the one that was in the correct place.
    
        * contrib/groff_filenames/groff_filenames.5.man:
          In Name section, separate man page topic from description with
          a hyphen-minus (\-) as is standard and done in the 60 other
          in-tree page sources, rather than an em dash (\(em), done only
          here.
    
        * contrib/groffer/groffer.1.man:
          Replace non-breaking adjustable space escape (\~) with an
          ordinary space in the phrase "man pages".  Lexgrog and friends
          are not going to put a line break there.
    
        * contrib/mm/groff_mmse.7.man:
        * contrib/mom/groff_mom.7.man:
          Remove empty request between .TH call and first .SH.
    
        * contrib/mm/groff_mmse.7.man:
        * contrib/mom/groff_mom.7.man:
          Use only classical roff character escape format in the Name
          section, not the groff extended one; i.e., use \( instead of
          \[].  We have not yet exited compatibility mode, and I have
          little faith in Solaris's *roff or its lexgrog/mandb to handle
          the newer form correctly.  (Actual data is welcome, however.)
    
        * contrib/mom/groff_mom.7.man:
        * src/preproc/preconv/preconv.1.man:
          Use \<newline> to wrap long input lines in Name section.
    
        * tmac/groff_me.7.man:
          Delete '.hc %' request immediately after the preprocessor hint
          comment.  I'm not sure what it was intended to do (percent
          signs are used nowhere else in the page source), but it
          produces no distinguishable change in PDF or UTF-8 TTY output.
    
    Signed-off-by: G. Branden Robinson <address@hidden>
---
 contrib/glilypond/glilypond.1.man             | 2 --
 contrib/gperl/gperl.1.man                     | 2 --
 contrib/gpinyin/gpinyin.1.man                 | 5 +----
 contrib/groff_filenames/groff_filenames.5.man | 4 +---
 contrib/groffer/groffer.1.man                 | 4 +---
 contrib/mm/groff_mmse.7.man                   | 3 +--
 contrib/mom/groff_mom.7.man                   | 5 ++---
 man/groff_char.7.man                          | 2 --
 src/preproc/preconv/preconv.1.man             | 3 ++-
 src/roff/grog/grog.1.man                      | 1 -
 tmac/groff_me.7.man                           | 4 ++--
 11 files changed, 10 insertions(+), 25 deletions(-)

diff --git a/contrib/glilypond/glilypond.1.man 
b/contrib/glilypond/glilypond.1.man
index ba3832b..9843f24 100644
--- a/contrib/glilypond/glilypond.1.man
+++ b/contrib/glilypond/glilypond.1.man
@@ -2,8 +2,6 @@
 .SH NAME
 glilypond \- integrate lilypond parts into groff
 .
-.\" This .SH was moved to this place in order to appease 'apropos'.
-.
 .\" glilypond - integrate 'lilypond' parts into 'groff' files
 .\" Source file position:  <groff_source_top>/contrib/glilypond.man
 .\" Installed position:    <prefix>/share/man/man1/glilypond.1
diff --git a/contrib/gperl/gperl.1.man b/contrib/gperl/gperl.1.man
index 1474b0e..ba5cac4 100644
--- a/contrib/gperl/gperl.1.man
+++ b/contrib/gperl/gperl.1.man
@@ -2,8 +2,6 @@
 .SH NAME
 gperl \- groff preprocessor for Perl parts in roff files
 .
-.\" The .SH was moved to this place in order to appease 'apropos'.
-.
 .\" ====================================================================
 .\" Legal Terms
 .\" ====================================================================
diff --git a/contrib/gpinyin/gpinyin.1.man b/contrib/gpinyin/gpinyin.1.man
index 11f55b4..db634fd 100644
--- a/contrib/gpinyin/gpinyin.1.man
+++ b/contrib/gpinyin/gpinyin.1.man
@@ -3,9 +3,6 @@
 .SH NAME
 gpinyin \- use Hanyu Pinyin Chinese in roff
 .
-.SH "SYNOPSIS"
-.\" The .SH was moved to this place in order to appease 'apropos'.
-.
 .\" ====================================================================
 .\" Legal Terms
 .\" ====================================================================
@@ -36,7 +33,7 @@ gpinyin \- use Hanyu Pinyin Chinese in roff
 .
 .
 .\" ====================================================================
-.\" SH "SYNOPSIS"
+.SH "SYNOPSIS"
 .\" ====================================================================
 .
 .SY gpinyin
diff --git a/contrib/groff_filenames/groff_filenames.5.man 
b/contrib/groff_filenames/groff_filenames.5.man
index 3f104fb..dcb713a 100644
--- a/contrib/groff_filenames/groff_filenames.5.man
+++ b/contrib/groff_filenames/groff_filenames.5.man
@@ -1,8 +1,6 @@
 .TH GROFF_FILENAMES @MAN5EXT@ "@MDATE@" "groff @VERSION@"
 .SH NAME
-groff_filenames \(em filename extensions for roff and groff
-.
-.\" The .SH was moved to this place in order to appease 'apropos'.
+groff_filenames \- filename extensions for roff and groff
 .
 .\" ad l
 .\" ====================================================================
diff --git a/contrib/groffer/groffer.1.man b/contrib/groffer/groffer.1.man
index 3f365a8..e7b4b6a 100644
--- a/contrib/groffer/groffer.1.man
+++ b/contrib/groffer/groffer.1.man
@@ -1,8 +1,6 @@
 .TH GROFFER @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH NAME
-groffer \- display groff files and man\~pages on X and tty
-.
-.\" The .SH was moved to this place in order to appease 'apropos'.
+groffer \- display groff files and man pages on X and tty
 .
 .
 .\"*********************************************************************
diff --git a/contrib/mm/groff_mmse.7.man b/contrib/mm/groff_mmse.7.man
index 0e232c9..7c8d8fc 100644
--- a/contrib/mm/groff_mmse.7.man
+++ b/contrib/mm/groff_mmse.7.man
@@ -1,7 +1,6 @@
 .TH GROFF_MMSE @MAN7EXT@ "@MDATE@" "groff @VERSION@"
-.
 .SH NAMN
-groff_mmse \- svenska \[rq]memorandum\[rq] makro f�r GNU roff
+groff_mmse \- svenska \(rqmemorandum\(rq makro f\(:or GNU roff
 .
 .
 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
diff --git a/contrib/mom/groff_mom.7.man b/contrib/mom/groff_mom.7.man
index d75fbab..c198489 100644
--- a/contrib/mom/groff_mom.7.man
+++ b/contrib/mom/groff_mom.7.man
@@ -1,8 +1,7 @@
 .TH GROFF_MOM @MAN7EXT@ "@MDATE@" "groff @VERSION@"
 .SH NAME
-groff_mom \- groff \[lq]mom\[rq] macros; \[lq]mom\[rq] is a \[lq]roff\[rq] 
language, part of \[lq]groff\[rq]
-.
-.\" The .SH was moved to this place in order to appease 'apropos'.
+groff_mom \- groff \(lqmom\(rq macros; \(lqmom\(rq is a \(lqroff\(rq \
+language, part of \(lqgroff\(rq
 .
 .
 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
diff --git a/man/groff_char.7.man b/man/groff_char.7.man
index 8480ce2..ef3c047 100644
--- a/man/groff_char.7.man
+++ b/man/groff_char.7.man
@@ -3,8 +3,6 @@
 .SH NAME
 groff_char \- groff glyph names
 .
-.\" The lines above were designed to satisfy 'apropos'.
-.
 .\" For best results, format this document with 'groff' (GNU roff).
 .
 .\" groff_char(7):
diff --git a/src/preproc/preconv/preconv.1.man 
b/src/preproc/preconv/preconv.1.man
index fbc1c74..087ce13 100644
--- a/src/preproc/preconv/preconv.1.man
+++ b/src/preproc/preconv/preconv.1.man
@@ -1,6 +1,7 @@
 .TH PRECONV @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH NAME
-preconv \- convert encoding of input files to something GNU troff understands
+preconv \- convert encoding of input files to something GNU troff \
+understands
 .
 .
 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
diff --git a/src/roff/grog/grog.1.man b/src/roff/grog/grog.1.man
index 3d45556..d23c63a 100644
--- a/src/roff/grog/grog.1.man
+++ b/src/roff/grog/grog.1.man
@@ -1,7 +1,6 @@
 .TH GROG @MAN1EXT@ "@MDATE@" "groff @VERSION@"
 .SH NAME
 grog \- guess options for a following groff command
-.\" The .SH was moved to this place in order to appease 'apropos'.
 .
 .\" grog.man -> grog.1 - man page for grog (section 1)
 .\" Source file position:  <groff_source_top>/src/roff/grog/grog.man
diff --git a/tmac/groff_me.7.man b/tmac/groff_me.7.man
index f6b1ca8..3e972b4 100644
--- a/tmac/groff_me.7.man
+++ b/tmac/groff_me.7.man
@@ -1,8 +1,8 @@
 '\" t
-.hc %
 .TH GROFF_ME @MAN7EXT@ "@MDATE@" "@VERSION@"
 .SH NAME
-groff_me \- \(lqme\(rq macro package for formatting documents with GNU roff
+groff_me \- \(lqme\(rq macro package for formatting documents with GNU \
+roff
 .
 .
 .\" ====================================================================



reply via email to

[Prev in Thread] Current Thread [Next in Thread]