% Linux Installation and Getting Started    -*- TeX -*-
% Documentation conventions (convntns.tex)
% Copyright 1992, 1993 Michael K. Johnson, to be distributed freely.
% Use as directed ;-)

\section*{Documentation Conventions}
\addcontentsline{toc}{section}{Documentation Conventions}

These conventions should be obvious, but we'll include them here for
the pedantic.

\begin{dispitems}
\ditem {{\bf Bold}} Used to mark {\bf new concepts}, {\bf WARNINGS},
and {\bf keywords} in a language.

\ditem {{\em italics}} Used for {\em emphasis} in text, and
occasionally for quotes or introductions at the beginning of a section.
Also used to indicate commands for the user to type when showing
screen interaction (see below).

\ditem {\cparam{slanted}} Used to mark {\bf meta-variables} in the text,
especially in representations of the command line.  For example,
\begin{quote}{\tt ls -l} \cparam{foo}\end{quote}
where \cparam{foo} would ``stand for'' a filename, such as {\tt /bin/cp}.

\ditem {{\tt Typewriter}} Used to represent screen interaction, as in
\begin{tscreen}
\$ {\em ls --l /bin/cp} \\
\verb!-rwxr-xr-x  1 root    wheel    12104 Sep 25 15:53 /bin/cp !
\end{tscreen}

Also used for code examples, whether it is C code, a shell script,
or something else, and to display general files, such as configuration
files.  When necessary for clarity's sake, these examples or figures
will be enclosed in thin boxes.

\ditem {\key{Key}} Represents a key to press.  You will often see it
in this form:
\begin{quote}Press \ret\ to continue.\end{quote}
% note that this is in a san-serif font...

\ditem {\hfill$\Diamond$} A diamond in the margin, like a
black diamond on a ski hill, marks ``danger'' or ``caution.''  Read
paragraphs marked this way carefully.

\end{dispitems}
