docs/diploma

view thesis/tex/0-preface.tex @ 45:faf3c7524993

split up into one sentence per line
author meillo@marmaro.de
date Tue, 14 Oct 2008 10:45:22 +0200
parents 81ff8b093efe
children d52fa2350137
line source
1 \cleardoublepage
2 \chapter*{Preface}
3 \addcontentsline{toc}{chapter}{Preface}
5 \section*{Preface}
6 %FIXME: write about the motivation to cover this topic
7 %TODO: eventually have some words of oliver here
10 \section*{Audience}
11 This document is targeted for \masqmail\ users and for people interested in mail systems in general. Security problems in electronic mail, \unix\ and the \NAME{C} programming language will also be discussed. Additional ones planning to take over an unmaintained software project will find real life experience in here.
13 In each topic, basic knowledge is preconditioned. Nevertheless introductions are given and sources for further reading will be mentioned.
15 This work focuses on the \unix\ operating system. Experience in usage, administration and program development is assumed. 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 \NAME{C} language.
17 General information about \unix\ can be found in \cite{unixprogenv} %FIXME: references
18 . %FIXME: references
19 explain about administrating \unix. And developing programs in \NAME{C} may be learned from \cite{cprog} and \cite{advunixprog}. %FIXME: references
21 %TODO: should I tell them to send email to me when having questions? Or somewhere else?
24 \section*{Organisation}
25 %FIXME: write about organisation of the book: parts, chapters, sections. And more thats useful to know.
28 \section*{How to read this document}
29 %TODO: what to write here??
30 %TODO: include this in section ``Organisation''?
33 \section*{Conventions used}
34 %TODO: check if this tells what is really used!
35 %FIXME: make it complete!
36 The following typographic conventions are used in this book:
38 \begin{tabular}{ p{0.15\textwidth} p{0.8\textwidth} }
39 \emph{Italic} &
40 is used for names, including command names, file name, hostnames, usernames and email addresses.
41 Further more it is used to emphasize text.
42 \\ &\\
44 \texttt{Constant Width} &
45 is used for source code, contents of files and output from programs.
46 \\ &\\
48 \texttt{\$} &
49 indicates the the user shell prompt.
50 \\ &\\
52 \texttt{\#} &
53 indicates the the root shell prompt.
54 \\
55 \end{tabular}
59 \section*{Additional sources}
60 %FIXME: specify the really important external documents here
61 %TODO: write about the bundled CD, and tell what's included
62 \NAME{RFC}s, other books, source code, websites
65 \section*{Acknowledgements}
66 %FIXME: write this at the very end.
67 % dont forget: proove readers, suggestion makers, supporters, ...