contrib/groff/src/devices/xditview/gxditview.man

   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 not always good.
  55 .
  56 .
  57 .PP
  58 The best result is 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 .
  86 .PP
  87 .BR groff 's
  88 option
  89 .B \-X
  90 should be considered obsolete today; it produces
  91 .I intermediate output
  92 for
  93 .I Postscript
  94 and uses
  95 .B \%gxditview
  96 as a viewer for it, but with a bad quality.
  97 .
  98 Simply don't use it.
  99 .
 100 .
 101 .PP
 102 During the run of
 103 .BR \%gxditview ,
 104 the left mouse button brings up a menu with the following entries:
 105 .
 106 .TP 8
 107 .B "Next Page"
 108 Display the next page.
 109 .
 110 .TP
 111 .B "Previous Page"
 112 Display the previous page.
 113 .
 114 .TP
 115 .B "Select Page"
 116 Select a particular numbered page specified by a dialog box.
 117 .
 118 .TP
 119 .B Print
 120 Print the
 121 .I groff intermediate output
 122 using a command specified by a dialog box.
 123 .
 124 The default command initially displayed is controlled by the
 125 .B printCommand
 126 application resource, and by the
 127 .B \-printCommand
 128 option.
 129 .
 130 .TP
 131 .B Open
 132 Open for display a new file specified by a dialog box.
 133 .
 134 The file should contain some
 135 .I groff intermediate
 136 .IR output .
 137 If the filename starts with
 138 .B |
 139 it will be taken to be a command to read from.
 140 .
 141 .TP
 142 .B Quit
 143 Exit from
 144 .BR \%gxditview .
 145 .
 146 .
 147 .PP
 148 The
 149 .IR n ,
 150 .I Space
 151 and
 152 .I Return
 153 keys are bound to the
 154 .B Next\ Page
 155 action.
 156 .
 157 The
 158 .IR p ,
 159 .I BackSpace
 160 and
 161 .I Delete
 162 keys are bound to the
 163 .B Previous\ Page
 164 action.
 165 .
 166 The
 167 .I q
 168 key is bound to the
 169 .B Quit
 170 action.
 171 .
 172 The
 173 .I r
 174 key is bound to the
 175 .B Rerasterize
 176 action which rereads the current file, and redisplays the current
 177 page; if the current file is a command, the command will be
 178 reexecuted.
 179 .
 180 .
 181 .PP
 182 The
 183 .B paperlength
 184 and
 185 .B paperwidth
 186 commands in the DESC file specify the length and width in machine units
 187 of the virtual page displayed by
 188 .BR \%gxditview .
 189 .
 190 .
 191 .SH OPTIONS
 192 The
 193 .B \%gxditview
 194 program accepts all of the standard X\~Toolkit command line options
 195 along with the additional options listed below:
 196 .
 197 .TP 8
 198 .B \-help
 199 This option indicates that a brief summary of the allowed options should be
 200 printed.
 201 .
 202 .TP
 203 .B \-page
 204 This option specifies the page number of the document to be displayed.
 205 .
 206 .TP
 207 .BI \-backingStore\  backing-store-type
 208 Redisplay of the
 209 .I groff intermediate output
 210 window can take up to a second or so, this option causes the server to
 211 save the window contents so that when it is scrolled around the
 212 viewport, the window is painted from contents saved in backing store.
 213 .I backing-store-type
 214 can be one of
 215 .BR Always ,
 216 .B WhenMapped
 217 or
 218 .BR NotUseful .
 219 .
 220 .TP
 221 .BI \-printCommand\  command
 222 The default command displayed in the dialog box for the
 223 .B Print
 224 menu entry will be
 225 .IR command .
 226 .
 227 .TP
 228 .BI \-resolution\  res
 229 The
 230 .I groff intermediate output
 231 file will be displayed at a resolution of
 232 .I res
 233 dpi, unless the DESC file contains the
 234 .B X11
 235 command, in which case the device resolution will be used.
 236 .
 237 This corresponds to the
 238 .I Dvi
 239 widget's
 240 .B resolution
 241 resource.
 242 .
 243 The default is 75.
 244 .
 245 .TP
 246 .BI \-filename\  string
 247 The default filename displayed in the dialog box for the
 248 .B Open
 249 menu entry will be
 250 .IR string .
 251 This can be either a filename, or a command starting with
 252 .BR | .
 253 .
 254 .
 255 .PP
 256 The following standard X\~Toolkit command line arguments are commonly used
 257 with
 258 .BR \%gxditview :
 259 .
 260 .TP 8
 261 .BI \-bg\  color
 262 This option specifies the color to use for the background of the window.
 263 .
 264 The default is \fIwhite\fP.
 265 .
 266 .TP
 267 .BI \-bd\  color
 268 This option specifies the color to use for the border of the window.
 269 .
 270 The default is \fIblack\fP.
 271 .
 272 .TP
 273 .BI \-bw\  number
 274 This option specifies the width in pixels of the border surrounding the
 275 window.
 276 .
 277 .TP
 278 .BI \-fg\  color
 279 This option specifies the color to use for displaying text.
 280 .
 281 The default is
 282 \fIblack\fP.
 283 .
 284 .TP
 285 .BI \-fn\  font
 286 This option specifies the font to be used for displaying widget text.
 287 .
 288 The default is \fIfixed\fP.
 289 .
 290 .TP
 291 .B \-rv
 292 This option indicates that reverse video should be simulated by swapping
 293 the foreground and background colors.
 294 .
 295 .TP
 296 .BI \-geometry\  geometry
 297 This option specifies the preferred size and position of the window.
 298 .
 299 .TP
 300 .BI \-display\  host : display
 301 This option specifies the X\~server to contact.
 302 .
 303 .TP
 304 .BI \-xrm\  resourcestring
 305 This option specifies a resource string to be used.
 306 .
 307 .
 308 .SH X DEFAULTS
 309 This program uses the
 310 .I Dvi
 311 widget in the X\~Toolkit.
 312 .
 313 It understands all of the core resource names and classes as well as:
 314 .
 315 .TP 8
 316 .BR width\  (class\  Width )
 317 Specifies the width of the window.
 318 .
 319 .TP
 320 .BR height\  (class\  Height )
 321 Specifies the height of the window.
 322 .
 323 .TP
 324 .BR foreground\  (class\  Foreground )
 325 Specifies the default foreground color.
 326 .
 327 .TP
 328 .BR font\  (class\  Font )
 329 Specifies the font to be used for error messages.
 330 .
 331 .TP
 332 .BR fontMap\  (class\  FontMap )
 333 Specifies the mapping from
 334 .I groff
 335 font names to X\~font names.
 336 .
 337 This must be a string containing a sequence of lines.
 338 .
 339 Each line contains two whitespace separated fields: first the
 340 .I groff
 341 font name, and secondly the X\~font name.
 342 .
 343 The default is
 344 .nf
 345 "\e
 346 TR      -adobe-times-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
 347 TI      -adobe-times-medium-i-normal--*-100-*-*-*-*-iso8859-1\en\e
 348 TB      -adobe-times-bold-r-normal--*-100-*-*-*-*-iso8859-1\en\e
 349 TBI     -adobe-times-bold-i-normal--*-100-*-*-*-*-iso8859-1\en\e
 350 CR      -adobe-courier-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
 351 CI      -adobe-courier-medium-o-normal--*-100-*-*-*-*-iso8859-1\en\e
 352 CB      -adobe-courier-bold-r-normal--*-100-*-*-*-*-iso8859-1\en\e
 353 CBI     -adobe-courier-bold-o-normal--*-100-*-*-*-*-iso8859-1\en\e
 354 HR      -adobe-helvetica-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
 355 HI      -adobe-helvetica-medium-o-normal--*-100-*-*-*-*-iso8859-1\en\e
 356 HB      -adobe-helvetica-bold-r-normal--*-100-*-*-*-*-iso8859-1\en\e
 357 HBI     -adobe-helvetica-bold-o-normal--*-100-*-*-*-*-iso8859-1\en\e
 358 NR      -adobe-new century schoolbook-medium-r-normal--*-100-*-*-*-*-iso8859-1\en\e
 359 NI      -adobe-new century schoolbook-medium-i-normal--*-100-*-*-*-*-iso8859-1\en\e
 360 NB      -adobe-new century schoolbook-bold-r-normal--*-100-*-*-*-*-iso8859-1\en\e
 361 NBI     -adobe-new century schoolbook-bold-i-normal--*-100-*-*-*-*-iso8859-1\en\e
 362 S       -adobe-symbol-medium-r-normal--*-100-*-*-*-*-adobe-fontspecific\en\e
 363 SS      -adobe-symbol-medium-r-normal--*-100-*-*-*-*-adobe-fontspecific\en\e
 364 "
 365 .fi
 366 .
 367 .
 368 .SH "SEE ALSO"
 369 .BR X (1),
 370 .BR xrdb (1),
 371 .BR xditview (1),
 372 .BR groff (@MAN1EXT@),
 373 .BR groff_out (@MAN5EXT@)
 374 .
 375 .
 376 .SH ORIGIN
 377 This program is derived from
 378 .BR \%xditview ;
 379 portions of
 380 .B \%xditview
 381 originated in
 382 .B \%xtroff
 383 which was derived from
 384 .BR \%suntroff .
 385 .
 386 .
 387 .SH COPYRIGHT
 388 Copyright 1989, Massachusetts Institute of Technology.
 389 .br
 390 See
 391 .BR X (1)
 392 for a full statement of rights and permissions.
 393 .
 394 .
 395 .SH AUTHORS
 396 Keith Packard (MIT X Consortium)
 397 .br
 398 Richard L. Hyde (Purdue)
 399 .br
 400 David Slattengren (Berkeley)
 401 .br
 402 Malcolm Slaney (Schlumberger Palo Alto Research)
 403 .br
 404 Mark Moraes (University of Toronto)
 405 .br
 406 James Clark
 407 .
 408 .\" Local Variables:
 409 .\" mode: nroff
 410 .\" End: