help

   clean                   -- Hold or delete queued messages
   counters clear          -- Zero the channel counters
   counters create         -- Create the channel counters
   counters delete         -- Delete the channel counters
   counters show [channel] -- Show the channel counters
   date                    -- Show the current time and date
   delete [n]              -- Delete queued messages
   directory [channel]     -- List queued messages
   exit                    -- Exit this utility
   held [channel]          -- List messages marked as held
   help [topic]            -- Display help on this utility
   history [n]             -- Show history information for a queued message
   hold [n]                -- Mark a queued message as held
   quit                    -- Exit this utility
   read [n]                -- Show the contents of a queued message
   release [n]             -- Release a message marked as held
   return [n]              -- Return (bounce) a queued message
   run command-file        -- Execute commands from the specified file
   start channel           -- Resume processing for the specified channel
   stop channel            -- Suspend processing for the specified channel
   summarize               -- Display a summary listing of message files
   top                     -- Display frequently occurring fields in message
   view database|directory -- Select source of queued message information

 To see help on a specific topic, issue the command "help topic".  For example,
 "help directory"

clean

 Syntax: clean [-content=str] [-database|-directory_tree] [-delete|-hold]
               [-domain_to=str] [-from=str] [-ignore_zz] [-match=and|or]
               [-min_length=len] [-nothreads|-threads=count] [-subject=str]
               [-to=str] [-verbose] [channel-name]

 The clean command holds or delete message files from the queue area that
 contain specified substrings in their envelope From: address, Subject:
 header, or message content.

 By default, message files are held (-hold).  Specify -delete to instead
 delete matching message files.  The -from, -to, -domain_to, -subject, and
 -content switches are used, respectively, to specify envelope From:,
 envelope To:, envelope To: domain, Subject: header line, and message content
 substrings to search for.

 By default, each substring to be searched for must be at least 24 bytes
 long.  Use the -min_length switch to override this limit.

counters clear

 Syntax: counters clear [-channels] [-associations]

 The counters clear command performs the following operations:

   (1) Creates the shared memory segment for the channel message and
       association counters if the segment does not already exist.

   (2) Sets all counter values to zero.

   (3) When -channels is specified or implied, sets the counts of stored
       messages, recipients, and volume from the Job Controller's in-memory
       message queue database.

 Specify -channels to only clear the message counters.  Specify -associations
 to only clear the association counters.  When neither switches are specified,
 both are assumed.  When -associations is specified and -channels is not,
 step (3) above is not performed.

counters create

 Syntax: counters create [-max_channels=n]

 The counters create command performs the following operations:

   (1) Creates the shared memory segment for the channel message and
       association counters if the segment does not already exist.

   (2) Sets the counts of stored messages, recipients, and volume from the
       queue cache database.

 The optional -max_channels switch may be used to tell iMS how many channels
 to allow for in the memory segment.  If you omit this switch, then iMS will
 look at the imta.cnf file and figure out a generous value on its own.

counters delete

 Syntax: counters delete

 The counters delete command deletes the shared memory segment used for
 channel message and association counters.  Note that active iMS server
 processes and channels will likely recreate the memory segment.

counters show

 Syntax: counters show [-[no]headers] [-output=file] [channel-name]

 Use the counters show command to display channel message counters.  When
 the optional channel-name parameter is omitted, * is assumed and the
 message counters for all channels are displayed.  The channel-name parameter
 may contain the * and ? wild card characters.

 The counters show command will

   (1) Create the shared memory segment for the channel message and
       association counters if the segment does not already exist.

   (2) Set the counts of stored messages, recipients, and volume from the
       queue cache database.

   (3) Display the message counters for the specified channels.
    
 The -headers and -noheaders switches control whether or not a heading
 is displayed.  -headers is the default.

 To cause the output to be written to a file, use the -output switch.  Any
 existing file with the same name as the output file will be overwritten.

date

 Syntax: date

 Display the current time and date in RFC 822, 1123 format.

delete

 Syntax: delete [-channel=name [-all]] [-[no]confirm] [-[no]log] [id[,...]]

 Delete the specified messages shown in the most recently generated message
 queue listing.  Normally, you will use the id parameter to specify the
 specific messages to deleted.

 See the help topic "specification" for information on using the command
 switches -channel, -all, -confirm, and -log.

directory

 Syntax: directory [-database|-directory_tree] [-envelope] [-[no]file_info]
                   [-from=address] [-[no]held] [-match=and|or]
                   [-owner=username] [-to=address] [-[no]total] [channel-name]

 Generate a listing of queued message files.  By default, the iMS directory
 tree is used as the source of queued message information; this default may
 be changed with the view command.  The -database and -directory_tree switches
 may be used to override the default.  The -database switch selects the
 in-memory queue database held by the Job Controller.

 Use the -envelope switch to generate a listing which also contains envelope
 address information.  Specify -total to generate size and count totals across
 all selected channels.

 The -owner=username switch may be used to list only those messages owned by
 a particular user.  Messages enqueued by a local user will be owned by that
 user; most other messages will be owned by the iMS user id .  Use of the
 -owner switch implies -database.

 The -from=address and -to=address switches may be used to list only those
 messages with envelope From: or To: addresses matching the specified address.
 When both -from and -to are specified, a message is listed if either its
 envelope From: or To: addresses match the specified addresses.  This
 corresponds to -match=or.  Specify -match=and to list only messages matching
 both the specified From: and To: addresses.  Use of -from or -to implies
 -envelope.

 The channel-name parameter may be used to restrict the listing to one or more
 channels.  If the channel-name parameter is omitted, a listing is made for
 all channels.  The channel name parameter may contain * and ? wild card
 characters.

 By default, active messages are listed.  Specify -held to instead list
 messages which have been marked as held.  Note that -held implies
 -directory_tree.

 When the directory tree is scanned, each message file is opened to determine
 its size as measured in units of iMS blocks (normally 1024 bytes).  To
 suppress this behavior and speed up generation of the listing, specify
 -nofile_info.  When the queue cache database is used, the -nofile_info switch
 is ignored as the size information is stored in the database.

exit

 Syntax: exit

 Exit the utility.  Synonymous with the quit command.

held

 Syntax: held [-envelope] [-[no]file_info] [-from=address] [-match=and|or]
              [-to=address] [-[no]total] [channel-name]

 Generate a listing of message files which have been marked as held.  This
 listing is always generated from the iMS queue directory tree.

 Use the -envelope switch to generate a listing which also contains envelope
 address information.  Specify -total to generate size and count totals across
 all selected channels.

 The -from=address and -to=address switches may be used to list only those
 messages with envelope From: or To: addresses matching the specified address.
 When both -from and -to are specified, a message is listed if either its
 envelope From: or To: addresses match the specified addresses.  This
 corresponds to -match=or.  Specify -match=and to list only messages matching
 both the specified From: and To: addresses.  Use of -from or -to implies
 -envelope.

 The channel-name parameter may be used to restrict the listing to one or more
 channels.  If the channel-name parameter is omitted, a listing is made for
 all channels.  The channel name parameter may contain * and ? wild card
 characters.

 When the directory tree is scanned, each message file is opened to determine
 its size as measured in units of iMS blocks (normally 1024 bytes).  To
 suppress this behavior and speed up generation of the listing, specify
 -nofile_info.

history

 Syntax: history [-channel=name [-all]] [-[no]confirm] [id[,...]]

 Display any delivery history information for the specified messages from the
 most recently generated message queue listing.  Normally, you will use the id
 parameter to specify the specific messages to operate upon.

 See the help topic "specification" for information on using the command
 switches -channel, -all, and -confirm.

hold

 Syntax: hold [-channel=name [-all]] [-[no]confirm] [-[no]log] [id[,...]]

 Mark as held the specified messages from the most recently generated message
 queue listing.  Normally, you will use the id parameter to specify the
 specific messages to mark as held.

 See the help topic "specification" for information on using the command
 switches -channel, -all, -confirm, and -log.

quit

 Syntax: quit

 Exit the utility.  Synonymous with the exit command.

read

 Syntax: read [-[no]content] [-channel=name [-all]] [-[no]confirm] [id[,...]]

 Display the specified messages from the most recently generated message queue
 listing.  Normally, you will use the id parameter to specify the specific
 messages to display.

 By default, -nocontent, the content of messages is not displayed -- only the
 envelope and header information is shown.  Use the -content switch to request
 display of message content along with the envelope and header information.

 See the help topic "specification" for information on using the -channel,
 -all, and -confirm switches.

release

 Syntax: release [-channel=name [-all]] [-[no]confirm] [-[no]log] [id[,...]]

 Unmark as held the specified messages from the most recently generated message
 queue listing.  Normally, you will use the id parameter to specify the
 specific messages to unmark as held.

 See the help topic "specification" for information on using the -channel,
 -all, -confirm, and -log switches.

return

 Syntax: return [-channel=name [-all]] [-[no]confirm] [-[no]log] [id[,...]]

 Return as undelivered the specified messages shown in the most recently
 generated message queue listing.  Normally, you will use the id parameter to 
 specify the specific messages to returned.

 See the help topic "specification" for information on using the -channel,
 -all, -confirm, and -log switches.

run

 Syntax: run [-[no]ignore] [-[no]log] command-file

 Process, line by line, the commands from the specified file.  Specifically,
 the specified file is opened and each line from it is read and executed.
 Unless -ignore is specified, command execution will be aborted should one of
 the commands generate an error.  By default, -log, each command is echoed to
 the terminal before being executed.  Specify -nolog to suppress this echo.

start

 Syntax: start channel

 Resume processing for the specified channel.

stop

 Syntax: stop channel

 Suspend processing for the specified channel.  Until a start command is
 issued, the Job Controller will no longer start processing jobs for the
 specified channel.  This suspended state will persist across restarts of
 iMS.

summarize

 Syntax: summarize [-database|directory_tree] [-[no]heading] [-[no]held]
                   [-[no]trailing] [channel-name]

 Display a summary listing of message files.  By default, the iMS directory
 tree is used as the source of queued message information; this default may
 be changed with the view command.  The -database and -directory_tree switches
 may be used to override the default.  The -database switch selects the
 in-memory queue database held by the Job Controller.

 The channel-name parameter may be used to restrict the listing to one or more
 channels.  If the channel-name parameter is omitted, a listing is made for
 all channels.  The channel name parameter may contain * and ? wild card
 characters.

 By default, active messages are listed.  Specify -held to instead list
 messages which have been marked as held.  Note that -held implies
 -directory_tree.

top

 Syntax: top [-content] [-database|-directory_tree] [-delete|-hold]
             [-domain_to] [-from] [-ignore_zz] [-min_count=count]
             [-nothreads|-threads=count] [-subject] [-to] [-top=count]
             [-verbose] [channel-name]

 Display the most frequently occurring envelope From:, envelope To:, envelope
 To: domain, Subject:, or message content fields found in message files in the
 channel queues.

 By default, only Subject: fields are shown (-subject).  Use -from,
 -to, -domain_to, or -content to display, respectively, frequent envelope
 From:, envelope To:, envelope To: domain, or message content fields.
 Additionally, starting offsets and scan lengths may be specified for these
 fields by following the switch with =(start=n,length=m).  For example,

   -content=(length=200)  [ or, equivalently, -content=length=200 ]

 would look at only the first 200 bytes of each message while

   -content=(length=200,start=50)

 would look at only 200 bytes of each message but starting at the 50th byte.

 By default, the top 20 most frequently occurring fields are shown provided
 that they occur 2 or more times.  Use the -top and -min_count switches to
 alter this behavior.

view

 Syntax: view database
         view directory_tree

 Specify the source of queued message information for subsequent directory
 commands.

 By default, queued message listings are generated by scanning the message
 queue directory tree.  This corresponds to the

   view directory_tree

 command.  You can, alternatively, generate the listings from the the in-memory
 queue database held by the Job Controller.

   view database

 Settings made with the view command remain the default until either another
 view command is issued or the utility is quit.  The default may be overridden
 with the -database or -directory_tree switches of the directory command.

 Note that the directory tree is always used when listing held message files.

specification

 The delete, history, hold, read, release, and return commands all support the
 switches

    [-channel=name [-all]] [-[no]confirm] [-[no]log] [id[,...]]

 These switches identify which messages to apply the command to.  When none of
 the switches are specified, at least one id parameter must be supplied.  The
 id parameter gives the identification number of a message shown in the most
 recent listing generated by either the directory or held command.  The
 identification number for a message is the integer value shown in the left
 most column of the listing.  For example, in the following listing the first
 message shown has an identification number of 1 and the second 2:

   qm.maint> directory tcp_local
   Channel: tcp_local                Size Queued since
   --------------------------------------------------------------
       1 XS01IVX1T0QZ18984YIW.00       24 16-APR-1998 00:30:30.07
       2 YH01IW2MZLN0RE984VUK.00       24 20-APR-1998 00:30:40.31

 These two messages can therefore be selected by either "1,2" or "1-2".

 The -all switch may be used to operate on all of the previously listed
 messages.  When used in conjunction with the -channel switch, only those
 previously listed messages for the specified channel are operated on.  The
 specified channel name may contain wild card characters.  The -all switch may
 not be used in conjunction with an id parameter.  However, -all or at least
 one id parameter must be specified.

 When the id parameter is not used to explicitly select messages, you will be
 prompted to confirm the operation.  This prevents accidental "delete -all"
 commands from being executed.  You can use the -noconfirm switch to suppress
 this prompt.  Similarly, -confirm causes a confirmation prompt to be required.

 The -log and -nolog switches control whether or not the operation on each
 selected message is reported.
