Command Line Parameters and File:MailAV Scan Option.jpg: Difference between pages

From eScan Wiki
(Difference between pages)
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
Line 1: Line 1:
{| class="wikitable" border="0"
|-
{| id="mp-topbanner" style="width:100%; background:#fcfcfc; margin-top:1.2em; border:1px solid #ccc;"
|style="text-align:left;"|'''Languages :'''&nbsp;&nbsp;'''·''' [[EPC|<font size=1.5 color="blue">English</font>]]&nbsp;&nbsp;'''·''' [[Escan/latinspanish/protection|<font size=1.5 color="blue">Español</font>]]&nbsp;&nbsp;'''·''' [[Escan/italian/protection|<font size=1.5 color="blue">Italiano</font>]]&nbsp;&nbsp;'''·''' [[Escan/chinese/EPC|<font size=1.5 color="blue">中文(繁體)</font>]]
|}
<!--
{| class="wikitable" border="0"
|-
{| id="mp-topbanner" style="width:100%; background:#fcfcfc; margin-top:1.2em; border:1px solid #ccc;"
| style="width:56%; color:#000;" |
{| style="width:280px; border:none; background:none;"
| [[Image:mwti_logo.gif|left]]
|}
-->
{| id="mp-topbanner" style="width:100%; background:#fcfcfc; margin-top:1.2em; border:1px solid #ccc;text-align:left;"
|width="1000pt" style="width:18%; font-size:95%;text-align:left;white-space:nowrap;"|
<B>General</B>
* [http://www.mwti.net/<font color="blue">MicroWorld Website</font>]
* [[Main Page|<font color="blue">MicroWorld WIKI</font>]]
* [[Marketing|<font color="blue">Marketing</font>]]
* [[Events|<font color="blue">Events</font>]]
* [[Marketing/Advertisement|<font color="blue">Advertisement</font>]]
|width="1000pt" style="width:18%; font-size:95%;text-align:left;white-space:nowrap;"|
<B>Knowledgebase</B>
* [[Technical Info|<font color="blue">Technical Information</font>]]
* [[Beta Testing|<font color="blue">Beta Testing</font>]]
* [[Release Candidate|<font color="blue">Release Candidate</font>]]
* [[User Guide|<font color="blue">User Guides</font>]]
|width="1000pt" style="width:18%; font-size:95%;text-align:left;white-space:nowrap;"|
<B> Support </B>
* [[EMail|<font color="blue">eMail</font>]]
* [[Online Chat|<font color="blue">Online Chat</font>]]
* [[Telephonic Support|<font color="blue">Telephone</font>]]
* [[Remote Support|<font color="blue">Remote Support</font>]]
* [[Forums|<font color="blue">Forums</font>]]
|}
{| class="wikitable" border="0"
|-
{| id="mp-topbanner" style="width:100%; background:#fcfcfc; margin-top:1.2em; border:1px solid #ccc;"
|style="text-align:left;"|<font size=3>'''Command-Line Parameters for Manual scanning'''</font>
| style="width:10%; color:#000;" |
{| style="width:100px; border:none; background:none;"
| [[Image:EScanLinux.jpg|right]]
|}
|}
<!--__NOTOC__-->


<B>INFO</B><br/>
      To scan a system from the Command-line using the terminal, run the following command <B>escan [OPTIONS]... [OBJECT]...</B>.<br/>      This command will scan and clean directories for viruses and other malwares.<br/>      <br/>      The command-line option is available in eScan for Linux Desktop and eScan for Linux File Servers
<B>SYNOPSIS</B><br/>
      escan [OPTIONS]... [OBJECT]...
       
<B>OPTIONS</B>
  <B><font size=3>Scan Actions</font></B><br/>         
            These option are the action to be taken in case of any infected object found by scanner.<br/>         
      <B><font size=2>-ly, --log-only</font></B>
            Only Report infection found / detected in the scanned log. No action on infected 
            files.<br/>         
      <B><font size=2>-dl, --disinfect-log</font></B>
            Will try to Disinfect, if not possible shall Report infection found / detected in the scanned log.<br/>         
      <B><font size=2>-dd, --disinfect-delete</font></B>
            Will try to Disinfect, if not possible shall delete the infected object.<br/>         
      <B><font size=2>-dq, --disinfect-quarantine</font></B>
            Will try to Disinfect, if not possible shall quarantine (Default) the infected object.<br/>         
      <B><font size=2>-dr, --disinfect-rename</font></B>
            Will try to Disinfect, if not possible shall rename the infected object.<br/>         
      <B><font size=2>-dp, --disinfect-prompt</font></B>
            Will try to Disinfect, if not possible shall prompt for the action to be taken on the infected object.
            Following Actions will be prompted:
                Do Nothing
                Delete
                Quarantine
                Rename
                Cancel Scan<br/>         
      <B><font size=2>-di, --delete-infected</font></B>
            Will Delete the Infected object.<br/>         
      <B><font size=2>-ri, --rename-infected</font></B>
            Will Rename the Infected object.<br/>         
      <B><font size=2>-qi, --quarantine-infected</font></B>
            Will Quarantine the Infected object.<br/>         
      <B><font size=2>-pr, --prompt</font></B>
            Will Prompt for an Action to be taken on the infected object without trying to  disinfect it.<br/>         
      <B><font size=2>-qp, --quarantine-path*</font></B>
            Sets the Quarantine Path for the infected object. It sets action as quarantine.         
            While setting Quarantine Path, make sure that user has write permission to
            directory.<br/>         
      Example
                # escan -qp /var/MicroWorld/var/quarantine/escan<br/>         
      <B><font size=2>-re, --rename-extension*</font></B>
            Renames infected file with this extension. Extension must be alphanumeric string
            starting with alphabet and 1 to 5 characters long. Please do not put dot (’.’)
            before extension value.<br/>         
      Example
                # escan -re mwt<br/>         
      <B>NOTE:</B>Quarantine  path  and  Rename extension Parameters are descarded, if action is set as ’prompt’.<br/>          In that case default qurantine path ’/var/MicroWorld/var/quarantine/escan’ and default rename extension ’.mwt’<br/>          will be used.Also, provide only one of -qp or -re, otherwise both the parameters will be ignored and default values<br/>          will be used.<br/>         
  <B><font size=3>Recursion Options</font></font></B><br/>         
      <B><font size=2>-rr, --recursion</font></B>
            Will Scan files in the Directories and in the Sub-Directories recursively.
            By default this option is enabled.<br/>         
      <B><font size=2>-rr-, --no-recursion</font></B>
            Will scan only the files in the directory of subject to scan without following
            any sub-directory in the path.<br/>         
      <B><font size=2>-lk-, --no-symlink</font></B>
            While scanning the object(s), any symbolic link in the path will be will not be
            followed and will be ignored. By default, all symbolic link scanning is disabled.<br/>         
      <B><font size=2>-lk, --all-symlink</font></B>
            While scanning the object(s), any symbolic link in the path will be resolved and
            will be scanned.<br/>         
      <B><font size=2>-cr-, --no-cross-fs</font></B>
            While resolving the symbolic link in scan path or object, if any object is found
            on other device (physical device or logical file system), the object will be
            ignored and path will not be followed. By default, any cross file system scanning
            is diabled.<br/>         
      <B><font size=2>-cr, --cross-fs</font></B>
            While resolving the symbolic link in scan path or object, if object(s) is/are
            foundon other device, the path will be followed for scanning.<br/>         
  <B><font size=3>Scan Options</font></B><br/>         
      <B><font size=2>-m0, --mem-scan-only</font></B>
            In current scan  session, scan memory for any virus(es).<br/>         
      <B><font size=2>-m, --mem-scan</font></B>
            For every scan, memory will be scanner before performing any other scanning.
            By defualt, memory is set to scan at every scan session startup.<br/>         
      <B><font size=2>-m-, --no-mem-scan</font></B>
            Disbale all memory scan at scan session startup.<br/>         
      <B><font size=2>-au, --auto-update</font></B>
            At every scan session startup, update virus definition database, before scanning.<br/>         
      <B><font size=2>-pk, --pack</font></B>
            Scan packed files on scan path.<br/>         
      <B><font size=2>-pk-, --no-pack</font></B>
            Do not scan any packed files on scan path.<br/>         
      <B><font size=2>-ac, --archives</font></B>
            Scan archived files on scan path.<br/>         
      <B><font size=2>-ac-, --no-archives</font></B>
            Do not scan archived files on scan path.<br/>         
      <B><font size=2>-db, --mails</font></B>
            Scan plain mails & mail database files on scan path.<br/>         
      <B><font size=2>-db-, --no-mail</font></B>
            Do not scan plain mails & mail database files on scan path.<br/>         
      <B><font size=2>-hu, --heuristic</font></B>
            Perform heuristic checks for any suspected pattern of unknown virus(es) in object(s).<br/>         
      <B><font size=2>-hu-, --no-heuristic</font></B>
            Do perform heuristic checks for suspected pattern of unknown virus(es).<br/>         
      <B><font size=2>-sx, --scan-ext</font></B>
            Scan file(s) having defined extension(s).
            Seperate multiple extensions by ’,’.<br/>         
      Example:<br/>         
                To scan files having extensions exe
                      # escan -sx exe /home<br/>         
                To scan files having extensions exe or com
                      # escan -sx exe,com /home<br/>         
      <B><font size=2>-xx, --exclude-ext</font></B>
            Exclude file(s) having defined extension(s) on scan path.
            Seperate multiple extensions by ’,’.<br/>         
      Example:<br/>         
                To exclude files having extension exe type
                      # escan -xx exe /home<br/>         
                To exclude files having extension exe, com type
                      # escan -xx exe, com /home<br/>         
      <B>NOTE:</B> By default, all files with extension ’.mwt’ will be exclude, if not explicitly declared in scan extension list.
      <B><font size=2>-xd, --exclude-dirs</font></B>
            Exclude directory(ies) on scan path.
            Seperate multiple directories by ’,’.<br/>         
      Example:<br/>         
                To exclude the /var directory from scanning
                      # escan -xd /var /<br/>         
                To exclude the /var and /opt directory from scanning
                      # escan -xd /var,/opt /<br/>         
      <B><font size=2>-dh, --max-depth</font></B>
            While performing recursive scanning, it allows scanner to follow the defined
            number of depth only. This option is ignored, if recursive scanning is disabled.<br/>         
      Example:<br/>         
                To scan upto 2 level of depth while scanning /home
                      # escan -dh 2 /home<br/>         
      <B><font size=2>-ms, --max-size</font></B>
            As larger files takes more time to scan, exclude the larger file(s) by providing
            this option. suffix the size parameter with
            ’b’ for byte / ’k’ for kilo-bytes / ’m’ for mega-bytes.
            If no suffix is provides, scanner assumes the size parameter in KB.<br/>         
      Example:<br/>         
                To exclude files larger than 5 MB
                      # escan -mx 5m /home<br/>         
  <B><font size=3>General Options</font></B><br/>         
      <B><font size=2>-v, --version</font></B>
            Display the MicroWorld eScan version inforamtion(s).<br/>         
      <B><font size=2>y0, --display-none</font></B>
            Do not display any output on the terminal while scan is in progress.<br/>         
      <B><font size=2>-ym, --display-minimum</font></B>
            Display Minimum output on terminal. Only initialization alert,
            scan configuration and scan result statistics will be printed.<br/>         
      <B><font size=2>-yi, --display-infected</font></B>
            In addition to above information, all infection and action details
            will be printed to terminal.<br/>         
      <B><font size=2>-y, --display-all</font></B>
            Display eveything on terminal.<br/>         
      <B><font size=2>-l, --log-path</font></B>
            Will set the scan log file path. eScan creates escan directory in
            log directory to differentiate escan log from other logs.<br/>         
      <B><font size=2>-l0, --no-log</font></B>
            Do not log any thing. No log file will be created.<br/>         
      <B><font size=2>-lm, --log-minimum</font></B>
            Log Minimum infomation. Only initialization alert, scan configuration
            and scan result statistics will be printed.<br/>         
      <B><font size=2>-li, --log-infections</font></B>
            In addition to above information, all infection and action details
            will be printed in log file.<br/>         
      <B><font size=2>-la, --log-all</font></B>
            Log everything.<br/>         
      <B><font size=2>-ss, --save-settings</font></B>
            Save the provided scan setting as default settings before scanning.<br/>         
      <B><font size=2>-so, --save-only</font></B>
            Save the provided scan setting as default settings and exit without
            scanning.<br/>         
      <B><font size=2>-G, --restore-global</font></B>
            This option is available to non-root user’s only. All user (except root)
            has their own default settings configuration saved. This option reset
            the user’s default settings with the Global settings (root’s settings).<br/>         
      <B><font size=2>-ui, --av-info</font></B>
            Display the AV engine version, last virus signature update date and
            virus signature count and exit.<br/>         
 
  <B><font size=3>Update Options (for root only)</font></B><br/>         
            These options are available to root user only.<br/>         
      <B><font size=2>-u, --update</font></B>
            Start downloading the latest virus definitions.<br/>         
      <B><font size=2>-x, --use-proxy</font></B>
            Use Proxy for downloading the updates from internet.<br/>         
      <B><font size=2>-x-, --no-proxy</font></B>
            Do not use the Proxy for downloading the updates from internet.<br/>         
      <B><font size=2>-xi, --proxy-ip</font></B>
            IP Address of the Proxy Server.<br/>         
      <B><font size=2>-xt, --proxy-port</font></B>
            Port of the Proxy Server<br/>         
      Example:<br/>         
            To download the Virus defination using the proxy setting
                # escan -u -xi 192.168.0.25 -xt 8080<br/>         
      <B><font size=2>-xa, --use-proxy-auth</font></B>
            Use the Proxy authentication for downloading the virus definition.<br/>         
      <B><font size=2>-xa-, --no-proxy-auth</font></B>
            Do not use Proxy authentication for downloading the virus definition.<br/>         
      <B><font size=2>-xu, --proxy-user</font></B>
            Proxy authentication user name.<br/>         
      <B><font size=2>-pw, --proxy-passwd</font></B>
            Proxy authentication password.<br/>         
      <B><font size=2>-ul, --server-list</font></B>
            Use update server(s) instead of default update server (not recommended).
            Separate multi servers by comma.<br/>         
      <B><font size=2>-xs, --use-https</font></B>
            Use the secure http to download updates.<br/>         
      <B><font size=2>-xs-, --use-http</font></B>
            Do not use secure http to download updates.<br/>         
      <B><font size=2>-to, --time-out</font></B>
            Set the connection time out (in seconds) for downloading updates.<br/>         
      <B><font size=2>-rc, --retries</font></B>
            Set the retry count in case of connection failure for downloading.
            These options are available to root user only.<br/>         
  <B><font size=3>Schedule Options (for root only)</font></B><br/>         
      <B><font size=2>-sc, --save-schedule</font></B>
            Save the  Scheduled Job for scanning. This option requires a parameter
            as UNIQUE job name. Job name must be alphanumeric starting with an alphabet and
            1 to 10 characters long.<br/>         
      <B><font size=2>-min, --minute</font></B>
            Schedule job minutes of hour [0-59].<br/>         
      <B><font size=2>-hr, --hour</font></B>
            Schedule job hour of day [0-23].<br/>         
      <B><font size=2>-day, --month-day</font></B>
            Schedule job day of month [1-(28/29/30/31)].<br/>         
      <B><font size=2>-wd, --week-day</font></B>
            Schedule job day of week [0-6] (0 Sun/1 Mon/.../6 Sat).<br/>         
      <B><font size=2>-mon, --month</font></B>
            Schedule job month of yesk [1-12].<br/>         
      <B><font size=2>-fq, --frequency</font></B>
            Schedule job frequency.<br/>         
                0    once
                1    hourly
                2    daily
                3    monthly
                4    weekly<br/>         
      <B><font size=2>-ds, --del-schedule</font></B>
            Delete save scheduled job. This option requires a parameter
            as existing job name.<br/>         
      Example:<br/>         
                #  escan -ds <job name><br/>         
      <B><font size=2>-do, --delete-old</font></B>
            Purge all expired/outdated schdules.<br/>         
           
      <B>Note:</B><br/>         
            All schedules accepts scan and action parameters (except memory scan options),
            that will be saved for new job. By default, schedules are saved with the default
            scan options<br/>         
      <B>Schedule examples:</B><br/>         
            To schedule a scanning to run only ONCE on the current date at paritcular time:
                # escan -sc job1 -fq 0 -hr 15 -min 30 /home         
            Above command saves schedule with name job1, that will start scan at
            15:30 on current day.<br/>         
            To schedule a scanning to run only ONCE  on specified date at particular time:
                # escan -sc job2 -fq 0 -day 1 -mon 10 -hr 15 -min 30 /home         
            Above command saves schedule with name job2, that will start scan at
            15:30 on 1st of octobor.<br/>         
            To schedule a scanning to run at every HOUR:
                # escan -sc job3 -fq 1 -min 59 /home
            Above command saves schedule with name job3, that will start scan at
            59th minute of every hour.<br/>         
            To schedule a scanning to run Daily at a particular:
                # escan -sc job4 -fq 2 -hr 15 -min 40 /home
            Above command saves schedule with name job4, that will start scan at
            2:15 every day.<br/>         
            To schedule a scanning to run every MONTH:
                # escan -sc job5 -fq 3 -day 1 -hr 15 -min 30 /home
            Above command saves schedule with name job5, that will start scan at
            15:30 on 1st of every month.<br/>         
            To schedule a scanning to run every WEEK:
                # escan -sc job6 -fq 4 -wd 3 -hr 15 -min 30 /home
            Above command saves schedule with name job5, that will start scan at
            15:30 on every Wednesday.<br/>         
  <B><font size=3>Help Options</font></B><br/>         
            <B><font size=2>-h,--help</font></B><br/>         
              Print this help message and Exit<br/>

Latest revision as of 06:59, 2 August 2010