* src/devices/xditview/gxditview.man: Revised and improved.

1 files changed, 139 insertions, 45 deletions

diff --git a/src/devices/xditview/gxditview.man b/src/devices/xditview/gxditview.man
index 4b540f70..432869fc 100644
--- a/src/devices/xditview/gxditview.man
+++ b/src/devices/xditview/gxditview.man
@@ -2,11 +2,11 @@
 .
 .
 .SH NAME
-gxditview \- display gtroff output files
+gxditview \- display groff intermediate output files
 .
 .
 .SH SYNOPSIS
-.B gxditview
+.B \%gxditview
 .RI [\fB\- toolkitoption\  .\|.\|.\|]
 .RI [\fB\- option\  .\|.\|.\|]
 .RI [ filename ]
@@ -15,20 +15,83 @@ gxditview \- display gtroff output files
 .SH DESCRIPTION
 The
 .I \%gxditview 
-program displays gtroff output on an X display.
-It uses the standard X11 fonts,
-so it does not require access to the server machine for font loading.
+program displays the
+.I groff intermediate
+.IR output ,
+see
+.BR groff_out (@MAN5EXT@),
+on an X display.
+.
+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
+.IR \%gxditview .
+.
 .
 .PP
+The
+.I groff intermediate output
+can be generated by
+.B groff -Z
+which then can be viewed by explicity calling
+.I \%gxditview
+.IR \%filename .
 If
 .I filename
 is
 .BR \- ,
 .I \%gxditview
 will read the standard input.
+.I \%filename
+cannot be omitted.
+.
+.
+.PP
+A simpler method is to use an
+.BR X *
+device for the option
+.B -T
+of
+.IR groff .
+.
+Then
+.I groff
+generates the
+.I intermediate output
+and calls
+.I \%gxditview
+automatically for viewing.
+.
+There are four
+.BR X *
+devices:
+.BR -TX75 ,
+.BR -TX75-12 ,
+.BR -TX100 ,
+.BR -TX100-12 .
+They differ by the X resolution (75dpi or 100dpi) and the used base font
+size (10pt or 12pt).
+.
+.
+.PP
+.IR groff 's
+option
+.B -X
+should be considered obsolete today;
+it produces
+.I Postscript
+output and uses
+.I \%gxditview
+as a previewer for it, but with a bad quality.
+.
+Simply don't use it.
+.
 .
 .PP
-The left mouse button brings up a menu with the following entries:
+During the run of
+.IR \%gxditview ,
+the left mouse button brings up a menu with the following entries:
 .
 .TP 8
 .B "Next Page"
@@ -44,7 +107,10 @@ Select a particular numbered page specified by a dialog box.
 .
 .TP
 .B Print
-Print the gtroff output using a command specified by a dialog box.
+Print the
+.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
@@ -54,7 +120,10 @@ option.
 .TP
 .B Open
 Open for display a new file specified by a dialog box.
-The file should contain gtroff output.
+.
+The file should contain
+.I groff intermediate
+.IR output .
 If the filename starts with
 .B |
 it will be taken to be a command to read from.
@@ -64,32 +133,40 @@ it will be taken to be a command to read from.
 Exit from
 .IR \%gxditview .
 .
+.
 .PP
 The
-.BR n ,
-Space
-and Return keys are bound to the
+.IR n ,
+.I Space
+and
+.I Return
+keys are bound to the
 .B Next\ Page
 action.
+.
 The
-.BR p ,
-BackSpace
+.IR p ,
+.I BackSpace
 and
-Delete
+.I Delete
 keys are bound to the
 .B Previous\ Page
 action.
+.
 The
-.B q
+.I q
 key is bound to the
 .B Quit
 action.
+.
 The
-.B r
+.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
+reexecuted.
+.
 .
 .PP
 The
@@ -102,9 +179,10 @@ of the virtual page displayed by
 .
 .
 .SH OPTIONS
-.I \%Gxditview
-accepts all of the standard X Toolkit command line options along with the 
-additional options listed below:
+The
+.I \%gxditview
+program accepts all of the standard X Toolkit command line options
+along with the additional options listed below:
 .
 .TP 8
 .B \-help
@@ -117,10 +195,11 @@ This option specifies the page number of the document to be displayed.
 .
 .TP
 .BI \-backingStore\  backing-store-type
-Redisplay of the gtroff output window can take upto 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.
+Redisplay of the
+.I groff intermediate output
+window can take upto 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.
 .I backing-store-type
 can be one of
 .BR Always ,
@@ -137,17 +216,20 @@ menu entry will be
 .
 .TP
 .BI \-resolution\  res
-The gtroff output file will be displayed at a resolution of
+The
+.I groff intermediate output
+file will be displayed at a resolution of
 .I res
-dpi,
-unless the DESC file contains the
+dpi, unless the DESC file contains the
 .B X11
 command, in which case the device resolution will be used.
+.
 This corresponds the
 .I Dvi
 widget's
 .B resolution
 resource.
+.
 The default is 75.
 .
 .TP
@@ -159,6 +241,7 @@ menu entry will be
 This can be either a filename, or a command starting with
 .BR | .
 .
+.
 .PP
 The following standard X Toolkit command line arguments are commonly used with 
 .IR \%gxditview :
@@ -166,11 +249,13 @@ The following standard X Toolkit command line arguments are commonly used with
 .TP 8
 .BI \-bg\  color
 This option specifies the color to use for the background of the window.  
+.
 The default is \fIwhite\fP.
 .
 .TP
 .BI \-bd\  color
 This option specifies the color to use for the border of the window.
+.
 The default is \fIblack\fP.
 .
 .TP
@@ -180,13 +265,16 @@ window.
 .
 .TP
 .BI \-fg\  color
-This option specifies the color to use for displaying text.  The default is 
+This option specifies the color to use for displaying text.
+.
+The default is 
 \fIblack\fP.
 .
 .TP
 .BI \-fn\  font
-This option specifies the font to be used for displaying widget text.  The
-default is \fIfixed\fP.
+This option specifies the font to be used for displaying widget text.
+.
+The default is \fIfixed\fP.
 .
 .TP
 .B \-rv
@@ -209,8 +297,9 @@ This option specifies a resource string to be used.
 .SH X DEFAULTS
 This program uses the 
 .I Dvi
-widget in the X Toolkit.  It understands all of the core resource names and
-classes as well as:
+widget in the X Toolkit.
+.
+It understands all of the core resource names and classes as well as:
 .
 .TP 8
 .BR width\  (class\  Width )
@@ -230,10 +319,16 @@ Specifies the font to be used for error messages.
 .
 .TP
 .BR fontMap\  (class\  FontMap )
-Specifies the mapping from 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 groff font name, and
-secondly the X font name.  The default is
+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 groff
+font name, and secondly the X font name.
+.
+The default is
 .nf
 "\e
 TR	-adobe-times-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
@@ -259,17 +354,16 @@ SS	-adobe-symbol-medium-r-normal--*-100-*-*-*-*-adobe-fontspecific\en\e
 .
 .
 .SH "SEE ALSO"
-.IR X (1),
-.IR xrdb (1),
-.IR xditview (1),
-.IR gtroff (@MAN1EXT@),
-.IR groff (@MAN1EXT@)
+.BR X (1),
+.BR xrdb (1),
+.BR xditview (1),
+.BR groff (@MAN1EXT@),
+.BR groff_out (@MAN5EXT@)
 .
 .
 .SH ORIGIN
-This program is derived from \%xditview;
-portions of \%xditview originated in xtroff which was derived
-from suntroff.  
+This program is derived from \%xditview; portions of \%xditview
+originated in xtroff which was derived from suntroff.
 .
 .
 .SH COPYRIGHT