Debian Codegraph @

upstream/debian-trixie/man1/gxditview.1

raw
1 .TH gxditview 1 "3 June 2025" "groff 1.23.0"
2 .SH Name
3 gxditview \- display
4 .I groff
5 intermediate output files in X11
6 .
7 .
8 .\" ====================================================================
9 .\" Legal Terms
10 .\" ====================================================================
11 .\"
12 .\" Copyright 1991 Massachusetts Institute of Technology
13 .\"
14 .\" Permission to use, copy, modify, distribute, and sell this software
15 .\" and its documentation for any purpose is hereby granted without fee,
16 .\" provided that the above copyright notice appear in all copies and
17 .\" that both that copyright notice and this permission notice appear in
18 .\" supporting documentation, and that the name of M.I.T. not be used in
19 .\" advertising or publicity pertaining to distribution of the software
20 .\" without specific, written prior permission. M.I.T. makes no
21 .\" representations about the suitability of this software for any
22 .\" purpose. It is provided "as is" without express or implied
23 .\" warranty.
24 .\"
25 .\" M.I.T. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
26 .\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
27 .\" NO EVENT SHALL M.I.T. BE LIABLE FOR ANY SPECIAL, INDIRECT OR
28 .\" CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
29 .\" OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
30 .\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
31 .\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
32 .
33 .
34 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
35 .do nr *groff_gxditview_1_man_C \n[.cp]
36 .cp 0
37 .
38 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
39 .nr do-fallback 0
40 .if !\n(.f .nr do-fallback 1 \" mandoc
41 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
42 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
43 .if \n[do-fallback] \{\
44 . de MR
45 . ie \\n(.$=1 \
46 . I \%\\$1
47 . el \
48 . IR \%\\$1 (\\$2)\\$3
49 . .
50 .\}
51 .rr do-fallback
52 .
53 .
54 .\" ====================================================================
55 .SH Synopsis
56 .\" ====================================================================
57 .
58 .SY gxditview
59 .RI [ X-toolkit-option \~.\|.\|.\&]
60 .RB [ \-backingStore\~\c
61 .IR backing-store-type ]
62 .RB [ \-filename\~\c
63 .IR file ]
64 .\" While recognized, the relevant logic is "#if 0"ed out in draw.c.
65 .\" .RB [ \-noPolyText ]
66 .RB [ \-page\~\c
67 .IR page-number ]
68 .RB [ \-printCommand\~\c
69 .IR command ]
70 .RB [ \-resolution\~\c
71 .IR resolution ]
72 .I file
73 .YS
74 .
75 .
76 .SY gxditview
77 .B \-help
78 .
79 .SY gxditview
80 .B \-\-help
81 .YS
82 .
83 .
84 .SY gxditview
85 .B \-version
86 .
87 .SY gxditview
88 .B \-\-version
89 .YS
90 .
91 .
92 .\" ====================================================================
93 .SH Description
94 .\" ====================================================================
95 .
96 .I gxditview
97 interprets and displays the intermediate output format of
98 .MR groff 1
99 on an X11\~display.
100 .
101 It uses the standard X11 fonts,
102 so it does not require access to the server machine for font loading.
103 .
104 There are several ways to use
105 .IR gxditview .
106 .
107 .
108 .PP
109 The
110 intermediate output format of
111 .IR groff ,
112 documented in
113 .MR groff_out 5 ,
114 is produced by
115 .I \%troff
116 or the
117 .B \-Z
118 option to
119 .IR groff .
120 .
121 .
122 It can be viewed by explicitly calling
123 .RB \[lq] gxditview
124 .IR file \[rq].
125 .
126 If the
127 .I file
128 operand is
129 .RB \[lq] \- \[rq],
130 .I gxditview
131 will read the standard input stream;
132 .I file
133 cannot be omitted.
134 .
135 The intermediate output format of
136 .I groff
137 is device-independent but not device-agnostic.
138 .
139 .I gxditview
140 can view it for all typesetter devices,
141 but the quality is device-dependent.
142 .
143 .I gxditview
144 will not display output for terminal
145 .RI ( nroff )
146 devices.
147 .
148 .
149 .PP
150 The best results are achieved with the
151 .BR X *
152 devices for
153 .IR groff 's
154 .B \-T
155 option,
156 of which there are four:
157 .BR \-TX75 ,
158 .BR \-TX75\-12 ,
159 .BR \-TX100 ,
160 and
161 .BR \-TX100\-12 .
162 .
163 They differ by the X\~resolution
164 (75 or 100 dots per inch)
165 and the base point size
166 (10 or 12 points).
167 .
168 They are especially built for
169 .IR gxditview .
170 .
171 When using one of these,
172 .I groff
173 generates the intermediate output for this device and calls
174 .I gxditview
175 automatically for viewing.
176 .
177 .
178 .P
179 .B \-X
180 produces good results only with
181 .BR \-Tps ,
182 .BR \-TX75 ,
183 .BR \-TX75\-12 ,
184 .BR \-TX100 ,
185 and
186 .BR \-TX100\-12 .
187 .
188 The default resolution for previewing
189 .B \-Tps
190 output is 75\|dpi;
191 this can be changed with the
192 .B \-resolution
193 option.
194 .
195 .
196 .PP
197 While
198 .I gxditview
199 is running,
200 the left mouse button brings up a menu with several entries.
201 .
202 .
203 .TP 13n
204 .B Next Page
205 Display the next page.
206 .
207 .
208 .TP
209 .B Previous Page
210 Display the previous page.
211 .
212 .
213 .TP
214 .B Select Page
215 Select a particular numbered page specified by a dialog box.
216 .
217 .
218 .TP
219 .B Print
220 Print the
221 .I groff
222 intermediate output using a command specified by a dialog box.
223 .
224 The default command initially displayed is controlled by the
225 .B printCommand
226 application resource,
227 and by the
228 .B \-printCommand
229 option.
230 .
231 .
232 .TP
233 .B Open
234 Open for display a new file specified by a dialog box.
235 .
236 The file should contain
237 .I groff
238 intermediate output.
239 .
240 If the filename starts with a bar or pipe symbol,
241 .RB \[lq] | \[rq]
242 it will be interpreted as a command from which to read.
243 .
244 .
245 .TP
246 .B Quit
247 Exit from
248 .BR gxditview .
249 .
250 .
251 .PP
252 The menu entries correspond to actions with similar but not identical
253 names,
254 which can also be accessed with keyboard accelerators.
255 .
256 The
257 .IR n ,
258 .IR Space ,
259 .IR Return ,
260 and
261 .I Next
262 .RI ( PgDn )
263 keys are bound to the
264 .B NextPage
265 action.
266 .
267 The
268 .IR p ,
269 .IR b ,
270 .IR BackSpace ,
271 .IR Delete ,
272 and
273 .I Prior
274 .RI ( PgUp )
275 keys are bound to the
276 .B PreviousPage
277 action.
278 .
279 The
280 .I g
281 key is bound to the
282 .B SelectPage
283 action.
284 .
285 The
286 .I o
287 key is bound to the
288 .B OpenFile
289 action.
290 .
291 The
292 .I q
293 key is bound to the
294 .B Quit
295 action.
296 .
297 The
298 .I r
299 key is bound to a
300 .B Rerasterize
301 action which rereads the current file,
302 and redisplays the current page;
303 if the current file is a command,
304 the command will be re-executed.
305 .
306 Vertical scrolling can be done with the
307 .I k
308 and
309 .I j
310 keys;
311 horizontal scrolling is bound to the
312 .I h
313 and
314 .I l
315 keys.
316 .
317 The arrow keys
318 .RI ( up ,
319 .IR down ,
320 .IR left ,
321 and
322 .IR right )
323 are also bound to the obvious scrolling actions.
324 .
325 .
326 .PP
327 The
328 .B paperlength
329 and
330 .B paperwidth
331 commands in the
332 .I DESC
333 file describing a
334 .I groff
335 output device specify the length and width in machine units of the
336 virtual page displayed by
337 .IR gxditview ;
338 see
339 .MR groff_font 5 .
340 .
341 .
342 .\" ====================================================================
343 .SS "X defaults"
344 .\" ====================================================================
345 .
346 This program uses the
347 .I Dvi
348 widget from the X\~Toolkit.
349 .
350 It understands all of the core resource names and classes as well as:
351 .
352 .
353 .TP
354 .BR width\~ (class\~ Width )
355 Specifies the width of the window.
356 .
357 .
358 .TP
359 .BR height\~ (class\~ Height )
360 Specifies the height of the window.
361 .
362 .
363 .TP
364 .BR foreground\~ (class\~ Foreground )
365 Specifies the default foreground color.
366 .
367 .
368 .TP
369 .BR font\~ (class\~ Font )
370 Specifies the font to be used for error messages.
371 .
372 .
373 .TP
374 .BR fontMap\~ (class\~ FontMap )
375 Specifies the mapping from
376 .I groff
377 font names to X\~font names.
378 .
379 This must be a string containing a sequence of lines.
380 .
381 Each line contains two whitespace-separated fields:
382 firstly the
383 .I groff
384 font name,
385 and secondly the XLFD
386 (X Logical Font Description).
387 .
388 The default is shown in subsection \[lq]Default font map\[rq] below.
389 .
390 .
391 .\" ====================================================================
392 .SS "Default font map"
393 .\" ====================================================================
394 .
395 XLFDs are long and unwieldy,
396 so some lines are shown broken and indented below.
397 .\" Break them after the POINT_SIZE field (in "decipoints", so "100").
398 .
399 .
400 .PP
401 .EX
402 TR \-adobe\-times\-medium\-r\-normal\-\-*\-100\
403 \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
404 TI \-adobe\-times\-medium\-i\-normal\-\-*\-100\
405 \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
406 TB \-adobe\-times\-bold\-r\-normal\-\-*\-100\
407 \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
408 TBI \-adobe\-times\-bold\-i\-normal\
409 \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
410 CR \-adobe\-courier\-medium\-r\-normal\-\-*\-100\" break
411 \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
412 CI \-adobe\-courier\-medium\-o\-normal\" break
413 \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
414 CB \-adobe\-courier\-bold\-r\-normal\
415 \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
416 CBI \-adobe\-courier\-bold\-o\-normal\
417 \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
418 HR \-adobe\-helvetica\-medium\-r\-normal\" break
419 \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
420 HI \-adobe\-helvetica\-medium\-o\-normal\" break
421 \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
422 HB \-adobe\-helvetica\-bold\-r\-normal\" break
423 \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
424 HBI \-adobe\-helvetica\-bold\-o\-normal\" break
425 \-\-*\-100\-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
426 NR \-adobe\-new century schoolbook\-medium\-r\-normal\-\-*\-100\" break
427 \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
428 NI \-adobe\-new century schoolbook\-medium\-i\-normal\-\-*\-100\" break
429 \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
430 NB \-adobe\-new century schoolbook\-bold\-r\-normal\-\-*\-100\" break
431 \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
432 NBI \-adobe\-new century schoolbook\-bold\-i\-normal\-\-*\-100\" break
433 \-*\-*\-*\-*\-iso8859\-1\[rs]n\[rs]
434 S \-adobe\-symbol\-medium\-r\-normal\-\-*\-100\" break
435 \-*\-*\-*\-*\-adobe\-fontspecific\[rs]n\[rs]
436 SS \-adobe\-symbol\-medium\-r\-normal\-\-*\-100\" break
437 \-*\-*\-*\-*\-adobe\-fontspecific\[rs]n\[rs]
438 .EE
439 .
440 .
441 .br
442 .ne 3v
443 .\" ====================================================================
444 .SH Options
445 .\" ====================================================================
446 .
447 .B \-help
448 and
449 .B \-\-help
450 display a usage message,
451 while
452 .B \-version
453 and
454 .B \-\-version
455 show version information;
456 all exit afterward.
457 .
458 .
459 .P
460 .I gxditview
461 accepts all of the standard X\~Toolkit command-line options along with
462 the additional options listed below.
463 .
464 .
465 .TP
466 .B \-page
467 This option specifies the page number of the document to be displayed.
468 .
469 .
470 .TP
471 .BI \-backingStore\~ backing-store-type
472 Because redisplay of the
473 .I groff
474 intermediate output window can take a perceiptible amount of time,
475 this option causes the server to save the window contents so that when
476 it is scrolled around the viewport,
477 the window is painted from contents saved in backing store.
478 .
479 .I backing-store-type
480 can be one of
481 .BR Always ,
482 .B WhenMapped
483 or
484 .BR NotUseful .
485 .
486 .
487 .TP
488 .BI \-printCommand\~ command
489 The default command displayed in the dialog box for the
490 .B Print
491 menu entry will be
492 .IR command .
493 .
494 .
495 .TP
496 .BI \-resolution\~ res
497 The
498 .I groff
499 intermediate output file will be displayed at a resolution of
500 .I res
501 dots per inch,
502 unless the
503 .I DESC
504 file contains the
505 .B X11
506 command,
507 in which case the device resolution will be used.
508 .
509 This corresponds to the
510 .I Dvi
511 widget's
512 .B resolution
513 resource.
514 .
515 The default is
516 .BR 75 .
517 .
518 .
519 .TP
520 .BI \-filename\~ string
521 The default filename displayed in the dialog box for the
522 .B Open
523 menu entry will be
524 .IR string .
525 .
526 This can be either a filename,
527 or a command starting with
528 .RB \[lq] | \[rq].
529 .
530 .
531 .PP
532 The following standard X\~Toolkit command-line arguments are commonly
533 used with
534 .IR gxditview .
535 .
536 .
537 .TP
538 .BI \-bg\~ color
539 This option specifies the color to use for the background of the window.
540 .
541 The default is
542 .RB \[lq] white \[rq].
543 .
544 .
545 .TP
546 .BI \-bd\~ color
547 This option specifies the color to use for the border of the window.
548 .
549 The default is
550 .RB \[lq] black \[rq].
551 .
552 .
553 .TP
554 .BI \-bw\~ number
555 This option specifies the width in pixels of the border surrounding the
556 window.
557 .
558 .
559 .TP
560 .BI \-fg\~ color
561 This option specifies the color to use for displaying text.
562 .
563 The default is
564 .RB \[lq] black \[rq].
565 .
566 .
567 .TP
568 .BI \-fn\~ font
569 This option specifies the font to be used for displaying widget text.
570 .
571 The default is
572 .RB \[lq] fixed \[rq].
573 .
574 .
575 .TP
576 .B \-rv
577 This option indicates that reverse video should be simulated by swapping
578 the foreground and background colors.
579 .
580 .
581 .TP
582 .BI \-geometry\~ geometry
583 This option specifies the preferred size and position of the window.
584 .
585 .
586 .TP
587 .BI \-display\~ host : display
588 This option specifies the X\~server to contact.
589 .
590 .
591 .TP
592 .BI \-xrm\~ resourcestring
593 This option specifies a resource string to be used.
594 .
595 .
596 .\" ====================================================================
597 .SH Environment
598 .\" ====================================================================
599 .
600 .TP
601 .I GROFF_FONT_PATH
602 A list of directories in which to seek the selected output device's
603 directory of device and font description files.
604 .
605 See
606 .MR \%troff 1
607 and
608 .MR groff_font 5 .
609 .
610 .
611 .\" ====================================================================
612 .SH Files
613 .\" ====================================================================
614 .
615 .TP
616 .I /etc/\:\%X11/\:\%app\-defaults/\:\%GXditview
617 .TQ
618 .I /etc/\:\%X11/\:\%app\-defaults/\:\%GXditview\-color
619 define X application defaults for
620 .IR gxditview .
621 .
622 Users can override these values in the
623 .I .Xdefaults
624 file,
625 normally located in the user's home directory.
626 .
627 See
628 .MR appres 1
629 and
630 .MR xrdb 1 .
631 .
632 .
633 .TP
634 .I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%font/\:\%devX100/\:DESC
635 describes the
636 .B X100
637 output device.
638 .
639 .
640 .TP
641 .IR /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%font/\:\%devX100/ F
642 describes the font known
643 .RI as\~ F
644 on device
645 .BR X100 .
646 .
647 .
648 .TP
649 .I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%font/\:\%devX100\-12/\:DESC
650 describes the
651 .B X100\-12
652 output device.
653 .
654 .
655 .TP
656 .IR /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%font/\:\%devX100\-12/ F
657 describes the font known
658 .RI as\~ F
659 on device
660 .BR X100\-12 .
661 .
662 .
663 .TP
664 .I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%font/\:\%devX75/\:DESC
665 describes the
666 .B X75
667 output device.
668 .
669 .
670 .TP
671 .IR /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%font/\:\%devX75/ F
672 describes the font known
673 .RI as\~ F
674 on device
675 .BR X75 .
676 .
677 .
678 .TP
679 .I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%font/\:\%devX75\-12/\:DESC
680 describes the
681 .B X75\-12
682 output device.
683 .
684 .
685 .TP
686 .IR /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%font/\:\%devX75\-12/ F
687 describes the font known
688 .RI as\~ F
689 on device
690 .BR X75\-12 .
691 .
692 .
693 .TP
694 .I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/\:X.tmac
695 defines macros for use with the
696 .BR X100 ,
697 .BR X100\-12 ,
698 .BR X75 ,
699 and
700 .B X75\-12
701 output devices.
702 .
703 It is automatically loaded by
704 .I troffrc
705 when any of those output devices is selected.
706 .
707 .
708 .TP
709 .I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/\:Xps\:.tmac
710 sets up
711 .I \%troff
712 to use
713 .I \%gxditview
714 as a previewer for device-independent output targeting the
715 .B ps
716 output device.
717 .
718 It is automatically loaded by
719 .I troffrc
720 when
721 .I \%troff
722 is given the options
723 .B \-X
724 and
725 .BR \-Tps .
726 .
727 .
728 .\" ====================================================================
729 .SH Examples
730 .\" ====================================================================
731 .
732 The following command views this man page with a base point size of 12.
733 .
734 .
735 .RS
736 .P
737 .EX
738 groff \-TX100\-12 \-man gxditview.1
739 .EE
740 .RE
741 .
742 .
743 .P
744 The quality of the result depends mainly on the chosen point size and
745 display resolution;
746 for rapid previewing,
747 however,
748 something like
749 .
750 .RS
751 .EX
752 .RI "groff \-X \-P\-resolution \-P100\~" document
753 .EE
754 .RE
755 .
756 yields acceptable results.
757 .
758 .
759 .\" ====================================================================
760 .SH Authors
761 .\" ====================================================================
762 .
763 .I gxditview
764 and its predecessor
765 .I xditview
766 were written by
767 Keith Packard (MIT X Consortium),
768 Richard L.\& Hyde (Purdue),
769 David Slattengren (Berkeley),
770 Malcolm Slaney (Schlumberger Palo Alto Research),
771 Mark Moraes (University of Toronto),
772 and
773 James Clark.
774 .
775 .
776 .PP
777 This program is derived from
778 .IR xditview ;
779 portions of
780 .I xditview
781 originated in
782 .IR xtroff ,
783 which was derived from
784 .IR \%suntroff .
785 .
786 .
787 .\" ====================================================================
788 .SH "See also"
789 .\" ====================================================================
790 .
791 .UR https://\:www\:.x\:.org/\:releases/\:X11R7.6/\:doc/\:xorg\-docs/\
792 \:specs/\:XLFD/xlfd\:.html
793 \[lq]X Logical Font Description Conventions\[rq]
794 .UE ,
795 by Jim Flowers and Stephen Gildea.
796 .
797 .
798 .PP
799 .MR X 7 ,
800 .MR xrdb 1 ,
801 .MR xditview 1 ,
802 .MR groff 1 ,
803 .MR groff_out 5
804 .
805 .
806 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
807 .cp \n[*groff_gxditview_1_man_C]
808 .do rr *groff_gxditview_1_man_C
809 .
810 .
811 .\" Local Variables:
812 .\" fill-column: 72
813 .\" mode: nroff
814 .\" End:
815 .\" vim: set filetype=groff textwidth=72: