docs/diploma

view thesis/tex/0-preface.tex @ 33:b3ba69ef35ab

added text about audience; added FIXMEs
author meillo@marmaro.de
date Tue, 07 Oct 2008 15:32:15 +0200
parents fb9ba63f6957
children 42a2a3565b89
line source
1 \cleardoublepage
2 \chapter*{Preface}
3 \addcontentsline{toc}{chapter}{Preface}
5 \section*{Preface}
6 Lorem ipsum dolor sit amet, \cite{brooks95} consectetur\index{Daten} adipisicing elit
9 \section*{Organisation}
10 %FIXME: write about organisation of the book: parts, chapters, sections. And more thats useful to know.
11 %TODO: have this section after ``Audience''?
14 \section*{Audience}
15 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.
17 In each topic, basic knowledge is %FIXME: vorrausgesetzt
18 . Nevertheless introductions are given and sources for further reading will be mentioned.
20 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.
22 General information about \unix\ can be found in %FIXME: references
23 . %FIXME: references
24 explain about administrating \unix. And developing programs in \NAME{C} may be learned from %FIXME: references (``The C programming language'', ``The Unix programming environment'', ...)
25 .
27 %TODO: should I tell them to send email to me when having questions? Or somewhere else?
30 \section*{How to read this document}
31 %TODO: what to write here??
32 %TODO: include this in section ``Organisation''?
35 \section*{Conventions used in the book}
36 %TODO: check if this tells what is really used!
37 %FIXME: make it complete!
38 The following typographic conventions are used in this book:
40 \begin{tabular}{ p{0.15\textwidth} p{0.8\textwidth} }
41 \emph{Italic} &
42 is used for names, including command names, file name, hostnames, usernames and email addresses.
43 Further more it is used to emphasize text.
44 \\ &\\
46 \texttt{Constant Width} &
47 is used for source code, contents of files and output from programs.
48 \\ &\\
50 \texttt{\$} &
51 indicates the the user shell prompt.
52 \\ &\\
54 \texttt{\#} &
55 indicates the the root shell prompt.
56 \\
57 \end{tabular}
61 \section*{Regarded versions}
62 %FIXME: do I need this (here)?
65 \section*{Additional sources}
66 %FIXME: specify the really important external documents here
67 %TODO: write about the bundled CD, and tell what's included
68 \NAME{RFC}s, other books, source code, websites
71 \section*{Acknowledgements}
72 %FIXME: write this at the very end.
73 % dont forget: proove readers, suggestion makers, supporters, ...