Mercurial > docs > diploma

annotate thesis/tex/0-preface.tex @ 298:0d88bf21e152

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
minor changes
author meillo@marmaro.de
date Sun, 18 Jan 2009 18:33:30 +0100
parents 1749abc10235
children fb66805bc870
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
274
56cc2f5755f8 cleardoublepage -> clearpage (as the document is single sided)
meillo@marmaro.de
parents: 253
diff changeset
1 \clearpage
8
1d35768e1643 first prototype of thesis (with some sample content)
meillo@marmaro.de
parents:
diff changeset
2 \chapter*{Preface}
98
1b7dba16c74a minor stuff in preface
meillo@marmaro.de
parents: 96
diff changeset
3 \addcontentsline{toc}{section}{Preface}
8
1d35768e1643 first prototype of thesis (with some sample content)
meillo@marmaro.de
parents:
diff changeset
4
101
6e2eaf91e59f some comments
meillo@marmaro.de
parents: 98
diff changeset
5 << preface text (about 1 page) >> %FIXME
6e2eaf91e59f some comments
meillo@marmaro.de
parents: 98
diff changeset
6
6e2eaf91e59f some comments
meillo@marmaro.de
parents: 98
diff changeset
7 goal: revive masqmail; make it future save; clean it up; add some missing features; release a new version
6e2eaf91e59f some comments
meillo@marmaro.de
parents: 98
diff changeset
8
6e2eaf91e59f some comments
meillo@marmaro.de
parents: 98
diff changeset
9 << write about the motivation to cover this topic: what is it I want? >> %FIXME
8
1d35768e1643 first prototype of thesis (with some sample content)
meillo@marmaro.de
parents:
diff changeset
10
101
6e2eaf91e59f some comments
meillo@marmaro.de
parents: 98
diff changeset
11 << preface == target of the book, related to the reader >> %FIXME
6e2eaf91e59f some comments
meillo@marmaro.de
parents: 98
diff changeset
12
6e2eaf91e59f some comments
meillo@marmaro.de
parents: 98
diff changeset
13 << make the topic more concrete and limit it >> %FIXME
6e2eaf91e59f some comments
meillo@marmaro.de
parents: 98
diff changeset
14
6e2eaf91e59f some comments
meillo@marmaro.de
parents: 98
diff changeset
15 << have text by oliver here? >> %TODO
6e2eaf91e59f some comments
meillo@marmaro.de
parents: 98
diff changeset
16
277
8a25b6262497 minor changes; added todos
meillo@marmaro.de
parents: 274
diff changeset
17 usage examples:
8a25b6262497 minor changes; added todos
meillo@marmaro.de
parents: 274
diff changeset
18
8a25b6262497 minor changes; added todos
meillo@marmaro.de
parents: 274
diff changeset
19 debian popcon stats
8a25b6262497 minor changes; added todos
meillo@marmaro.de
parents: 274
diff changeset
20
8a25b6262497 minor changes; added todos
meillo@marmaro.de
parents: 274
diff changeset
21 << hikernet >>
8
1d35768e1643 first prototype of thesis (with some sample content)
meillo@marmaro.de
parents:
diff changeset
22
96
8db526d7a678 reorganized preface and introduction (feels better now)
meillo@marmaro.de
parents: 93
diff changeset
23
277
8a25b6262497 minor changes; added todos
meillo@marmaro.de
parents: 274
diff changeset
24 \subsubsection*{Audience}
96
8db526d7a678 reorganized preface and introduction (feels better now)
meillo@marmaro.de
parents: 93
diff changeset
25
47
d52fa2350137 split up into one sentence per line
meillo@marmaro.de
parents: 42
diff changeset
26 This document is targeted for \masqmail\ users and for people interested in mail systems in general.
136
b5f141edee4e one uppercase letter words are not set in small caps
meillo@marmaro.de
parents: 101
diff changeset
27 Security problems in electronic mail, \unix\ and the C programming language will also be discussed.
47
d52fa2350137 split up into one sentence per line
meillo@marmaro.de
parents: 42
diff changeset
28 Additional ones planning to take over an unmaintained software project will find real life experience in here.
33
b3ba69ef35ab added text about audience; added FIXMEs
meillo@marmaro.de
parents: 26
diff changeset
29
47
d52fa2350137 split up into one sentence per line
meillo@marmaro.de
parents: 42
diff changeset
30 In each topic, basic knowledge is preconditioned.
d52fa2350137 split up into one sentence per line
meillo@marmaro.de
parents: 42
diff changeset
31 Nevertheless introductions are given and sources for further reading will be mentioned.
8
1d35768e1643 first prototype of thesis (with some sample content)
meillo@marmaro.de
parents:
diff changeset
32
47
d52fa2350137 split up into one sentence per line
meillo@marmaro.de
parents: 42
diff changeset
33 This work focuses on the \unix\ operating system.
d52fa2350137 split up into one sentence per line
meillo@marmaro.de
parents: 42
diff changeset
34 Experience in usage, administration and program development is assumed.
136
b5f141edee4e one uppercase letter words are not set in small caps
meillo@marmaro.de
parents: 101
diff changeset
35 This includes the basic toolchain (e.g.\ \name{tar}, \name{grep}, etc.), user, file and permission management, as well as writing, compiling and installing programs written in the C language.
33
b3ba69ef35ab added text about audience; added FIXMEs
meillo@marmaro.de
parents: 26
diff changeset
36
210
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
37 General information about \unix\ can be found in \cite{kernighan84} %FIXME: references
33
b3ba69ef35ab added text about audience; added FIXMEs
meillo@marmaro.de
parents: 26
diff changeset
38 . %FIXME: references
47
d52fa2350137 split up into one sentence per line
meillo@marmaro.de
parents: 42
diff changeset
39 explain about administrating \unix.
210
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
40 And developing programs in C may be learned from \cite{k&r} and \cite{rochkind85}. %FIXME: references
33
b3ba69ef35ab added text about audience; added FIXMEs
meillo@marmaro.de
parents: 26
diff changeset
41
b3ba69ef35ab added text about audience; added FIXMEs
meillo@marmaro.de
parents: 26
diff changeset
42 %TODO: should I tell them to send email to me when having questions? Or somewhere else?
b3ba69ef35ab added text about audience; added FIXMEs
meillo@marmaro.de
parents: 26
diff changeset
43
8
1d35768e1643 first prototype of thesis (with some sample content)
meillo@marmaro.de
parents:
diff changeset
44
36
42a2a3565b89 structural changes in preface
meillo@marmaro.de
parents: 33
diff changeset
45 \section*{Organisation}
98
1b7dba16c74a minor stuff in preface
meillo@marmaro.de
parents: 96
diff changeset
46
1b7dba16c74a minor stuff in preface
meillo@marmaro.de
parents: 96
diff changeset
47 << write about organisation of the book: parts, chapters, sections. And more thats useful to know. >> %FIXME
33
b3ba69ef35ab added text about audience; added FIXMEs
meillo@marmaro.de
parents: 26
diff changeset
48
98
1b7dba16c74a minor stuff in preface
meillo@marmaro.de
parents: 96
diff changeset
49 << explain where the main part lies (theory vs. implementation) >> %FIXME:
1b7dba16c74a minor stuff in preface
meillo@marmaro.de
parents: 96
diff changeset
50
1b7dba16c74a minor stuff in preface
meillo@marmaro.de
parents: 96
diff changeset
51 << write about the bundled CD, and tell what's included >> %TODO
8
1d35768e1643 first prototype of thesis (with some sample content)
meillo@marmaro.de
parents:
diff changeset
52
33
b3ba69ef35ab added text about audience; added FIXMEs
meillo@marmaro.de
parents: 26
diff changeset
53
280
1749abc10235 minor changes
meillo@marmaro.de
parents: 277
diff changeset
54 \section*{Conventions}
150
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
55 %TODO: check if this tells what is really used!
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
56 %FIXME: make it complete!
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
57 %FIXME: remove everything not needed. Maybe write only a few sentences text.
280
1749abc10235 minor changes
meillo@marmaro.de
parents: 277
diff changeset
58 The following typographic conventions are used in this thesis:
150
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
59
210
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
60 \begin{tabular}{ p{0.25\textwidth} p{0.7\textwidth} }
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
61 \emph{Italics} &
150
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
62 is used for names, including command names, file name, hostnames, usernames and email addresses.
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
63 Further more it is used to emphasize text.
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
64 \\ &\\
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
65
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
66 \texttt{Constant Width} &
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
67 is used for source code, contents of files and output from programs.
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
68 \\ &\\
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
69
248
724cc6057105 complete names are now in small caps
meillo@marmaro.de
parents: 234
diff changeset
70 \person{Small Caps} &
210
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
71 are used to indicate names of persons.
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
72 \\ &\\
280
1749abc10235 minor changes
meillo@marmaro.de
parents: 277
diff changeset
73 \end{tabular}
150
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
74
280
1749abc10235 minor changes
meillo@marmaro.de
parents: 277
diff changeset
75 References to external resources are marked using one of three styles:
210
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
76
280
1749abc10235 minor changes
meillo@marmaro.de
parents: 277
diff changeset
77 \begin{tabular}{ p{0.25\textwidth} p{0.7\textwidth} }
210
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
78 \cite{kernighan84} &
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
79 is a reference to a book, an article, or a similar document. The Bibliography is located at the end of the thesis.
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
80 \\ &\\
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
81
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
82 \citeweb{masqmail:homepage} &
253
4dacd0d50342 work on intro and preface
meillo@marmaro.de
parents: 248
diff changeset
83 is a reference to a website. Websites differ from documents as they are less of a text written by some author, but more a place where information is gathered.
210
2181dc39ec06 extended typo conventions; and minor stuff
meillo@marmaro.de
parents: 150
diff changeset
84 \\ &\\
234
4f2ebfac5ce0 added convention of refs to RFCs
meillo@marmaro.de
parents: 210
diff changeset
85
4f2ebfac5ce0 added convention of refs to RFCs
meillo@marmaro.de
parents: 210
diff changeset
86 \RFC821 &
253
4dacd0d50342 work on intro and preface
meillo@marmaro.de
parents: 248
diff changeset
87 is a reference to the \name{Request For Comments}, here the one numbered 821. \RFC{}s are only referenced in this way. A list of relevant \RFC{}s and how they can be retrieved is available in the Appendix. %fixme: add ref
234
4f2ebfac5ce0 added convention of refs to RFCs
meillo@marmaro.de
parents: 210
diff changeset
88 \\ &\\
150
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
89 \end{tabular}
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
90
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
91
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
92
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
93
0d097f4300ce moved typographic conventions from ch01 to preface
meillo@marmaro.de
parents: 136
diff changeset
94
98
1b7dba16c74a minor stuff in preface
meillo@marmaro.de
parents: 96
diff changeset
95 \section*{Acknowledgments}
33
b3ba69ef35ab added text about audience; added FIXMEs
meillo@marmaro.de
parents: 26
diff changeset
96 %FIXME: write this at the very end.
b3ba69ef35ab added text about audience; added FIXMEs
meillo@marmaro.de
parents: 26
diff changeset
97 % dont forget: proove readers, suggestion makers, supporters, ...
93
a6f8a93abd64 new chapter 4 (split ch5); added lots of annotations
meillo@marmaro.de
parents: 92
diff changeset
98 % FIXME: if too long, include a file on the CD and refer on it here