Command-Line Arguments

To run the scanning engine Dr.Web Scanning Engine from the command line, type the following command:

Option	Description
--help	Function: Instructs to output short help information about command-line parameters to the console or to the terminal emulator and to exit upon completion. Short form: -h Arguments: None.
--version	Function: Instructs to output information about the version of this component to the console or to the terminal emulator and to exit after completion. Short form: -v Arguments: None.
Additional launch parameters (they are the same as configuration file parameters and substitute them when required):
--Socket	Function: Specify a socket used by Dr.Web Scanning Engine. Short form: No. Arguments:<socket>—socket address. It can be specified as a file path (UNIX socket) or as a network socket—the<IP address>:<port> pair. If you need to use a network interface by default, type the asterisk character '' instead of IP address. Examples: --Socket /var/opt/drweb.com/ipc/.se --Socket 127.0.0.1:1000 --Socket :1000
--EnginePath	Fucntion: Specify a path to the library of Dr.Web Virus-Finding Engine anti-virus engine. Short form: No. Arguments: <path to the file>—a full path to the library that you want to use.
--VirusBaseDir	Function: Specify a path to the directory with virus database files. Short form: No. Arguments: <path to the catalog>—path to the virus database directory.
--TempDir	Function: Specify a path to the directory with temporary files. Short form: No. Arguments: <path to the catalog>—full path to the directory with temporary files.
--Key	Function: Specify a path to the key file. Short form: No. Arguments: <path to the file>—a full path to the key file that you want to use.
--MaxForks	Function: Determine the maximum allowed number of child processes which can be started by Dr.Web Scanning Engine during scanning. Short form: No. Arguments: <number>—the maximum allowed number of child processes.
--MaxForksPerFile	Function: Determine the maximum allowed number of child processes which can be used by Dr.Web Scanning Engine during scanning one compound file (an archive, a container, etc.). Short form: No. Arguments: <number>—the maximum allowed number of child processes. Cannot be less than 1 and greater than the MaxForks parameter value.
--WatchdogInterval	Description: Determine frequency with which Dr.Web Scanning Engine checks whether child processes are operable and stops those processes that stopped responding. Short form: No. Arguments: <time interval>—frequency of checking child processes.
--Shelltrace	Function: turn on the shell tracing (log detailed information on file scanning performed by Dr.Web Virus-Finding Engine). Short form: No. Arguments: None.
--LogLevel	Description: Set the level of logging executed by Dr.Web Scanning Engine during the operation. Short form: No. Arguments: <logging level>. Allowed values: •DEBUG—the most detailed logging level. All messages and debug information are registered. •INFO—all messages are registered. •NOTICE—all error messages, warnings, and notifications are registered. •WARNING—all error messages and warnings are registered. •ERROR—only error messages are registered.
--Log	Description: Specify the method for logging component messages. Short form: No. Arguments: <log type>. Allowed values: •Stderr[:ShowTimestamp]—messages are output to a standard error stream stderr. Additional option ShowTimestamp instructs to add a time stamp to every message. •Syslog[:<facility>]—messages are transmitted to the system logging servicesyslog. Additional option <facility> is used to specify a level at which syslog registers messages. The following values are possible: oDAEMON—messages of daemons. oUSER—messages of user processes. oMAIL—messages of mail programs. oLOCAL0—messages of local processes 0. ... oLOCAL7—messages of local processes 7. •<path>—path to the file where all messages are registered. Examples: --Log /var/opt/drweb.com/log/se.log --Log Stderr:ShowTimestamp --Log Syslog:DAEMON

This command starts an instance of Dr.Web Scanning Engine, instructs it to use the /etc/opt/drweb.com/drweb.ini configuration file, and sets the limit to start no more than 5 child scanning processes.

When necessary, any number of scanning engine Dr.Web Scanning Engine instances can be started. The instances provide the scanning service for client applications (not only for Dr.Web for UNIX components). At that, if a value of the FixedSocketPath parameter is specified in the component’s configuration, one instance of the scanning engine is always running by the configuration daemon Dr.Web ConfigD and is always available for the clients via this UNIX socket. The instances of the scanning engine started directly from the command line, will operate in an autonomous mode without establishing connection to the configuration daemon, even if it is running.

To scan files at request, use the command-line-based management tool for Dr.Web for UNIX (called by the drweb-ctl command).

The product described in the present document is designed for operation in different UNIX-based operating system. Real paths to product files depend on the operating system installed on the user’s computer. For notational convenience, the following conventions are used:

•<opt_dir>—directory where main product files are located (including executable files and libraries).

•<etc_dir>—directory where the configuration file and a key file are located.

•<var_dir>—directory where supporting and temporary product files are located.

Real paths corresponding to the conventions in different operating systems are given in the table below.

For space considerations, examples given in the present document use paths for GNU/Linux operating systems. In some places of the document, where it is possible, examples contain real paths for all of the operating systems.