summaryrefslogtreecommitdiff
path: root/obsolete/systems/os2/emtex-contrib/emtexTDS/readme.eng
blob: 4743c27709effda3a6e3fef0104868843b8a7dac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
************************************************************
*                                                          *
*                        emTeX/TDS                         *
*                                                          *
*                Installation Instructions                 *
*                 and General Information                  *
*                                                          *
************************************************************
                                                Version 0.56
                                                  2001-09-30
                                              Walter Schmidt                                              
Copyright (C) 1999--2001 Walter Schmidt


************************************************************
*                                                          *
* Support for emTeX/TDS will be discontinued on 2002-06-30.*
*                                                          *
* If you are new to TeX on OS/2, install VTeX/2 instead:   *
* see CTAN:systems/vtex .                                  *
*                                                          *
************************************************************


Contents:
=========

1) Overview
2) Prerequisites
3) Installing Ghostscript
4) Installing emTeX/TDS
5) Environment variables and LIBPATH
6) Documentation
7) Setting up the printer
8) Running an example document through LaTeX

Appendix:

A) Uninstalling emTeX/TDS
C) Support
D) Legal stuff


1) Overview
===========
emTeX/TDS is an emTeX-based TeX system for OS/2 Warp with a
TDS-compliant directory structure.  emTeX/TDS comes with an
installation program for setting up the following components:

   LaTeX2e with additional packages:  "graphics", "tools",
   "german", "babel" and others.
   
   Postscript font support for LaTeX, aka. "psnfss" (for
   the 35 standard fonts);  support for the Adobe Euro 
   fonts.

   Additional Metafont and PostScript fonts, including the
   Type1 (PostScript) versions of the CM, AMS and Euler
   fonts.
   
   plain TeX
  
   TeX hyphenation patterns for American English and many
   European languages, pre-installed in LaTeX and plain TeX.
  
   dvips 5.83

   dvipm
   
   emTeX dvi printer driver for Laserjet/Deskjet
   
   Metafont incl.  MFJob and various tools (gftodvi etc.)

   Makeindex 2.12
   
   Bibtex 0.99c with the original styles
   
The "EPM TeX Front End" is recommended as a GUI.  This is a
powerful integrated TeX environment based on the OS/2
"Enhanced Editor" (EPM).  It is distributed from CTAM, see
the directory systems/os2/epmtfe.



2) Prerequisites
================
TeX is to be installed on a HPFS drive, because emTeX/TDS
will be using long filenames.  

The Ghostscript program is required for viewing PostScript
documents -- see the next section.

The TeX system requires about 30MB for the files to be
installed.  The fonts, which will be generated on demand
when viewing or printing documents, will be stored on the
same drive; extra 30MB should be provided at least for these
fonts and for future additions.  The latest version of
Ghostscript incl. GSView needs 12MB.

Installation will require about 14MB of temporary disk space
which may be released afterwards.

Installing Ghostscript as well as emTeX will require the
program "unzip.exe".  In case it is not available on your
PC, you may obtain it from the same directory where
emTeX/TDS is located; you will have to copy it to a
directory where other programs are kept, too; e.g., to the
directory \OS2 on the boot drive.

Ghostscript and emTeX are based on the the emx runtime
environment, version 0.9d; it can be installed automatically
in conjunction with Ghostscript.  However, older versions of
emx should be updated manually, before installing emTeX or
Ghostscript!

In addition to the emTeX/TDS distribution you will also need
various files of the original emTeX distribution; the
particular files are be listed below.  They can be obtained
from the CTAN directory systems/msdos/emtex.



3) Installing Ghostscript
=========================
Obtain the following files:

<ftp://ftp.cs.wisc.edu/pub/ghost/ghostgum/gsv36os2.zip>
<ftp://ftp.cs.wisc.edu/ghost/aladdin/gs650/gs650os2.zip>

The files gsv36os2.zip and gs650.zip are also distributed
from CTAN.  The file and directory names reflect the version
numbers and may have changed in the meantime.

In case the emx runtime environment needs also to be 
installed, the file

<ftp://ftp-os2.nmsu.edu/pub/os2/dev/emx/v0.9d/emxrt.zip>

is required, too.

Unzip gsv36os2.zip to a temporary directory, place the files
gs650os2.zip (and emxrt.zip, if required) in the same
directory, and run os2setup.exe then.  (Pay attention to the
instructions of the program, if you are also installing emx
during this step!)  The temporary directory can be deleted
afterwards.



4) Installing emTeX/TDS
=======================
Please, read this section carefully and completely, even if
you intend to update an existing emTeX/TDS only.  In this
case, notice the file NEWS, too:  Important changes
introduced with the latest version are listed there.

1. Copy the following files into one directory (which can be
   removed once the installation is completed):

   From this emTeX/TDS distribution:
   
     tdsinst.cmd  (the installation program)
     config.zip
     texmf.zip
     
   From the original emTeX distribution, 
   i.e., CTAN:systems/msdos/emtex:

     bibtex4b.zip
     dvid16h1.zip
     dvid16h2.zip
     makeindx.zip
     mf4b.zip
     mfjob12d.zip
     mfware.zip
     tex4b.zip
     texware.zip
     
   The latter files are NOT required, if you only want to 
   update from version 0.53 or above!

2. Go to the above directory; then start the installation
   program "tdsinst".  (tdsinst CANNOT be executed from a
   different directory!)  You will be asked for the drive,
   where TeX is to be installed ("TeX drive"); it will be
   installed in the directory "\texmf" of that drive.
   
   If a version of emTeX/TDS < 0.55 is found on your HD, the
   installation program needs to overwrite various
   configuration files; however, you will be asked to agree:

      tex/latex/local/hyphen.cfg
      tex/latex/local/graphics.cfg
      tex/latex/local/color.cfg
      tex/latex/local/ltxdoc.cfg
      tex/latex/local/ltxguide.cfg
      tex/plain/local/plain.cfg
      emtex/data/vp.cnf
      emtex/data/dvijet.cnf

   In case you have customized any of the above files, then
   you should unpack the new version under a different name
   first (enter "r" when asked for) and compare the changes
   with yours, before you run TeX or the dvi drivers.
   
   The installation program will ask you whether you want a
   program object for the dvi viewer "dvipm" to be created
   on the desktop.  When installing emTeX/TDS for the first
   time, you cannot run this program unless you will have
   performed the below steps 3 and 5. You may want to
   change the settings of this program object so as to
   associate all files of type "*.dvi" with it by default.
   
   emTeX/TDS requires various environment variables to be
   set; the LIBPATH as well as PATH and HELP are to be
   changed.  The installation program can apply the
   necessary changes to the OS/2 configuration file
   config.sys, but will ask you before doing so.  You may
   quit the program there and perform the changes manually;
   the necessary information can be found in the section
   below.  This must be done before you can proceed with the
   following steps!
   
   In case the installation program terminates abnormally
   with a message including the word "Error", please,
   cut-and-paste as much as possible from the command window
   to a file and send it to me via email.  See the below
   section "Support" for the address.
   
3. Shut down OS/2, then reboot.

4. Now execute the program "makelatex" to generate the LaTeX
   format file;   This can be done from any directory.
   
5. Execute the program "makemf" to generate the Metafont
   base file; this can be done in an arbitrary directory,
   too.
   
6. Execute the program "makeplaintex" in an arbitrary
   directory in order to to create the plain TeX format
   file.  In case you want to use LaTeX only or do not
   understand what "plain TeX" is, you may skip this step.
   
   *** The above steps 4, 5 (and 6) need also to be     ***
   *** executed, when an existing emTeX/TDS is updated. ***
   
7. The directory texmf\doc\emtextds contains the "Technical
   Manual" (filename manual.eng) WHICH YOU SHOULD READ NOW!
   This directory also holds the below mentioned file
   eurofont.eng.

   *** Adobe Euro Fonts ***
   
8. The file eurofont.eng tells you how to obtain and install
   the Adobe Euro fonts ("Euro" symbols in Type1/PostScript
   format).  Their use is supported through a LaTeX package,
   but the fonts are not included here due to legal reasons.
   
   *** EPM TeX Front End ***
   
9. The "EPM TeX Front End" can be obtained from the CTAN
   directory systems\os2\epmtfe; see the file README.epmtfe
   for initial information then.  The emTeX/TDS distribution
   contains a suitable configuration file tfe.cfg for the
   EPM TeX Front End.

   *** VTeX/2 ***
   
10.  When installing emTeX/TDS v0.56 over VTeX/2 7.3x, LaTeX
   will be updated.  You MUST create a new format file for
   VTeX afterwards!



5) Environment variables and LIBPATH
====================================
You need NOT read this section if the installation program
has already applied the necessary changes to the OS/2
configuration file config.sys!

The following settings are required for running emTeX/TDS:

TMP
   must point to a directory where temporary files can be
   created.

EMTEXDIR=C:\TEXMF\EMTEX
   The base directory for emTeX and dvips stuff.

TEXMACROS=C:\TEXMF\TEX 
   Points to the base directory for TeX macros in a TDS
   tree.  This variable is evaluated by the shell scripts
   tex.cmd and latex.cmd.

TEXTFM=C:\TEXMF\FONTS\TFM!!;.  
   According to the TDS standard, the directory
   texmf\fonts\tfm and all its subdirectory must be searched
   for font metrics.  Additionally, font metrics can be
   taken from the current directory (.).
   
BFONTS=C:\TEXMF\FONTS\PK
VFONTS=C:\TEXMF\FONTS\VF!!                        
   According to the TDS standard, bitmap fonts and virtual
   fonts are stored below these directories.  These
   environment variables are evaluated by dvipm, dvihplj,
   and dvips (see the appropriate configuration files).
   Additionally the current directory will be searched for
   .pk files.

TYPE1FONTS=C:\TEXMF\FONTS\TYPE1
   PostScript fonts for dvips are to be found below this 
   directory.
   
TEXCONFIG=.;C:\TEXMF\DVIPS!!
   The search path for dvips' configuration files, i.e. 
   config.ps, *.cfg and *.map

EMTEXSWCHAR=-            
   Options to the dvi drivers must be introduced by a 
   minus sign, not by a slash.  Thus the slash can be used 
   more freely as a directory separator, as with Un*x.
   
MFOPT=-mp50000                                    
   Default Metafont option; useful for certain large 
   applications.
   
MFJOBOPT=-3 -i
   Makes MFJob run mf386 (-3) and ignore Metafont errors
   (-i).
  
MFINPUT=C:\TEXMF\FONTS\SOURCE!!;C:\TEXMF\METAFONT!
   The default Metafont input directories.  Must point to
   the TDS directories where Metafont font sources and other
   .mf files are stored.
   
INDEXSTYLE=C:\TEXMF\MAKEINDEX             
   Here we keep .ist files for the Makeindex program.

BSTINPUT=C:\TEXMF\BIBTEX\BST                      
BIBINPUT=C:\TEXMF\BIBTEX\BIB                      
   The directories where BibTeX's .bst and .bib files are 
   stored.

PATH C:\TEXMF\EMTEX\BIN must be part of the PATH.  All
   executable programs of emTeX/TDS are located here.

LIBPATH
   C:\TEXMF\EMTEX\DLL must be part of the LIBPATH.

HELP
   C:\TEXMF\EMTEX\HELP must be part of the HELP path.

TMP may be set individually.  All other environment
variables should have the values shown here, except, of
course for the drive letter (here C:  as an example).

Caution:  The particular programs may recognize further
environment variables!



6) Documentation
================
Documentation of the emTeX/TDS system is located in the
directory texmf\doc\emtextds.

!!!   READING THE "TECHNICAL MANUAL" (FILE manual.eng)   !!!
!!!   IS HIGHLY RECOMMENDED                              !!!

The documentation for LaTeX, dvips, BibTeX and Makeindex is
located in the other directories below texmf\doc.

Files with the extension ".dvi" can be opened using the dvi
previewing program once you have completed the installation.

Documentation for the programs from the emTeX distribution
(TeX, Metafont, dvipm, dvihplj et al.)  can be found in the
directories texmf\emtex\doc (ASCII) and texmf\emtex\book
(OS/2 .inf).  Caution:  These documents may refer to
components of the original emTeX distribution which are not
provided and/or not usable here.

See also the file help.eng of the original emTeX collection,
which resides in the CTAN directory systems/msdos/emtex/.



7) Setting up the printer
==========================
Due to the modular nature of TeX several programs have to be
configured separately for the printer to be used.


7.1) The dvi previewing program "dvipm"
---------------------------------------
dvipm should make use of the same bitmap fonts as the 
printer; thus one can print from the graphical user
interface of dvipm on any printing device supported by OS/2.

Initially, dvipm is configured so as to use fonts for a HP
Laserjet 4, Laserjet 5L or Deskjet with a resolution of
600dpi.  You need not change anything as long as you are
using one of these or a compatible one.

Configuring dvipm works through editing the file vp.cnf in 
the directory texmf\emtex\data\dvips . Search for the 
following lines:

%       Options for dvipm.exe, using "ljfour" mode:
%
+resolution=600
+metafont-mode=ljfour

Enter the resolution of your printing device and the 
suitable Metafont mode here.  Typical "modes" are:

mode      printer
......................................................
deskjet   Deskjet  (300dpi)
cx        Laserjet (300dpi), except for the following:
jetiiisi  Laserjet IIIsi, Laserjet 4L (300dpi)
ljfour    Laserjet 4, Laserjet 5L (600dpi)
ljfive    Laserjet 5P (600dpi)
ljfivemp  Laserjet 5MP (600dpi)
jfzzz     LaserJet 4000N, ProRes mode (1200dpi)
ljfzzzfr  LaserJet 4000 FastRes (600dpi)

As long as you do not make use of PostScript fonts or
PostScript graphics in your TeX documents, no further
programs need to be configured.


7.2) dvips
----------
dvips should be configured appropriately for your printing
device in order to make use of PostScript elements in TeX.
Initially it is set up for a Laserjet 4, Laserjet 5L or
Deskjet with 600dpi.  You need not change anything as long
as you are using one of these or a compatible one.

Any printer-specific information is to be entered in the
file dvips.ini in the directory texmf\dvips\local . You will
have to create the directory and the file if they do not yet
exist.  At least the Metafont mode and the resolution must
be specified;  e.g., for a 300dpi Deskjet the following two 
lines must be in dvips.ini:

D 300
M deskjet

D indicates the resolution, M is for the Metafont mode.  See
above (dvipm) for typical modes.

dvips is described in the file texmf\doc\dvips\dvips.dvi .

See the "Technical Manual" for information about using dvips
with emTeX/TDS (default settings, configuration files,
search paths etc.).


7.3) The dvi printer driver "dvihplj"
-------------------------------------
emTeX/TDS also supports direct printing of dvi files
(without PostScript images or fonts) on a Laserjet, Deskjet
or compatible device.  This is faster and needs less memory
than printing via dvipm.  Configuring dvihplj may, however,
be somewhat difficult.

A general description of dvihplj can be found in the file
texmf\emtex\book\german\dvidrv.inf (OS/2 inf format).

See the "Technical Manual" for information about using
dvihplj with emTeX/TDS (default settings, configuration
file, search paths etc.).


7.4) EPM TeX Front End
----------------------
In case you are using the EPM TeX Front End as your TeX
environment, you may want to configure a command for the
menu item "Print" suitable for your printing device.

The configuration file tfe.cfg which is distributed with
emTeX/TDS has two example entries for using dvihplj and for
printing on a PostScript printer.  Initially these entries
are commented out.  

In case you prefer to print via the graphical user interface
of dvipm or GSview only, you may just leave the PRINT_CMD
empty;  the related menu item will not be displayed then.
(This holds for texfe version 2.4 and above only.)



8) Running an example file through LaTeX
========================================
Having installed emTeX/TDS, you should run an example file
through LaTeX.  Do this via the command line so as to check
the functions of the "basic" TeX system (as opposed to an
IDE):

1. Open an OS/2 window (i.e.  a command line) in an
   arbitrary directory outside the texmf tree

2. Copy the file C:\texmf\tex\latex\base\small2e.tex to this 
   directory.  (Replace "C:" with the drive where TeX has
   actually been installed.)

3. Run this file through LaTeX by executing the command
   
   latex small2e

4. Start the previewer by executing the command 

   vp small2e

   If the fonts used in the document small2e do not yet
   exist, dvipm will ask you whether they should be created
   by running MFJob; click on "Yes".  When MFJob has
   finished, dvipm will ask whether to reload the document
   (now using the fonts which have been created); click on
   "Yes" again.



************************************************************
*                                                          *
*                         Appendix                         *
*                                                          *
************************************************************


A) Uninstalling emTeX/TDS
=========================
The distribution contains a REXX script tdskill.cmd, which
can remove emTeX/TDS from your HD.  It is to be run from any
directory outside the \texmf tree to be deleted.  The script
removes all entries for emTeX/TDS from the configuration
file config.sys, too, after asking for confirmation, of
course.  This script can also be used to remove a corrupt or
incomplete TeX system.

In case there remain any files or dirctories in the texmf
tree after executing tdskill.cmd, they can be deleted after
re-booting the system.
   


B) Support
==========
Bug fixes and additional information concerning emTeX/TDS
are available from <ftp://ftp.dante.de/tex-archive/> or from
any other CTAN host in the directory

    systems/os2/emtex-contrib/emtexTDS .

The latest version of emTeX/TDS will also be made available
there.

Questions, bug reports and suggestions should be addressed 
to the author:

    Walter Schmidt 
    <was@VR-Web.de>

Please, understand that I cannot answer any questions
concerning particular programs like tex386, dvips or LaTeX
packages; they should be addressed to the authors of these
programs.

There is an electronic mailing list, EMTEX-USER, for emTeX.
To get information on how to subscribe and unsubscribe, send
a message containing

    HELP
    INFO EMTEX-USER

in the body to <majordomo@physik.tu-berlin.de>.



C) Legal stuff
===============
You are allowed to distribute the following set of files as
long as it is complete and all files are unchanged:

readme.eng
readme.ger
NEWS
tdsinst.cmd
tdskill.cmd
texmf.zip
config.zip
tfe.cfg
unzip.exe

You are NOT allowed to take money for these files or changed
versions, except for a nominal charge for copying etc.

No guarantee is made as to the proper functioning of this
software.  No liability will be admitted for damage
resulting from using this software.

NOTE:  emTeX/TDS is packaged using Info-ZIP's compression
utility.  The installation program makes use of Info-ZIP's
UnZip program, the version 5.40 of which is provided in
conjunction with emTeX/TDS.  Info-ZIP's software (Zip, UnZip
and related utilities) is free and can be obtained as source
code or executables from various internet sites, including
<ftp://ftp.dante.de/tex-archive/tools/zip/info-zip/>.

NOTE:  The original sources of the "dvips" program and the
patches to be applied for the PC version can be obtained
from any CTAN site, e.g.  <ftp://ftp.dante.de/tex-archive/>;
they are located in the directories:

    dviware/dvips/dvips583.tar.gz
and 
    systems/os2/dviware/dvips/dvips583.zip



-- finis

P.S.  I would like to apologize for my bad English.
English is not my native language.