Clbuild utility

From Messaging Server Technical Reference Wiki
Jump to: navigation, search

Compile an MTA command definition file and generate an image file (suitable for memory mapping by MTA processes).

Syntax

  imsimta clbuild cld-file-spec
imsimta clbuild Command Switches
Switch Default
-debug -nodebug
-image_file=file-spec -noimage_file
-maximum -nomaximum
-option_file=file-spec -nooption_file
-sizes -nosizes
-statistics -nostatistics

Restrictions

Must have superuser privileges (UNIX) or be logged in as the MTA user (see the user option in restricted.cnf) in order to use this utility.

Parameters

cld-file-spec

The file specification of an MTA command definition file to read as input; e.g., on UNIX SERVERROOT/lib/pmdf.cld.

Description

The imsimta clbuild utility compiles a command line definition file and generates a binary file (suitable for memory mapping by MTA processes).

The MTA ships with any pre-compiled command line definition files it needs so it is not normally necessary to run this utility.

Switches

-debug, -nodebug (default)

The -debug switch causes imsimta clbuild to output debug information regarding its operation.

-image_file=file-spec, -noimage_file (default)

By default, imsimta clbuild does not produce a compiled command definition image file. In order to produce a compiled command definition file, the file to produce must be specified using the -image_file switch.

-maximum, -nomaximum (default)

The file SERVERROOT/lib/maximum_command.dat is read when -maximum is specified. This file specifies near maximum table sizes but does not change any other command option file parameter settings. Only use this switch if the current table sizes are inadequate. The -noimage_file and -option_file switches should always be used in conjunction with this switch---it makes no sense to output the enormous command definition image that is produced by -maximum, but it does make sense to use -maximum to get past size restrictions in order to build a properly sized command option file so that a properly sized command definition image can be built with a subsequent imsimta clbuild invocation.

-option_file[=file-spec], -nooption_file (default)

imsimta clbuildcan optionally produce a command option file that contains correct table sizes to hold the command definitions which were just compiled (plus a little room for growth). The -option_file switch causes this file to read as input and a new such option file created as output. If -option_file is specified with no value, then the file written will have the same name as the input command definition file, but with the file extension .cop; for instance, if the file SERVERROOT/lib/pmdf.cld was the input parameter, then the default name for the output command option file would be SERVERROOT/lib/pmdf.cop. If the -nooption_file switch is specified (the default), then no option file will be output. Note that use of the -maximum switch causes imsimta clbuild to read options from maximum_command.dat in addition to any command option file. This file specifies near maximum table sizes. Only use this switch if the current table sizes are inadequate, and only use it to create a new option file. The -noimage_file switch should always be specified when -maximum is specified since a maximum-size image would be truly enormous and extremely wasteful.

-remove

Remove an existant compiled command definition image.

-sizes, -nosizes (default)

The -sizes switch instructs imsimta clbuild to output information on the sizes of the uncompiled command definitions.

-statistics, -nostatistics (default)

The -statistics switch instructs imsimta clbuild to output information on the compiled command definition image. These numbers give a rough measurement of the efficiency of the compilation, and may indicate whether or not an additional rebuild with the -option_file switch is needed.

Examples

The standard command used to compile the basic MTA command definition file on UNIX is:


# imsimta clbuild -option -image=IMTA_TABLE:advanced/command_data IMTA_LIB:pmdf.cld

To remove the compiled version of the basic MTA command definitions, use


# imsimta clbuild -remove IMTA_TABLE:advanced/command_data

See also: