!
!   MBM.HLP	Help file for MailBox Master program
!		Version 4.0
!
1 MBM
 The MailBox Master program is a utility for manipulating VMS
 mailboxes.  See the VAX/VMS System Services Reference Manual and the
 VAX/VMS I/O User's Guide for information on mailboxes.
!
2 Installation
 The MailBox Master is to be installed as a foreign command, see the
 "VAX/VMS Command Language User's Guide", appendix A.

 A help file (.HLP) is supplied and can be installed in a help
 library, see the "VAX/VMS Command Language User's Guide", HELP 
 command. 
!
2 Commands
 The MailBox Master program can be run as an utility, entering
 mulitple commands, or can be run as a foreign command to invoke one
 function from DCL.
!
3 CREATE
 Create a VMS mailbox:

    MBM CREATE mailbox
!
4 Parameters
 mailbox

 Specifies the (logical) name of the mailbox to be created.
!
4 Qualifiers
/BUFQUO=buffer-quota

 Number of bytes of system dynamic memory that can be used to buffer
 messages sent to the mailbox.  For a temporay mailbox, this value
 must be less than or equal to the process buffer quota.  If not
 specified, or if specified as 0, the system provides a default value.
!
/MAXMSG=maximum-message-size

 The maximum size of a message that can be sent to the mailbox.  If
 not specified, or specified as 0, the system provides a default
 value.
!
/PERMANENT (D)
/TEMPORARY

 Create either a permanent or temporary mailbox.
!
/PROTECTION=protection

 Specifies protection values for mailbox.  If not specified, the
 process default file protection is applied.
!
/WAIT=time-value

 Hibernate until either an absolute time is reached or a delta time
 expires.  Used for creating temporary mailboxes, and then having the
 process wait until a cooperating process can open the mailbox.
!
3 DELETE
 Delete a VMS mailbox:

    MBM DELETE mailbox
!
4 Parameters
 mailbox [, ...]

 Specifies the name(s) of the mailbox(es) to be deleted.
!
3 DUMP
 Read a mailbox, dumping the records contents in hexadecimal:

    MBM DUMP mailbox
!
4 Parameters
 mailbox

 Specifies the name of the mailbox to be dumped.
4 Qualifiers
/COPY=copy-mailbox

 Copy the record recieved in the mailbox to another mailbox.  This
 allows the MBM program to be placed between a mailbox source and sink
 while looking at the mailbox messages.
!
/END_OF_FILE (D)
/NOEND_OF_FILE

 Terminate the DUMP command upon recieving a mailbox end-of-file.
!
/OUTPUT=file-spec

 Direct the DUMP command output to a file.  (The default is
 SYS$OUTPUT).
!
/PULL (D)
/NOPULL

 Have a read pending on the mailbox.  /NOPULL defers doing the read
 until another process has done a write to the mailbox.
!
/WAIT=time-value

 Stop the MBM DUMP command after a certain amount of time.
!
/WRITEOF (D)
/NOWRITEOF

 Forward recieved mailbox end-of-files to the /COPY mailbox.
!
3 EXIT
 Exit the MBM program.  Control-Z will also exit the program.

    MBM> EXIT
!
3 FORMAT
 Read a mailbox, interpreting the mailbox messages.  The only
 currently implemented format is process termination messages.

    MBM FORMAT mailbox
!
4 Parameters
 mailbox

 Specifies the name of the mailbox to be formatted.
4 Qualifiers
/COPY=copy-mailbox

 Copy the record recieved in the mailbox to another mailbox.  This
 allows the MBM program to be placed between a mailbox source and sink
 while looking at the mailbox messages.
!
/END_OF_FILE (D)
/NOEND_OF_FILE

 Terminate the FORMAT command upon recieving a mailbox end-of-file.
!
/OUTPUT=file-spec

 Direct the FORMAT command output to a file.  (The default is
 SYS$OUTPUT).
!
/PULL (D)
/NOPULL

 Have a read pending on the mailbox.  /NOPULL defers doing the read
 until another process has done a write to the mailbox.
!
/WAIT=time-value

 Stop the MBM FORMAT command after a certain amount of time.
!
/WRITEOF (D)
/NOWRITEOF

 Forward recieved mailbox end-of-files to the /COPY mailbox.
!
3 SET
 Change the protection attribute of a mailbox.

    MBM SET mailbox /PROTECTION=protection
!
4 Parameters
 mailbox

    The name of the mailbox having its device protection changed.
!
4 Qualifiers
/PROTECTION=protection

 Specifies the device protection for the mailbox.
!
3 SHOW
 Show the device attributes of a mailbox.

    MBM SHOW mailbox [, ...]
!
4 Paramaters
 mailbox

 The name(s) of the mailbox(es) to be shown.
!
3 TYPE
 Read a mailbox, copying the records to SYS$OUTPUT.

    MBM TYPE mailbox
!
4 Parameters
 mailbox

 Specifies the name of the mailbox to be typed.
4 Qualifiers
/COPY=copy-mailbox

 Copy the record recieved in the mailbox to another mailbox.  This
 allows the MBM program to be placed between a mailbox source and sink
 while looking at the mailbox messages.
!
/END_OF_FILE (D)
/NOEND_OF_FILE

 Terminate the TYPE command upon recieving a mailbox end-of-file.
!
/OUTPUT=file-spec

 Direct the TYPE command output to a file.  (The default is
 SYS$OUTPUT).
!
/PULL (D)
/NOPULL

 Have a read pending on the mailbox.  /NOPULL defers doing the read
 until another process has done a write to the mailbox.
!
/WAIT=time-value

 Stop the MBM TYPE command after a certain amount of time.
!
/WRITEOF (D)
/NOWRITEOF

 Forward recieved mailbox end-of-files to the /COPY mailbox.
!