docs/diploma

view thesis/tex/0-preface.tex @ 316:f3a86ce788ec

spell checking
author meillo@marmaro.de
date Wed, 21 Jan 2009 15:19:25 +0100
parents 34ecf52520d3
children 3a544a333752
line source
1 \clearpage
2 \chapter*{Preface}
3 \addcontentsline{toc}{section}{Preface}
5 << preface text (about 1 page) >> %FIXME
7 << \textbf{say what you want to say} >>
9 << the overall goal of the document >>
11 goal: revive masqmail; make it future save; clean it up; add some missing features; release a new version
13 << write about the motivation to cover this topic: what is it I want? >> %FIXME
15 << preface == target of the book, related to the reader >> %FIXME
17 << make the topic more concrete and limit it >> %FIXME
19 << have text by Oliver here? >> %TODO
21 usage examples:
23 debian popcon stats
25 << hikernet >>
28 \subsubsection*{Audience}
30 This document is targeted for \masqmail\ users and for people interested in mail systems in general.
31 Security problems in electronic mail, \unix\ and the C programming language will also be discussed.
32 Additional ones planning to take over an unmaintained software project will find real life experience in here.
34 In each topic, basic knowledge is preconditioned.
35 Nevertheless introductions are given and sources for further reading will be mentioned.
37 This work focuses on the \unix\ operating system.
38 Experience in usage, administration and program development is assumed.
39 This includes the basic tool chain (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.
41 General information about \unix\ can be found in \cite{kernighan84} %FIXME: references
42 . %FIXME: references
43 explain about administrating \unix.
44 And developing programs in C may be learned from \cite{k&r} and \cite{rochkind85}. %FIXME: references
48 \section*{Organization}
50 << write about organization of the book: parts, chapters, sections. And more that's useful to know. >> %FIXME
52 << explain where the main part lies (theory vs. implementation) >> %FIXME:
56 \section*{Conventions}
57 %TODO: check it!
58 The following typographic conventions are used in this thesis:
60 \begin{enumerate}
61 \item \emph{Italic shape} is used to emphasize text, to introduce new terms, and for names, including product, host, and user names, as well as email addresses.
63 \item For names of persons \textsc{Small Caps} are used.
65 \item File and path names, source code excerpts, contents of files, and output from programs are displayed in \texttt{Typewriter font}.
66 \end{enumerate}
68 References to external resources are marked using one of three styles, distinguished by the type of resource.
70 \begin{enumerate}
71 \item References to books, articles, and similar documents looks like this: \cite{kernighan84}. The letters represent the author(s) (here \person{Kernighan} and \person{Pike}), the number represents the year of publication (here 1984).
73 \item Websites differ from documents as they are less of a text written by some author but more a place where information is gathered. They are only indicated by numbers, like for example: \citeweb{masqmail:homepage}.
75 \item \name{Request for Comments}---documents that define Internet standards---are referenced in a third way, by specifying the unique number of the \RFC\ directly: \RFC821.
76 \end{enumerate}
78 The Bibliography is located at the end of the thesis. It also includes a list of the relevant \RFC{}s and how they can be retrieved.
84 \section*{Acknowledgments}
85 %FIXME: write this at the very end.
86 % dont forget: proove readers, suggestion makers, supporters, ...
87 % FIXME: if too long, think about a page in the appendix