docs/diploma

annotate thesis/tex/0-preface.tex @ 302:fb66805bc870

reworked section about conventions; minor other stuff
author meillo@marmaro.de
date Tue, 20 Jan 2009 12:06:34 +0100
parents 1749abc10235
children 34ecf52520d3
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@302 7 << \textbf{say what you want to say} >>
meillo@302 8
meillo@302 9 << the overall goal of the document >>
meillo@302 10
meillo@101 11 goal: revive masqmail; make it future save; clean it up; add some missing features; release a new version
meillo@101 12
meillo@101 13 << write about the motivation to cover this topic: what is it I want? >> %FIXME
meillo@101 14
meillo@101 15 << preface == target of the book, related to the reader >> %FIXME
meillo@101 16
meillo@101 17 << make the topic more concrete and limit it >> %FIXME
meillo@101 18
meillo@101 19 << have text by oliver here? >> %TODO
meillo@101 20
meillo@277 21 usage examples:
meillo@8 22
meillo@277 23 debian popcon stats
meillo@96 24
meillo@277 25 << hikernet >>
meillo@277 26
meillo@277 27
meillo@277 28 \subsubsection*{Audience}
meillo@96 29
meillo@47 30 This document is targeted for \masqmail\ users and for people interested in mail systems in general.
meillo@136 31 Security problems in electronic mail, \unix\ and the C programming language will also be discussed.
meillo@47 32 Additional ones planning to take over an unmaintained software project will find real life experience in here.
meillo@33 33
meillo@47 34 In each topic, basic knowledge is preconditioned.
meillo@47 35 Nevertheless introductions are given and sources for further reading will be mentioned.
meillo@33 36
meillo@47 37 This work focuses on the \unix\ operating system.
meillo@47 38 Experience in usage, administration and program development is assumed.
meillo@136 39 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 40
meillo@210 41 General information about \unix\ can be found in \cite{kernighan84} %FIXME: references
meillo@33 42 . %FIXME: references
meillo@47 43 explain about administrating \unix.
meillo@210 44 And developing programs in C may be learned from \cite{k&r} and \cite{rochkind85}. %FIXME: references
meillo@33 45
meillo@33 46
meillo@8 47
meillo@36 48 \section*{Organisation}
meillo@33 49
meillo@98 50 << write about organisation of the book: parts, chapters, sections. And more thats useful to know. >> %FIXME
meillo@8 51
meillo@98 52 << explain where the main part lies (theory vs. implementation) >> %FIXME:
meillo@33 53
meillo@98 54
meillo@98 55
meillo@280 56 \section*{Conventions}
meillo@302 57 %TODO: check it!
meillo@280 58 The following typographic conventions are used in this thesis:
meillo@150 59
meillo@302 60 \emph{Italic shape} is used to emphasize text and for all kinds of names, including command names, file name, hostnames, usernames, and email addresses, except names of persons for which \textsc{Small Caps} are used.
meillo@150 61
meillo@302 62 Source code, contents of files, and output from programs is displayed in \texttt{Typewriter font}.
meillo@150 63
meillo@302 64 References to external resources are marked using one of three styles, distinguished by the type of resource.
meillo@210 65
meillo@302 66 \begin{enumerate}
meillo@302 67 \item References to books, articles, and similar documents looks like this: \cite{kernighan84}. The letters represent the author(s) (here \person{Kenighan} and \person{Pike}), the number represents the year of publication (here 1984).
meillo@150 68
meillo@302 69 \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}.
meillo@210 70
meillo@302 71 \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.
meillo@302 72 \end{enumerate}
meillo@234 73
meillo@302 74 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.
meillo@150 75
meillo@150 76
meillo@150 77
meillo@150 78
meillo@150 79
meillo@98 80 \section*{Acknowledgments}
meillo@33 81 %FIXME: write this at the very end.
meillo@33 82 % dont forget: proove readers, suggestion makers, supporters, ...
meillo@302 83 % FIXME: if too long, think about a page in the appendix