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