summaryrefslogtreecommitdiff
path: root/dviware/dvgtk/doc/options.txt
diff options
context:
space:
mode:
Diffstat (limited to 'dviware/dvgtk/doc/options.txt')
-rw-r--r--dviware/dvgtk/doc/options.txt139
1 files changed, 139 insertions, 0 deletions
diff --git a/dviware/dvgtk/doc/options.txt b/dviware/dvgtk/doc/options.txt
new file mode 100644
index 0000000000..b913ebb1f9
--- /dev/null
+++ b/dviware/dvgtk/doc/options.txt
@@ -0,0 +1,139 @@
+dvgt is a version of the DVItoVDU interactive TeX page previewer.
+The program allows you to look at TeX-generated DVI files on a variety
+of commonly available VDUs.
+
+The "DVItoVDU User Guide", "userguide.tex", explains how to use the program.
+
+USAGE: dvgt filename[.dvi]
+ [-H x_offset] [-V y_offset] [-d dummy_pk] [-e dummy_tfm]
+ [-f pk_directory] [-h helpfile] [-i] [-l]
+ [-m magnification] [-p postscript_font_prefix]
+ [-r xres yres] [-t tfm_directory]
+ [-v vdu] [-x paperwd] [-y paperht]
+
+NOTE ON OPTIONS' DEFAULTS:
+
+All options have default values.
+System dependent initial defaults are set at compile-time.
+(Compilation note: these constants are set in the source file "defaults.h".)
+Some defaults can be set by environment variables.
+The command line options override the environment variables, which in
+turn override the compiled initial defaults.
+
+BRIEF SUMMARY OF OPTIONS:
+
+-H horizontal_offset (default = 0.0 in)
+-V vertical_offset (default = 0.0 in)
+-l (set landscape mode, instead of the default portrait mode)
+-m magnification (default = DVI file's intrinsic magnification)
+-v vdu (default = value of the environment variable TERM)
+
+ vdu may be one of:
+
+ aed512 gigi kermit ncsatel regis tek4010 vis240 vis241 vis500 vis550
+ vis603 vis630 vk100 vt100 vt100132 vt102 vt125 vt200 vt220 vt240
+ vt640
+
+The other options' default values are system dependent.
+Try "dvgt -f", for example, to find the current default PK font directory.
+
+COMMAND OPTIONS:
+
+-H horizontal_offset (default = 0.0in)
+
+-V vertical_offset (default = 0.0in)
+
+ TeX, by default, considers the top left corner of the printed page as
+ one inch below and one inch to the right of the physical page. So
+ does dvgt. The two offsets move this corner. Positive dimensions
+ move it downwards and rightwards; negative offsets are allowed.
+
+-d file (default is system dependent; environment: DV_DUMMY_PK)
+
+ dvgt will warn you if your document uses a font at a non-existent size.
+ Rather than abort, it will load the PK font specified after -d and continue
+ so you can look for more errors. Paragraphs using this dummy information
+ are likely to have ragged right margins.
+
+-e file (default is system dependent; environment: DV_DUMMY_TFM)
+
+ Default TFM file, similar to -d option.
+
+-f file (default is system dependent; environment: PKFONTS or TEXFONTS)
+
+ dvgt gets all its font information from PK files. These files are
+ kept within the directory specified by this option.
+
+-h file (default is system dependent; environment: DV_HELP)
+
+ The ? command reads the help text file specified by this option.
+
+-i (default is system dependent; environment: DV_IMMED_HELP)
+
+ Display the path name of the immediate help file.
+ Typing "dv" by itself displays the immediate help file.
+
+-l
+
+ Set landscape mode: exchange x and y dimensions.
+ (This does NOT rotate the page, sorry.)
+ The default is portrait mode.
+
+-m i (default = DVI magnification)
+
+ This option allows you to replace the magnification used in the
+ DVI file with some other value; i is a positive *integer*, 1000 times
+ the desired magnification. The given value should be chosen carefully
+ so that the new font sizes still correspond to existing PK files.
+ Unless you know exactly what you are doing you should avoid using -m,
+ especially if your TeX source file uses \magnification AND true dimensions.
+
+-r x,y (default is system dependent)
+-r x
+
+ dvgt treats the imaginary sheet of paper on which a DVI page will
+ appear as a two dimensional array of tiny dots known as paper pixels.
+ x and y are positive floating point numbers that define the numbers of
+ pixels per inch in the horizonatl and vertical directions, respectively.
+ Their values should match the respective resolutions of the device that
+ will be used to print your document.
+ If only one value is given, then it is used as the resolution both
+ horizontally and vertically.
+
+-t tfm_directory (default is system dependent; environment: TEXFONTS)
+
+ This sets the directory where dvgt will look for TFM (TeX Font
+ Metric) files, such as "cmr10.tfm".
+
+-v string (default = value of TERM)
+
+ This option is used to tell dvgt what type of VDU you are using.
+ If TERM does not describe your VDU, you need to override the default value.
+ Typing `dvgt -v vis550 foo' will tell dvgt you're using a VISUAL 550.
+ The current version will accept the following strings
+ (in upper or lower case):
+
+ aed512 (AED 512 with 512 by 512 screen)
+ kermit (same as ncsatel)
+ ncsatel (NCSA Telnet's Tektronix 4010 emulation)
+ regis (any ReGIS compatible VDU; synonyms = GIGI, VK100, VT125, VT240)
+ tek4010 (same as ncsatel)
+ vis240 (VISUAL 240; synonym = VIS241)
+ vis500 (VISUAL 500)
+ vis550 (VISUAL 550)
+ vis603 (VISUAL 603)
+ vis630 (VISUAL 630)
+ vt100 (any VT100 compatible VDU in 80 column mode; synonym = VT102)
+ vt100132 (any VT100 compatible VDU in 132 column mode)
+ vt220 (VT220 using down-loaded chunky graphics; synonym = VT200)
+ vt640 (VT100 with Retro-Graphics)
+
+-x dimen (default is system dependent)
+-y dimen (default is system dependent)
+
+ These two options define the width and height of the paper upon which your
+ document will be printed. Both values are specified as dimensions like
+ those used in TeX, but the units are restricted to BP, CM, IN, MM, PC, PT,
+ PX, or SP. PX is specific to dvgt, and represents one paper pixel.
+ Every time you select a page, dvgt will use these paper dimensions
+ to check that all printed material falls within the paper edges.