[groff] 08/08: gxditview(1): Update.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit e56139aa610933264cedc62496ade44a3c18810f
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Sep 15 20:36:22 2020 +1000

    gxditview(1): Update.
    
    * Stop marking file operand as optional in synopsis; it's not, as the
      description already indicates.
    * Remove claim that the program can view intermediate output for "all"
      devices.  Note that the program does not work to preview nroff
      documents.  While it's not necessary (any environment that has an X
      display will have a terminal emulator), I found it a little
      surprising.
    * Remove advice to call groff with -rS12 option when viewing man pages
      with a 12-point output device.  The macro package now takes care of
      this (f637d03dceb0b7004e8c5eff3a7607183cb45b1e, 14 September).
    * Add cross-reference to groff_font(5) when discussing the DESC file.
    * Mention the correct name for (old/core/server-side) font identifiers:
      XFLDs.  Expand initialism.  Add cross-reference to defining document
      in "See Also" section.
    * Split the default groff to X11 font map into its own subsection.
      XLFDs are so unreasonably long that they are a huge pain to typeset.
      Somewhere between XLFDs and Ken Thompson lies the Golden Mean.
    
    And make the usual battery of style fixes...
    
    * Coalesce "Origin" section into "Authors".
    * Demote "X Defaults" from a section to a subsection, and put it in
      sentence case.
    * Expand abbreviations "dpi" and "pt".
    * Use .EX/.EE to set examples.
    * Put a space between a repeatable optional parameter and its ellipsis.
    * Stop setting the phrase "intermediate output" in italics.
    * Set program names and man page topics in italics, not bold.
    * Quote multi-word inline examples.
    * Break input lines after commas, colons, and semicolons.
    * Use \~ escape instead of \<space> in macro calls.
    * Stop protecting words that won't hyphenate from hyphenation
      (gxditview, ...
    * Unflatten adverb; "firstly", not "first", goes with "secondly".
    * Tighten wording.
---
 src/devices/xditview/gxditview.1.man | 460 ++++++++++++++++++++---------------
 1 file changed, 258 insertions(+), 202 deletions(-)

diff --git a/src/devices/xditview/gxditview.1.man 
b/src/devices/xditview/gxditview.1.man
index 298604c..4698f45 100644
--- a/src/devices/xditview/gxditview.1.man
+++ b/src/devices/xditview/gxditview.1.man
@@ -39,13 +39,13 @@ gxditview \- display groff intermediate output files
 .\" ====================================================================
 .
 .SY gxditview
-.RI [ X-toolkit-option \&.\|.\|.\&]
+.RI [ X-toolkit-option \~.\|.\|.\&]
 .OP \-backingStore backing-store-type
 .OP \-filename string
 .OP \-page n
 .OP \-printCommand string
 .OP \-resolution res
-.RI [ file ]
+.I file
 .YS
 .
 .
@@ -61,161 +61,166 @@ gxditview \- display groff intermediate output files
 .SH Description
 .\" ====================================================================
 .
-The
-.B \%gxditview
-program displays the
-.I groff intermediate
-.IR output ,
-see
-.BR groff_out (@MAN5EXT@),
-on an X\~display.
+.I gxditview
+interprets and displays the intermediate output format of
+.IR groff (@MAN1EXT@)
+on an X11\~display.
 .
-It uses the standard X11 fonts, so it does not require access to the
-server machine for font loading.
+It uses the standard X11 fonts,
+so it does not require access to the server machine for font loading.
 .
 There are several ways to use
-.BR \%gxditview .
+.IR gxditview .
 .
 .
 .PP
 The
-.I groff intermediate output
-can be generated by
-.BR groff\~\-Z .
-This can be viewed by explicitly calling
-.B \%gxditview
-.IR \%filename .
-.
-If
-.I filename
-is
-.BR \- ,
-.B \%gxditview
-will read the standard input;
-.I \%filename
+intermediate output format of
+.IR groff,
+documented in
+.IR groff_out (@MAN5EXT@),
+is produced by
+.IR @g@troff
+or the
+.B \-Z
+option to
+.IR groff .
+.
+.
+It can be viewed by explicitly calling
+.RB \[lq] gxditview
+.IR file \[rq].
+.
+If the
+.I file
+operand is
+.RB \[lq] \- \[rq],
+.I gxditview
+will read the standard input stream;
+.I file
 cannot be omitted.
 .
-The
-.I groff intermediate output
-is different for all devices.
+The intermediate output format of
+.I groff
+is device-independent but not device-agnostic.
 .
-.B \%gxditview
-can view it for all devices, but the quality is device dependent.
+.I gxditview
+can view it for all typesetter devices;
+that is,
+it will not display output for terminal
+.RI ( nroff )
+devices,
+but the quality is device-dependent.
 .
 .
 .PP
 The best results are achieved with the
 .BR X *
 devices for
-.BR groff 's
-option
-.BR \-T .
-.
-There are four
-.BR X *
-devices:
+.IR groff 's
+.B \-T
+option,
+of which there are four:
 .BR \%\-TX75 ,
 .BR \%\-TX75\-12 ,
 .BR \%\-TX100 ,
+and
 .BR \%\-TX100\-12 .
+.
 They differ by the X\~resolution
-(75dpi or 100dpi)
-and the used base font
-size (10pt or 12pt).
+(75 or 100 dots per inch)
+and the base point size
+(10 or 12 points).
 .
 They are especially built for
-.BR \%gxditview .
+.IR gxditview .
 .
 When using one of them
-.B groff
-generates the
-.I intermediate output
-for this device and calls
-.B \%gxditview
+.I groff
+generates the intermediate output for this device and calls
+.I gxditview
 automatically for viewing.
 .
-For example, to view this man page with a base resolution of 12pt, say
-.
-.IP
-.B groff \-TX100\-12 \-man \-rS12 gxditview.@MAN1EXT@
-.
+For example,
+the following command views this man page with a base point size of 12.
 .
 .PP
-(option
-.BI \-rS XX
-is documented in the
-.BR groff_man (@MAN7EXT@)
-man page).
+.RS
+.EX
+groff \-TX100\-12 \-man gxditview
+.EE
+.RE
 .
 .
 .PP
-.BR groff 's
-option
-.B \-X
-produces
-.I intermediate output
-for the
-.I PostScript
-device and subsequently uses
-.B \%gxditview
-as a viewer for it.
-.
 The quality of the result depends mainly on the chosen point size and
-display resolution; for rapid previewing, however, something like
-.
-.IP
-.BI "groff \-X \-P\-resolution \-P100 " document
-.
+display resolution;
+for rapid previewing,
+however,
+something like
+.
+.RS
+.EX
+groff \-X \-P\-resolution \-P100\~\c
+.I document
+.EE
+.RE
 .
-.PP
 yields acceptable results.
 .
 .
 .PP
-During the run of
-.BR \%gxditview ,
-the left mouse button brings up a menu with the following entries:
+While
+.I gxditview
+is running,
+the left mouse button brings up a menu with several entries.
 .
-.TP 8
-.B "Next Page"
+.TP
+.B Next Page
 Display the next page.
 .
+.
 .TP
-.B "Previous Page"
+.B Previous Page
 Display the previous page.
 .
+.
 .TP
-.B "Select Page"
+.B Select Page
 Select a particular numbered page specified by a dialog box.
 .
+.
 .TP
 .B Print
 Print the
-.I groff intermediate output
-using a command specified by a dialog box.
+.I groff
+intermediate output using a command specified by a dialog box.
 .
 The default command initially displayed is controlled by the
 .B printCommand
-application resource, and by the
+application resource,
+and by the
 .B \-printCommand
 option.
 .
+.
 .TP
 .B Open
 Open for display a new file specified by a dialog box.
 .
-The file should contain some
-.I groff intermediate
-.IR output .
+The file should contain
+.I groff
+intermediate output.
+.
+If the filename starts with a bar or pipe symbol,
+.RB \[lq] | \[rq]
+it will be interpreted as be a command from which to read.
 .
-If the filename starts with
-.B |
-it will be taken to be a command to read from.
 .
 .TP
 .B Quit
 Exit from
-.BR \%gxditview .
+.BR gxditview .
 .
 .
 .PP
@@ -227,7 +232,7 @@ and
 .I Next
 .RI ( PgDn )
 keys are bound to the
-.B Next\ Page
+.B Next\~Page
 action.
 .
 The
@@ -239,7 +244,7 @@ and
 .I Prior
 .RI ( PgUp )
 keys are bound to the
-.B Previous\ Page
+.B Previous\~Page
 action.
 .
 The
@@ -264,9 +269,10 @@ The
 .I r
 key is bound to the
 .B Rerasterize
-action which rereads the current file, and redisplays the current
-page; if the current file is a command, the command will be
-reexecuted.
+action which rereads the current file,
+and redisplays the current page;
+if the current file is a command,
+the command will be re-executed.
 .
 Vertical scrolling can be done with the
 .I k
@@ -295,117 +301,141 @@ and
 .B paperwidth
 commands in the
 .I DESC
-file specify the length and width in machine units of the virtual page
-displayed by
-.BR \%gxditview .
+file describing a
+.I groff
+output device specify the length and width in machine units of the
+virtual page displayed by
+.IR gxditview ;
+see
+.IR groff_font (@MAN5EXT@).
 .
 .
 .\" ====================================================================
-.SH "X Defaults"
+.SS "X defaults"
 .\" ====================================================================
 .
 This program uses the
 .I Dvi
-widget in the X\~Toolkit.
+widget from the X\~Toolkit.
 .
 It understands all of the core resource names and classes as well as:
 .
-.TP 8
-.BR width\  (class\  Width )
+.
+.TP
+.BR width\~ (class\~ Width )
 Specifies the width of the window.
 .
+.
 .TP
-.BR height\  (class\  Height )
+.BR height\~ (class\~ Height )
 Specifies the height of the window.
 .
+.
 .TP
-.BR foreground\  (class\  Foreground )
+.BR foreground\~ (class\~ Foreground )
 Specifies the default foreground color.
 .
+.
 .TP
-.BR font\  (class\  Font )
+.BR font\~ (class\~ Font )
 Specifies the font to be used for error messages.
 .
+.
 .TP
-.BR fontMap\  (class\  FontMap )
+.BR fontMap\~ (class\~ FontMap )
 Specifies the mapping from
 .I groff
 font names to X\~font names.
 .
 This must be a string containing a sequence of lines.
 .
-Each line contains two whitespace separated fields: first the
+Each line contains two whitespace-separated fields:
+firstly the
 .I groff
-font name, and secondly the X\~font name.
+font name,
+and secondly the XLFD
+(X Logical Font Description).
 .
-The default is
-.nf
-"\[rs]
-TR     \-adobe\-times\-medium\-r\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-TI     \-adobe\-times\-medium\-i\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-TB     \-adobe\-times\-bold\-r\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-TBI    \-adobe\-times\-bold\-i\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-CR     \-adobe\-courier\-medium\-r\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-CI     \-adobe\-courier\-medium\-o\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-CB     \-adobe\-courier\-bold\-r\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-CBI    \-adobe\-courier\-bold\-o\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-HR     \-adobe\-helvetica\-medium\-r\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-HI     \-adobe\-helvetica\-medium\-o\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-HB     \-adobe\-helvetica\-bold\-r\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-HBI    \-adobe\-helvetica\-bold\-o\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-NR     \-adobe\-new century schoolbook\-medium\-r\-normal\
-\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-NI     \-adobe\-new century schoolbook\-medium\-i\-normal\
+The default is shown in subsection \[lq]Default font map\[rq] below.
+.
+.
+.\" ====================================================================
+.SS "Default font map"
+.\" ====================================================================
+.
+XLFDs are long and unwieldy,
+so some lines are shown broken and indented below.
+.\" Break them after the POINT_SIZE field (in "decipoints", so "100").
+.
+.PP
+.EX
+TR  \-adobe\-times\-medium\-r\-normal\-\-*\-100\
+\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+TI  \-adobe\-times\-medium\-i\-normal\-\-*\-100\
+\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+TB  \-adobe\-times\-bold\-r\-normal\-\-*\-100\
+\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+TBI \-adobe\-times\-bold\-i\-normal\
 \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-NB     \-adobe\-new century schoolbook\-bold\-r\-normal\
+CR  \-adobe\-courier\-medium\-r\-normal\-\-*\-100\" break
+        \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+CI  \-adobe\-courier\-medium\-o\-normal\" break
+        \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+CB  \-adobe\-courier\-bold\-r\-normal\
 \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-NBI    \-adobe\-new century schoolbook\-bold\-i\-normal\
+CBI \-adobe\-courier\-bold\-o\-normal\
 \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
-S      \-adobe\-symbol\-medium\-r\-normal\
-\-\-*\-100\-*\-*\-*\-*\-adobe\-fontspecific\[rs]n\[rs]
-SS     \-adobe\-symbol\-medium\-r\-normal\
-\-\-*\-100\-*\-*\-*\-*\-adobe\-fontspecific\[rs]n\[rs]
-"
-.fi
+HR  \-adobe\-helvetica\-medium\-r\-normal\" break
+        \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+HI  \-adobe\-helvetica\-medium\-o\-normal\" break
+        \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+HB  \-adobe\-helvetica\-bold\-r\-normal\" break
+        \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+HBI \-adobe\-helvetica\-bold\-o\-normal\" break
+        \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+NR  \-adobe\-new century schoolbook\-medium\-r\-normal\-\-*\-100\" break
+        \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+NI  \-adobe\-new century schoolbook\-medium\-i\-normal\-\-*\-100\" break
+        \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+NB  \-adobe\-new century schoolbook\-bold\-r\-normal\-\-*\-100\" break
+        \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+NBI \-adobe\-new century schoolbook\-bold\-i\-normal\-\-*\-100\" break
+        \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
+S   \-adobe\-symbol\-medium\-r\-normal\-\-*\-100\" break
+        \-*\-*\-*\-*\-adobe\-fontspecific\[rs]n\[rs]
+SS  \-adobe\-symbol\-medium\-r\-normal\-\-*\-100\" break
+        \-*\-*\-*\-*\-adobe\-fontspecific\[rs]n\[rs]
+.EE
 .
 .
 .\" ====================================================================
 .SH Options
 .\" ====================================================================
 .
-The
-.B \%gxditview
-program accepts all of the standard X\~Toolkit command-line options
-along with the additional options listed below:
+.I gxditview
+accepts all of the standard X\~Toolkit command-line options along with
+the additional options listed below.
 .
-.TP 8
+.
+.TP
 .B \-help
 This option indicates that a brief summary of the allowed options should
 be printed.
 .
+.
 .TP
 .B \-page
 This option specifies the page number of the document to be displayed.
 .
+.
 .TP
-.BI \-backingStore\  backing-store-type
-Redisplay of the
-.I groff intermediate output
-window can take up to a second or so, this option causes the server to
-save the window contents so that when it is scrolled around the
-viewport, the window is painted from contents saved in backing store.
+.BI \-backingStore\~ backing-store-type
+Because redisplay of the
+.I groff
+intermediate output window can take a perceiptible amount of time,
+this option causes the server to save the window contents so that when
+it is scrolled around the viewport,
+the window is painted from contents saved in backing store.
 .
 .I backing-store-type
 can be one of
@@ -414,24 +444,28 @@ can be one of
 or
 .BR NotUseful .
 .
+.
 .TP
-.BI \-printCommand\  command
+.BI \-printCommand\~ command
 The default command displayed in the dialog box for the
 .B Print
 menu entry will be
 .IR command .
 .
+.
 .TP
-.BI \-resolution\  res
+.BI \-resolution\~ res
 The
-.I groff intermediate output
-file will be displayed at a resolution of
+.I groff
+intermediate output file will be displayed at a resolution of
 .I res
-dpi, unless the
+dots per inch,
+unless the
 .I DESC
 file contains the
 .B X11
-command, in which case the device resolution will be used.
+command,
+in which case the device resolution will be used.
 .
 This corresponds to the
 .I Dvi
@@ -439,68 +473,84 @@ widget's
 .B resolution
 resource.
 .
-The default is 75.
+The default is
+.BR 75 .
+.
 .
 .TP
-.BI \-filename\  string
+.BI \-filename\~ string
 The default filename displayed in the dialog box for the
 .B Open
 menu entry will be
 .IR string .
-This can be either a filename, or a command starting with
-.BR | .
+.
+This can be either a filename,
+or a command starting with
+.RB \[lq] | \[rq].
 .
 .
 .PP
 The following standard X\~Toolkit command-line arguments are commonly
 used with
-.BR \%gxditview :
+.IR gxditview .
+.
 .
-.TP 8
-.BI \-bg\  color
+.TP
+.BI \-bg\~ color
 This option specifies the color to use for the background of the window.
 .
-The default is \fIwhite\fP.
+The default is
+.RB \[lq] white \[rq].
+.
 .
 .TP
-.BI \-bd\  color
+.BI \-bd\~ color
 This option specifies the color to use for the border of the window.
 .
-The default is \fIblack\fP.
+The default is
+.RB \[lq] black \[rq].
+.
 .
 .TP
-.BI \-bw\  number
+.BI \-bw\~ number
 This option specifies the width in pixels of the border surrounding the
 window.
 .
+.
 .TP
-.BI \-fg\  color
+.BI \-fg\~ color
 This option specifies the color to use for displaying text.
 .
 The default is
-\fIblack\fP.
+.RB \[lq] black \[rq].
+.
 .
 .TP
-.BI \-fn\  font
+.BI \-fn\~ font
 This option specifies the font to be used for displaying widget text.
 .
-The default is \fIfixed\fP.
+The default is
+.RB \[lq] fixed \[rq].
+.
 .
 .TP
 .B \-rv
 This option indicates that reverse video should be simulated by swapping
 the foreground and background colors.
 .
+.
 .TP
-.BI \-geometry\  geometry
+.BI \-geometry\~ geometry
 This option specifies the preferred size and position of the window.
 .
+.
 .TP
-.BI \-display\  host : display
+.BI \-display\~ host : display
 This option specifies the X\~server to contact.
 .
+.
 .TP
-.BI \-xrm\  resourcestring
+.BI \-xrm\~ resourcestring
 This option specifies a resource string to be used.
 .
 .
@@ -515,9 +565,9 @@ A list of directories in which to search for the
 directory in addition to the default ones.
 .
 See
-.BR @g@troff (@MAN1EXT@)
+.IR @g@troff (@MAN1EXT@)
 and
-.BR \%groff_font (@MAN5EXT@)
+.IR groff_font (@MAN5EXT@)
 for more details.
 .
 .
@@ -526,20 +576,21 @@ for more details.
 .\" ====================================================================
 .
 .TP
-.I @APPRESDIR@/GXditview
+.I \%@APPRESDIR@/\:\%GXditview
 .TQ
-.I @APPRESDIR@/GXditview\-color
+.I \%@APPRESDIR@/\:\%GXditview\-color
 The default resource files of
-.BR \%gxditview .
+.IR gxditview .
 .
-Users should override these values in the
+Users can override these values in the
 .I .Xdefaults
-file, normally located in the user's home directory.
+file,
+normally located in the user's home directory.
 .
 See
-.BR xrdb (1)
+.IR xrdb (1)
 and
-.BR appres (1)
+.IR appres (1)
 for more.
 .
 .
@@ -547,9 +598,9 @@ for more.
 .SH Authors
 .\" ====================================================================
 .
-.B gxditview
+.I gxditview
 and its predecessor
-.B xditview
+.I xditview
 were written by
 Keith Packard (MIT X Consortium),
 Richard L.\& Hyde (Purdue),
@@ -560,24 +611,29 @@ and
 James Clark.
 .
 .
-.\" ====================================================================
-.SH Origin
-.\" ====================================================================
-.
+.PP
 This program is derived from
-.BR \%xditview ;
+.IR xditview ;
 portions of
-.B \%xditview
+.I xditview
 originated in
-.B \%xtroff
+.IR xtroff ,
 which was derived from
-.BR \%suntroff .
+.IR \%suntroff .
 .
 .
 .\" ====================================================================
 .SH "See Also"
 .\" ====================================================================
 .
+.UR https://\:www\:.x\:.org/\:releases/\:X11R7.6/\:doc/\:xorg\-docs/\
+\:specs/\:XLFD/xlfd\:.html
+\[lq]X Logical Font Description Conventions\[rq]
+.UE ,
+by Jim Flowers and Stephen Gildea.
+.
+.
+.PP
 .BR X (7),
 .BR xrdb (1),
 .BR xditview (1),