/usr/share/doc/iptraf-ng-1.1.4/Documentation/ Current File: //usr/share/doc/iptraf-ng-1.1.4/Documentation/conventions.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML
><HEAD
><TITLE
>Document Conventions</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.64
"><LINK
REL="HOME"
TITLE="IPTraf User's Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="About This Document"
HREF="preface.html"><LINK
REL="PREVIOUS"
TITLE="About This Document"
HREF="preface.html"><LINK
REL="NEXT"
TITLE="Getting Started"
HREF="gettingstarted.html"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>IPTraf User's Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="preface.html"
>&#60;&#60;&#60; Previous</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>About This Document</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="gettingstarted.html"
>Next &#62;&#62;&#62;</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="CONVENTIONS"
>Document Conventions</A
></H1
><P
>  The following symbols and typefaces are used throughout this manual:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="COMPUTEROUTPUT"
>[ ]</TT
></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
><TT
CLASS="COMPUTEROUTPUT"
>{ }</TT
></DT
><DD
><P
>     curly braces enclose items you choose from</P
></DD
><DT
><TT
CLASS="COMPUTEROUTPUT"
>|</TT
></DT
><DD
><P
>     the vertical bar separates choices in curly braces</P
></DD
><DT
><TT
CLASS="COMPUTEROUTPUT"
>normal monospace</TT
></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
><TT
CLASS="COMPUTEROUTPUT"
><TT
CLASS="REPLACEABLE"
><I
>  monospace italics</I
></TT
></TT
></DT
><DD
><P
>&#13;     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 <TT
CLASS="COMPUTEROUTPUT"
>eth0</TT
>).&#13;</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
><I
CLASS="EMPHASIS"
>Notes</I
> are additional pieces of information that may be useful or may
  clarify the preceeding paragraphs of the manual.</P
><P
>  <I
CLASS="EMPHASIS"
>Tips</I
> provide shortcuts, clarify tasks that may not
  be immediately obvious, or provide references to additional sources of information.</P
><P
><I
CLASS="EMPHASIS"
>Technical notes</I
> 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
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="preface.html"
>&#60;&#60;&#60; Previous</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="gettingstarted.html"
>Next &#62;&#62;&#62;</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>About This Document</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="preface.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Getting Started</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>