File: //usr/share/doc/iptraf-ng/Documentation/x27.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Document Conventions</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="IPTraf-ng User's Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="About This Document"
HREF="f21.html"><LINK
REL="PREVIOUS"
TITLE="About This Document"
HREF="f21.html"><LINK
REL="NEXT"
TITLE="Getting Started"
HREF="c66.html"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>IPTraf-ng User's Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="f21.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>About This Document</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="c66.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="CONVENTIONS"
>2. Document Conventions</A
></H1
><P
> The following symbols and typefaces are used throughout this manual:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>[ ]</SAMP
></DT
><DD
><P
>items in brackets are optional. Brackets also denote items that may or may
not be displayed onscreen depending on settings or conditions.</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>{ }</SAMP
></DT
><DD
><P
> curly braces enclose items you choose from</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>|</SAMP
></DT
><DD
><P
> the vertical bar separates choices in curly braces</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>normal monospace</SAMP
></DT
><DD
><P
> normal monospace text in syntax specifications should be typed in exactly as presented. Because UNIX and variants are case-sensitive, case must be preserved. Monospace is also used in presenting items that appear on the screen.</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
><TT
CLASS="REPLACEABLE"
><I
> monospace italics</I
></TT
></SAMP
></DT
><DD
><P
> italics in syntax specifications indicate items that are to be
replaced with an actual item (e.g.
<TT
CLASS="REPLACEABLE"
><I
>interface</I
></TT
> should be replaced with an
actual interface name, like <SAMP
CLASS="COMPUTEROUTPUT"
>eth0</SAMP
>). </P
></DD
></DL
></DIV
><P
>Additional information appears distinctively set apart from the main text.
This information includes Notes, Tips, or Technical Notes.</P
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Notes</I
></SPAN
> are additional pieces of information that may be useful or may
clarify the preceeding paragraphs of the manual.</P
><P
> <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Tips</I
></SPAN
> provide shortcuts, clarify tasks that may not
be immediately obvious, or provide references to additional sources of information.</P
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Technical notes</I
></SPAN
> are explanations of a
more technical nature and may be of more use to programmers and advanced
users.</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="f21.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="c66.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>About This Document</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="f21.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Getting Started</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>