home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 2: PC / frozenfish_august_1995.bin / bbs / graphics / egsdvi10.lha / EGSdvi / EGSDVI.manual < prev    next >
Text File  |  1993-12-21  |  12KB  |  251 lines
  1.  
  2.    NAME
  3.      EGSDVI - DVI Previewer for the EGS window system
  4.  
  5.    SYNOPSIS
  6.      egsdvi shrink/k/n, density/k/n, dpi/k/n, side/k, top/k, paper/k,
  7.             altfont/k, listfonts/s, hush/s, hushspecials/s, hushlostchars/s,
  8.             copy/s, thorough/s, version/s, mgs/k/n, page/k, width/k/n,
  9.             height/k/n, dvifile/f/a
  10.  
  11.    STATUS AND COPYRIGHT
  12.      This program is public domain. It may be distributed as long as the
  13.      program and this manual file are always distributed together with the
  14.      following copyright notice and are not modified in any way:
  15.              EGSDVI Copyright in 1993 by Dietmar Heidrich
  16.  
  17.    DESCRIPTION
  18.      EGSDVI is a program which runs under the EGS window system. It is used to
  19.      preview DVI files, such as are produced by TeX. EGSDVI needs EGS version 6
  20.      or higher.
  21.  
  22.      This program has the capability of showing the file shrunken by various
  23.      (integer) factors, and also has a `magnifying glass' which allows one to
  24.      see a small part of the unshrunk image momentarily.
  25.  
  26.      Before displaying any page or part thereof, it checks to see if the dvi
  27.      file has changed since the last time it was displayed.  If this is the
  28.      case, then EGSDVI will reinitialize itself for the new dvi file.  For this
  29.      reason, exposing parts of the EGSDVI window while TeX is running should be
  30.      avoided.  This feature allows you to preview many versions of the same
  31.      file while running EGSDVI only once.
  32.  
  33.      In addition to using keystrokes to move within the file, EGSDVI provides
  34.      buttons on the right side of the window, which are synonymous with vari-
  35.      ous sequences of keystrokes.
  36.  
  37.    SHELL OPTIONS
  38.      In addition to specifying the .dvi file (with or without the .dvi suffix),
  39.      EGSDVI supports the following command line options. The corresponding name
  40.      for the environment file (see below) is given in parantheses.
  41.  
  42.      page
  43.           Specifies the first page to show; the first page is the default.
  44.  
  45.      shrink
  46.           (shrinkFactor) Defines the initial shrink factor.  The default value
  47.           is 3.
  48.  
  49.      density
  50.           (densityPercent) Determines the density used when shrinking bitmaps
  51.           for fonts.  A higher value produces a lighter font.  The default
  52.           value is 40.
  53.  
  54.      dpi
  55.           (pixelsPerInch) Defines the size of the fonts to use, in pixels
  56.           per inch.  The default value is 300.
  57.  
  58.      altfont
  59.           (altFont) Declares a default font to use when the font in the dvi
  60.           file cannot be found.  This is useful, for example, with PostScript
  61.           <tm> fonts.
  62.  
  63.      listfonts
  64.           (listFonts) Causes the names of the fonts used to be listed.
  65.  
  66.      hushspecials
  67.           (hushSpecials) Causes EGSDVI to suppress warnings about \special
  68.           strings which it cannot process.
  69.  
  70.      hushlostchars
  71.           (hushLostChars) Causes EGSDVI to suppress warnings about references
  72.           to characters which are not defined in the font.
  73.  
  74.      hush
  75.           (hush) Causes EGSDVI to suppress all suppressable warnings.
  76.  
  77.      thorough
  78.           (thorough) EGSDVI will usually try to ensure that overstrike charac-
  79.           ters (e.g.  \notin) are printed correctly.  On monochrome displays,
  80.           this is always possible with one logical operation, either and or
  81.           or.  On color displays, however, this may take two operations, one
  82.           to set the appropriate bits and one to clear other bits.  If this
  83.           is the case, then by default EGSDVI will instead use the copy opera-
  84.           tion, which does not handle overstriking correctly.  The
  85.           `thorough' option chooses the slower but more correct choice.
  86.           See also copy, below.
  87.  
  88.      copy
  89.           (copy) Always use the copy operation when writing characters to
  90.           the display.  This option may be necessary for correct operation on
  91.           a color display, but overstrike characters will be incorrect.
  92.  
  93.      version
  94.           (version) Print information on the version of EGSDVI.
  95.  
  96.      sidemargin
  97.           (sideMargin) Specifies the side margin.
  98.           This should be a decimal number optionally followed by "cm",
  99.           e.g., 1.5 or 3cm, giving a measurement in inches or centimeters.
  100.           It determines the `home' position of the page within the window
  101.           as follows.  If the entire page fits in the window, then the margin
  102.           settings are ignored.  If, even after removing the margins from the
  103.           left, right, top, and bottom, the page still cannot fit in the win-
  104.           dow, then the page is put in the window such that the top and left
  105.           margins are hidden, and presumably the upper left-hand corner of
  106.           the text on the page will be in the upper left-hand corner of the
  107.           window.  Otherwise, the text is centered in the window.  See also
  108.           `M' under the KEYSTROKES section.
  109.  
  110.      topmargin
  111.           (topMargin) Specifies the top and bottom margins (see above).
  112.  
  113.      paper
  114.           (paper) Specifies the size of the printed page.  This may be of
  115.           the form wxh (or wxhcm), where w is the width in inches (or cm) and
  116.           h is the height in inches (or cm), respectively.  There are also
  117.           synonyms which may be used:  us (8.5x11), usr (11x8.5), legal
  118.           (8.5x14), foolscap (13.5x17), as well as the ISO sizes a1-a7, b1-
  119.           b7, c1-c7, a1r-a7r (a1-a7 rotated), etc.  The default size is 8.5 x
  120.           11 inches.
  121.  
  122.      mgs
  123.           (magnifierSize[n]) Specifies the size of the window to be used for
  124.           the `magnifying glass' for button n.  See the MOUSE ACTIONS sec-
  125.           tion.  Defaults are 200, 350, 600, 900, and 1200.  The shell option
  126.           lets you only specify the size for button 1.
  127.  
  128.      width
  129.           (width) Specifies the initial window width.
  130.  
  131.      height
  132.           (height) Specifies the initial window height.
  133.  
  134.    WORKBENCH
  135.      For the workbench, you will need to click the icon of the dvi file to
  136.      display and then double-click the EGSDVI icon while pressing a shift key.
  137.  
  138.    KEYSTROKES
  139.      EGSDVI recognizes the following keystrokes when typed in its window.
  140.  
  141.      q    Quits the program.  'x' will do this, too.
  142.  
  143.      n    Moves to the next page.  Synonyms are Space, Control-M (Carriage
  144.           Return) and Control-J (Line Feed).  If you press shift
  145.           simultaneously, the top part of that page will be displayed.
  146.  
  147.      p    Moves to the previous page.  Synonym is `b'.  If you press shift
  148.           simultaneously, the bottom part of that page will be displayed.
  149.  
  150.      cursor-up
  151.      cursor-down
  152.      cursor-left
  153.      cursor-right
  154.           Moves into the specified direction.  Pressing an alternate key
  155.           simultaneously moves a bigger portion, pressing a shift key
  156.           moves to the appropriate border.
  157.  
  158.      R    Forces the dvi file to be reread.  This allows you to preview many
  159.           versions of the same file while running EGSDVI only once.
  160.  
  161.    MOUSE ACTIONS
  162.      If the shrink factor is set to any number other than one, then clicking
  163.      any mouse button will pop up a `magnifying glass' which shows the
  164.      unshrunk image in the vicinity of the mouse click.  This subwindow
  165.      disappears when the mouse button is released.  Different mouse buttons
  166.      produce different sized windows, as indicated by the mgs option.  Mov-
  167.      ing the cursor while holding the button down will move the magnifying
  168.      glass.
  169.  
  170.      Also, the scrollbars behave in the standard way.  The buttons work the
  171.      expected way.  The page gadget lets you enter a direct page number.
  172.  
  173.    ENVIRONMENT
  174.      For access to persistent defaults, EGSDVI reads an environment file named
  175.      "TEX:.egsdvidefaults".  This file contains the options listed above.  Each
  176.      line of the file consists of a keyword and its arguments, separated by
  177.      spaces or tabs.  Comment lines start with a semicolon as the first
  178.      character.  Additionally, there can be the environment variables explained
  179.      in the following paragraph.
  180.  
  181.      The environment variable `DVIFONTS' determines the path(s) searched for
  182.      fonts in the following manner.  The string consists of one or more strings
  183.      separated by semicolons.  In each such string, the substring `%f' is
  184.      changed to the font name; `%d' is changed to the magnification; and `%p'
  185.      is changed to the font family (`gf', `pk', or `pxl'). If no `%f' appears
  186.      in the string, then the string `/%f.%d%p' is added on the end. For
  187.      example, if the string is `/usr/local/tex/fonts' and the font is cmr10 at
  188.      300dpi, then it searches for /usr/local/tex/fonts/cmr10.300gf,
  189.      /usr/local/tex/fonts/cmr10.300pk, and /usr/local/tex/fonts/cmr10.1500pxl,
  190.      in that order.  An extra semicolon anywhere in the `DVIFONTS' variable
  191.      causes the system default paths to be tried at that point.  If the font is
  192.      not found in the desired size, then EGSDVI will try to find the nearest
  193.      size.  If the font cannot be found at all, then EGSDVI will try to vary
  194.      the point size of the font (within a certain range), and if this fails,
  195.      then it will use the font specified as the alternate font (cf. altfont).
  196.  
  197.      The default for DVIFONTS is "TEX:pk/%d/%f.%d%p", well suited for the
  198.      public domain TeX implementation PasTeX.
  199.  
  200.      For compatibility with TeX, you may also use `TEXFONTS' in place of
  201.      `DVIFONTS', although in that case the variable should not include any
  202.      `%' specifiers.  The reason for recognizing TEXFONTS is that certain
  203.      versions of TeX also support the convention regarding an extra colon in
  204.      the font path; therefore, users who create their own fonts can put both
  205.      their .tfm and raster files in the same directory and do `TEXFONTS
  206.      :MFdir' or `TEXFONTS MFdir:' in order to get both TeX and EGSDVI to search
  207.      their directory in addition to the system standard directories. The
  208.      DVIFONTS variable overrides the TEXFONTS variable, so that on those sites
  209.      where TEXFONTS must be set explicitly, and therefore this feature is not
  210.      useful, the DVIFONTS may be omitted to cause EGSDVI to ignore TEXFONTS.
  211.  
  212.      EGSDVI also recognizes the PKFONTS variable, which is checked after DVI-
  213.      FONTS but before TEXFONTS.
  214.  
  215.      The `DVISIZES' variable must be set to indicate which sizes of fonts are
  216.      available.  It should consist of a list of numbers separated by colons. If
  217.      the list begins with a colon, the system default sizes are used, as well.
  218.      Sizes are expressed in dots per inch; decimals may be used for `pxl'
  219.      files: for example, a 300 dots per inch file magnified by half a step
  220.      comes out to 1643 dots per five inches, which should be encoded as 328.6.
  221.      The current default set of sizes is 300 : 328.6 : 360 : 432 : 518.4 : 622
  222.      : 746.4.  EGSDVI will also try the actual size of the font before trying
  223.      any of the given sizes.
  224.  
  225.      Virtual fonts are also supported, although EGSDVI does not have any
  226.      built-in fonts to which they can refer.  The search path for .vf files
  227.      can be specified with the `DVIVFS' environment variable in a similar
  228.      manner to that for the `DVIFONTS' variable.  EGSDVI will also check the
  229.      VFFONTS variable if the DVIFONTS variable is not set.  Virtual fonts are
  230.      searched for immediately after looking for the font as a normal font in
  231.      the exact size specified.
  232.  
  233.      It's possible to automatically invoce MetaFont for creating fonts not
  234.      available.  For this, the DVIMAKEPK environment variable can be used.  The
  235.      format of DVIMAKEPK should be "scriptname %n %d %b %m".  "scriptname" is
  236.      the name of the shell script to be started in order to call MetaFont.
  237.      It's up to you to write a script that calls MetaFont appropriately. Before
  238.      the script is called, the % arguments are substituted. %n is substituted
  239.      by the font name, such as `cmr10', %d by the resolution the font is needed
  240.      at, %b by the base resolution, useful for figuring out the mode to make
  241.      the font in, and %m is a string to pass to MF as the magnification. The
  242.      default script name is "MakeTeXPK".
  243.  
  244.    AUTHORS
  245.      Eric Cooper, CMU, did a version for direct output to a QVSS.  Modified
  246.      for X by Bob Scheifler, MIT Laboratory for Computer Science.  Modified
  247.      for X11 by Mark Eichin, MIT SIPB.  Additional enhancements by many oth-
  248.      ers.  EGS port by Dietmar Heidrich.
  249.  
  250.      This manual is based on the XDVI manual.
  251.