12.6 mtasim command line options

This section summarizes all available mtasim command line options.

--append

-a

Append to the trace file. See traces.

--body-chunk=number

Set the body chunk length (bytes) for xxfi_body calls.

--daemon

-bd

Run as daemon. See daemon mode.

--define=macro=value

-D macro=value

Define Sendmail macro macro to the given value. It is similar to the \D administrative command (see D command)

--gacopyz-log=level

Set desired logging level for gacopyz library (see Gacopyz). See gacopyz-log option, for a detailed description of level. Notice, that unless this option is used, the --verbose (-v) command line option implies --gacopyz-log=debug.

--group=name

-g name

When switching to user’s privileges as requested by the --user command line option, retain the additional group name. Any number of --group options may be given to supply a list of additional groups.

--user=name

-u name

Run with this user privileges. This option and the --group option have effect only if mtasim was started with root privileges.

--help

-?

Display a short help summary

--milter-version=version

Force using the given Milter protocol version number. The version argument is either a numeric version (e.g. ‘2’), or a version string in form ‘major.minor[.patch]’, where square brackets indicate optional part. The default is ‘1.0.0’. If version is any of ‘2’, ‘3’ or ‘1.0.0’, the default protocol capabilities and actions for that version are set automatically. This option is intended for development and testing of the Gacopyz library (see Gacopyz).

--milter-proto=bitmask

Set Milter protocol capabilities. See gacopyz/gacopyz.h for the meaning of various bits in the bitmask. Look for the C macros with the prefix ‘SMFIP_’.

--milter-timeout=values

Set timeouts for various Milter operations. Values is a comma-separated list of assignments ‘T=V’, where T is a timeout code, indicating which timeout to set, and V is its new value. Valid timeout codes are:

C

Timeout for connecting to a filter.

W

S

Timeout for sending information from the simulator to a filter.

R

Timeout for reading reply from the filter.

E

Overall timeout between sending end-of-message to filter and receiving final acknowledgment. Indirectly, it configures the upper limit on the execution time of the eom handler (see eom handler).

--milter-actions=bitmask

Set Milter actions. See gacopyz/gacopyz.h for the meaning of various bits in the bitmask. Look for the C macros with the prefix ‘SMFIF_’.

--no-interactive

Not-interactive mode (disable readline). See Command Line Editing in GNU Readline Library.

--port=port

-X port

Communicate with given Milter port. Valid values for port are:

port specification

See milter port specification, for a detailed discussion. Example:

--port inet:999@localhost

sendmail.cf X command format

For example:

--port='mailfrom, S=inet:999@localhost, F=T, T=C:100m;R:180s'

auto

Create a temporary directory and start an instance of mailfromd configured to communicate over a UNIX socket in that directory. If --statedir is also given, the created mailfromd instance will use that directory as its state directory (see statedir). Additional arguments for mailfromd may be supplied after the -- delimiter.

Before termination, mtasim will stop the mailfromd instance it created and remove the temporary directory.

dir:dirname

Same as auto, except that instead of the temporary directory the directory dirname is used. This directory is not removed when mtasim terminates. Example:

--port dir:/tmp/state

See mtasim milter port, for a detailed discussion of the --port option and its use.

--prompt=string

Set readline prompt. The default prompt string is ‘(mtasim) ’.

--sender-socket=family[,hostname,address[,port]]

Declare sender socket address. This option has the same effect as the S command. See S command, for a detailed discussion and a description of its arguments.

--statedir

When using -Xauto, use the temporary directory name as mailfromd state directory (see statedir mtasim option).

--stdio

-bs

Use the SMTP protocol on standard input and output. This is the default mode for mtasim. See interactive mode.

--trace-file=file

Set name of the trace file. See traces.

--usage

Display option summary

--verbose

-v

Increase verbosity level. Implies --gacopyz-log=debug, unless that option is used explicitly.

--version

-V

Print program version