71 lines
3.7 KiB
HTML
71 lines
3.7 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3O//DTD W3 HTML 2.0//EN">
|
|
<!Converted with LaTeX2HTML 95.1 (Fri Jan 20 1995) by Nikos Drakos (nikos@cbl.leeds.ac.uk), CBLU, University of Leeds >
|
|
<HEAD>
|
|
<TITLE> Documentation Conventions</TITLE>
|
|
</HEAD>
|
|
<BODY>
|
|
<meta name="description" value=" Documentation Conventions">
|
|
<meta name="keywords" value="gs">
|
|
<meta name="resource-type" value="document">
|
|
<meta name="distribution" value="global">
|
|
<P>
|
|
<BR> <HR><A NAME=tex2html1701 HREF="node8.html"><IMG ALIGN=BOTTOM ALT="next" SRC="next_motif.gif"></A> <A NAME=tex2html1699 HREF="node2.html"><IMG ALIGN=BOTTOM ALT="up" SRC="up_motif.gif"></A> <A NAME=tex2html1695 HREF="node6.html"><IMG ALIGN=BOTTOM ALT="previous" SRC="previous_motif.gif"></A> <A NAME=tex2html1703 HREF="node1.html"><IMG ALIGN=BOTTOM ALT="contents" SRC="contents_motif.gif"></A> <A NAME=tex2html1704 HREF="node250.html"><IMG ALIGN=BOTTOM ALT="index" SRC="index_motif.gif"></A> <BR>
|
|
<B> Next:</B> <A NAME=tex2html1702 HREF="node8.html">1 Introduction to Linux</A>
|
|
<B>Up:</B> <A NAME=tex2html1700 HREF="node2.html"> Preface</A>
|
|
<B> Previous:</B> <A NAME=tex2html1696 HREF="node6.html"> Credits and Legalese</A>
|
|
<BR> <HR> <P>
|
|
<H1><A NAME=SECTION00250000000000000000> Documentation Conventions</A></H1>
|
|
<P>
|
|
These conventions should be obvious, but we'll include them here for
|
|
the pedantic.
|
|
<P>
|
|
<DL COMPACT><DT><b>Bold</b>
|
|
<DD> Used to mark <b>new concepts</b>, <b>WARNINGS</b>,
|
|
and <b>keywords</b> in a language.
|
|
<P>
|
|
<DT><em>italics</em>
|
|
<DD> Used for <em>emphasis</em> 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).
|
|
<P>
|
|
<DT><IMG BORDER=0 ALIGN=BOTTOM ALT="" SRC="img4.gif">
|
|
<DD> Used to mark <b>meta-variables</b> in the text,
|
|
especially in representations of the command line. For example,
|
|
<blockquote> <tt>ls -l</tt> <IMG BORDER=0 ALIGN=BOTTOM ALT="" SRC="img5.gif"></blockquote>
|
|
where <IMG BORDER=0 ALIGN=BOTTOM ALT="" SRC="img6.gif"> would ``stand for'' a filename, such as <tt>/bin/cp</tt>.
|
|
<P>
|
|
<DT><tt>Typewriter</tt>
|
|
<DD> Used to represent screen interaction, as in
|
|
<P><TT> $ <em>ls --l /bin/cp</em> <BR>
|
|
<code>-rwxr-xr-x 1 root wheel 12104 Sep 25 15:53 /bin/cp </code>
|
|
<P></TT>
|
|
<P>
|
|
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.
|
|
<P>
|
|
<DT><IMG BORDER=0 ALIGN=BOTTOM ALT="" SRC="img7.gif">
|
|
<DD> Represents a key to press. You will often see it
|
|
in this form:
|
|
<blockquote> Press <IMG BORDER=0 ALIGN=BOTTOM ALT="" SRC="img8.gif"> to continue.</blockquote>
|
|
|
|
<P>
|
|
<DT><IMG BORDER=0 ALIGN=BOTTOM ALT="" SRC="bdt.gif">
|
|
<DD> A diamond in the margin, like a
|
|
black diamond on a ski hill, marks ``danger'' or ``caution.'' Read
|
|
paragraphs marked this way carefully.
|
|
<P>
|
|
</DL><BR> <HR><A NAME=tex2html1701 HREF="node8.html"><IMG ALIGN=BOTTOM ALT="next" SRC="next_motif.gif"></A> <A NAME=tex2html1699 HREF="node2.html"><IMG ALIGN=BOTTOM ALT="up" SRC="up_motif.gif"></A> <A NAME=tex2html1695 HREF="node6.html"><IMG ALIGN=BOTTOM ALT="previous" SRC="previous_motif.gif"></A> <A NAME=tex2html1703 HREF="node1.html"><IMG ALIGN=BOTTOM ALT="contents" SRC="contents_motif.gif"></A> <A NAME=tex2html1704 HREF="node250.html"><IMG ALIGN=BOTTOM ALT="index" SRC="index_motif.gif"></A> <BR>
|
|
<B> Next:</B> <A NAME=tex2html1702 HREF="node8.html">1 Introduction to Linux</A>
|
|
<B>Up:</B> <A NAME=tex2html1700 HREF="node2.html"> Preface</A>
|
|
<B> Previous:</B> <A NAME=tex2html1696 HREF="node6.html"> Credits and Legalese</A>
|
|
<BR> <HR> <P>
|
|
<BR> <HR>
|
|
<P><ADDRESS>
|
|
<I>Matt Welsh <BR>
|
|
mdw@sunsite.unc.edu</I>
|
|
</ADDRESS>
|
|
</BODY>
|