[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/01: groff(1): Recast installation directory material.
From: |
G. Branden Robinson |
Subject: |
[groff] 01/01: groff(1): Recast installation directory material. |
Date: |
Tue, 11 Dec 2018 07:50:09 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit 26be5ad7beb96a9f06eee6e620080d8114d6ce49
Author: G. Branden Robinson <address@hidden>
Date: Tue Dec 11 07:01:49 2018 -0500
groff(1): Recast installation directory material.
src/roff/groff/groff.1.man:
* Retitle section per Bertrand. I chose "Installation Directories" over
the existing "Positions from Installation".
* Kill off outdated reference to Makefile.comm.
* Resync list with the variables in Makefile.am that we makevarescape.
* The list is now collated by the order of the Makefile variable
names, which is pretty feeble (and totally opaque to the reader), but
there doesn't seem to be a better sort order given that the items'
expansions are under the control of the person running the configure
script.
doc/groff.texi:
* Update reference to aforementioned section of groff(1).
* Make style fixes while I'm here.
+ Use TeX quotation marks around section name, not ASCII 34s.
+ Capitalize HTML and PDF.
+ Tag HTML as an "acronym" for consistency with the rest of the
Texinfo manual.
- That's not an acronym, it's an initialism; you don't pronounce it
"hitmul", you simply utter the names of the letters.
+ ...but don't tag PDF, for consistency with the rest of the
Texinfo manual.
- This is, however, an absurd pattern for the manual to follow. We
should fix it later.
+ "manual page", "manpage" -> "man page", for consistency with the
rest of the Texinfo manual.
+ Tag "groff(1)" as a @cite{}, just as other man page references,
including "groff_mom(7)" immediately below, are.
Signed-off-by: G. Branden Robinson <address@hidden>
---
doc/groff.texi | 15 +++---
src/roff/groff/groff.1.man | 131 ++++++++++++++++++++++++++++-----------------
2 files changed, 88 insertions(+), 58 deletions(-)
diff --git a/doc/groff.texi b/doc/groff.texi
index 8ec0a5e..f8396da 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -4649,10 +4649,10 @@ command line).
@c XXX documentation
@c XXX this is a placeholder until we get stuff knocked into shape
-The main documentation files for the @file{mom} macros are in html
-format. Additional, useful documentation is in pdf format. See the
-groff(1) manpage "Collection of Installation Directories" for their
-location.
+The main documentation files for the @file{mom} macros are in
address@hidden format. Additional, useful documentation is in PDF
+format. See the @cite{groff(1)} man page, section ``Installation
+Directories'', for their location.
@itemize @bullet
@item
@@ -4676,10 +4676,9 @@ The mom macros are in active development between groff
releases.
The most recent version, along with up-to-date documentation, is
available at @uref{http://www.schaffter.ca/mom/mom-05.html}.
-The @cite{groff_mom(7)} manual page (type @command{man groff_mom}
-at the command line) contains a partial list of available macros,
-however their usage is best understood by consulting the html
-documentation.
+The @cite{groff_mom(7)} man page (type @command{man groff_mom} at the
+command line) contains a partial list of available macros, however their
+usage is best understood by consulting the @acronym{HTML} documentation.
@c =====================================================================
@c =====================================================================
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index 945f8c4..3c98076 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -1625,79 +1625,110 @@ is not available on \f[CR]ASCII\f[] based operating
systems.
.
.
.\" ====================================================================
-.SH "POSITIONS FROM INSTALLATION"
+.SH "INSTALLATION DIRECTORIES"
.\" ====================================================================
.
-There are some directories in which
.I groff
-installs all of its data files.
+installs files in varying locations depending on its compile-time
+configuration.
.
-Due to different installation habits on different operating systems,
-their locations are not absolutely fixed, but their function is
-clearly defined and coincides on all systems.
+On this installation, the following locations are used.
.
.
-.\" ====================================================================
-.SS "Collection of Installation Directories"
-.\" ====================================================================
-.
-This section describes the position of all files of the
-.I groff
-package after the installation \[em] got from
-.B Makefile.comm
-at the top of the
-.I groff
-source package.
+.TP
+.I @APPRESDIR@
+Application defaults directory for
+.IR gxditview (@MAN1EXT@).
.
.
.TP
-.B @DEFAULT_INDEX@
-index directory and index name
-.TP
-.B @LEGACYFONTDIR@
-legacy font directory
+.I @BINDIR@
+Directory containing
+.IR groff 's
+executable commands.
+.
+.
.TP
-.B @BINDIR@
-directory for binary programs
+.I @COMMON_WORDS_FILE@
+List of common words for
+.IR indxbib (@MAN1EXT@).
+.
+.
.TP
-.B @SYSTEMMACRODIR@
-system tmac directory
+.I @DATASUBDIR@
+Directory for data files.
+.
+.
.TP
-.B @DOCDIR@
-documentation directory
+.I @DEFAULT_INDEX@
+Default index for
+.IR lkbib (@MAN1EXT@)
+and
+.IR refer (@MAN1EXT@).
+.
+.
.TP
-.B @EXAMPLEDIR@
-directory for examples
+.I @DOCDIR@
+Documentation directory.
+.
+.
.TP
-.B @HTMLDOCDIR@
-documentation directory for HTML files
+.I @EXAMPLEDIR@
+Example directory.
+.
+.
.TP
-.B @PDFDOCDIR@
-documentation directory for PDF files
+.I @FONTDIR@
+Font directory.
+.
+.
.TP
-.B @DATASUBDIR@
-data subdirectory
+.I @HTMLDOCDIR@
+HTML documentation directory.
+.
+.
.TP
-.B @COMMON_WORDS_FILE@
-file for common words
+.I @LEGACYFONTDIR@
+Legacy font directory.
+.
+.
.TP
-.B @FONTDIR@
-directory for fonts
+.I @LOCALFONTDIR@
+Local font directory.
+.
+.
.TP
-.B @OLDFONTDIR@
-directory for old fonts
+.I @LOCALMACRODIR@
+Local macro package
+.RI ( tmac
+file) directory.
+.
+.
.TP
-.B @MACRODIR@
-tmac directory
+.I @MACRODIR@
+Macro package
+.RI ( tmac
+file) directory.
+.
+.
.TP
-.B @TMAC_MDIR@
-mm tmac directory
+.I @OLDFONTDIR@
+Font directory for compatibility with old versions of
+.IR groff ;
+see
+.IR grops (@MAN1EXT@).
+.
+.
.TP
-.B @LOCALFONTDIR@
-local font directory
+.I @PDFDOCDIR@
+PDF documentation directory.
+.
+.
.TP
-.B @LOCALMACRODIR@
-local tmac directory
+.I @SYSTEMMACRODIR@
+System macro package
+.RI ( tmac
+file) directory.
.
.
.\" ====================================================================
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 01/01: groff(1): Recast installation directory material.,
G. Branden Robinson <=