docs/diploma

annotate thesis/tex/0-preface.tex @ 210:2181dc39ec06

extended typo conventions; and minor stuff
author meillo@marmaro.de
date Sun, 04 Jan 2009 10:27:30 +0100
parents 0d097f4300ce
children 4f2ebfac5ce0
rev   line source
meillo@8 1 \cleardoublepage
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@8 17
meillo@96 18
meillo@98 19 Audience:
meillo@96 20
meillo@47 21 This document is targeted for \masqmail\ users and for people interested in mail systems in general.
meillo@136 22 Security problems in electronic mail, \unix\ and the C programming language will also be discussed.
meillo@47 23 Additional ones planning to take over an unmaintained software project will find real life experience in here.
meillo@33 24
meillo@47 25 In each topic, basic knowledge is preconditioned.
meillo@47 26 Nevertheless introductions are given and sources for further reading will be mentioned.
meillo@33 27
meillo@47 28 This work focuses on the \unix\ operating system.
meillo@47 29 Experience in usage, administration and program development is assumed.
meillo@136 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.
meillo@33 31
meillo@210 32 General information about \unix\ can be found in \cite{kernighan84} %FIXME: references
meillo@33 33 . %FIXME: references
meillo@47 34 explain about administrating \unix.
meillo@210 35 And developing programs in C may be learned from \cite{k&r} and \cite{rochkind85}. %FIXME: references
meillo@33 36
meillo@33 37 %TODO: should I tell them to send email to me when having questions? Or somewhere else?
meillo@33 38
meillo@8 39
meillo@36 40 \section*{Organisation}
meillo@33 41
meillo@98 42 << write about organisation of the book: parts, chapters, sections. And more thats useful to know. >> %FIXME
meillo@8 43
meillo@98 44 << explain where the main part lies (theory vs. implementation) >> %FIXME:
meillo@33 45
meillo@98 46 << write about the bundled CD, and tell what's included >> %TODO
meillo@98 47
meillo@98 48
meillo@150 49 \section*{Typographic conventions}
meillo@150 50 %TODO: check if this tells what is really used!
meillo@150 51 %FIXME: make it complete!
meillo@150 52 %FIXME: remove everything not needed. Maybe write only a few sentences text.
meillo@150 53 The following typographic conventions are used in this book:
meillo@150 54
meillo@210 55 \begin{tabular}{ p{0.25\textwidth} p{0.7\textwidth} }
meillo@210 56 \emph{Italics} &
meillo@150 57 is used for names, including command names, file name, hostnames, usernames and email addresses.
meillo@150 58 Further more it is used to emphasize text.
meillo@150 59 \\ &\\
meillo@150 60
meillo@150 61 \texttt{Constant Width} &
meillo@150 62 is used for source code, contents of files and output from programs.
meillo@150 63 \\ &\\
meillo@150 64
meillo@210 65 \textsc{Small Caps} &
meillo@210 66 are used to indicate names of persons.
meillo@210 67 \\ &\\
meillo@210 68
meillo@150 69 \texttt{\$} &
meillo@210 70 indicates the user's shell prompt.
meillo@150 71 \\ &\\
meillo@150 72
meillo@150 73 \texttt{\#} &
meillo@210 74 indicates the shell prompt of the superuser---root.
meillo@210 75 \\ &\\
meillo@210 76
meillo@210 77 \cite{kernighan84} &
meillo@210 78 is a reference to a book, an article, or a similar document. The Bibliography is located at the end of the thesis.
meillo@210 79 \\ &\\
meillo@210 80
meillo@210 81 \citeweb{masqmail:homepage} &
meillo@210 82 is a reference to a website. Websites differ from documents as they are hardly a text written by some author, but a place where information is gathered.
meillo@210 83 \\ &\\
meillo@150 84 \end{tabular}
meillo@150 85
meillo@150 86
meillo@150 87
meillo@150 88
meillo@150 89
meillo@98 90 \section*{Acknowledgments}
meillo@33 91 %FIXME: write this at the very end.
meillo@33 92 % dont forget: proove readers, suggestion makers, supporters, ...
meillo@93 93 % FIXME: if too long, include a file on the CD and refer on it here