File: //usr/share/doc/iptraf-ng/Documentation/x171.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Command-line Options</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="Getting Started"
HREF="c66.html"><LINK
REL="PREVIOUS"
TITLE="Starting and Stopping IPTraf-ng"
HREF="x144.html"><LINK
REL="NEXT"
TITLE="Using the Menus"
HREF="x262.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="x144.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 1. Getting Started</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="x262.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="CMDLINE"
>1.4. Command-line Options</A
></H1
><P
> IPTraf-ng has a few optional command-line parameters. As with most UNIX
commands, IPTraf-ng command-line parameters are
case-sensitive (<SAMP
CLASS="COMPUTEROUTPUT"
>-l</SAMP
>
is NOT the same as <SAMP
CLASS="COMPUTEROUTPUT"
>-L</SAMP
>).</P
><P
> The following command-line parameters can be supplied
to the <B
CLASS="COMMAND"
>iptraf-ng</B
> command:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>-i <TT
CLASS="REPLACEABLE"
><I
>iface</I
></TT
></SAMP
></DT
><DD
><P
> causes the IP traffic monitor to start immediately on the specified interface.
If -i all is specified, all interfaces are monitored.</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>-g</SAMP
></DT
><DD
><P
> starts the general interface statistics</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>-d <TT
CLASS="REPLACEABLE"
><I
>iface</I
></TT
></SAMP
></DT
><DD
><P
> shows detailed statistics for the specified interface</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>-s <TT
CLASS="REPLACEABLE"
><I
>iface</I
></TT
></SAMP
></DT
><DD
><P
> starts the TCP/UDP traffic monitor for the specified interface</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>-z <TT
CLASS="REPLACEABLE"
><I
>iface</I
></TT
></SAMP
></DT
><DD
><P
> starts the packet size breakdown for the specified interface</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>-l <TT
CLASS="REPLACEABLE"
><I
>iface</I
></TT
></SAMP
></DT
><DD
><P
> starts the LAN station monitor on the specified interface. If
<SAMP
CLASS="COMPUTEROUTPUT"
>-l all</SAMP
> is specified, all LAN interfaces are monitored.</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>-t <TT
CLASS="REPLACEABLE"
><I
>timeout</I
></TT
></SAMP
></DT
><DD
><P
> The <SAMP
CLASS="COMPUTEROUTPUT"
>-t</SAMP
> parameter, when used with one
of the other parameters that specify a facility to start, tells
IPTraf-ng to run the indicated facility for only timeout
minutes, after which the facility
exits. The <SAMP
CLASS="COMPUTEROUTPUT"
>-t</SAMP
> parameter is ignored in menu
mode.</P
><P
> If this parameter is not specified, the facility runs until the
exit keystroke is pressed.</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>-B</SAMP
></DT
><DD
><P
> Redirects all terminal output to the "bit bucket"
<TT
CLASS="FILENAME"
>/dev/null</TT
>, closes standard input, and
places the program in the background. This parameter can be used only with
one of the <SAMP
CLASS="COMPUTEROUTPUT"
>-i</SAMP
>, <SAMP
CLASS="COMPUTEROUTPUT"
>-g</SAMP
>,
<SAMP
CLASS="COMPUTEROUTPUT"
>-d</SAMP
>,
<SAMP
CLASS="COMPUTEROUTPUT"
>-s</SAMP
>, <SAMP
CLASS="COMPUTEROUTPUT"
>-z</SAMP
>, or
<SAMP
CLASS="COMPUTEROUTPUT"
>-l</SAMP
> parameters. See
<A
HREF="c1957.html"
>Background Operation</A
> in Chapter 9. <SAMP
CLASS="COMPUTEROUTPUT"
>-B</SAMP
> is ignored in menu
mode.</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>-L <TT
CLASS="REPLACEABLE"
><I
>filename</I
></TT
></SAMP
></DT
><DD
><P
> Allows you to specify an alternate log file name when the
any facility is directly started from the command line, whether in foreground or
background mode. If specified in foreground mode, the log filename prompt is
bypassed, even when logging is turned on in the <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Configure...</I
></SPAN
>
menu. If this parameter is omitted in background mode, the default log filename
is used.</P
><P
> This parameter always turns on logging.</P
><P
> If an absolute path is not specified, the log
file will be created in the default log file directory</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>-f</SAMP
></DT
><DD
><P
> Forces IPTraf-ng to clear all lock files and reset all instance counters
to zero before running any facilities. IPTraf-ng will then think
it's the first instance of itself.</P
><P
> The <SAMP
CLASS="COMPUTEROUTPUT"
>-f</SAMP
> parameter overrides the
existing locks and counters imposed by the IPTraf-ng process and
by the various facilities, causing this instance to think it is the
first and that there are no other facilities running. Use
this parameter with great caution. A common use for this parameter is
to recover from abrupt or abnormal terminations which may leave stale
locks and counters still lying around.</P
><P
> The <SAMP
CLASS="COMPUTEROUTPUT"
>-f</SAMP
> parameter may be used together with the others.</P
></DD
><DT
><SAMP
CLASS="COMPUTEROUTPUT"
>-h</SAMP
></DT
><DD
><P
> displays a short help screen</P
></DD
></DL
></DIV
><P
> While the command-line options are case-sensitive, interactive keystroke
at the IPTraf-ng full-screen interface are not.</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="x144.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="x262.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Starting and Stopping IPTraf-ng</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="c66.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Using the Menus</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>