Initial import from FreeBSD RELENG_4:
[dragonfly.git] / contrib / groff / src / xditview / gxditview.man
1 .TH GXDITVIEW 1 "Release 5" "X Version 11"
2 .SH NAME
3 gxditview \- display gtroff output files
4 .SH SYNOPSIS
5 .B gxditview
6 .RI [\fB\- toolkitoption\  .\|.\|.\|]
7 .RI [\fB\- option\  .\|.\|.\|]
8 .RI [ filename ]
9 .SH DESCRIPTION
10 The
11 .I gxditview 
12 program displays gtroff output on an X display.
13 It uses the standard X11 fonts,
14 so it does not require access to the server machine for font loading.
15 .PP
16 If
17 .I filename
18 is
19 .BR \- ,
20 .I gxditview
21 will read the standard input.
22 .PP
23 The left mouse button brings up a menu with the following entries:
24 .TP 8
25 .B "Next Page"
26 Display the next page.
27 .TP
28 .B "Previous Page"
29 Display the previous page.
30 .TP
31 .B "Select Page"
32 Select a particular numbered page specified by a dialog box.
33 .TP
34 .B Print
35 Print the gtroff output using a command specified by a dialog box.
36 The default command initially displayed is controlled by the
37 .B printCommand
38 application resource, and by the
39 .B \-printCommand
40 option.
41 .TP
42 .B Open
43 Open for display a new file specified by a dialog box.
44 The file should contain gtroff output.
45 If the filename starts with
46 .B |
47 it will be taken to be a command to read from.
48 .TP
49 .B Quit
50 Exit from
51 .IR gxditview .
52 .PP
53 The
54 .BR n ,
55 Space
56 and Return keys are bound to the
57 .B Next\ Page
58 action.
59 The
60 .BR p ,
61 BackSpace
62 and
63 Delete
64 keys are bound to the
65 .B Previous\ Page
66 action.
67 The
68 .B q
69 key is bound to the
70 .B Quit
71 action.
72 The
73 .B r
74 key is bound to the
75 .B Rerasterize
76 action which rereads the current file, and redisplays the current page;
77 if the current file is a command, the command will be reexecuted.
78 .PP
79 The
80 .B paperlength
81 and
82 .B paperwidth
83 commands in the DESC file specify the length and width in machine units
84 of the virtual page displayed by
85 .IR gxditview .
86 .SH OPTIONS
87 .I Gxditview
88 accepts all of the standard X Toolkit command line options along with the 
89 additional options listed below:
90 .TP 8
91 .B \-help
92 This option indicates that a brief summary of the allowed options should be
93 printed.
94 .TP
95 .B \-page
96 This option specifies the page number of the document to be displayed.
97 .TP
98 .BI \-backingStore\  backing-store-type
99 Redisplay of the gtroff output window can take upto a second or so,
100 this option causes the server to save the window contents so that when
101 it is scrolled around the viewport, the window is painted from
102 contents saved in backing store.
103 .I backing-store-type
104 can be one of
105 .BR Always ,
106 .B WhenMapped
107 or 
108 .BR NotUseful .
109 .TP
110 .BI \-printCommand\  command
111 The default command displayed in the dialog box for the
112 .B Print
113 menu entry will be
114 .IR command .
115 .TP
116 .BI \-resolution\  res
117 The gtroff output file will be displayed at a resolution of
118 .I res
119 dpi,
120 unless the DESC file contains the
121 .B X11
122 command, in which case the device resolution will be used.
123 This corresponds the
124 .I Dvi
125 widget's
126 .B resolution
127 resource.
128 The default is 75.
129 .TP
130 .BI \-filename\  string
131 The default filename displayed in the dialog box for the
132 .B Open
133 menu entry will be
134 .IR string .
135 This can be either a filename, or a command starting with
136 .BR | .
137 .PP
138 The following standard X Toolkit command line arguments are commonly used with 
139 .IR gxditview :
140 .TP 8
141 .BI \-bg\  color
142 This option specifies the color to use for the background of the window.  
143 The default is \fIwhite\fP.
144 .TP
145 .BI \-bd\  color
146 This option specifies the color to use for the border of the window.
147 The default is \fIblack\fP.
148 .TP
149 .BI \-bw\  number
150 This option specifies the width in pixels of the border surrounding the window.
151 .TP
152 .BI \-fg\  color
153 This option specifies the color to use for displaying text.  The default is 
154 \fIblack\fP.
155 .TP
156 .BI \-fn\  font
157 This option specifies the font to be used for displaying widget text.  The
158 default is \fIfixed\fP.
159 .TP
160 .B \-rv
161 This option indicates that reverse video should be simulated by swapping
162 the foreground and background colors.
163 .TP
164 .BI \-geometry\  geometry
165 This option specifies the preferred size and position of the window.
166 .TP
167 .BI \-display\  host : display
168 This option specifies the X server to contact.
169 .TP
170 .BI \-xrm\  resourcestring
171 This option specifies a resource string to be used.
172 .SH X DEFAULTS
173 This program uses the 
174 .I Dvi
175 widget in the X Toolkit.  It understands all of the core resource names and
176 classes as well as:
177 .PP
178 .TP 8
179 .BR width\  (class\  Width )
180 Specifies the width of the window.
181 .TP
182 .BR height\  (class\  Height )
183 Specifies the height of the window.
184 .TP
185 .BR foreground\  (class\  Foreground )
186 Specifies the default foreground color.
187 .TP
188 .BR font\  (class\  Font )
189 Specifies the font to be used for error messages.
190 .TP
191 .BR fontMap\  (class\  FontMap )
192 Specifies the mapping from groff font names to X font names.  This
193 must be a string containing a sequence of lines.  Each line contains
194 two whitespace separated fields: first the groff font name, and
195 secondly the X font name.  The default is
196 .nf
197 "\e
198 TR      -adobe-times-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
199 TI      -adobe-times-medium-i-normal--*-100-*-*-*-*-iso8859-1\en\e
200 TB      -adobe-times-bold-r-normal--*-100-*-*-*-*-iso8859-1\en\e
201 TBI     -adobe-times-bold-i-normal--*-100-*-*-*-*-iso8859-1\en\e
202 CR      -adobe-courier-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
203 CI      -adobe-courier-medium-o-normal--*-100-*-*-*-*-iso8859-1\en\e
204 CB      -adobe-courier-bold-r-normal--*-100-*-*-*-*-iso8859-1\en\e
205 CBI     -adobe-courier-bold-o-normal--*-100-*-*-*-*-iso8859-1\en\e
206 HR      -adobe-helvetica-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
207 HI      -adobe-helvetica-medium-o-normal--*-100-*-*-*-*-iso8859-1\en\e
208 HB      -adobe-helvetica-bold-r-normal--*-100-*-*-*-*-iso8859-1\en\e
209 HBI     -adobe-helvetica-bold-o-normal--*-100-*-*-*-*-iso8859-1\en\e
210 NR      -adobe-new century schoolbook-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
211 NI      -adobe-new century schoolbook-medium-i-normal--*-100-*-*-*-*-iso8859-1\en\e
212 NB      -adobe-new century schoolbook-bold-r-normal--*-100-*-*-*-*-iso8859-1\en\e
213 NBI     -adobe-new century schoolbook-bold-i-normal--*-100-*-*-*-*-iso8859-1\en\e
214 S       -adobe-symbol-medium-r-normal--*-100-*-*-*-*-adobe-fontspecific\en\e
215 SS      -adobe-symbol-medium-r-normal--*-100-*-*-*-*-adobe-fontspecific\en\e
216 "
217 .fi
218
219 .SH "SEE ALSO"
220 .IR X (1),
221 .IR xrdb (1),
222 .IR gtroff (1),
223 .IR groff (1)
224 .SH ORIGIN
225 This program is derived from xditview;
226 portions of xditview originated in xtroff which was derived
227 from suntroff.  
228 .SH COPYRIGHT
229 Copyright 1989, Massachusetts Institute of Technology.
230 .br
231 See
232 .IR X (1)
233 for a full statement of rights and permissions.
234 .SH AUTHORS
235 Keith Packard (MIT X Consortium)
236 .br
237 Richard L. Hyde (Purdue)
238 .br
239 David Slattengren (Berkeley)
240 .br
241 Malcolm Slaney (Schlumberger Palo Alto Research)
242 .br
243 Mark Moraes (University of Toronto)
244 .br
245 James Clark
246 .
247 .\" Local Variables:
248 .\" mode: nroff
249 .\" End: