 .! .!  File:       MXALIAS.HELP .! .!  Author:     Hunter Goatley& .! Copyright (c) 2008, Hunter Goatley. .!   .! All rights reserved.  .!  E .! Redistribution and use in source and binary forms, with or without E .! modification, are permitted provided that the following conditions  .! are met:  .!  = .!     * Redistributions of source code must retain the above D .!       copyright notice, this list of conditions and the following .!       disclaimer.@ .!     * Redistributions in binary form must reproduce the aboveD .!       copyright notice, this list of conditions and the followingH .!       disclaimer in the documentation and/or other materials provided .!       with the distribution. E .!     * Neither the name of the copyright owner nor the names of any F .!       other contributors may be used to endorse or promote productsB .!       derived from this software without specific prior written .!       permission. .!  F .! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORSD .! "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOTH .! LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FORG .! A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT H .! OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,C .! SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT H .! LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,H .! DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANYF .! THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORTH .! (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USEG .! OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  .!  .!  Date:       January 20, 1993 .!N .!  Abstract:   Source file to build RUNOFF .RNH file for MXALIAS on-line help .! .! <INIT> .!  <MAIN>
 Using_Aliases   O Once an MX alias has been added to the MX alias database, it can be used on the O VMS Mail "To:" line by simply prefixing the alias name with MX%.  MX will check K every address that does not include the "@" character to see if it is an MX K alias. For example, if JOE is defined as an alias, the following "To:" line  would be specified:   	 <LITERAL>  |MAIL> SEND  |To:     MX%JOE  |Subj:	.... 	 <LARETIL>   G Sending to MX%"JOE@localhost" will prevent MX from performing the alias  translation.   <TOPIC>  Displaying_Translations   @ To see the resulting addresses used by MX for all MX% addresses,0 define the logical MX_VMSMAIL_SHOW_ADDR as TRUE:  	 <LITERAL> # |$ define mx_vmsmail_show_addr true  |$ mail  |  |MAIL> SEND 3 |To:     MX%JOE, MX%"MX-List@WKUVX1.BITNET", SYSTEM 1 |  MX rewrote alias JOE as <SYSTEM@WKUVX1.BITNET> > |  MX rewrote MX-List@WKUVX1.BITNET as <MX-List@WKUVX1.BITNET>
 |Subj:   .... 	 <LARETIL>   J The MX_VMSMAIL_SHOW_ADDR works regardless of whether or not MX aliases are
 specified.   <TOPIC> $ Setting_MX_as_Default_Mail_Transport  F The undocumented VMS Mail command SET TRANSPORT can be used to make MXK the default transport for all mail messages.  The format of the command is:   	 <LITERAL>  MAIL> SET TRANSPORT MX% 	 <LARETIL>   H The MX% prefix can be omitted from MX aliases when the default transportH has been set.  Note that non-alias "user@domain" addresses must still be	 prefixed.   C The MAIL command SET NOTRANSPORT can be used to disable the default 
 transport.   <NOTE>D The SET TRANSPORT command is undocumented; its behavior could change in a future release of VMS.  <ETON>   .!  <MAIN> ADD   D The ADD command is used to add an MX alias to the MX alias database.   Format:  <FORMAT>. MXalias> ADD alias address[,...] [description]   <TOPIC> 
 Parameters   <PARAMETER>  alias    <PTEXT> E Specifies the alias to be defined.  The alias is a string of up to 20 J alphanumeric characters (plus $, -, _, and .) that is equated to the givenL e-mail address. The alias is the address given to MX from the VMS Mail "To:"K line using a format like MX%alias.  All aliases are converted to uppercase.  <TXETP>    <PARAMETER>  address    <PTEXT> M Specifies the e-mail address to which the alias is equated.  The address must I be a valid RFC-822 address in the format "user@domain".  If the domain is > omitted, it defaults to the local host name (as defined by theM MX_VMSMAIL_LOCALHOST logical name).  The maximum length of the address is 255 C characters.  To maintain the case of an address, double-quotes must E surround the address.  Double-quotes must also be used if the address " contains the "bang" character (!).  K If the address includes quotes, the address should be quoted and the inside ( quotes doubled: """node::user""@domain".  J You can supply multiple addresses by separating the addresses with commas.L The maximum length of a comma-separated list of addresses is 255 characters, including the commas.  <TXETP>    <PARAMETER>  description    <PTEXT> N Specifies a description for the alias and address.  A text string of up to 255O characters may be given.  Double-quotes must surround the string if it contains M any blanks.  The description is displayed by the DIRECTORY command; it is not 5 included in the RFC-822 headers of any mail messages.  <TXETP>    <TOPIC>  Examples  J The following examples demonstrate how an address is added to the MX alias	 database.   	 <LITERAL> 3 |1.  MXalias> ADD JOE SYSTEM "Local system manager" ) |    Added alias JOE to MX alias database 
 |    MXalias> 	 <LARETIL>    <ETEXT> L This example defines JOE as an alias for the local SYSTEM account.  VMS Mail@ addressed "To:" MX%JOE will be delivered to <system@local-host>. <TXETE>   	 <LITERAL> A |2.  MXalias> add mx-list mx-list@wkuvx1.bitnet "MX support list" - |    Added alias MX-LIST to MX alias database 
 |    MXalias> 	 <LARETIL>    <ETEXT> K This example defines MX-LIST as an alias for the MX support mailing list on C WKUVX1.BITNET.  VMS Mail addressed "To:" MX%MX-LIST will be sent to  <MX-LIST@WKUVX1.BITNET>. <TXETE>   	 <LITERAL> . |3.  MXalias> ADD YYZ """NODE1::JOE""@YYZ.COM") |    Added alias YYZ to MX alias database 
 |    MXalias> 	 <LARETIL>    <ETEXT> I This example defines YYZ as an alias for an address that includes quotes.  <TXETE>   	 <LITERAL> : |4.  MXalias> ADD THEM "Joe@YYZ.COM","Rick@SWAN.Com","X@Y"* |    Added alias THEM to MX alias database
 |    MXalias> 	 <LARETIL>    <ETEXT> L This example equates three addresses with the alias THEM.  Mail addressed to. THEM will be forwarded to all three addresses. <TXETE>    .!  <MAIN>	 DIRECTORY   E The DIRECTORY command provides a list of aliases or information about D an alias or a group of aliases.  The default alias directory listingI includes the alias and the description.  Wildcards can be used to display % aliases matching a particular string.    Format:  <FORMAT>( MXalias> DIRECTORY [alias] [/qualifiers]   <TOPIC> 	 Parameter    <PARAMETER>  alias    <PTEXT> O Specifies the alias or group of aliases to be displayed.  The alias is optional $ and can include wildcards (* and %). <TXETP>    <QUALIFIERS> <QUALIFIER>  /FULL    /FULL   J Displays the alias, the description, and the e-mail address for each alias shown. <QUALIFIER>  /OUTPUT    /OUTPUT=file.ext  L Specifies the name of a text file to which the directory listing is written.   <TOPIC>  Examples  E The following examples show sample output from the DIRECTORY command.   	 <LITERAL>  |1.  MXalias> dir  | & |    MX Alias              Description& |    ------------          -----------/ |    JOE                   Local system manager  | 
 |    MXalias> 	 <LARETIL>    <ETEXT> 7 This example shows the default brief directory listing.  <TXETE>   	 <LITERAL>  |2.  MXalias> dir/full joe |  |    Alias:    JOE# |    Desc:     Local system manager # |    Address:  SYSTEM@WKUVX1.BITNET  | 
 |    MXalias> 	 <LARETIL>    <ETEXT> , This example shows a full directory listing. <TXETE>    .!  <MAIN> EXIT  = The EXIT command leaves MXALIAS.  QUIT is a synonym for EXIT.    .!  <MAIN> HELP  M MXALIAS is a simple database manager for user-defined MX aliases.  It creates E the MX alias database and lets the user add, remove, and list defined  aliases.  O The MX alias database filename defaults to MX_ALIAS_DATABASE.DAT in SYS$LOGIN:. J The logical MX_ALIAS_DATABASE can be defined to point to another directory or file specification.  I MXALIAS will automatically create the MX alias database the first time an L alias is added.  The user is prompted for confirmation before a new database is created.  .!  <MAIN> MODIFY  O The MODIFY command is used to change the address or description associated with  an MX alias.   Format:  <FORMAT>" MXalias> MODIFY alias [/qualifier]   <TOPIC> 
 Parameters   <PARAMETER>  alias    <PTEXT> N Specifies the alias to be modified.  The alias must already be in the MX alias	 database.  <TXETP>    <QUALIFIERS> <QUALIFIER>  /ADDRESS  
 /ADDRESS=text   L Specifies the new e-mail address to which the alias is equated.  The addressN must be a valid RFC-822 address in the format "user@domain".  If the domain is> omitted, it defaults to the local host name (as defined by theM MX_VMSMAIL_LOCALHOST logical name).  The maximum length of the address is 255 J characters.  Double-quotes must surround the address to maintain its case.  B You can supply multiple addresses by separating the addresses withE commas and surrounding them with parentheses. The maximum length of a B comma-separated list of addresses is 255 characters, including the commas.  <QUALIFIER>  /DESCRIPTION   /DESCRIPTION=text  /NODESCRIPTION  N Specifies a new description for the alias and address.  A text string of up toJ 255 characters may be given.  Double-quotes must surround the string if itO contains any blanks.  The description is displayed by the DIRECTORY command; it < is not included in the RFC-822 headers of any mail messages.   <TOPIC>  Examples  M The following examples demonstrate how an address is modified in the MX alias 	 database.   	 <LITERAL> ; |1.  MXalias> MODIFY JOE/DESCRIPTION="Local system manager"  |    Modified alias JOE 
 |    MXalias> 	 <LARETIL>    <ETEXT>e4 This example modifies the description for alias JOE. <TXETE>p  	 <LITERAL>0F |2.  MXalias> modify joe/address="SmithJB@SomeWhere.Com"/nodescription |    Modified alias JOE 
 |    MXalias>i	 <LARETIL>u   <ETEXT>fG This example changes the e-mail address and removes the description fort
 alias JOE. <TXETE>d  	 <LITERAL>oO |3.  MXalias> modify me/address=("goathunter@MadGoat.com","goathunter@YYZ.COM")d |    Modified alias ME
 |    MXalias>l	 <LARETIL>    <ETEXT>r8 This example supplies two e-mail addresses for alias ME. <TXETE>t   .!, <MAIN> REMOVE  I The REMOVE command is used to delete an alias from the MX alias database.tJ By default, the REMOVE prompts for confirmation before removing the alias.   Format:t <FORMAT>" MXalias> REMOVE alias [/qualifier]   <TOPIC>c	 Parameter    <PARAMETER>e aliaso   <PTEXT>rG Specifies the alias to be removed from the database.  Wildcards are notn
 permitted. <TXETP>.   <QUALIFIERS> <QUALIFIER>R /CONFIRM   /[NO]CONFIRM  N Specifies whether or not REMOVE should prompt the user for confirmation beforeN removing the alias.  By default, REMOVE does prompt; use /NOCONFIRM to disable the prompt.R   <TOPIC>P ExampleI  J The following example shows how alias JOE can be removed from the MX alias	 database.R  	 <LITERAL>, MXalias> remove joeI( Remove JOE <SYSTEM@WKUVX1.BITNET> [N]? y Removed alias JOE  MXalias>	 <LARETIL>E   .!  <MAIN> SHOW  9 Displays information about or from the MX alias database.S   Format:O <FORMAT> MXalias> SHOW option [...]   <TOPIC>I ALIAST  J SHOW ALIAS is a synonym for DIRECTORY.  See the DIRECTORY listing for more information.   Format:U <FORMAT>) MXalias> SHOW ALIAS [alias] [/qualifiers]    <TOPIC>L DATABASE  5 SHOW DATABASE displays the current MX alias database.    <TOPIC>  Examplel  I The following example shows sample output from the SHOW DATABASE command:M  	 <LITERAL>l MXalias> show database> Current MX alias database is DUA0:[JOE]MX_ALIAS_DATABASE.DAT;1 MXalias>	 <LARETIL>n .!s <MAIN> USEn  D The USE command is used to close the open MX alias database file and open a specified database file.i   Format:M <FORMAT> MXalias> USE database-file   <TOPIC>l
 Parameters   <PARAMETER>n
 database-filee   <PTEXT> L Specifies the name of the database file to open.  The device, directory, andN type default to SYS$LOGIN:.DAT.  Used primarily by system management personnel" to access a global alias database. <TXETP>s