summaryrefslogtreecommitdiff
path: root/web/funnelAC/hackman/h_manual.tex
blob: 716a28277c2a58aa467243fba32ab1134f7a9a81 (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
%==============================================================================%
%                             FUNNELWEB USER'S MANUAL                          %
%==============================================================================%
%
% Summary
% -------
% This is the main .tex file of the FunnelWeb Hacker's Manual.
%
% For a list of the other files that contribute to this document,
% see the list of files given in \input lines at the end of this file.
%
% See the TeX comments below to find out how to typeset this document.
%
%
% Copyright
% ---------
% Copyright (C) 1992 Ross N. Williams.
%
% Permission is granted to make and distribute verbatim copies of this manual
% provided that the copyright notice and this permission notice are preserved
% on all copies.
%
%
% Version
% -------
% Date    : May 1992.
% Version : 1.0.
%
%
% Author
% ------
% Name  : Ross Williams.
% Email : ross@spam.adelaide.edu.au
% Snail : 16 Lerwick Avenue, Hazelwood Park 5066, Australia.
%
%
% How to Typeset This Document
% ----------------------------
% This document is written in a format suitable for processing by the LaTeX
% typesetting system which can be found on many machines around the world.
% The document is an entirely self contained LaTeX document. To assist in
% the electronic distribution of this document, all diagrams have been
% constructing using ASCII text from within LaTeX. This means that all you
% need to print this document is a LaTeX typesetting system.
%
% To print this document using LaTeX, give a command sequence that looks
% something like this:
%
%    latex manual
%    latex manual
%    sort  -f <manual.idx >manual.sin
%    % Start here if manual.aux, manual.toc, and manual.sin already exist.
%    latex manual
%    print manual
%
% The commands must be given three times so as to allow the cross
% referencing information to be correctly assembled.
% The "sort" command should perform a case insensitive sort of the lines of
% its input, but should not alter the lines it is sorting. In the example
% about, the "-f" option specifies that the sort should be case insensitive.
% The "print" command should print the .dvi file generated by LaTeX.
% The details of the typesetting sequence above may vary on your computer
% system.
%
%=============================================================================%


% Basic Document Style
% --------------------
%    The default font size is 10pt which is what I want.
%    titlepage - Instructs LaTeX to produce a title page at the front.
%    book      - Use the "book" built in format.
\documentstyle[titlepage]{book}

% The following pagestyle command instructs LaTeX to set each page with just
% a page number at the middle of the bottom of each page.
\pagestyle{plain}

% By default, the "book" style sets even and odd pages differently on the
% assumption that the result is to be used in a two-sided printing process.
% However, most people printing this will print it single sided.
% To suppress double sided mode, we need to give the \onecolumn command.
\onecolumn


% Page Size and Position
% ----------------------
% The following sets the size of the text box and its position on the page.
% It works OK on A4 paper. I suppose I should test it on American paper too.
\textwidth     15cm
\textheight    24cm
\topmargin      0cm
\oddsidemargin  1.5cm
\evensidemargin 1.5cm
\headheight     0cm
\headsep        0cm


% Table of Contents
% -----------------
% Specify that all headings be numbered and appear in the Table of Contents.
\setcounter{secnumdepth}{100}
\setcounter{tocdepth}{100}

% LaTeX lets you create an unnumbered chapter, but it doesn't put it in
% the table of contents. So we have to do it manually.
\def\pseudochapter#1{%
\chapter*{#1}
\addcontentsline{toc}{chapter}{#1}
}

% Paragraph Separation and Indentation
% ------------------------------------
% The default LaTeX format is to have paragraphs jammed up against each other
% with indentation of text on the first line of each paragraph used to
% highlight the start of each paragraph. I prefer to identify paragraphs
% by separating them with space and eliminating the indentation.
\parskip   \medskipamount
\parindent 0pt


% Quick Style Macros
% ------------------
% Use of the following macros is much neater and safer than opening a group
% and setting a mode (e.g. {\bf sloth}) as these macros will cause TeX to
% scream if they span more than one paragraph whereas the group method
% can cause half the document to be set in a funny mode.
% Other little macros here serve the same neatening normalizing purposes.
\def\i#1{{\it #1}}                    % Italics.
\def\b#1{{\bf #1}}                    % Bold.
\def\p#1{{\tt #1}}                    % Program text.
\def\sq#1{`#1'}                       % Single quotes.
\def\dq#1{``#1''}                     % Double quotes.
\def\dqp#1{\dq{\p{#1}}}               % Double quoted program text.
\def\fix#1{\footnote{$\bullet$ #1}}   % Fix it up footnote.
\def\softfix#1{}                      % Marks opportunity for improvement.
\def\eg{e.g.~}                        % Spacing regulated "e.g.".
\def\ie{i.e.~}                        % Spacing regulated "i.e.".
\def\til{\char`\~}                    % For tilde ("~") character.
\def\circumflex{\char`\^}             % Circumflex.
\def\bs{{\tt\char`\\}}                % Backslash.

% Point Making
% ------------
% LaTeX provides some useful environment for listing points. However, it does
% not seem to provide what I want which is a paragraph of text led in by
% a label set in bold.
\def\thing#1{{\bf #1}}
\def\firstthing#1{\thing{#1}}
\def\narrowthing#1#2{{%From defintion of \narrower
\advance\leftskip1cm%
\advance\rightskip1cm%
{\bf #1} #2\vskip0pt}}
\def\narrowtext#1{{%From defintion of \narrower
\advance\leftskip1cm%
\advance\rightskip1cm%
#1\vskip0pt}}
\def\summary{\b{Summary:}\ }

% Invisible Annotations
% ---------------------
% Sometimes it is convenient to be able to annotate the LaTeX code without
% causing text to appear in the document.
% Here, the \checked{} macro can be placed next to any quotation or
% fact, or other externally dependent material that has to be checked
% before publication. The \note{} macro can be used to add a note.
% Both macros are safer than "%" in a paragraph where the text may be
% continually being rearranged across lines.
\def\checked#1{}
\def\note#1{}


% Wide Verbatim Text
% ------------------
% This document was originally set in 12pt and the result was that many of
% the verbatim examples wouldn't fit. To solve this, I created two macros
% to reduce and increase the size of the text, and wrapped the longer
% verbatim texts in calls to the macros. Later, the document was reset in
% 10pt eliminating the original problem, so I redefined the macros to empty.
%\def\beginsmall{\scriptsize}
%\def\endsmall{\normalsize}
\def\beginsmall{}
\def\endsmall{}


% The Index
% ---------
% LaTeX provides a single command (\index) for adding index entries to the
% index. We shorten it and refine it a little with a few definitions.
\def\newterm#1{{\bf #1}\x{#1}}            % Special terminology.
\def\x#1{\index{#1}}                      % Normal index entry.
\def\xx#1#2{\index{#1 #2}\index{#2 #1}}   % Symmetric index entry.
\def\xn#1#2{\xx{#1}{#2}}                  % For a person's name.
\def\xs#1#2{\index{#1, #2}}               % For an entry with a subclause.


% References
% ----------
\def\paper#1{{\bf [#1]}\x{#1}\linebreak[1]{}}


% Figures and Tables
% ------------------
% LaTeX numbers figures by chapter and doesn't position captions where I
% want them and so I have decided to do it all manually. I haven't got
% time for fancy stuff so I am using manual macros.
\def\mylabel#1#2{%
\begin{quotation}
\footnotesize\baselineskip=12pt #2
\end{quotation}
\centerline{#1}
\smallskip}

\def\figfor#1{{\bf Figure~#1}}
\def\tabfor#1{{\bf Table~#1}}

\def\figlicense{\figfor{1}}
%\def\figtwo{\figfor{2}}

%\def\tabone{\tabfor{1}}
%\def\tabtwo{\tabfor{2}}


% Glossary
% --------
\def\gloss#1{\thing{#1:}\x{#1}}


% Random Leftover Stuff
% ---------------------
\def\topicbreak{\bigskip\centerline{--- $\S$ ---}\bigskip}



%------------------------------------------------------------------------------

% Title Page
% ----------
% Although the title should really be in the ch0.tex file, LaTeX forces us to
% put it here.
\begin{titlepage}
\vspace*{3cm}
\begin{center}
\Huge
\vspace{2cm}
FunnelWeb Hacker's Manual\\
\vspace{2cm}
\LARGE
Ross~N.~Williams\\
\vspace{1cm}
\Large
V1.0 for FunnelWeb V3.0\\
\vspace{1cm}
May 1992\\
\normalsize
\end{center}
\end{titlepage}

% Note: LaTeX sometimes puts a blank page before chapters so as to
% start each chapter on an odd-numbered page. There is nothing that I
% can do about this. This is part of the cost of using LaTeX instead
% of TeX.

\makeindex

%-------------------------------------------------------------------------------

\begin{document}
\sloppy
\nonstopmode

\input h_ch0    % Table of contents etc.
\input h_ch1    % FunnelWeb Design
\input h_ch2    % FunnelWeb Implementation
\input h_ch3    % FunnelWeb Modification
\input h_ch4    % FunnelWeb Future
\input h_cha    % Appendices

\end{document}

%==============================================================================%
%             End of Main .TeX File of FunnelWeb Hacker's Manual               %
%==============================================================================%