Notes on LaTeX Sources of the Perl 5 Tutorial
========================================================================


You have downloaded the LaTeX sources that is used to construct the 
offline version of my Perl 5 Tutorial. This README documents the
various points you have to know before using this package.

Compiling
-----------------

The extracted package contains all the source files you can use to 
generate a Postscript (PS) or Portable Document Format (PDF) file.

Although you are allowed to generate the PDF yourself with my sources,
I suppose doing this is generally not worth the hassle. I'm 
distributing my sources simply because I am a staunch supporter of 
the open source campaign and I hope my sources, although ugly and
messy, may help people understand what LaTeX sources look like. In
particular, the official font used is Adobe Myriad, which is a 
commercial font not shipped with any distributions of LaTeX. If
you have to generate the PS or PDF yourself, you may change the
font to one that is available on your system that has been setup 
for use by LaTeX. Just change the last argument of the following
command in perltut.tex

\renewcommand{\familydefault}{pwm}		% default font: Myriad

from ``pwm'' to another. The safest bet is ``ptm'', which stands
for Adobe Times. If you have a complete LaTeX installation, you may
also have Adobe Palatino ``ppl'' that is another nice font to
try out.

For Unix-variant operating systems, the PDF output can be, in general,
generated by using the makefile provided:

make

This was the exact command used to generate the official PDF
file that is offered for download on my Debian Linux 3.0 system.

If you don't have GNU make on your system you have to run the following
commands manually in sequence:

latex perltut.tex
latex perltut.tex
makeindex perltut.idx
latex perltut.tex
dvipdf perltut.dvi

(you need a total of three passes of "latex" to generate everything)

You may need to use a different program to convert the dvi output
into the format desired, depending on the set of programs available
on your system. dvipdf is part of the GNU/APFL Ghostscript distribution.
Without modification, this document does not compile on pdflatex.

Note that images in this document as generated by dvipdf may be blurred and
ugly because they are compressed into very low resolutions when printed
as PDF. You may have to pass additional options to it. The makefile has
the appropriate options included that you may wish to change if further
optimization is needed.

In Microsoft Windows environment, you may use the MikTeX distribution.
Unfortunately, running the Makefile on MikTeX on my system did not 
produce the best results and the Makefile had to be changed.

If you receive a "TeX capacity exceeded" error, try to increase the value
of "pool_size" in the TeX configuration file. On recent versions of 
teTeX it is usually $TEXMF/web2c/texmf.cnf. On MikTeX it is in 
$TEXMF/miktex/config/miktex.ini. $TEXMF is the "texmf" directory in your
TeX installation.

These packages were used in the sources, so they need to be installed
on your system or compilation will fail (most of these should be part
of LaTeX distributions):

pslatex
color
hyperref
graphicx

Notes on distribution of this package
--------------------------------------

The license information in LICENSE.TXT in the package applies to this
package. You may also find this license in the PS/PDF generated output.

Modification of any files in this package is allowed, provided the
attributes of the original author are to be remained intact. If you
believe your changes can further improve the quality of this tutorial
or some errors can be corrected, you are encouraged to give me a
notification so that the modifications can be incorporated into the next
release.

