docs/diploma

annotate thesis/tex/0-preface.tex @ 295:822a4b135dd2

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