mirror of https://github.com/tLDP/LDP
126 lines
4.1 KiB
TeX
126 lines
4.1 KiB
TeX
\section{Introduction}
|
|
|
|
\subsection{Why was this document written?}\label{introux5f01}
|
|
|
|
Some explanations.
|
|
|
|
\subsection{Audience}\label{introux5f02}
|
|
|
|
Explain for whom it has been written.
|
|
|
|
\subsection{New versions of this doc}\label{introux5f03}
|
|
|
|
Point to \href{http://somewhere.org}{the latest version} of this
|
|
document.
|
|
|
|
\subsection{Revision History}\label{introux5f04}
|
|
|
|
1.2 2003-02-28 MG More stuff you changed. 1.1 2003-01-22 MG Stuff you
|
|
changed. 1.0 2002-12-29 MG Initial release for TLDP
|
|
|
|
\subsection{Contributions}\label{introux5f05}
|
|
|
|
Thank people who helped realizing this doc.
|
|
|
|
\subsection{Feedback}\label{introux5f06}
|
|
|
|
Missing information, missing links, missing characters? Mail it to the
|
|
maintainer of this document:
|
|
\href{mailto:you@your.domain}{\nolinkurl{you@your.domain}}
|
|
|
|
\subsection{Copyright information}\label{introux5f07}
|
|
|
|
Copyright 2002 Your\_first\_name Your\_last\_name.
|
|
|
|
Permission is granted to copy, distribute and/or modify this document
|
|
under the terms of the GNU Free Documentation License, Version 1.1 or
|
|
any later version published by the Free Software Foundation; with no
|
|
Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A
|
|
copy of the license is included in ? entitled ``GNU Free Documentation
|
|
License''.
|
|
|
|
Read \href{http://www.fsf.org/gnu/manifesto.html}{The GNU Manifesto} if
|
|
you want to know why this license was chosen for this book.
|
|
|
|
The author and publisher have made every effort in the preparation of
|
|
this book to ensure the accuracy of the information. However, the
|
|
information contained in this book is offered without warranty, either
|
|
express or implied. Neither the author nor the publisher nor any dealer
|
|
or distributor will be held liable for any damages caused or alleged to
|
|
be caused either directly or indirectly by this book.
|
|
|
|
The logos, trademarks and symbols used in this book are the properties
|
|
of their respective owners.
|
|
|
|
\subsection{What do you need?}\label{introux5f08}
|
|
|
|
List requirements: materials, knowledge.
|
|
|
|
\subsection{Conventions used in this document}\label{introux5f09}
|
|
|
|
The following typographic and usage conventions occur in this text:
|
|
|
|
\begin{longtable}[c]{@{}ll@{}}
|
|
\caption{Typographic and usage conventions}\tabularnewline
|
|
\toprule
|
|
Text type & Meaning\tabularnewline
|
|
\midrule
|
|
\endfirsthead
|
|
\toprule
|
|
Text type & Meaning\tabularnewline
|
|
\midrule
|
|
\endhead
|
|
``Quoted text'' & Quotes from people, quoted computer
|
|
output.\tabularnewline
|
|
\begin{verbatim}
|
|
terminal view
|
|
\end{verbatim}
|
|
& Literal computer input and output captured from the terminal, usually
|
|
rendered with a light grey background.\tabularnewline
|
|
\texttt{command} & Name of a command that can be entered on the command
|
|
line.\tabularnewline
|
|
\texttt{VARIABLE} & Name of a variable or pointer to content of a
|
|
variable, as in \texttt{\$VARNAME}.\tabularnewline
|
|
\texttt{option} & Option to a command, as in ``the \texttt{-a} option to
|
|
the \texttt{ls} command''.\tabularnewline
|
|
\texttt{argument} & Argument to a command, as in ``read
|
|
\texttt{man\ ls}''.\tabularnewline
|
|
\texttt{command\ options\
|
|
arguments} & Command synopsis or general usage, on a separated
|
|
line.\tabularnewline
|
|
\texttt{filename} & Name of a file or directory, for example ``Change to
|
|
the \texttt{/usr/bin} directory.''\tabularnewline
|
|
Key & Keys to hit on the keyboard, such as ``type Q to
|
|
quit''.\tabularnewline
|
|
Button & Graphical button to click, like the OK button.\tabularnewline
|
|
{Menu \textgreater{} Choice} & Choice to select from a graphical menu,
|
|
for instance: ``Select {Help \textgreater{} About Mozilla} in your
|
|
browser.''\tabularnewline
|
|
\emph{Terminology} & Important term or concept: ``The Linux
|
|
\emph{kernel} is the heart of the system.''\tabularnewline
|
|
See ? & link to related subject within this guide.\tabularnewline
|
|
\href{http://tille.soti.org}{The author} & Clickable link to an external
|
|
web resource.\tabularnewline
|
|
\bottomrule
|
|
\end{longtable}
|
|
|
|
\subsection{Organization of this document}\label{introux5f10}
|
|
|
|
List chapters (and optionally, appendices) with a short content for each
|
|
(only for longer docs).
|
|
|
|
\begin{itemize}
|
|
\item
|
|
?: short description.
|
|
\item
|
|
?: short description.
|
|
\item
|
|
?: short description.
|
|
\item
|
|
?: short description.
|
|
\item
|
|
?: short description.
|
|
\end{itemize}
|
|
|
|
CHAP1 CHAP2 APP1 GLOSS
|