|
Like every UNIX program, Dr.Web MailD modules support command line parameters. The command line format is as follows:
<module_name> [parameters] <agent_socket>
where:
•<module_name> - name of the module; •<parameters> - optional command line parameters; •<agent_socket> - socket used for receiving module configuration from Dr.Web Agent component. General Parameters
In the current version of Dr.Web for UNIX mail servers, the modules support the following command line parameters:
Short case
|
Extended case
|
Arguments
|
-h
|
--help
|
|
Description: Show information about supported command line parameters on the screen and exit
|
|
-v
|
--version
|
|
Description: Show module version on the screen and exit
|
|
-l
|
--level
|
<log verbosity level>
|
Description: Verbosity level for logging information on module startup (default value is info)
|
|
-t
|
--timeout
|
<number of seconds>
|
Description: Maximum wait time for receiving configuration from Dr.Web Agent
|
|
|
--component
|
<components name>
|
Description: Name of the component that requests configuration from Dr.Web Agent
Note that this command line parameter is not supported by drweb-zmailer!
|
|
|
--log-name
|
<components name>
|
Description: Name of the component that performs logging
|
|
|
--check-only
|
|
Description: Start the component in the configuration check mode. To provide correct operation, Dr.Web Agent must be previously started. If configuration test is successful, the following message is output to the console: "Options OK". If configuration test failed, the following message is output: "Options ERROR".
Note that this command line parameter is not supported by drweb-zmailer!
|
Example:
drweb-maild -t 30 local:%var_dir/ipc/.agent
This command starts Dr.Web MailD with 30 seconds time-out for receiving configuration from Dr.Web Agent via the local:%var_dir/ipc/.agent socket.
Module Specific Parameters
Different modules of Dr.Web MailD also support additional command line parameters that are specific for a certain module. The exceptions are drweb-notifier and drweb-proxy-client modules that can be used only with the parameters mentioned above.
1. drweb-maild
The following command line parameters are specific for drweb-maild and are used to check correctness of message processing Rules:
Short case
|
Extended case
|
Arguments
|
-s
|
--sender
|
<mail address>
|
Description: Sender's address (from the message envelope)
|
|
-r
|
--recipient
|
<mail address>
|
Description: Recipient address (from the message envelope). To set several recipients, specify the parameter several times
|
|
-b
|
--block
|
<object name>
|
Description: Name of the blocking object found in the message (for example, virus name). To set several blocking objects, specify the parameter several times
|
|
|
--client-ip
|
<IP address>
|
Description: IP address of the client which sent the message
|
|
|
--server-ip
|
<IP address>
|
Description: IP address of the server interface that received the message
|
|
|
--client-port
|
<port number>
|
Description: Port of a client from which the message was received
|
|
|
--server-port
|
<port number>
|
Description: Port of a server which received the message
|
|
|
--server-us
|
<UNIX socket>
|
Description: Name of the UNIX socket of the server that received the message
|
|
|
--id
|
<identifier>
|
Description: Unique identifier of Receiver that transmitted the message
|
|
|
--auth
|
|
Description: Flag indicating that the message was received from an authorized user
|
|
|
--size
|
<size>
|
Description: Size of the checked message (the value is of the size type)
|
|
|
--score
|
<score>
|
Description: Score assigned to the message (number)
|
|
|
--md-client
|
<MailDesk Client name>
|
Description: Unique identifier of the MailDesk Client
|
2. Other plug-ins (except for drweb-zmailer) have two specific parameters used for operation with several Sender and Receiver components simultaneously:
Short case
|
Extended case
|
Arguments
|
|
--unique-id
|
<identifier>
|
Description: Unique component identifier. This parameter enables MailD core to work with several copies of Sender and Receiver components. Every new Sender+Receiver pair must be started with the unique identifier (paired Sender and Receiver components must have the same ID). Thus, an email message must be dispatched by Sender which has the same ID as Receiver which got the message. If the component with the required ID is not found, the default Sender is selected.
List of available Senders is reinitialized via the SIGHUP signal.
The following list shows the way MailD core treats a component ID for each of the modules:
•drweb-receiver - Receiver s identifier; •drweb-sender - Sender's identifier; •drweb-proxy-server - Identifier shared by paired Receiver and Sender interacting with MailD core via this component (see Using Internal Proxy); •drweb-imap - IMAP filter's identifier (used similar to the Receiver identifier for search of the corresponding Sender); •drweb-pop3 - POP3 filter's identifier (used similar to the Receiver identifier for search of the corresponding Sender); •drweb-milter - Receiver's identifier; •drweb-cgp-receiver - Receiver's identifier; •drweb-cgp-sender - Sender's identifier; •drweb-courier - Receiver's identifier; •drweb-qmail - Receiver's identifier. |
|
|
--section
|
<имя секции>
|
Description: Name of the configuration file section that contains settings for the module. If the parameter is not specified, the module uses settings from the default section.
These are the following default sections for each module:
•drweb-receiver - [Receiver] •drweb-sender - [Sender] •drweb-proxy-server - [ProxyServer] •drweb-imap - [IMAP] •drweb-pop3 - [POP3] •drweb-milter - [Milter] •drweb-cgp-receiver - [CgpReceiver] •drweb-cgp-sender - [CgpSender] •drweb-courier - [Courier] •drweb-qmail - [Qmail] |
3. drweb-zmailer
The following command line parameters are specific for drweb-zmailer:
Short case
|
Extended case
|
Arguments
|
-u
|
--user
|
<user name>
|
Description: User account name under which drweb-maild is running.
Note that if the parameter is not specified, drweb-zmailer is running with root rights, which can cause interoperability problems with drweb-maild if it is not running with root rights.
|
|
-i
|
--ipclevel
|
<verbosity level>
|
Description: Log verbosity level for IPC library used by drweb-zmailer.
Available values: quiet, error, alert, info, debug
|
|
-f
|
--facility
|
<syslog flag>
|
Description: Used syslog label (if the syslog service is enabled).
Available values: daemon, mail, local0, ..., local7
|
|
-b
|
--basedir
|
<directory path>
|
Description: Path to the home directory where Dr.Web MailD plug-ins are located
|
|
|
--id
|
<identifier>
|
Description: Similar to the --unique-id parameter specified for other components (see above). MailD core treats this parameter as a Receiver identifier.
|
|
|
--log-filename
|
<log file name>
|
Description: Name of the used log file or syslog (if the syslog service is enabled)
|
|
|
--file
|
<path to the file>
|
Description: Path to the file which must be processed on the plug-in startup
|
|
|
--hash
|
<value>
|
Description: The SecureHash parameter value from the [Sender] section of Dr.Web MailD configuration file
|
|
|
--interface
|
<0|1>
|
Description: Version of the used smtpserver: 0 – for 2.99.55 version or earlier, 1 – for 2.99.56 version or later
|
|
-e
|
--error-action
|
<action>
|
Description: Action applied if an internal error occurs in the plug-in during message processing.
Available values: pass, reject, discard, tempfail
|
|
-Z
|
|
<file path>
|
Description: Path to the ZMailer configuration file that is to be ignored
|
For information on utility command line parameters, refer to the description of the corresponding utility in the present document.
|