/usr/share/doc/samhain/manual.html/command-line.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>List of command line options</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="The Samhain Host Integrity Monitoring System"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Paths"
HREF="paths.html"><LINK
REL="NEXT"
TITLE="samhain"
HREF="samhain-command-line.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="./docbook.css"></HEAD
><BODY
CLASS="APPENDIX"
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"
>The Samhain Host Integrity Monitoring System</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="paths.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="samhain-command-line.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="APPENDIX"
><H1
><A
NAME="COMMAND-LINE"
></A
>Appendix B. List of command line options</H1
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="COMMAND-LINE-GENERAL"
>B.1. General</A
></H1
><P
><P
></P
><OL
TYPE="1"
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-D,        --daemon</I
></SPAN
>                     
       Run as daemon. </P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>--foreground</I
></SPAN
>                     
       Stay in the foreground, do not run as daemon. </P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-f,        --forever</I
></SPAN
>                     
       Loop forever, even if not daemon. </P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>--bind-address=&lt;IP-Address&gt;</I
></SPAN
>
       Use this IP address (i.e. interface) for outgoing connections 
       (e.g. on multi-interface machines).</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>--server-port=&lt;port number&gt;</I
></SPAN
>
       Connect to this port on the server (client-side option for 
       client-server connection).</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-s &lt;arg&gt;,  --set-syslog-severity=&lt;arg&gt;</I
></SPAN
>  
       Set the severity threshold for syslog.
       <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> may be one 
       of <B
CLASS="COMMAND"
>none, debug, info, notice, warn, mark,
       err, crit, alert</B
>.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-l &lt;arg&gt;,  --set-log-severity=&lt;arg&gt;</I
></SPAN
> 
       Set the severity threshold for logfile.
       <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> 
       may be one of <B
CLASS="COMMAND"
>none, debug, info, notice, warn, mark,
       err, crit, alert</B
>.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-m &lt;arg&gt;,  --set-mail-severity=&lt;arg&gt;</I
></SPAN
> 
       Set the severity threshold  for e-mail.
       <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> 
       may be one of <B
CLASS="COMMAND"
>none, debug, info, notice, warn, mark,
       err, crit, alert</B
>.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>--set-database-severity=&lt;arg&gt;</I
></SPAN
> 
       Set the severity threshold  for logging to a RDBMS.
       <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> 
       may be one of <B
CLASS="COMMAND"
>none, debug, info, notice, warn, mark,
       err, crit, alert</B
>.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>--set-prelude-severity=&lt;arg&gt;</I
></SPAN
> 
       Set the severity threshold  for logging to the Prelude IDS system.
       <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> 
       may be one of <B
CLASS="COMMAND"
>none, debug, info, notice, warn, mark,
       err, crit, alert</B
>.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-p &lt;arg&gt;,  --set-print-severity=&lt;arg&gt;</I
></SPAN
>  
       Set the severity threshold for terminal/console. 
       <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> may be one of 
       <B
CLASS="COMMAND"
>none, debug, info, notice, warn, mark,
       err, crit, alert</B
>.  </P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-x &lt;arg&gt;,  --set-extern-severity=&lt;arg&gt;</I
></SPAN
>  
       Set the severity threshold for external program(s). 
       <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> 
       may be one of <B
CLASS="COMMAND"
>none, debug, info, notice, warn, mark,
       err, crit, alert</B
>.  </P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-L &lt;arg&gt;,  --verify-log=&lt;arg&gt;</I
></SPAN
> 
       Verify the integrity of the log file and print the entries
       (<SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> is the path of the log file).</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-j, --just-list</I
></SPAN
>
              Modify -L to just list  the  logfile,  rather  than  verify  (to
              de-obfuscate  the  logfile if you have compiled for
              stealth mode). <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Order matters:</I
></SPAN
> this 
	      must come before -L. </P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-M &lt;arg&gt;,  --verify-mail=&lt;arg&gt;</I
></SPAN
> 
       Verify the integrity of e-mailed messages 
       (<SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> is the path of the mail box).</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-V &lt;arg&gt;,  --add-key=&lt;arg&gt;</I
></SPAN
>
       Add key material to the compiled-in key (see <A
HREF="keypad.html"
>Section 11.2</A
>&#62;).
       <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> must be of the form 
       <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>key@/path/to/executable</I
></SPAN
>. Output
       will be written to <TT
CLASS="FILENAME"
>/path/to/executable.out</TT
>.

  </P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-H &lt;arg&gt;,  --hash-string=&lt;arg&gt;</I
></SPAN
> 
       Print the hash of a string / the checksum of a file, and exit. If
       <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> 
       starts with a '/', it is assumed to be a file, otherwise a
       string. This function is useful to test the hash algorithm.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-z &lt;arg&gt;,        --tracelevel=&lt;arg&gt;</I
></SPAN
> 
       If compiled with --enable-debug: arg &gt; 0 to switch on debug output.
       If compiled with --enable-trace: arg &gt; 0 max. level for call tracing.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-i &lt;arg&gt;,        --milestone=&lt;arg&gt;</I
></SPAN
> 
       If compiled with --enable-trace: trace from milestone arg to arg+1. If
	arg = -1, trace all.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-d &lt;arg&gt;,        --list-database=&lt;arg&gt;</I
></SPAN
> 
       List the database file <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> (use 
       ``default'' for the compiled-in
       path).</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>--list-file=&lt;path&gt;</I
></SPAN
> 
       Modify -d to list the literal content of a file, if this
       has been stored.
       <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Order matters:</I
></SPAN
> this must come before -d.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-a,        --full-detail</I
></SPAN
> 
       Modify -d to list full details (numeric mode, owner, group, 
       all three timestamps (ctime, mtime, atime), and the checksum.
       <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Order matters:</I
></SPAN
> this must come before -d.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>        --delimited</I
></SPAN
> 
       Same as --full-detail, but with <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>comma-delimited</I
></SPAN
>
       fields.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-c,        --copyright</I
></SPAN
> 
       Print copyright information and exit.  </P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-v,        --version</I
></SPAN
> 
       Show version information and compiled-in options.  </P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>-h,        --help</I
></SPAN
>
       Print a short help on command line options and exit.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>--trace-enable</I
></SPAN
>
       Print a trace of the execution flow.</P
></LI
><LI
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>--trace-logfile=&lt;arg&gt;</I
></SPAN
>
       Use file <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arg</I
></SPAN
> to log the trace.</P
></LI
></OL
></P
></DIV
></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="paths.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="samhain-command-line.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Paths</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><SPAN
CLASS="APPLICATION"
>samhain</SPAN
></TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
samhain 2.8.3a-1 / usr / share / doc / samhain / manual.html / command-line.html
