| blob | 5da53c202b9276ae875d292438c9b96143c772aa |
1 .TH GXDITVIEW @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
2 .
3 .
4 .SH NAME
5 gxditview \- display groff intermediate output files
6 .
7 .
8 .SH SYNOPSIS
9 .B \%gxditview
10 .RI [\fB\- toolkitoption\ .\|.\|.\|]
11 .RI [\fB\- option\ .\|.\|.\|]
12 .RI [ filename ]
13 .
14 .
15 .SH DESCRIPTION
16 The
17 .B \%gxditview
18 program displays the
19 .I groff intermediate
20 .IR output ,
21 see
22 .BR groff_out (@MAN5EXT@),
23 on an X\~display.
24 .
25 It uses the standard X11 fonts, so it does not require access to the
26 server machine for font loading.
27 .
28 There are several ways to use
29 .BR \%gxditview .
30 .
31 .
32 .PP
33 The
34 .I groff intermediate output
35 can be generated by
36 .BR groff\~\-Z .
37 This can be viewed by explicity calling
38 .B \%gxditview
39 .IR \%filename .
40 If
41 .I filename
42 is
43 .BR \- ,
44 .B \%gxditview
45 will read the standard input;
46 .I \%filename
47 cannot be omitted.
48 .
49 The
50 .I groff intermediate output
51 is different for all devices.
52 .
53 .B \%gxditview
54 can view it for all devices, but the quality is device dependent.
55 .
56 .
57 .PP
58 The best results are achieved with the
59 .BR X *
60 devices for
61 .BR groff 's
62 option
63 .BR \-T .
64 .
65 There are four
66 .BR X *
67 devices:
68 .BR \%\-TX75 ,
69 .BR \%\-TX75\-12 ,
70 .BR \%\-TX100 ,
71 .BR \%\-TX100\-12 .
72 They differ by the X\~resolution (75dpi or 100dpi) and the used base font
73 size (10pt or 12pt).
74 .
75 They are especially built for
76 .BR \%gxditview .
77 When using one of them
78 .B groff
79 generates the
80 .I intermediate output
81 for this device and calls
82 .B \%gxditview
83 automatically for viewing.
84 .
85 For example, to view this man page with a base resolution of 12pt, say
86 .
87 .IP
88 .B groff \-TX100\-12 \-man \-rS12 gxditview.@MAN1EXT@
89 .
90 .PP
91 (option
92 .BI \-rS XX
93 is documented in the
94 .BR groff_man (@MAN7EXT@)
95 man page).
96 .
97 .PP
98 .BR groff 's
99 option
100 .B \-X
101 produces
102 .I intermediate output
103 for the
104 .I Postscript
105 device and subsequently uses
106 .B \%gxditview
107 as a viewer for it.
108 .
109 The quality of the result depends mainly on the chosen point size and
110 display resolution; for rapid previewing, however, something like
111 .
112 .IP
113 .BI "groff \-X \-P\-resolution \-P100 " document
114 .
115 .PP
116 yields acceptable results.
117 .
118 .
119 .
120 .PP
121 During the run of
122 .BR \%gxditview ,
123 the left mouse button brings up a menu with the following entries:
124 .
125 .TP 8
126 .B "Next Page"
127 Display the next page.
128 .
129 .TP
130 .B "Previous Page"
131 Display the previous page.
132 .
133 .TP
134 .B "Select Page"
135 Select a particular numbered page specified by a dialog box.
136 .
137 .TP
138 .B Print
139 Print the
140 .I groff intermediate output
141 using a command specified by a dialog box.
142 .
143 The default command initially displayed is controlled by the
144 .B printCommand
145 application resource, and by the
146 .B \-printCommand
147 option.
148 .
149 .TP
150 .B Open
151 Open for display a new file specified by a dialog box.
152 .
153 The file should contain some
154 .I groff intermediate
155 .IR output .
156 If the filename starts with
157 .B |
158 it will be taken to be a command to read from.
159 .
160 .TP
161 .B Quit
162 Exit from
163 .BR \%gxditview .
164 .
165 .
166 .PP
167 The
168 .IR n ,
169 .IR Space ,
170 .IR Return ,
171 and
172 .I Next
173 .RI ( PgDn )
174 keys are bound to the
175 .B Next\ Page
176 action.
177 .
178 The
179 .IR p ,
180 .IR b ,
181 .IR BackSpace ,
182 .IR Delete ,
183 and
184 .I Prior
185 .RI ( PgUp )
186 keys are bound to the
187 .B Previous\ Page
188 action.
189 .
190 The
191 .I g
192 key is bound to the
193 .B SelectPage
194 action.
195 .
196 The
197 .I o
198 key is bound to the
199 .B OpenFile
200 action.
201 .
202 The
203 .I q
204 key is bound to the
205 .B Quit
206 action.
207 .
208 The
209 .I r
210 key is bound to the
211 .B Rerasterize
212 action which rereads the current file, and redisplays the current
213 page; if the current file is a command, the command will be
214 reexecuted.
215 .
216 Vertical scrolling can be done with the
217 .I k
218 and
219 .I j
220 keys;
221 horizontal scrolling is bound to the
222 .I h
223 and
224 .I l
225 keys.
226 .
227 The arrow keys
228 .RI ( up ,
229 .IR down ,
230 .IR left ,
231 and
232 .IR right )
233 are also bound to the obvious scrolling actions.
234 .
235 .
236 .PP
237 The
238 .B paperlength
239 and
240 .B paperwidth
241 commands in the DESC file specify the length and width in machine units
242 of the virtual page displayed by
243 .BR \%gxditview .
244 .
245 .
246 .SH OPTIONS
247 The
248 .B \%gxditview
249 program accepts all of the standard X\~Toolkit command line options
250 along with the additional options listed below:
251 .
252 .TP 8
253 .B \-help
254 This option indicates that a brief summary of the allowed options should be
255 printed.
256 .
257 .TP
258 .B \-page
259 This option specifies the page number of the document to be displayed.
260 .
261 .TP
262 .BI \-backingStore\ backing-store-type
263 Redisplay of the
264 .I groff intermediate output
265 window can take up to a second or so, this option causes the server to
266 save the window contents so that when it is scrolled around the
267 viewport, the window is painted from contents saved in backing store.
268 .I backing-store-type
269 can be one of
270 .BR Always ,
271 .B WhenMapped
272 or
273 .BR NotUseful .
274 .
275 .TP
276 .BI \-printCommand\ command
277 The default command displayed in the dialog box for the
278 .B Print
279 menu entry will be
280 .IR command .
281 .
282 .TP
283 .BI \-resolution\ res
284 The
285 .I groff intermediate output
286 file will be displayed at a resolution of
287 .I res
288 dpi, unless the DESC file contains the
289 .B X11
290 command, in which case the device resolution will be used.
291 .
292 This corresponds to the
293 .I Dvi
294 widget's
295 .B resolution
296 resource.
297 .
298 The default is 75.
299 .
300 .TP
301 .BI \-filename\ string
302 The default filename displayed in the dialog box for the
303 .B Open
304 menu entry will be
305 .IR string .
306 This can be either a filename, or a command starting with
307 .BR | .
308 .
309 .
310 .PP
311 The following standard X\~Toolkit command line arguments are commonly used
312 with
313 .BR \%gxditview :
314 .
315 .TP 8
316 .BI \-bg\ color
317 This option specifies the color to use for the background of the window.
318 .
319 The default is \fIwhite\fP.
320 .
321 .TP
322 .BI \-bd\ color
323 This option specifies the color to use for the border of the window.
324 .
325 The default is \fIblack\fP.
326 .
327 .TP
328 .BI \-bw\ number
329 This option specifies the width in pixels of the border surrounding the
330 window.
331 .
332 .TP
333 .BI \-fg\ color
334 This option specifies the color to use for displaying text.
335 .
336 The default is
337 \fIblack\fP.
338 .
339 .TP
340 .BI \-fn\ font
341 This option specifies the font to be used for displaying widget text.
342 .
343 The default is \fIfixed\fP.
344 .
345 .TP
346 .B \-rv
347 This option indicates that reverse video should be simulated by swapping
348 the foreground and background colors.
349 .
350 .TP
351 .BI \-geometry\ geometry
352 This option specifies the preferred size and position of the window.
353 .
354 .TP
355 .BI \-display\ host : display
356 This option specifies the X\~server to contact.
357 .
358 .TP
359 .BI \-xrm\ resourcestring
360 This option specifies a resource string to be used.
361 .
362 .
363 .SH X DEFAULTS
364 This program uses the
365 .I Dvi
366 widget in the X\~Toolkit.
367 .
368 It understands all of the core resource names and classes as well as:
369 .
370 .TP 8
371 .BR width\ (class\ Width )
372 Specifies the width of the window.
373 .
374 .TP
375 .BR height\ (class\ Height )
376 Specifies the height of the window.
377 .
378 .TP
379 .BR foreground\ (class\ Foreground )
380 Specifies the default foreground color.
381 .
382 .TP
383 .BR font\ (class\ Font )
384 Specifies the font to be used for error messages.
385 .
386 .TP
387 .BR fontMap\ (class\ FontMap )
388 Specifies the mapping from
389 .I groff
390 font names to X\~font names.
391 .
392 This must be a string containing a sequence of lines.
393 .
394 Each line contains two whitespace separated fields: first the
395 .I groff
396 font name, and secondly the X\~font name.
397 .
398 The default is
399 .nf
400 "\e
401 TR -adobe-times-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
402 TI -adobe-times-medium-i-normal--*-100-*-*-*-*-iso8859-1\en\e
403 TB -adobe-times-bold-r-normal--*-100-*-*-*-*-iso8859-1\en\e
404 TBI -adobe-times-bold-i-normal--*-100-*-*-*-*-iso8859-1\en\e
405 CR -adobe-courier-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
406 CI -adobe-courier-medium-o-normal--*-100-*-*-*-*-iso8859-1\en\e
407 CB -adobe-courier-bold-r-normal--*-100-*-*-*-*-iso8859-1\en\e
408 CBI -adobe-courier-bold-o-normal--*-100-*-*-*-*-iso8859-1\en\e
409 HR -adobe-helvetica-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
410 HI -adobe-helvetica-medium-o-normal--*-100-*-*-*-*-iso8859-1\en\e
411 HB -adobe-helvetica-bold-r-normal--*-100-*-*-*-*-iso8859-1\en\e
412 HBI -adobe-helvetica-bold-o-normal--*-100-*-*-*-*-iso8859-1\en\e
413 NR -adobe-new century schoolbook-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
414 NI -adobe-new century schoolbook-medium-i-normal--*-100-*-*-*-*-iso8859-1\en\e
415 NB -adobe-new century schoolbook-bold-r-normal--*-100-*-*-*-*-iso8859-1\en\e
416 NBI -adobe-new century schoolbook-bold-i-normal--*-100-*-*-*-*-iso8859-1\en\e
417 S -adobe-symbol-medium-r-normal--*-100-*-*-*-*-adobe-fontspecific\en\e
418 SS -adobe-symbol-medium-r-normal--*-100-*-*-*-*-adobe-fontspecific\en\e
419 "
420 .fi
421 .
422 .
423 .SH ENVIRONMENT
424 .TP
425 .SM
426 .B GROFF_FONT_PATH
427 A list of directories in which to search for the
428 .BI dev name
429 directory in addition to the default ones.
430 .
431 See
432 .BR @g@troff (@MAN1EXT@)
433 and
434 .BR \%groff_font (@MAN5EXT@)
435 for more details.
436 .
437 .
438 .SH FILES
439 .TP
440 .B @APPRESDIR@/GXditview
441 .TQ
442 .B @APPRESDIR@/GXditview-color
443 The default resource files of
444 .BR \%gxditview .
445 Users should override these values in the
446 .B .Xdefaults
447 file, normally located in the user's home directory.
448 .
449 See
450 .BR xrdb (1)
451 and
452 .BR appres (1)
453 for more.
454 .
455 .
456 .SH "SEE ALSO"
457 .BR X (1),
458 .BR xrdb (1),
459 .BR xditview (1),
460 .BR groff (@MAN1EXT@),
461 .BR groff_out (@MAN5EXT@)
462 .
463 .
464 .SH ORIGIN
465 This program is derived from
466 .BR \%xditview ;
467 portions of
468 .B \%xditview
469 originated in
470 .B \%xtroff
471 which was derived from
472 .BR \%suntroff .
473 .
474 .
475 .SH COPYRIGHT
476 Copyright 1989, Massachusetts Institute of Technology.
477 .br
478 See
479 .BR X (1)
480 for a full statement of rights and permissions.
481 .
482 .
483 .SH AUTHORS
484 Keith Packard (MIT X Consortium)
485 .br
486 Richard L. Hyde (Purdue)
487 .br
488 David Slattengren (Berkeley)
489 .br
490 Malcolm Slaney (Schlumberger Palo Alto Research)
491 .br
492 Mark Moraes (University of Toronto)
493 .br
494 James Clark
495 .
496 .\" Local Variables:
497 .\" mode: nroff
498 .\" End: