% convntns.tex
% Copyright 1992, 1993 Michael K. Johnson, to be distributed freely.
% Use as directed ;-)
%
% For \documentstyle, use the linuxdoc option.  If you want one-sided
% printing, choose report, and if you want two-sided printer, choose
% book.
%
% Style options:
% linuxdoc is required (not an option :-), and should be the last
%   option specified.
% boxedminipage is encouraged.
% fullpage is illegal
% twoside is illegal.
%
% Note: marginal notes
% Using marginal notes is illegal.
%
% Read linuxdoc.sty for an explanation of what macros are made
%  available there.  Really, do read it.  I made an effort to comment
%  it well.

\section{Typographical Conventions}

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

\item [{\em italics}] Used for {\em emphasis} in text, and
occasionally for quotes or introductions at the beginning of a section.
% Italics should be used sparingly, and in general, putting entire
% sentences in italics makes them difficult to read.  Use /bf if it is
% absolutely necessary to emphasize a whole sentence or paragraph.
% Think twice before doing this.

\item [{\sl slanted}] Used to mark {\bf meta-variables} in the text,
especially in representations of the command line.  For example,
\begin{quote}{\tt ls -l} {\sl foo}\end{quote}
where {\sl foo} would ``stand for'' a filename, such as {\tt /bin/cp}.
Sometimes, this might be difficult to see, and so the text is put in
angle brackets, like this: \cparam{slanted}.

\item [{\tt Typewriter}] Used to represent screen interaction, as in
\begin{screen}\begin{verbatim}ls -l /bin/cp
-rwxr-xr-x  1 root    wheel    12104 Sep 25 15:53 /bin/cp
\end{verbatim}\end{screen}
% I have provided a ``screen'' environment.  This sets things up
%  as \small\begin{quote} at the beginning and \end{quote}\normalsize
%  at the end.  It is useful for keeping your screens looking the
%  same.  You have the choice, depending on the circumstances, to use
%  \tt as your font, or to use a verbatim environment, or some
%  combination of the two, to typeset your screen.
% An \st font is also available, and is \small\tt.  I generally use
%  verbatim in these situations instead.

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.
% The verbatim environment can be used for this.  Also, note that verb*
% and verbatim* show spaces as little cup characters.

\item [\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...

\item [\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.

% In normal text, you will use this like this:
%  \blackdiamond This is the beginning of a paragraph that you want
%  flagged by a diamond.
% This will come out like this:
%   D     This is the beginning of a
%      paragraph that you want flag-
%      ged by a diamond.
% Or like this, if the paragraph is not indented:
%   D  This is  the  beginning  of a
%      paragraph that you want flag-
%      ged by a diamond.
% where ``D'' represents a diamond-shaped character.  Notice the
% alignment...

\end{dispitems}
