OS/2 Professional

home *** CD-ROM | disk | FTP | other *** search

/ OS/2 Professional / OS2PRO194.ISO / os2 / editor / emtex / doc / english / tex.doc < prev

Wrap

Text File | 1993-12-29 | 27.2 KB | 775 lines

============================================================================== TEX.DOC for emTeX 3.1415 [3c-beta9] VERSION: 29-Dec-1993 ============================================================================== ****************************************************************************** ****************************************************************************** ** ** ** ATTENTION: VERSION 3.1415 [3c-beta9] IS A BETA TEST RELEASE! ** ** ** ** YOU HAVE TO CREATE NEW FORMAT FILES! ** ** ** ****************************************************************************** ****************************************************************************** Running emTeX ------------- Standard version: tex [options] [&format] [input_file] [TeX commands] (DOS; 8086/88 CPU) tex186 [options] [&format] [input_file] [TeX commands] (DOS; 80186 CPU) texp [options] [^&format] [input_file] [TeX commands] (OS/2) bigTeX version: btex [options] [&format] [input_file] [TeX commands] (DOS; 8086/88 CPU) btex186 [options] [&format] [input_file] [TeX commands] (DOS; 80186 CPU) tex386 [options] [&format] [input_file] [TeX commands] (DOS; 80386 CPU) btexp [options] [^&format] [input_file] [TeX commands] (OS/2 1.x) tex386 [options] [^&format] [input_file] [TeX commands] (OS/2 2.x) tex186.exe can be used instead of tex.exe on a machine which has an 80186 (or V20, V30, 80188, 80286, 80386, 80486) CPU. The 186 version of the program is shorter and slightly faster. tex186.exe can be renamed tex.exe if running under DOS 3.x. If only a 8086/8088 CPU is available, tex.exe must be used. The bigTeX versions provide four times the main memory of the standard versions but are significantly slower (this isn't true for tex386) and need more memory. The command line ---------------- All arguments of the command line coming after the options (see below) are passed as first input line to TeX. The first input line is the one with the ** prompt. You can load a FMT file by typing '&format' in that line. Characters with codes 0 to 31 (control characters) and 128 to 255 (extended characters) should not be used in the first input line and in the command line. If you want to pass a quotation mark in the command line to TeX, you have to escape the quotation mark by a backslash: \". When specifying a file name in the command line, you should consider the following: TeX treats the character `\' specially (macro name) and emTeX treats the character `/' at the beginning of a command line argument specially (command line option, unless the switch character is set to `-'). Therefore you should precede a file name starting with `\' by the drive name: correct: tex d:/mytex/mytext wrong: tex /mytex/mytext wrong: tex \mytex\mytext wrong: tex d:\mytex\mytext Using options ------------- All options must be preceded by `-' or `/'. Options may be separated by spaces or another option may follow immediately: in this case the following option must start with `/'. If your operating system is setup to use `-' for options instead of `/', you must precede options by `-' and you must separate options by spaces. In this case, you can use `/' in path names, for example tex -i -mt15000 /mytex/myfmt \dump With a standard setup (using `/' for options), you should enter tex /i/mt15000 c:\mytex\mytext \dump instead. Only `/' is used in these instructions. Upper and lower case are currently not significant. /7 Bit 7 of input characters is ignored. /8 8-bit characters are accepted in input files. Without /8, codes 128 to 255 will be mapped to code 127, which is declared invalid by plain.tex. This option can be used only with INITEX (following /i). The setting will be stored in the FMT file. If /c is given, the tables in the TCP file will be used and /8 ignored. /a* This option is used to set the name of the file used for calling an editor. Between /a and the file name you can insert `:', `=', `:=', or nothing. Spaces are not allowed. You have to use `\' as path delimiter, if your operating system isn't setup for using `-' as switch character. /b \batchmode. /c* Specify a TCP file for converting special characters and code page translation. Between /c and the file name you can insert `:', `=', `:=' or nothing. Spaces are not allowed. This option can be used only with INITEX (following /i). The translation tables will be stored in the FMT file. If /c* is given, /8 and /r will be ignored. See the maketcp.doc for more details. See `The /c option' and `Directories' below. The default extension is .tcp. /d* Use this option for disable special features. There's one letter for each feature; you can give multiple letters after /d. If you don't give any letters, ie, /d, all features will be disabled: b Don't install interrupt handler for Ctrl-Break e Don't use expanded memory (EMS) u Don't ues upper memory blocks (UMB) x Don't use extended memory (XMS) This option is not supported by tex386. Example: /deu disables usage of EMS and UMB, but doesn't disable usage of XMS. /e \errorstopmode. /i INITEX (create FMT file). Some options can be used only with INITEX, these must follow /i. /l Set low priority, so that TeX only runs when the machine has nothing better to do (OS/2 only, not supported by tex386). /ml Enable \charsubdef. This option is only available for INITEX and will be stored in the FMT file. /m* Set memory array sizes, see below. /n \nonstopmode. /o Allow 8 bit characters (codes 128-254) for output. This option can be used only with INITEX (following /i). The setting will be stored in the FMT file. If /o is not given, hexadecimal notation is used for codes 128-254. Code 255 is displayed ^^ff independent of the setting of the /8 option. /r Control characters left unchanged. Without /r, codes 1 to 8, 11, and 14 to 31 will be mapped to code 127, which is declared invalid by plain.tex. This option can be used only with INITEX (following /i). The setting will be stored in the FMT file. If /c is given, the tables in the TCP file will be used and /r ignored. /s \scrollmode. You can put options into the environment variable EMTEXOPT. These options are observed before the options given in the command line. Examples: tex -7 -s &lplain myfile tex /i /c850_tex plain \dump Calling an editor ----------------- When an error is encountered by TeX in an input file, you can call an editor by hitting `E'; cf. The TeXbook, page 34. The /a* option is used to set the name of a file into which emTeX writes the line number, the file name of the offending input file and the name of the log file. The environment variable EMTEXED controls the output to the file specified by /a*. `%1' will be replaced by the line number, `%2' will be replaced by the path name of the input file, and `%3' will be replaced by the path name of the log file. You can insert a percent sign by `%%'. If the environment variable `EMTEXED' is not set, emtexed %1 %2 %3 will be used as template. If you use the Norton Editor (for instance), you should enter set emtexed=ne +%1 %2 For QEdit v2.1 you can use set emtexed=q %2 -n%1 If you give the command line option /a=ed.bat and if, for instance, TeX finds an error in line 172 of test.tex (in directory d:\mytex), emTeX will write emtexed 172 d:\mytex\test.tex d:\mytex\test.log to the file ed.bat (EMTEXED not set). To use this feature, you have to call emTeX via a batch file. Example (texed.bat or texed.cmd): @echo off rem texed.bat if exist texed2.bat del texed2.bat tex /a=texed2.bat %1 %2 %3 %4 %5 %6 %7 %8 %9 if exist texed2.bat texed2 Warning: when running emTeX on a network, a unique batch file should be used for each user to avoid conflicts. You may use environment variables to accomplish this. If you don't set the environment variable EMTEXED, you have to create another batch file (emtexed.bat or emtexed.cmd) which calls the editor. And here's an example for the Programmer's WorkBench (or Microsoft Editor) running under OS/2. It is recommended to keep the editor loaded while running TeX. You should call emTeX with the following batch file (glatexed.cmd): @echo off rem glatexed.cmd set emtexed=%%2 %%1 texp -a=c:\init\emtexed.m ^&lplaing %1 %2 %3 %4 %5 %6 %7 %8 %9 Define the following macros for the Programmer's WorkBench: texed:=Arg "c:\\init\\emtexed.m" Setfile Begfile Arg Setfile -> _texed2 _texed2:=Setfile Arg Arg " [0-9]" Psearch -> _texed3 _texed3:=Right Arg Endline Lasttext Mark Arg Refresh Lasttext Mark (for the Microsoft Editor:) texed:=Arg "c:\\init\\emtexed.m" Setfile Arg Mpage Arg Setfile -> _texed2 _texed2:=Setfile Arg Arg " [0-9]" Psearch -> _texed3 _texed3:=Right Arg Endline " " Emacscdel Mark Arg Refresh Lasttext Mark and assign the texed macro to a key: texed:Ctrl+E Now you can move to the desired line by typing Ctrl+E. (The directory c:\init and the file c:\init\emtexed.m must exist before typing Ctrl-E.) Using file names in TeX input files ----------------------------------- When using file names in TeX input files (\input blahblah, for instance), you have to use `/' instead of '\' as path separator as `\' is interpreted by TeX as start of a macro name. correct: \input /mytex/mytext wrong: \input \mytex\mytext You should always use the official long name of a file, for instance \documentstyle[twocolumn]{book} \input prepictex.tex \font\circe=lcirclew10 DO NOT USE \documentstyle[twocolum]{book} \input prepicte.tex \font\circe=lcirclew emTeX takes care of truncating file names. Changing the memory layout -------------------------- The memory layout can be changed by command line options. This feature is required only for special cases, the defaults are suitable for most applications. You can insert `:', `=', `:=' or nothing between /mX and the number. Option | Removes this TeX error message: | Range | Default | TeX capacity exceeded, sorry [...=###] | min-max | DOS / OS/2 -------+----------------------------------------+--------------+----------- /ma# | parameter stack (macro parameters) | 60-1000 | 60 /mf# | font memory (font metric data) | 5000-65500 | 32766 /mm# | main memory (main memory) |262142-1048576| 262142 /mn# | semantic nest size (mode nesting) | 20-3000 | 40 / 100 /mp# | pool size (strings) | 20000-65500 | 50000 /ms# | save size (values saved by grouping) | 100-16000 | 600 /mt# | pattern memory (hyphenation) | 5000-65500 | 10000 Note: /mm# is supported by tex386 only. You may use, for instance, the command set emtexopt=/ms:2000 /mp:45000 to increase save size while decreasing pool size. See The TeXbook, pages 300 and 301. The maximum /mf# value of bigTeX is 262141, the default is 81920. Environment variables --------------------- BTEXFMT directories for FMT files and tex.pool (bigTeX) EMTEXDIR base emTeX directory EMTEXED template for calling an editor (see above) EMTEXOPT options (see above) TEXDATA directories for TCP files TEXFMT directories for FMT files and tex.pool (standard TeX) TEXTFM directories for TFM files TEXINPUT directories for input files TMP directory for temporary file Directories ----------- To find a file, emTeX performs the following steps: 1a. If no directory is specified (that is, the name does not contain `:', `/' or `\'), the file is sought in the current working directory (this step is skipped for TFM files) 1b. If a directory is specified (that is, the name contains `:', `/' or `\'), only the specified directory is searched; step 2 below is not performed. After step 1a, exactly one of the following steps is performed, depending on the environment variables: 2a. If the appropriate environment variable is set (for instance TEXINPUT, see above), all directories listed in that variable are searched in the specified order. For each directory listed, subdirectory search can be enabled; see below for details. Directories are separated by `;' 2b. If the appropriate environment variable is not set, but the EMTEXDIR environment variable is set, a default directory (and one level of its subdirectories) under the directory specified by EMTEXDIR is searched. The following default directories are used: btexfmts for FMT files and tex.pool (bigTeX) data for TCP files texinput for input files texfmts for FMT files and tex.pool (standard TeX) tfm for TFM files For instance, if TEXINPUT is not set and EMTEXDIR is set to d:\tex, the directory d:\tex\texinput and one level of its subdirectories is searched for input files. 2c. If both the appropriate environment variable and EMTEXDIR are not set, the default directory under \emtex and one level of its subdirectories are searched. For instance, input files are sought in \emtex\texinput. If you have installed emTeX in \emtex and you have only one disk drive, you don't have to set any environment variables. If you have installed emTeX in a different main directory (but you have kept the subdirectories) or if you have multiple disks, setting EMTEXDIR is sufficient. For instance, if emTeX is installed in d:\local\tex, use set emtexdir=d:\local\tex Then, input files are sought in d:\local\tex\texinput, TFM files are sought in d:\local\tex\tfm, and so on. If you have changed the directory structure, you have to set the individual environment variables such as TEXINPUT. It is sufficient to set EMTEXDIR and use the other environment variables to override the default directories. For instance, if you have installed emTeX in d:\emtex and you have additional input files in d:\tex\styles, use the following commands: set emtexdir=d:\emtex set texinput=d:\emtex\texinput;d:\tex\styles Recursively searching subdirectories ------------------------------------ emTeX supports subdirectory search. That is, either one level or all levels of subdirectories of the specified directories are searched. Append `!' to a directory name to get one-level subdirectory search. Append '!!' to a directory name to let emTeX search all subdirectories of that directory. One-level subdirectory seach is always enabled for the default directories, that is, set texinput=\emtex\texinput! is equivalent to the default behaviour. Directories are searched before there subdirectories. No other order between directories is defined. For example, suppose you have the following directories: \emtex\texinput \emtex\texinput\local \emtex\texinput\local\joe \emtex\texinput\local\zoe \emtex\texinput\latex \emtex\texinput\amstex With set texinput=\emtex\texinput only \emtex\texinput is searched. With set texinput=\emtex\texinput! the directories \emtex\texinput \emtex\texinput\local \emtex\texinput\latex \emtex\texinput\amstex are searched. With set texinput=\emtex\texinput!! all the directories listed above are searched. File name truncation -------------------- For each directory to be searched for a file, emTeX in turn tries the following modifications to the path name: 1. unmodified path name (this step is skipped under DOS) 2. path name truncated according to the 5+3.3 rule 3. path name truncated according to the 8.3 rule The 5+3.3 rule takes the first five and last three characters of the base name and truncates the extension to three characters: longfilename.texi -> longfame.tex ("longf" + "ame" + "." + "tex") The 8.3 rule truncates the base name to eight characters and the extension to three characters: longfilename.texi -> longfile.tex ("longfile" + "." + "tex") This applies to all components of a path name. After opening the main input file, \jobname contains the truncated name of the input file. In consequence, the names of the output files (which are derived from the name of the main input file) are also truncated. Long names of output files are always truncated according to the 5+3.3 rule if creating the file with the long name fails. The /c option ------------- Currently, only one TCP file is available: 850_tex.tcp. This file converts some characters of code page 850 into TeX commands: ^^80 -> \c C ^^a5 -> \~N ^^81 -> \"u ^^a6 -> \b a ^^82 -> \'e ^^a7 -> \b o ^^83 -> \^a ^^a8 -> ?` ^^84 -> \"a ^^ad -> !` ^^85 -> \`a ^^ae -> $\scriptstyle\ll$ ^^86 -> \aa{} ^^af -> $\scriptstyle\gg$ ^^87 -> \c c ^^b5 -> \'A ^^88 -> \^e ^^b6 -> \^A ^^89 -> \"e ^^b7 -> \`A ^^8a -> \`e ^^b8 -> \copyright{} ^^8b -> \"\i{} ^^bd -> \leavevmode\hbox{\rm\rlap/c} ^^8c -> \^\i{} ^^c6 -> \~a ^^8d -> \`\i{} ^^c7 -> \~A ^^8e -> \"A ^^d2 -> \^E ^^8f -> \AA{} ^^d3 -> \"E ^^90 -> \'E ^^d4 -> \`E ^^91 -> \ae{} ^^d5 -> \i{} ^^92 -> \AE{} ^^d6 -> \'I ^^93 -> \^o ^^d7 -> \^I ^^94 -> \"o ^^d8 -> \"I ^^95 -> \`o ^^de -> \`I ^^96 -> \^u ^^e0 -> \'O ^^97 -> \`u ^^e1 -> \ss{} ^^98 -> \"y ^^e2 -> \^O ^^99 -> \"O ^^e3 -> \`O ^^9a -> \"U ^^e4 -> \~o ^^9b -> \o{} ^^e5 -> \~O ^^9c -> \pounds{} ^^e9 -> \'U ^^9d -> \O{} ^^ea -> \^U ^^a0 -> \'a ^^eb -> \`U ^^a1 -> \'\i{} ^^ec -> \'y ^^a2 -> \'o ^^ed -> \'Y ^^a3 -> \'u ^^f4 -> \P{} ^^a4 -> \~n ^^f5 -> \S{} The characters with \' or \` do not work in the LaTeX tabbing environment. End of line ----------- emTeX recognizes CR, LF and CR/LF as end of line. End of file ----------- Ctrl-Z at the beginning of a line indicates end of file. Therefore, the last line of the file must not end in Ctrl-Z (without CR, LF or CR/LF). Creating FMT files ------------------ FMT files are created by INITEX, which will be activated by using the /i command line option. In addition to /i, you can give the options /8, /c* and /r for changing the interpretation of input character. The option /o causes emTeX to display characters 128 to 254 as single characters, without using hexadecimal notation (^^80 to ^^fe). Character 255 will always displayed ^^ff. These options are valid only with INITEX and must be given after /i. The size of various TeX memory areas can be changed with the /m* options. When loading a FMT file created with an enlarged memory area, you have to use appropriate /m* options. (The value of /mt# may be smaller than that used for INITEX.) Don't panic, if emTeX spends a long time reading a file containing hyphenation patterns or if emTeX seems to stop after displaying xx hyphenation exceptions. The capacity for hyphenation patterns has been increased at the expense of decreased speed. Examples for INITEX: Create FMT file for plain TeX without code translation: tex /i /r /8 /o plain \dump Create FMT file for LaTeX, translate extended characters of code page 850 into TeX commands, disable control characters: tex /i /c850_tex lplain \dump The same thing with German hyphenation patterns for language 1 in addition to the US English hyphenation patterns (\language isn't reset to 0 to make the German hyphenation patterns default after loading the FMT file): tex /i /c850_tex /mt20000 lplain \language1\input ghyphen.max \dump If you want to create lplaing.fmt instead of lplain.fmt in the previous example, you may create a file named lplaing.ini containing \input lplain \language1 \input ghyphen.max \dump and run INITEX by typing tex /i /c850_tex /mt20000 lplaing.ini to create the FMT file. TeX capacity ------------ Memory area (1) | Constant | tex (2) | btex, tex386 (2) ----------------------+-----------------+------------+-------------- number of strings | max_strings | 10000 | 10000 pool size | pool_size | 5000-65500 | 5000-65500 (4) main memory size | mem_max | 65532 | 262141 (5) hash size | hash_size | 3500 | 10000 font memory | font_mem_size | 5000-65500 | 5000-262141 exception dictionary | hyph_size | 307 | 607 input stack size | stack_size | 200 | 300 semantic nest size | nest_size | 20-3000 | 20-3000 parameter stack size | param_size | 60 | 60-1000 buffer size | buf_size | 2048 | 3000/5000 save size | save_size | 100-16000 | 100-16000 text input levels | max_in_open | 6 | 6 grouping levels | max_quarterword | 255 | 65535 pattern memory | trie_size | 5000-65500 | 5000-65500 number of fonts (3) | font_max | 127 | 254 total opcodes (3) | trie_op_size | 750 | 750 opcodes per lang. (3) | max_trie_op | 750 | 750 (1) cf. The TeXbook, p. 300 (2) x-y: you can set the value with a /m* option, see above x/y: x for DOS version, y for OS/2 version and tex386 (3) not shown in The TeXbook (4) tex386: up to 1048576 (5) tex386: settable to 262142 through 1048576 Changes ======= 3.14 [3c-beta1] --------------- Attention: You have to create new FMT files! - Version 3.14 of TeX - tex286 replaced with tex186, btex286 replaced with btex186 - OS/2: The output buffer will be flushed before reading from the keyboard. This allows piping TeX output into another program - Buffer size increased: tex, tex186, texp 2048 btex, btex186 3000 btexp, tex386 5000 - TFM files are no longer sought in the current working directory - Under DOS, extended memory (XMS) will be supported. If there are upper memory blocks (UMB) and these are supported by the XMS driver, emTeX will use them - New command line options: -de don't use expanded memory (EMS) -du don't use upper Memory Blocks -dx don't use extended memory (XMS) -d like -deux - emTeX now pays attention to the switch character; you can use tex -d /mytex/mytext if the switch character is set to `-' - bigTeX now uses double arithmetic instead of float arithmetic. Length of mantissa: tex, tex186, texp 23 bit tex386 32 bit btex, btex186, btexp 52 bit - Up to 750 trie opcodes can be used now (ghyphen.max!) - Error message if writing to the DVI or FMT file fails - Memory requirements of bigTeX under DOS reduced 3.14 [3c-beta5] --------------- - V20 and V30 CPU detection fixed (tex186, btex186) - Code page translation revised (/8, /o and /r options). For instance, code 127 has been mapped to 31 (wrong!) by older versions - If /c is given, /r will be ignored - New version of maketcp, same changes as in TeX - Clarification: you can use character code 255 (254 was wrong!). Character 255 will always displayed as ^^ff - Due to changes in the input character translation you should recreate your FMT files - Error message if writing to a file using \write fails - 850_tex.tcp has been changed slightly - If the /a* option is not used, file names won't be stored in the string pool - Number of trie op codes per language increased from 500 to 750 - If the TCP file cannot be found, TeX will be aborted 3.14 [3c-beta7] --------------- Attention: You have to create new FMT files! - Parameter stack size settable with /ma# (60 to 1000), the default is 60 - bigTeX: Hash size increased to 10000 - \charsubdef 3.141 [3c-beta8] ---------------- Attention: You have to create new FMT files! - Version 3.141 of TeX - FMT files are now interchangable between tex386 and btex (that was a bug in beta 7) - Size of FMT files reduced slightly 3.1415 [3c-beta9] ----------------- - The standard-sized emTeX (tex.exe) now supports \charsubdef (-ml command line option) - The parameter stack size is now settable for the standard-sized emTeX with the /ma# command line option (# in 60 through 1000), the default value is 60 - Support for long file names under OS/2 has been added - The method for file name truncation has been changed. The 5+3.3 rule is tried before the 8.3 rule. - Files with names that contain two or more dots cannot be read and written under DOS. This should solve the problem of \include{chap1.tex} overwriting chap1.tex with chap1.tex.aux - The default directory (\emtex\texinput, for instance) is no longer searched in addition to the directories specified by an environment variable (TEXINPUT, for instance) - Directories can now be searched recursively. To search one level of subdirectories, append ! to the path name, to search all levels of subdirectories, append !! to the path name. - A new environment variable, EMTEXDIR, can be used to change the path name of the emTeX directory - The EMTEXDRV environment variable and the /pv command line option are no longer supported; use EMTEXDIR instead. For instance, replace set emtexdrv=c with set emtexdir=c:\emtex - The TCP file (see the /c option) is now sought in \emtex\data (or in the directories set by the TEXDATA environment variable). - Loops which don't produce screen output can now be interrupted with Ctrl-Break. This feature can be disabled by the /db command line option (for machines which have problems with hooking interrupt 1C) - The speed of screen output has been improved, especially when running under GNU Emacs on OS/2 - Keyboard input now works under GNU Emacs on OS/2 -------- End of TEX.DOC -------------