src/devices/xditview/gxditview.1.man

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