Command-Line Arguments

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

$ <opt_dir>/bin/drweb-se [options]

Dr.Web Scanning Engine can process the following options:

Short form

Long form

Arguments

-h

--help

 

Description: instructs to output short help information about command-line parameters to the console and exit.

 

-v

--version

 

Description: instructs to output information on the module version and exit

Additional options (they are the same as configuration file parameters and substitute them when required):

 

--Socket

<address>

Description: socket address used by Dr.Web Scanning Engine. It can be specified as a file path (UNIX socket) or as an <IP address:port> pair; at that, if you need to use a network interface by default, type the asterisk character ('*').

Examples:

--Socket /var/opt/drweb.com/ipc/.se

--Socket 127.0.0.1:1000

--Socket *:1000

 

 

--EnginePath

<path to file>

Description: path to the library of Dr.Web Virus-Finding Engine.

 

 

--VirusBaseDir

<path to directory>

Description: path to the directory with virus database files.

 

 

--TempDir

<path to directory>

Description: path to the directory with temporary files.

 

 

--Key

<path to file>

Description: path to the license key file.

 

 

--MaxForks

<number>

Description: maximum allowed number of child processes, which can be started by Dr.Web Scanning Engine during scanning.

 

 

--WatchdogInterval

<time interval>

Description: frequency with which Dr.Web Scanning Engine checks whether child processes are operable and stops those processes that stopped responding.

 

 

--ShellTrace


Description: turn on the shell tracing (log detailed information on file scanning performed by Dr.Web Virus-Finding Engine).

 

 

--LogLevel

<logging level>

Description: level of detail at which operation of Dr.Web Scanning Engine is logged. Allowed values:

DEBUG — the most verbose 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

<destination>

Description: method for logging module messages. Allowed values:

Stderr[:ShowTimestamp] — messages are output to a standard error stream stderr.
Additional option ShowTimestamp prescribes 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

Example:

$ /opt/drweb.com/bin/drweb-se -c /etc/opt/drweb.com/drweb.ini --MaxForks=5

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.

Notes about startup

When necessary, any number of scanning engine Dr.Web Scanning Engine instances can be started. The instances provide client applications (not only Dr.Web for UNIX servers components) with the scanning service. If the parameter Dr.Web for UNIX servers SeFixedSocketPath (in the section [ScanEngine]), is specified, one the scanning engine instances will be always running (started by configuration daemon Dr.Web ConfigD). The instances of the scanning engine started directly from the command line, will operate in standalone mode without establishing connection to the configuration daemon, even if it is running.

To scan files at request, use the command-line tool for the solution management Dr.Web Ctl (it is run by drweb-ctl command).

Convention for paths to product files

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 reside (including executable files and libraries).

<etc_dir> — directory where the configuration file and a key file reside.

<var_dir> — directory where supporting and temporary product files reside.

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

Operating system

Convention

Real path

GNU/Linux

<opt_dir>

/opt/drweb.com

<etc_dir>

/etc/opt/drweb.com

<var_dir>

/var/opt/drweb.com

 

 

 

FreeBSD

<opt_dir>

/usr/local/libexec/drweb.com

<etc_dir>

/usr/local/etc/drweb.com

<var_dir>

/var/drweb.com

 

 

 

Solaris

<opt_dir>

The paths are the same as for GNU/Linux.

<etc_dir>

<var_dir>

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