docs/diploma

view thesis/tex/0-preface.tex @ 274:56cc2f5755f8

cleardoublepage -> clearpage (as the document is single sided)
author meillo@marmaro.de
date Thu, 15 Jan 2009 12:35:19 +0100
parents 4dacd0d50342
children 8a25b6262497
line source
1 \clearpage
2 \chapter*{Preface}
3 \addcontentsline{toc}{section}{Preface}
5 << preface text (about 1 page) >> %FIXME
7 goal: revive masqmail; make it future save; clean it up; add some missing features; release a new version
9 << write about the motivation to cover this topic: what is it I want? >> %FIXME
11 << preface == target of the book, related to the reader >> %FIXME
13 << make the topic more concrete and limit it >> %FIXME
15 << have text by oliver here? >> %TODO
19 Audience:
21 This document is targeted for \masqmail\ users and for people interested in mail systems in general.
22 Security problems in electronic mail, \unix\ and the C programming language will also be discussed.
23 Additional ones planning to take over an unmaintained software project will find real life experience in here.
25 In each topic, basic knowledge is preconditioned.
26 Nevertheless introductions are given and sources for further reading will be mentioned.
28 This work focuses on the \unix\ operating system.
29 Experience in usage, administration and program development is assumed.
30 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.
32 General information about \unix\ can be found in \cite{kernighan84} %FIXME: references
33 . %FIXME: references
34 explain about administrating \unix.
35 And developing programs in C may be learned from \cite{k&r} and \cite{rochkind85}. %FIXME: references
37 %TODO: should I tell them to send email to me when having questions? Or somewhere else?
40 \section*{Organisation}
42 << write about organisation of the book: parts, chapters, sections. And more thats useful to know. >> %FIXME
44 << explain where the main part lies (theory vs. implementation) >> %FIXME:
46 << write about the bundled CD, and tell what's included >> %TODO
49 \section*{Typographic conventions}
50 %TODO: check if this tells what is really used!
51 %FIXME: make it complete!
52 %FIXME: remove everything not needed. Maybe write only a few sentences text.
53 The following typographic conventions are used in this book:
55 \begin{tabular}{ p{0.25\textwidth} p{0.7\textwidth} }
56 \emph{Italics} &
57 is used for names, including command names, file name, hostnames, usernames and email addresses.
58 Further more it is used to emphasize text.
59 \\ &\\
61 \texttt{Constant Width} &
62 is used for source code, contents of files and output from programs.
63 \\ &\\
65 \person{Small Caps} &
66 are used to indicate names of persons.
67 \\ &\\
69 \texttt{\$} &
70 indicates the user's shell prompt.
71 \\ &\\
73 \texttt{\#} &
74 indicates the shell prompt of the superuser---root.
75 \\ &\\
77 \cite{kernighan84} &
78 is a reference to a book, an article, or a similar document. The Bibliography is located at the end of the thesis.
79 \\ &\\
81 \citeweb{masqmail:homepage} &
82 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.
83 \\ &\\
85 \RFC821 &
86 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
87 \\ &\\
89 \end{tabular}
95 \section*{Acknowledgments}
96 %FIXME: write this at the very end.
97 % dont forget: proove readers, suggestion makers, supporters, ...
98 % FIXME: if too long, include a file on the CD and refer on it here