Here is the conventions doc, as is.  This will have a major re-write
later, but I don't think you should worry about it too much..

BTW: these were both unbuffered ascii downloads, so if there are
errors, please fix them and ignore them....

michaelkjohnson

--------8<--------
% For \documentstyle, use the linuxdoc option.  If you will be
% printing a book, use the book style, and if you will be printing a
% 3-ring binder, use the report style.  All other options will
% automagically be set.
%
% Style options:
% linuxdoc is required (not an option :-), and should be the last
%   option specified.
% boxedminipage is strongly encouraged.
% fullpage is strongly discouraged, and illegal when using report style.
% twoside is illegal when using linuxdoc, because linuxdoc uses it to
%  determine which style has been called.  It will do two sided
%  printing for books, and one sided printing for ring-bound.  If you
%  want two sided ring-bound material, use linuxtwo (not yet written)
%
% Note: marginal notes
% Using marginal notes is strongly discouraged, and illegal in report
% mode, so please don't use it.  This is partly to make it easier to
% write a LaTeX->something converter.  (Please, no comments that
% marginal notes are legal in report mode -- they aren't after
% linuxdoc.sty is done with them.  And yes, there is a reason -- read
% linuxdoc.sty if you are wondering.)
%
% Macros that are available in linuxdoc.sty:
%
%       \key{<text>} --- sets <text> in sf font in an \fbox.
%
%       \st --- small typewriter font.
%
%       \blackdiamond --- see below.
%
%       environment screen --- see below, under Typewriter
%
%       environment dispitems ---  displays items more strongly
%       than description.

\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.
% 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 foo would ``stand for'' a filename, such as {\tt /bin/cp}.

\item [{\tt Typewriter}] Used to represent screen interaction, as in
\begin{quote}{\st ls -l /bin/cp\\
-rwxr-xr-x  1 root     wheel      12104 Sep 25 15:53 /bin/cp}\end{quote}
% note that I used \st -- this makes more fit in a screen width,
%  which means that you don't always have to be re-formatting your text
%  in a tricky way.
% I also 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.

Also used for code examples, whether it is ``{\tt 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 \key{Return} to continue.\end{quote}
% note that this is in a san-serif font...

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

% For now, the diamonds will unfortunatly infringe on your text, much
%  like the curvy-road signs in the TeXbook.  When I figure out how to
%  do it right, they will migrate into the right margin, .25 in from
%  your text.

\end{dispitems}