[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 02/03: Clean up miscellaneous man page problems.
|
From: |
G. Branden Robinson |
|
Subject: |
[groff] 02/03: Clean up miscellaneous man page problems. |
|
Date: |
Thu, 2 Nov 2017 19:26:13 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit acdb173b09ec687569ef99b75f2e4f6b9dcf0495
Author: G. Branden Robinson <address@hidden>
Date: Thu Nov 2 18:50:06 2017 -0400
Clean up miscellaneous man page problems.
* Use \- in the "apropos line", not a variant dash like \[em].
* Use groff-style character escapes, e.g. for the copyright symbol.
* Use an en-dash in copyright year and character class ranges.
* Use \- instead of - in command-line options, filespecs, email
addresses, URLs, and other syntax literals so cut and paste works.
* Eliminate useless uses of \&.
* Remove quotation marks from macros that treat the rest of the line
as a single argument (such as .B). Further work remains here.
* Remove useless trailing whitespace from input lines.
* Replace hard tab after a copyright year range with an ordinary space
(in a string definition, not a comment).
* Style: "man-page" -> "man page"
* Style: "de-facto" -> "de facto"
* Style: "allround-viewer" -> "all-around viewer"
* Style: "line-printers" -> "line printers"
* Style: "Windows\~32" -> "Windows"
* Add Vim modeline.
* Add comments notating pages that need much deeper editing.
groff_filenames(5):
* I did a slightly deeper editing pass on this page but ran out
of steam on the others for now. I recast several sentences and
updated information about man page sections 9, n, o, and l. I also
stopped the page from trying to use Courier Bold. Also clarified the
nature (and name) of hdtbl.
---
contrib/glilypond/glilypond.1.man | 56 +++++++--------
contrib/gperl/gperl.1.man | 35 +++++-----
contrib/gpinyin/gpinyin.1.man | 31 +++++----
contrib/groff_filenames/groff_filenames.5.man | 99 ++++++++++++++-------------
contrib/mom/groff_mom.7.man | 17 ++---
man/groff_diff.7.man | 15 ++--
man/groff_out.5.man | 11 +--
man/roff.7.man | 35 +++++-----
src/devices/grolj4/lj4_font.5.man | 3 +-
src/roff/groff/groff.1.man | 37 +++++-----
src/roff/grog/grog.1.man | 27 ++++----
src/utils/addftinfo/addftinfo.1.man | 5 +-
12 files changed, 194 insertions(+), 177 deletions(-)
diff --git a/contrib/glilypond/glilypond.1.man
b/contrib/glilypond/glilypond.1.man
index 0d7d3d2..a4e3bcc 100644
--- a/contrib/glilypond/glilypond.1.man
+++ b/contrib/glilypond/glilypond.1.man
@@ -1,6 +1,6 @@
.TH glilypond @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
.SH NAME
-glilypond \(em integrate lilypond parts into groff
+glilypond \- integrate lilypond parts into groff
.
.\" This .SH was moved to this place in order to appease `apropos'.
.
@@ -8,13 +8,14 @@ glilypond \(em integrate lilypond parts into groff
.\" Source file position: <groff_source_top>/contrib/glilypond.man
.\" Installed position: <prefix>/share/man/man1/glilypond.1
.
+.\" TODO: This page needs a thorough edit by a native English speaker.
.
.\" --------------------------------------------------------------------
.\" Legalese
.\" --------------------------------------------------------------------
.
.de co
-Copyright \(co 2013-2015 Free Software Foundation, Inc.
+Copyright \[co] 2013\[en]2015 Free Software Foundation, Inc.
Last update: 10 Sep 2015
@@ -26,7 +27,7 @@ General Public License version 2 (GPL2) as published by the
Free
Software Foundation.
The license text is available in the internet at
-.UR http://\%www.gnu.org/\%licenses/\%gpl-2.0.html
+.UR http://\%www.gnu.org/\%licenses/\%gpl\-2.0.html
.UE .
..
.
@@ -46,18 +47,16 @@ Bernd Warken
.el .ds EL \&.\|.\|.\&\"
.\" called with \*(EL
.
-.ad l
-.
.
.\" --------------------------------------------------------------------
.SH SYNOPSIS
.\" --------------------------------------------------------------------
.
.SY glilypond
-.OP \& options
+.OP options
.OP \-
.OP \-\-
-.OP \& "\%filespec \*(EL"
+.OP "\%filespec \*(EL"
.YS
.
.
@@ -107,11 +106,11 @@ devices.
I.e. the following
.B groff
devices work,
-.BR -Tps ,
-.BR -Tdvi ,
-.BR -Thtml ,
+.BR \-Tps ,
+.BR \-Tdvi ,
+.BR \-Thtml ,
and
-.BR -Txhtml .
+.BR \-Txhtml .
.
.
.P
@@ -127,18 +126,18 @@ In
.BR groffer ,
it is easier to use the following device options, either
.
-.BR --ps ,
-.BR --div ,
-.BR --html,
+.BR \-\-ps ,
+.BR \-\-div ,
+.BR \-\-html,
or
-.BR --xhtml .
+.BR \-\-xhtml .
.
.
.P
Unfortunately, the
.B groff
option
-.B -Tpdf
+.B \-Tpdf
does not work and the
.B groffer
default
@@ -159,7 +158,7 @@ It is based on the
in
.B groff
and is called through
-.B groffer --pdf2
+.B groffer \-\-pdf2
.IR roff-file-with-lilypond .
.
.
@@ -238,7 +237,7 @@ So at last, the temporary directory can be removed.
.
.
.TP
-.BR -p | --prefix "\fI begin_of_name\fP"
+.BR \-p | \-\-prefix "\fI begin_of_name\fP"
Normally all temporary files get names that start with the
.BI ly \*(EL
prefix.
@@ -247,7 +246,7 @@ With this option, you can freely change this prefix.
.
.
.TP
-.BR -k | --keep_all
+.BR \-k | \-\-keep_all
Normally all temporary files without the
.I eps
files are deleted.
@@ -258,7 +257,7 @@ program or other format transposers are kept.
.
.
.TP
-.BR -t | --temp_dir "\fI dir\fP"
+.BR \-t | \-\-temp_dir "\fI dir\fP"
With this option, you call a directory that is the base for the
temporary directory.
.
@@ -277,7 +276,7 @@ In this temporary directory, the temporary files are stored.
.\" --------------------------------------------------------------------
.
.TP
-.BR -o | --output "\fI file_name\fP"
+.BR \-o | \-\-output "\fI file_name\fP"
Normally all
.I groff
output of this program is sent to
@@ -289,7 +288,7 @@ into a file named in the option argument
.
.
.TP
-.BR -v | -V | --verbose
+.BR \-v | \-V | \-\-verbose
A lot more of information is sent to STDERR.
.
.
@@ -631,7 +630,7 @@ This process can be changed by command-line options.
.
The temporary directory for this program is either created
automatically or can be named by the option
-.BR -t | --temp_dir
+.BR \-t | \-\-temp_dir
.IR dir .
.
.
@@ -644,7 +643,7 @@ command in the final
.I groff
output can be stored in a different directory that can be set by the
command-line option
-.BR -e | --eps_dir
+.BR \-e | \-\-eps_dir
.IR directory_name .
.
With this option, the temporary directory can be removed completely at
@@ -654,7 +653,7 @@ the end of the program.
.P
The beginning of the names of the temporary files can be set by the
command-line option
-.OP -p | --prefix
+.OP \-p | \-\-prefix
.IR begin_of_name .
.
.
@@ -664,7 +663,7 @@ All of the temporary files except the
files are deleted finally.
.
This can be changed by setting the command-line option
-.OP -k | --keep_files .
+.OP \-k | \-\-keep_files .
.
With this, all temporary files and directories are kept, not deleted.
.
@@ -689,7 +688,7 @@ are needed for the display which can take a long time.
.\" --------------------------------------------------------------------
.
This mode is the actual default and can also be chosen by the option
-.BR --pdf2eps .
+.BR \-\-pdf2eps .
.
.
.P
@@ -787,7 +786,7 @@ But now it does not work any more, so accept the new default
For testing, this mode can also be chosen by the
.B glilypond
option
-.BR --ly2eps .
+.BR \-\-ly2eps .
.
.
.P
@@ -952,3 +951,4 @@ format.
.\" Local Variables:
.\" mode: nroff
.\" End:
+.\" vim: set filetype=groff:
diff --git a/contrib/gperl/gperl.1.man b/contrib/gperl/gperl.1.man
index c411bfe..179304e 100644
--- a/contrib/gperl/gperl.1.man
+++ b/contrib/gperl/gperl.1.man
@@ -10,13 +10,13 @@ gperl \- groff preprocessor for Perl parts in roff files
.
.de au
This file was written by
-.MT address@hidden
+.MT address@hidden
Bernd Warken
.ME .
..
.
.de co
-Copyright \(co 2014 Free Software Foundation, Inc.
+Copyright \[co] 2014 Free Software Foundation, Inc.
.
.P
This file is part of
@@ -27,7 +27,7 @@ a free software project.
.
You can redistribute it and/or modify it under the terms of the
.nh
-.B "GNU General Public License"
+.B GNU General Public License
.hy
as published by the
.nh
@@ -37,7 +37,7 @@ version\~2.
.
.P
The license text is available in the internet at
-.UR http://www.gnu.org/licenses/gpl-2.0.html
+.UR http://www.gnu.org/licenses/gpl\-2.0.html
.UE .
..
.
@@ -66,9 +66,9 @@ The license text is available in the internet at
.OP \& "\%filespec \*(EL"
.YS
.
-.BR "gperl -h" | --help
+.BR "gperl \-h" | \-\-help
.br
-.BR "gperl -v" | --version
+.BR "gperl \-v" | \-\-version
.
.
.\" --------------------------------------------------------------------
@@ -131,13 +131,13 @@ These
options are here
.
.TP
-.B -h\~\fR|\fB\~--help
+.B \-h\~\fR|\fB\~\-\-help
Print help information with a short explanation of options to
standard output.
.
.
.TP
-.B -v\~\fR|\fB\~--version
+.B \-v\~\fR|\fB\~\-\-version
Print version information to standard output.
.
.
@@ -168,9 +168,9 @@ can either be without arguments, or by a request that has
the term
as its only argument.
.RS
.IP \*(BU 2m
-.B \&.Perl
+.B .Perl
.IP \*(BU 2m
-.B \&.Perl start
+.B .Perl start
.RE
.
.
@@ -191,9 +191,9 @@ that's possible, but not necessary.
.
.RS
.IP \*(BU 2m
-.B \&.Perl stop
+.B .Perl stop
.IP \*(BU 2m
-.BI \&.Perl " other_than_start"
+.BI .Perl " other_than_start"
.RE
.
The argument
@@ -288,7 +288,7 @@ generates a
storage line
.RS
.EX
-\&\fB.ds \fIvar_name content
+\fB.ds \fIvar_name content
.EE
.RE
.
@@ -297,7 +297,7 @@ In
the following groff command is generated
.RS
.EX
-\&\fB.nr \fIvar_name content
+\fB.nr \fIvar_name content
.EE
.RE
.
@@ -308,7 +308,7 @@ We present argument collections in the following.
You can add as first argument for all
.BR stop .
.
-We omit this additional element.
+We omit this additional element.
.
.
.P
@@ -460,7 +460,7 @@ with several outputs is:
print \(rqfirst\(rsn\(rq;
print \(rqsecond line\(rsn\(rq;
print \(rq3\(rsn\(rq;
-\&.Perl var1 var2 .nr var3
+\&.Perl var1 var2 .nr var3
.EE
.RE
.
@@ -486,7 +486,7 @@ command lines are created:
.\" --------------------------------------------------------------------
.
.P
-Man\-pages related to
+Man pages related to
.I groff
are
.BR \%groff (@MAN1EXT@),
@@ -521,3 +521,4 @@ are
.\" Local Variables:
.\" mode: nroff
.\" End:
+.\" vim: set filetype=groff:
diff --git a/contrib/gpinyin/gpinyin.1.man b/contrib/gpinyin/gpinyin.1.man
index ebc604f..d0fa341 100644
--- a/contrib/gpinyin/gpinyin.1.man
+++ b/contrib/gpinyin/gpinyin.1.man
@@ -5,12 +5,14 @@ gpinyin \- Chinese European-like writing within groff
.SH "SYNOPSIS"
.\" The .SH was moved to this place in order to appease `apropos'.
.
+.\" TODO: This page needs a thorough edit by a native English speaker.
+.
.\" --------------------------------------------------------------------
.\" Legalese
.\" --------------------------------------------------------------------
.
.de co
-Copyright \(co 2014 Free Software Foundation, Inc.
+Copyright \[co] 2014 Free Software Foundation, Inc.
This file is part of gpinyin, which is part of groff, a free software
project.
@@ -20,12 +22,12 @@ General Public License version 2 as published by the Free
Software
Foundation.
The license text is available in the internet at
-.UR http://www.gnu.org/licenses/gpl-2.0.html
+.UR http://www.gnu.org/licenses/gpl\-2.0.html
.UE .
..
.
.de au
-This file was written by Bernd Warken <address@hidden>.
+This file was written by Bernd Warken <address@hidden>.
..
.
.\" --------------------------------------------------------------------
@@ -46,12 +48,12 @@ This file was written by Bernd Warken <address@hidden>.
.SY gpinyin
.OP \-
.OP \-\-
-.OP \& "\%filespec \*(EL"
+.OP "\%filespec \*(EL"
.YS
.
-.BR "gpinyin -h" | --help
+.BR "gpinyin \-h" | \-\-help
.br
-.BR "gpinyin -v" | --version
+.BR "gpinyin \-v" | \-\-version
.
.
.\" --------------------------------------------------------------------
@@ -88,13 +90,13 @@ The
options are here
.
.TP
-.B -h\~\fR|\fB\~--help
+.B \-h\~\fR|\fB\~\-\-help
Print help information with a short explanation of options to standard
output.
.
.
.TP
-.B -v\~\fR|\fB\~--version
+.B \-v\~\fR|\fB\~\-\-version
Print version information to standard output.
.
.
@@ -194,7 +196,7 @@ ASCII characters in upper and lower case, the only unusual
characters
are the
.BR "U dieresis " ( umlaut )
in both cases, i.e.
-.BR [a-zA-Z��] .
+.BR [a\(enzA\(enZ��] .
.
.
.P
@@ -302,7 +304,7 @@ numbers 0 or 5 must be written.
.BR \%grog (@MAN1EXT@)
.TQ
.BR \%groffer (@MAN1EXT@)
-Man\-pages with section
+Man pages with section
.B 1
related to
.IR groff .
@@ -322,7 +324,7 @@ They can be called with either
.BR \%groff (@MAN7EXT@)
.TQ
.BR \%groff_char (@MAN7EXT@)
-Man\-pages with section
+Man pages with section
.B 7
related to
.IR groff .
@@ -354,9 +356,9 @@ are
.UE ,
.
.br
-.UR http://\:www.sino.uni-heidelberg.de/\:course_resources/\:s02/\:\
-py-vowels.htm
-.I Unicode vowels for Pinyin
+.UR http://\:www.sino.uni\-heidelberg.de/\:course_resources/\:s02/\:\
+py\-vowels.htm
+.I Unicode vowels for Pinyin
.UE ,
.
.br
@@ -412,3 +414,4 @@ py-vowels.htm
.\" mode: nroff
.\" coding: latin-1
.\" End:
+.\" vim: set filetype=groff:
diff --git a/contrib/groff_filenames/groff_filenames.5.man
b/contrib/groff_filenames/groff_filenames.5.man
index 1769d16..e1e7af1 100644
--- a/contrib/groff_filenames/groff_filenames.5.man
+++ b/contrib/groff_filenames/groff_filenames.5.man
@@ -10,9 +10,9 @@ groff_filenames \(em filename extensions for roff and groff
.\" --------------------------------------------------------------------
.
.de co
-Copyright \(co 2013-2015 Free Software Foundation, Inc.
+Copyright \[co] 2013\[en]2015 Free Software Foundation, Inc.
-Last update: 22 Aug 2015
+Last update: 2017-11-02
This file is part of groff, a free software project. You can
redistribute it and/or modify it under the terms of the GNU General
@@ -26,7 +26,7 @@ The license text can be found in the internet at
.
.de au
This file was written by
-.MT address@hidden
+.MT address@hidden
Bernd Warken
.ME .
..
@@ -57,8 +57,9 @@ Later on,
.B groff
added some more extensions.
.
-We will now write a
-.I man\-page about these filename extensions.
+This
+.I man page
+is about these filename extensions.
.
.
.\" --------------------------------------------------------------------
@@ -76,11 +77,11 @@ ends with a
.IR "compressor name" .
.
So the whole filename has the structure
-.IR <name> \f(CB.\fP <extension>[ \f(CB.\fP <compression>] .
+.IR <name> . <extension>[ . <compression>] .
.
.
.P
-Mostly known are the
+Best-known are the
.I compressor extensions
.BR .Z ,
.BR .gz ,
@@ -99,16 +100,16 @@ and only comment the structure
.
.
.\" --------------------------------------------------------------------
-.SH MAN\-PAGES
+.SH MAN PAGES
.\" --------------------------------------------------------------------
.
The
.I Unix manual pages
-are shortly named
-.IR "man\-pages" .
+are widely called
+.IR "man pages" .
.
The
-.I man\-page
+.I man page
style is the best known part of the
.I roff
language.
@@ -130,11 +131,11 @@ language use the following extension:
.
.
.\" --------------------------------------------------------------------
-.SS Man-page Sections
+.SS Man page Sections
.\" --------------------------------------------------------------------
.
The traditional
-.I man\-page <section>
+.I man page <section>
is a digit from
.B 1
to
@@ -157,22 +158,24 @@ to
.IB <name> .7
.TQ
.IB <name> .8
-Classic man\-page
+Classic man page
.IR sections .
.
.
.P
-Linux added the section number
-.B 9
-for kernel man\-pages.
-.
-.
-.TP
-.IB <name> .9
-.I Linux
-kernel man-pages
-.
-.
+.\" NOTE: There was once a feeble attempt in this direction, but it
+.\" hasn't been true in any sense for a long time.
+.\"Linux added the section number
+.\".B 9
+.\"for kernel man pages.
+.\".
+.\".
+.\".TP
+.\".IB <name> .9
+.\".I Linux
+.\"kernel man pages
+.\".
+.\".
.P
In older commercial
.I Unix
@@ -197,12 +200,12 @@ but there are still documents in this format.
.TQ
.IB <name> .o
.I Deprecated
-old
-.IR "man\-page sections" .
+man page sections, which stood for \[lq]local[rq], \[lq]new\[rq], and
+\[lq]old\[rq], respectively.
.
.
.\" --------------------------------------------------------------------
-.SS Man\-page Group Extensions
+.SS Man page Group Extensions
.\" --------------------------------------------------------------------
.
The
@@ -228,7 +231,7 @@ Examples:
.
.TP
.B groff.1
-is the man-page for
+is the man page for
.B groff
in
.I section
@@ -239,7 +242,7 @@ without a
.
.TP
.B xargs.1posix.gz
-is the man\-page for the program
+is the man page for the program
.B xargs
in
.I section
@@ -266,8 +269,8 @@ with
.
.
.TP
-.B dpkg-reconfigure.8cdebconf
-man\-page for the program
+.B dpkg\-reconfigure.8cdebconf
+man page for the program
.B dpkg\-reconfigure
in
.I section
@@ -278,12 +281,12 @@ and
.
.
.\" --------------------------------------------------------------------
-.SS Source of Man\-pages
+.SS Source of man pages
.\" --------------------------------------------------------------------
.
There are 2
.I roff
-languages for writing man\-pages:
+languages for writing man pages:
.B man
and
.BR mdoc .
@@ -292,7 +295,7 @@ and
.P
The names of these 2 styles are taken as
.I extensions
-for the source code files of man\-pages in the
+for the source code files of man pages in the
.I groff
package.
.
@@ -300,14 +303,14 @@ package.
.TP
.IB <name> .man
.I traditional
-Unix\-like man\-page format within groff source files.
+Unix-like man page format within groff source files.
.
.
.TP
-.IB <name> .n
-A temporary man-page file produced from a
+.IB <name> . n
+A temporary man page file produced from a
.IB name .man
-man\-page by a run of
+man page by a run of
.B make
within the
.B groff
@@ -316,18 +319,18 @@ source package.
.
.TP
.IB <name> .mdoc
-Man-page format in BSD.
+Man page format in BSD.
.
.
.TP
.IB <name> .1b
-Man-page format in
+Man page format in
.IR "heirloom roff ".
.
.
.TP
.IB <name> .mandoc
-Files using this extension recognize both man\-page formats in
+Files using this extension recognize both man page formats in
.B groff
and other processors.
.
@@ -554,7 +557,7 @@ files written in the
.TP
.IB <name> .www
files written in
-.BR HTML \-like
+.BR HTML -like
.I groff
.IR macros .
.
@@ -565,9 +568,8 @@ files written in
.
.TP
.IB <name> .hdtbl
-a new
-.I tbl
-format.
+Heidelberger tables, an alternative to the preprocessor
+.IR tbl .
.
See
.BR groff_hdtbl (@MAN7EXT@).
@@ -590,7 +592,7 @@ pictures, see
.
.TP
.IB <name> .pdfroff
-ransform this file with
+transform this file with
.B pdfroff
of the
.I groff
@@ -619,7 +621,7 @@ History and future
.
.
.P
-A man-page of the naming form
+A man page of the naming form
.IB name ( n )
can be read in text mode by
.RS
@@ -665,3 +667,4 @@ You can get this package with the shell command:
.\" Local Variables:
.\" mode: nroff
.\" End:
+.\" vim: set filetype=groff:
diff --git a/contrib/mom/groff_mom.7.man b/contrib/mom/groff_mom.7.man
index 186152a..b5da0a0 100644
--- a/contrib/mom/groff_mom.7.man
+++ b/contrib/mom/groff_mom.7.man
@@ -1,6 +1,6 @@
.TH GROFF_MOM @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
.SH NAME
-groff_mom \- groff `mom' macros, `mom' is a `roff' language, part of `groff'
+groff_mom \- groff `mom' macros; `mom' is a `roff' language, part of `groff'
.
.\" The .SH was moved to this place in order to appease `apropos'.
.
@@ -14,7 +14,7 @@ groff_mom \- groff `mom' macros, `mom' is a `roff' language,
part of `groff'
.\" --------------------------------------------------------------------
.
.de co
-Copyright \[co] 2002-2017 Free Software Foundation, Inc.
+Copyright \[co] 2002\[en]2017 Free Software Foundation, Inc.
This file is part of groff, a free software project.
@@ -27,8 +27,8 @@ You should have received a copy of the GNU General Public
License
along with groff, see the files COPYING and LICENSE in the top
directory of the groff Text source package.
-Or read the manpage
-.BR gpl (1).
+Or read the man page
+.BR gpl (7).
You can also visit <http://www.gnu.org/licenses/>.
..
.
@@ -48,7 +48,7 @@ Deri James
.ME .
The alphabetical documentation of macros and escape seqauences in this
-man\-page were written by the
+man page were written by the
.I mom
team.
..
@@ -229,7 +229,7 @@ usage.
\[en] entry point to the HTML documentation
.
.TP
-.B address@hidden@/\:mom-pdf.pdf
+.B address@hidden@/\:mom\-pdf.pdf
\[en] the PDF manual,
.I Producing PDFs with groff and mom
.
@@ -243,7 +243,7 @@ usage.
.\" --------------------------------------------------------------------
.
.
-This part of the man-page contains information just as in groff(7),
+This part of the man page contains information just as in groff(7),
.I mom macros
and
.I mom escape sequences
@@ -276,7 +276,7 @@ But, so far, we took all documentation details from the
file, just in a more useful alphabetical order.
.
.
-So this part of the man-page is nothing new, but only a logical
+So this part of the man page is nothing new, but only a logical
arrangement.
.
.
@@ -3416,3 +3416,4 @@ or directly to the authors.
.\" Local Variables:
.\" mode: nroff
.\" End:
+.\" vim: set filetype=groff:
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 399b445..d5b41cb 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -14,12 +14,12 @@ groff_diff \- differences between GNU troff and classical
troff
.
.
.de co
-Copyright \[co] 1989-2014 Free Software Foundation, Inc.
+Copyright \[co] 1989\[en]2014 Free Software Foundation, Inc.
.
.P
This file is part of groff, the GNU roff type-setting system.
.
-It is the source of the man-page groff_diff(7).
+It is the source of the man page groff_diff(7).
.P
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -944,7 +944,7 @@ sets register\~\c
.B n
to\~1.
.
-Note that glyph information (font, font size, etc.\&) is not preserved;
+Note that glyph information (font, font size, etc.) is not preserved;
use
.B .unformat
instead.
@@ -2423,7 +2423,7 @@ are stretchable again.
.
Note that the vertical size of lines is not preserved.
.
-Glyph information (font, font size, space width, etc.\&) is retained.
+Glyph information (font, font size, space width, etc.) is retained.
.
Useful in conjunction with the
.B box
@@ -3846,8 +3846,8 @@ With
.I GNU troff
this is printed as
.BR \[rs]\[rs] .
-So each pair of input backslashes \&\[oq]\[rs]\[rs]\[cq] is turned
-into a single output backslash glyph \&\[oq]\[rs]\[cq] and the
+So each pair of input backslashes \[oq]\[rs]\[rs]\[cq] is turned
+into a single output backslash glyph \[oq]\[rs]\[cq] and the
resulting output backslashes are not interpreted as escape characters
when they are reread.
.
@@ -3953,7 +3953,7 @@ by
of 1976 in the revision of
.I Brian Kernighan
of 1992, being the
-.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:54.ps.gz
+.UR http://\:cm.bell\-labs.com/\:cm/\:cs/\:cstr/\:54.ps.gz
classical troff documentation
.UE .
.
@@ -3978,3 +3978,4 @@ classical troff documentation
.\" Local Variables:
.\" mode: nroff
.\" End:
+.\" vim: set filetype=groff:
diff --git a/man/groff_out.5.man b/man/groff_out.5.man
index dd2e45c..a267fec 100644
--- a/man/groff_out.5.man
+++ b/man/groff_out.5.man
@@ -18,7 +18,7 @@ groff_out \- groff intermediate output format
.\" --------------------------------------------------------------------
.
.de co
-Copyright \[co] 1989-2014 Free Software Foundation, Inc.
+Copyright \[co] 1989\[en]2014 Free Software Foundation, Inc.
This file is part of groff, the GNU roff type-setting system, which is
a free software project.
@@ -1866,7 +1866,7 @@ refers to a manual page; here
.B groff
in section\~\c
.I @MAN7EXT@
-of the man-page documentation system.
+of the man page documentation system.
.
To read the example, look up address@hidden@ in your desktop help
system or call from the shell prompt
@@ -1963,7 +1963,7 @@ or from the shell prompt by
The
.I classical troff output language
is described in two AT&T Bell Labs CSTR documents available on-line at
-.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr.html
+.UR http://\:cm.bell\-labs.com/\:cm/\:cs/\:cstr.html
Bell Labs CSTR site
.UE .
.
@@ -1975,7 +1975,7 @@ by
.I Brian Kernighan
is the original and most comprehensive documentation on the output
language; see
-.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:97.ps.gz
+.UR http://\:cm.bell\-labs.com/\:cm/\:cs/\:cstr/\:97.ps.gz
CSTR\~#97
.UE .
.
@@ -1991,7 +1991,7 @@ and
isn't as comprehensive as
.I [CSTR\~#97]
regarding the output language; see
-.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:54.ps.gz
+.UR http://\:cm.bell\-labs.com/\:cm/\:cs/\:cstr/\:54.ps.gz
CSTR\~#54
.UE .
.
@@ -2016,3 +2016,4 @@ CSTR\~#54
.\" Local Variables:
.\" mode: nroff
.\" End:
+.\" vim: set filetype=groff:
diff --git a/man/roff.7.man b/man/roff.7.man
index e95c43f..3452b37 100644
--- a/man/roff.7.man
+++ b/man/roff.7.man
@@ -3,7 +3,7 @@
.SH NAME
roff \- concepts and history of roff typesetting
.
-.\" this is man-page roff.7
+.\" this is the man page roff.7
.
.
.do nr groff_C \n[.C]
@@ -15,7 +15,7 @@ roff \- concepts and history of roff typesetting
.\" --------------------------------------------------------------------
.
.de co
-Copyright \[co] 2000-2014 Free Software Foundation, Inc.
+Copyright \[co] 2000\[en]2014 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the FDL (GNU Free Documentation License) Version
@@ -33,7 +33,7 @@ GNU copyleft site
..
.
.de au
-This man-page was written by
+This man page was written by
.MT address@hidden
Bernd Warken
.ME
@@ -419,7 +419,7 @@ is free.
.
This makes
.I groff
-the de-facto
+the de facto
.I roff
standard today.
.
@@ -429,7 +429,7 @@ standard today.
.\" --------------------------------------------------------------------
.
An alternative is
-.UR https://\:github.com/\:n-t-roff/\:heirloom-doctools
+.UR https://\:github.com/\:n\-t\-roff/\:heirloom\-doctools
.I Gunnar Ritter's Heirloom roff project
.UE
project, started in 2005, which provides enhanced versions of the various
@@ -439,14 +439,14 @@ available under free licenses.
You can get this package with the shell command:
.RS
.EX
-\[Do] git clone https://github.com/n-t-roff/heirloom-doctools
+\[Do] git clone https://github.com/n\-t\-roff/heirloom\-doctools
.EE
.RE
.
.
.P
Moreover, one finds there the
-.UR https://github.com/n-t-roff/DWB3.3
+.UR https://github.com/n\-t\-roff/DWB3.3
.I Original Documenter's Workbench Release 3.3
.UE .
.
@@ -1018,7 +1018,7 @@ This mode can be activated by the following methods.
.
.P
When editing a file within Emacs the mode can be changed by typing
-.RI \[oq] "M-x nroff-mode" \[cq],
+.RI \[oq] "M-x nroff\-mode" \[cq],
where
.B M-x
means to hold down the
@@ -1059,7 +1059,7 @@ Theoretically, it is possible to write the sequence
.RS
.IP
.EX
-\&.\[rs]" \%-*-\ nroff\ -*-\""
+\&.\[rs]" \%\-*\-\ nroff\ \-*\-\""
.EE
.RE
.
@@ -1201,13 +1201,13 @@ provides the source code and some binaries of the
ancient Unixes
.I troff
and its documentation) that were made public by Caldera since 2001,
e.g.\& of the famous Unix version\~7 for PDP-11 at the
-.UR http://\:www.tuhs.org/\:Archive/\:PDP-11/\:Trees/\:V7
+.UR http://\:www.tuhs.org/\:Archive/\:PDP\-11/\:Trees/\:V7
Unix V7 site
.UE .
.
.TP
Developers at AT&T Bell Labs
-.UR http://\:www.bell-labs.com/
+.UR http://\:www.bell\-labs.com/
Bell Labs Computing and Mathematical Sciences Research
.UE
.
@@ -1216,7 +1216,7 @@ developers.
.
.TP
Plan 9
-.UR http://\:plan9.bell-labs.com
+.UR http://\:plan9.bell\-labs.com
The Plan\~9 operating system
.UE
.
@@ -1232,7 +1232,7 @@ stores some documents using the ancient RUNOFF formatting
language.
.
.TP
CSTR Papers
-.UR https://\:www.alcatel-lucent.com/\:bell-labs-journals
+.UR https://\:www.alcatel\-lucent.com/\:bell\-labs\-journals
The Bell Labs (now Alcatel) CSTR site
.UE
.
@@ -1278,7 +1278,7 @@ Bell Labs, 1976; revised by Brian Kernighan, 1992.
.TP
[CSTR\~#97]
Brian Kernighan,
-.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:97.ps.gz
+.UR http://\:cm.bell\-labs.com/\:cm/\:cs/\:cstr/\:97.ps.gz
.I "A Typesetter-independent TROFF"
.UE ,
.
@@ -1292,7 +1292,7 @@ papers are
.TP
[CSTR\~#114]
Jon L.\& Bentley and Brian W.\& Kernighan,
-.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:114.ps.gz
+.UR http://\:cm.bell\-labs.com/\:cm/\:cs/\:cstr/\:114.ps.gz
.I "GRAP \[en] A Language for Typesetting Graphs"
.UE ;
.
@@ -1301,7 +1301,7 @@ Bell Labs, August 1984.
.TP
[CSTR\~#116]
Brian W.\& Kernighan,
-.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:116.ps.gz
+.UR http://\:cm.bell\-labs.com/\:cm/\:cs/\:cstr/\:116.ps.gz
.I "PIC \[en] A Graphics Language for Typesetting"
.UE ;
.
@@ -1310,7 +1310,7 @@ Bell Labs, December 1984.
.TP
[CSTR\~#122]
J.\& L.\& Bentley, L.\& W.\& Jelinski, and B.\& W.\& Kernighan,
-.UR http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:122.ps.gz
+.UR http://\:cm.bell\-labs.com/\:cm/\:cs/\:cstr/\:122.ps.gz
.I "CHEM \[en] A Program for Typesetting Chemical Structure Diagrams,"
.I "Computers and Chemistry"
.UE ;
@@ -1384,3 +1384,4 @@ might be a good starting point.
.\" Local Variables:
.\" mode: nroff
.\" End:
+.\" vim: set filetype=groff:
diff --git a/src/devices/grolj4/lj4_font.5.man
b/src/devices/grolj4/lj4_font.5.man
index 6766876..0ac0c7c 100644
--- a/src/devices/grolj4/lj4_font.5.man
+++ b/src/devices/grolj4/lj4_font.5.man
@@ -6,7 +6,7 @@ lj4_font \- groff fonts for use with devlj4
.
.\" license
.de co
-Copyright \(co 2004-2014 Free Software Foundation, Inc.
+Copyright \[co] 2004\[en]2014 Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
@@ -223,3 +223,4 @@ Font description file for font
.\" Local Variables:
.\" mode: nroff
.\" End:
+.\" vim: set filetype=groff:
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index d7e2d94..8a35a82 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -17,7 +17,7 @@ groff \- front-end for the groff document formatting system
.de co
Copyright \[co] 1989-2014 Free Software Foundation, Inc.
-Rewritten in 2002 by Bernd Warken <address@hidden>
+Rewritten in 2002 by Bernd Warken <address@hidden>
This document is part of groff, a free GNU software project.
@@ -46,7 +46,7 @@ James Clark
.UE .
.
It was rewritten, enhanced, and put under the FDL license by
-Bernd Warken <address@hidden>.
+Bernd Warken <address@hidden>.
.
It is maintained by
.MT address@hidden
@@ -551,13 +551,13 @@ as the \[oq]postprocessor\[cq] (it is rather a viewing
program):
X75
75\|dpi resolution, 10\|pt document base font.
.TP
-X75-12
+X75\-12
75\|dpi resolution, 12\|pt document base font.
.TP
X100
100\|dpi resolution, 10\|pt document base font.
.TP
-X100-12
+X100\-12
100\|dpi resolution, 12\|pt document base font.
.RE
.RE
@@ -622,10 +622,10 @@ action and the corresponding menu entry to that value.
only produces good results with
.BR \-Tps ,
.BR \-TX75 ,
-.BR \-TX75-12 ,
+.BR \-TX75\-12 ,
.BR \-TX100 ,
and
-.BR \-TX100-12 .
+.BR \-TX100\-12 .
.
The default resolution for previewing
.B \-Tps
@@ -638,7 +638,7 @@ for example
.RS
.IP
.EX
-groff \-X \-P-resolution \-P100 \-man foo.1
+groff \-X \-P\-resolution \-P100 \-man foo.1
.EE
.RE
.
@@ -849,7 +849,7 @@ A4 paper in landscape orientation for the PS device:
.
.IP
.EX
-groff \-Tps \-P-pa4 \-P-l ...
+groff \-Tps \-P\-pa4 \-P\-l ...
.EE
.
.
@@ -883,7 +883,7 @@ command line to format a file.
.P
The
.BR \%groffer (@MAN1EXT@)
-program is an allround-viewer for
+program is an all-around viewer for
.I groff
files and man pages.
.
@@ -1251,7 +1251,7 @@ for printers compatible to the HP LaserJet\~4 and PCL5,
.TP
.BR \%grotty (@MAN1EXT@)
for text output using various encodings, e.g., on text-oriented
-terminals or line-printers.
+terminals or line printers.
.
.
.P
@@ -1539,7 +1539,7 @@ If this is not set but the environment variable
instead, temporary files are created in the directory
.EnvVar $TMPDIR .
.
-On MS-DOS and Windows\~32 platforms, the environment variables
+On MS-DOS and Windows platforms, the environment variables
.EnvVar TMP
and
.EnvVar TEMP
@@ -1769,7 +1769,7 @@ before reading the macro sets and any input.
.
.
.TP
-.B troffrc-end
+.B troffrc\-end
Final startup file for
.IR troff .
.
@@ -1904,22 +1904,22 @@ or
.
.P
But there are special sections of
-.IR man-pages .
+.IR "man pages" .
.
.I groff
-has man\-pages in sections
+has man pages in sections
.BR 1 , " 5" , and " 7" .
.
When there are several
-.I man\-pages
+.I man pages
with the same name in the same
.I man
section, the one with the lowest section is should as first.
.
-The other man\-pages can be shown anyway by adding the section number
-as argument before the man-page name.
+The other man pages can be shown anyway by adding the section number
+as argument before the man page name.
.
-Reading the man-page about the
+Reading the man page about the
.I groff
language is done by one of
.RS
@@ -2042,3 +2042,4 @@ The following utilities are available:
.\" Local Variables:
.\" mode: nroff
.\" End:
+.\" vim: set filetype=groff:
diff --git a/src/roff/grog/grog.1.man b/src/roff/grog/grog.1.man
index 9c2a78c..a45cc1e 100644
--- a/src/roff/grog/grog.1.man
+++ b/src/roff/grog/grog.1.man
@@ -1,18 +1,20 @@
.TH GROG @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
.SH NAME
-grog \(em guess options for a following groff command
+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
.\" Installed position: <prefix>/share/man/man1/grog.1
.
+.\" TODO: This page needs a thorough edit by a native English speaker.
+.
.\" --------------------------------------------------------------------
.\" Legalese
.\" --------------------------------------------------------------------
.
.de co
-Copyright \(co 1989-2015 Free Software Foundation, Inc.
+Copyright \[co] 1989\[en]2015 Free Software Foundation, Inc.
Last update: 29 Jul 2015
@@ -26,7 +28,7 @@ ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.
The text for GPL2 is available in the internet at
-.UR http://\:www.gnu.org/\:licenses/\:gpl-2.0.txt
+.UR http://\:www.gnu.org/\:licenses/\:gpl\-2.0.txt
GNU copyleft site
.UE .
..
@@ -64,10 +66,10 @@ Bernd Warken
.OP \-\-run
.OP \-\-warnings
.OP \-\-ligatures
-.OP \& "\%groff\-option no arg"
-.OP \& "\%groff\-option with arg \*(EL"
+.OP "\%groff\-option no arg"
+.OP "\%groff\-option with arg \*(EL"
.OP \-\-
-.OP \& "\%filespec \*(EL"
+.OP "\%filespec \*(EL"
.YS
.
.BR "grog \-h " | " \-\-help"
@@ -88,9 +90,9 @@ options are needed to perform the input with the
program.
.
A suitable device is now always written as
-.BI -T device
+.BI \-T device
including the groff default as
-.BR "-T ps" .
+.BR "\-T ps" .
.
.
.P
@@ -150,7 +152,7 @@ command line.
.TP
.B \-\-ligatures
this option forces to include the arguments
-.B -P-y -PU
+.B \-P\-y \-PU
within the generated
.B groff
command line.
@@ -220,7 +222,7 @@ options are required for running the input under
(preprocessors); and
.BR \-man ,
.BR \-mdoc,
-.BR \-mdoc-old,
+.BR \-mdoc\-old,
.BR \-me ,
.BR \-mm ,
.BR \-mom ,
@@ -464,7 +466,7 @@ this file does not use a macro package.
.BR @address@hidden (@MAN1EXT@)
.
.RS
-Man-pages of section 1 can be viewed with either
+Man pages in section 1 can be viewed with either
.RS
\(Do
.BI man " name"
@@ -486,7 +488,7 @@ for graphical mode (default is PDF mode).
.BR groff_man (@MAN7EXT@)
.
.RS
-Man-pages of section 7 can be viewed with either with
+Man pages in section 7 can be viewed with either with
.RS
\(Do
.BI "man 7 " name
@@ -517,3 +519,4 @@ for graphical mode (default is PDF mode).
.\" Local Variables:
.\" mode: nroff
.\" End:
+.\" vim: set filetype=groff:
diff --git a/src/utils/addftinfo/addftinfo.1.man
b/src/utils/addftinfo/addftinfo.1.man
index 074deaf..3ed1e6e 100644
--- a/src/utils/addftinfo/addftinfo.1.man
+++ b/src/utils/addftinfo/addftinfo.1.man
@@ -8,7 +8,7 @@ addftinfo \- add information to troff font files for use with
groff
.\" --------------------------------------------------------------------
.
.de co
-Copyright \(co 1989-2014 Free Software Foundation, Inc.
+Copyright \[co] 1989\[en]2014 Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
@@ -160,7 +160,7 @@ font.
.
.
.P
-Watch a man\-page
+You can view a man page
.IB name ( n )
with
.RS
@@ -186,3 +186,4 @@ in graphical mode (PDF, etc.).
.\" Local Variables:
.\" mode: nroff
.\" End:
+.\" vim: set filetype=groff:
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 02/03: Clean up miscellaneous man page problems.,
G. Branden Robinson <=