src/devices/xditview/gxditview.man

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