Debian Codegraph @

upstream/debian-unstable/man1/gxditview.1

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