home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 3 / CD ACTUAL 3.iso / linux / docs / linux-do / network- / nag-1.002 / nag-1 / misc / source.mm < prev   
Encoding:
Text File  |  1994-08-17  |  10.2 KB  |  245 lines
  1. .\" ============================================================
  2. .\"
  3. .\"     Linux Network Administrators' Guide
  4. .\"        Compilation Guide
  5. .\"
  6. .\"         Copyright 1994 O. Kirch
  7. .\"
  8. .\" ============================================================
  9. .\" This document requires the GNU mm macro package.
  10. .\" 
  11. .PH "''''
  12. .po 3n
  13. .sp |2c
  14. .ce 3
  15. Building the Linux Network Administrators Guide
  16.  
  17. Olaf Kirch
  18. .PH "'Networking Guide 1.0''Source Notes'
  19. .PF "''- % -''
  20. .sp 1c
  21. .\" ============================================================
  22. .H 1 "Introduction
  23. .\" ============================================================
  24. The Network Administrators' Guide (NAG) allows you to produce a couple
  25. of different output formats from the same source. Currently, the main
  26. supported targets are DVI, PostScript(TM), and GNU roff (using the mm
  27. macro package). You can select these different formats by invoking
  28. the \fBMakefile\fR with the appropriate target name.
  29. .P
  30. The NAG is intended to compile on as many TeX platforms as possible.
  31. To fine-tune its behavior, you have to adapt the main configuration
  32. file, \fBConfig.tex\fR.  The options you can set in this file are 
  33. described below.
  34. .P
  35. As I'm not a LaTeX guru, and as there are quite a number of different
  36. LaTeX version around, compiling the NAG may fail on your system.
  37. If this happens to you, I'd be glad to hear from you if and
  38. how you solved your problems, and incorporate your fixes in a future
  39. release.
  40.  
  41. .\" ============================================================
  42. .H 1 "Different output formats
  43. .\" ============================================================
  44. The NAG can be compiled for three different output formats at
  45. the moment. These are
  46. .BVL 3n
  47. .LI DVI
  48. DVI is the generic LaTeX output format. This should be relatively
  49. painless on virtually all systems. But it isn't always, which is
  50. one of the reasons this installation guide is so long.
  51. .P
  52. To produce the DVI output,
  53. simply go to the source directory and type
  54. .P
  55. .VERBON
  56.          make dvi
  57. .VERBOFF
  58. .P
  59. This should produce the file \fBnag.dvi\fR as output.
  60. .P
  61. There's a minor \fBcaveat\fR here:
  62. The NAG contains a couple of figures that were produced with the
  63. \fBxfig\fR drawing program, and converted to eepic for inclusion
  64. with the NAG. You have to have a working \fBepic.sty\fR and
  65. \fBeepic.sty\fR macro file for this. The source for the NAG
  66. contains these files in the \fBstyles/latex\fR directory. If these
  67. fail to work with your TeX installation, but you have a working pair
  68. of style files installed on your system, you may want to remove
  69. the included eepic style files.  You can also find a set
  70. of eepic style files in the \fBtransfig\fR package.
  71. .P
  72. To print the DVI version, you will need a printer driver that understands
  73. the \fB\\special\fR instrutions generated by the eepic package. The
  74. drivers from Nelson Beebe's driver package should do. The latest
  75. version of \fBdvieps\fR I've seen (0.6) didn't have support for
  76. these \fB\\special\fRs. If you do use \fBdvieps\fR, you
  77. might want to print the document with it, and produce the pictures
  78. separately. One possible way to do this is to take the EPSF versions
  79. of them and print them with \fBghostscript\fR.
  80. .\" ============================================================
  81. .LI PostScript
  82. To generate PostScript output, the \fBMakefile\fR first builds a DVI
  83. version of the NAG, and converts it to PostScript afterwards using
  84. Tom Rokicki's \fBdvips\fR program. You will want to use \fBdvips\fR;
  85. I tried \fBdvitops\fR, but it didn't work out for me. You should
  86. also use a recent version of \fBdvips\fR, a version prior to 5.512
  87. I had didn't work right for me.
  88. .P
  89. The DVI version generated for PostScript output is 
  90. \fBdifferent\fR from the version built when doing ordinary DVI
  91. output, as it uses the EPSF versions of the pictures instead.
  92. The EPSF versions look much better than the eepic versions.
  93. .P
  94. Normally, when converting DVI to PostScript, \fBdvips\fR includes
  95. font images of all fonts used in the DVI file in the resulting PS
  96. file. This greatly increases the size of the resulting output
  97. file, and makes it dependent on the resolution of the output device
  98. (300dpi by default). If you have a printer capable of PostScript, you
  99. may choose to have the output file use the real PostScript fonts
  100. instead of the cmr fonts. The exact requirements for this are
  101. discussed in a later paragraph.
  102. .P
  103. To build the PostScript version, you go to the source directory
  104. and type the following command:
  105. .P
  106. .VERBON
  107.          make ps
  108. .VERBOFF
  109. .P
  110. This should produce the file \fBnag.ps\fR as output.
  111. .P
  112. .LI "GNU roff
  113. This output format isn't exactly the greatest thing since sliced
  114. bread, but it's included for the sake of those who don't have the
  115. disk space for a full TeX installation, and don't have access to
  116. PostScript laser printers. It allows you to produce an ASCII-only
  117. output of the NAG that doesn't look too bad. However, there are
  118. no figures in the roff version. Anyone with a faible for ASCII
  119. arts is invited to try his or her hand on this. I will gladly
  120. include the results in a future release.
  121. .P
  122. The TeX source has been converted to GNU roff using the
  123. \fBlotex\fR utility I wrote. The output uses the GNU version of
  124. the mm macro set. To format the roff source, you have to have
  125. \fBgroff\fR version 1.08 or later. To create the roff output and
  126. format it, go to the source directory and type:
  127. .P
  128. .VERBON
  129.          make mm
  130.          groff -t -mgm -Tlatin1 nag.mm | less
  131. .VERBOFF
  132. .P
  133. There is also a \fBMakefile\fR target that generates an `ASCII'
  134. version; this is basically the formatted roff version piped through
  135. \fBcolcrt\fR to get rid of all the character sequences used for
  136. highlighting and such. Note that some printers, like the HP Deskjet,
  137. will happily grok the backspacing sequences generated by \fBgroff\fR
  138. and produce real underlining and boldface text.
  139. .LE
  140. .\" ============================================================
  141. .H 1 "The Config.tex file
  142. .\" ============================================================
  143. The \fBConfig.tex\fR allows you to set a couple of options that
  144. fine-tune the compilation of the NAG.  You set these options
  145. by defining special LaTeX macros like \fB\\footrue\fR, which sets
  146. the foo option, or \fB\\foofalse\fR, which unsets it.
  147. .P
  148. At the moment, the following are valid options (showing the default
  149. settings):
  150. .BVL 3n
  151. .LI \fB\E\latexetrue\fR
  152. If you run LaTeX2e, you must set this option to true. Otherwise,
  153. \fBlatex\fR will choke horribly when compilig the NAG. (Thanks go
  154. to Peter Williams for adapting \fBlinuxdoc.sty\fR for LaTeX2e).
  155. .P
  156. Be warned that setting this option may not be enough to make the NAG
  157. compile cleanly on your LaTeX setup.  The dreary details are
  158. discussed in a separate section below.
  159. .LI \fB\E\ltxbeta\fR
  160. This is yet another option dealing with LaTeX2e.  There are points in
  161. which the latest release of LaTeX2e apparently differs from the Beta
  162. version that has been included in Slackware for quite some time. The
  163. \fB\\ltxbeta\fR switch determines which of these version the NAG will
  164. attempt to take care of.
  165. .LI \fB\E\veryoldtexfalse\fR
  166. If you run a very old LaTeX installation, you should set this to
  167. true. It disables a macro (\fB\\namedlabel\fR) which \fBlatex\fR
  168. refused to grok on an installation I once tried it on.
  169. I'm not really familiar with LaTeX version numbers, but I guess
  170. anything prior to 1992 qualifies as old in this context.
  171. .LI \fB\E\squeezefale\fR
  172. Setting this option to true will reduce the size of the output
  173. file from about 350 pages to 250 pages. The document's appearance will 
  174. suffer a bit, but it saves you ink and paper.
  175. .LI \fB\E\psfontsfalse\fR
  176. This option tells \fBlatex\fR whether to use PostScript or
  177. cmr font metrics whene generating the DVI output for the PostScript
  178. version. This option has no effect when compiling the NAG for
  179. DVI-only output. Again, setting this option may not be the only
  180. thing you have to do to get PS fonts. Please stay tuned...
  181. .LE
  182. .\" ============================================================
  183. .H 1 "Building the NAG with LaTeX2e
  184. .\" ============================================================
  185. There are a couple of things you should check before you can
  186. \fBlatex\fR the Networking Guide with LaTeX2e:
  187. .BL
  188. .LI
  189. In some versions of LaTeX2e,
  190. \fBreport.cls\fR (and several other cls files) have a bug in the
  191. definition of the makeindex option. There's a line
  192. that reads
  193. .P
  194. .VERBON
  195.        \\newcommand\\see##1##2{...
  196. .VERBOFF
  197. .P
  198. This should actually read
  199. .P
  200. .VERBON
  201.        \\def\\see##1##2{...
  202. .VERBOFF
  203. Note that this problem is likely to be gone in the latest version of
  204. LaTeX2e.
  205. .LI
  206. If \fBlatex\fR complains about not finding the \fBifthen.sty\fR package,
  207. you have to go to your \fB/usr/TeX/lib/texmf/tex/latex2e\fR directory,
  208. and run the following command:
  209. .P
  210. .VERBON
  211.       latex l2eextra.ins
  212. .VERBOFF
  213. .P
  214. This unpacks a couple of extra packages, among them \fBifthen.sty\fR.
  215. The script asks you a couple of questions about fonts, which
  216. you can answer with yes (these questions apply to a couple of
  217. other packages, like cyrillic fonts, which the NAG doesn't use:-)
  218. .LI
  219. To use PostScript fonts with LaTeX2e, you may have to unpack
  220. yet another package.  If building the NAG fails with error messages
  221. about not finding \fBpsfonts.sty\fR, or not finding fonts like
  222. \fBOT1pcr\fR, then you have to go to the
  223. \fB/usr/TeX/lib/texmf/tex/nfss2\fR directory
  224. and execute
  225. .P
  226. .VERBON
  227.       latex psfonts.ins
  228. .VERBOFF
  229. .LE
  230. As a conclusion, let me vent my personal opinion on LaTeX2e. Although
  231. the discussion above may give you the impression that LaTeX2e is a load
  232. of crap and utterly broken, this is not true. After coming to terms with
  233. some of the new features, I was very pleased how well-behaved it is.
  234. The problems I've encountered (and which you will prossibly face, too)
  235. actually seem to be problems of Slackware. Slackware used to come with a
  236. Beta-testing version, which, in addition, didn't have all crucial files
  237. unpacked. I haven't checked Slackware 2.0, though, so your mileage may vary.
  238. .\" ============================================================
  239. .H 1 "PostScript Fonts with LaTeX 2.09 or earlier
  240. .\" ============================================================
  241. To use Postscript fonts with LaTeX version 2.09 or even older, you have to
  242. have two macro files from the psfonts package, being \fBpsfonts.sty\fR and
  243. \fBtimes.sty\fR.  If you don't have them, get them from the latest release
  244. of Thomas Rokicki's \fBdvips\fR package.
  245.