home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 1998 April A / Pcwk4a98.iso / Lotus / Domino46 / LOTUS031.DSK / MODEMS / TEMPLATE.MDM < prev    next >
Text File  |  1994-11-22  |  36KB  |  863 lines
  1. ;                - A SAMPLE MODEM COMMAND FILE -
  2.  
  3. ; Last revision date: 11/22/94
  4.  
  5. ; The modem command files supplied with Lotus Notes (see EOF
  6. ; [Ctrl End] to learn how to obtain modem command files not 
  7. ; yet shipped with this Notes Release) are written to support
  8. ; a variety of modems, incorporating the greatest possible 
  9. ; interoperability between different modem types. If 
  10. ; cross-brand-compatibility is not an issue, users may choose 
  11. ; to edit a command file to optimize it for a particular modem.
  12.  
  13. ; In addition, users can work with a modem for which no command 
  14. ; file is supplied by editing an existing file which uses 
  15. ; similar commands. The fact that Lotus provides command files 
  16. ; for specific modems should not be construed as an endorsement 
  17. ; of a particular brand or model of modem, nor should the 
  18. ; absence of a file be interpreted as a reflection upon any
  19. ; brand or modem. The majority of modems available will work 
  20. ; well with Lotus Notes if the proper commands and responses
  21. ; are used, and new command files are added to the current
  22. ; list regularly.
  23.  
  24. ; This file is a sample provided to help explain the contents of 
  25. ; a Lotus Notes modem command file. The attributes, commands, and 
  26. ; responses shown below are merely examples developed for a 
  27. ; "Hayes compatible" (any modem which uses the standard AT set for 
  28. ; basic commands) 9600 bps modem and should be regarded as examples 
  29. ; only. 
  30.  
  31. ; A Notes modem command file (or .mdm file) serves the purpose 
  32. ; of communicating between the Notes application and the Notes XPC
  33. ; modem driver. It does not talk directly to the modem, that is 
  34. ; done by the XPC driver. A Notes modem command file is a user 
  35. ; editable ASCII text file which, via the XPC driver, automatically
  36. ; performs the same operations which, in a simpler communications 
  37. ; application, the user may perform manually, by typing instructions
  38. ; directly at the keyboard.  In a normally successful call, the flow 
  39. ; of control from the user via the Notes user interface (UI) is as
  40. ; follows:
  41.  
  42. ; UI-> NOTES PRGM-> MDM FILE-> XPC DRIVER-> MODEM <-> REMOTE MODEM
  43.  
  44. ; A typical modem command file is divided into three sections 
  45. ; (four, for the atypical "auto-configure" file auto.mdm--the 
  46. ; install default, described in NOTE[1] at the end of this 
  47. ; document*). Each section begins with the name of the section 
  48. ; enclosed in square brackets (for example: [commands]). 
  49.  
  50. ; All blank lines and lines beginning with a semicolon are 
  51. ; ignored by the Notes XPC driver; they are for better user
  52. ; understanding and readability purposes only. All other lines
  53. ; are either section indicators, or parameters being specified
  54. ; for that section. The format of each parameter specifier
  55. ; depends upon the section in which it appears, but all 
  56. ; parameter specifiers consist of a parameter name followed 
  57. ; by an equal sign (=), followed by a value or values. The values 
  58. ; are all ASCII strings which are used exactly as they are 
  59. ; specified in the command file, with the exception of 
  60. ; "special character" processing. 
  61.  
  62. ; Briefly, there are two special characters, the backslash (\) 
  63. ; and the caret (^). These characters modify the Notes XPC 
  64. ; driver's interpretation of the characters that immediately 
  65. ; follow them. When a given modem uses either of them as part 
  66. ; of a command (for example \B1 or ^C2, as listed in the vendor's 
  67. ; manual), in a Notes command file this special character must 
  68. ; be preceded by a backslash (\\ or \^) in order for the modem
  69. ; not to return an ERROR response. In the examples just given, 
  70. ; the commands must be written \\B1 or \^C2.
  71.  
  72. ; (For more complete information on special character 
  73. ; processing, see the detailed NOTE[2] at the end of this 
  74. ; document.**)
  75.  
  76. ;===============================================================
  77.  
  78. ; In general, any given command file will only contain a 
  79. ; subset of the possible parameters for each section. A fairly
  80. ; complete summary of the sections and their parameters 
  81. ; follows (all normally followed by an equal sign and an
  82. ; XPC-interpetable parameter setting):
  83.  
  84. ; 1.  [attributes] (modem characteristics)
  85. ; MODELS
  86. ; NULL MODEM
  87. ; MAXIMUM SPEED
  88. ; DEFAULT SPEED
  89. ; FIXED SPEED
  90. ; CARRIER CONNECT
  91.  
  92. ; 2.  [commands] (sent by the Notes XPC driver to the modem)
  93. ; ESCAPE
  94. ; ATTENTION
  95. ; INQUIRE
  96. ; HANGUP
  97. ; SETUP
  98. ; RTS/CTS ENABLED
  99. ; RTS/CTS IGNORED
  100. ; VOLUME OFF
  101. ; VOLUME LOW
  102. ; VOLUME MEDIUM
  103. ; VOLUME HIGH
  104. ; ANSWER
  105. ; MANUAL DIAL
  106. ; AUTO DIAL SETUP
  107. ; AUTO PULSE DIAL
  108. ; AUTO TONE DIAL 
  109. ; AUTO DIAL SUFFIX
  110.  
  111. ; 3.  [responses] (sent by the modem to the Notes XPC driver)
  112. ; OK
  113. ; BUSY
  114. ; NO ANSWER
  115. ; NO CARRIER
  116. ; NO DIAL TONE
  117. ; NO DIALTONE
  118. ; ERROR
  119. ; RING
  120. ; CONNECT
  121. ; CARRIER
  122.  
  123. ; 4.  [files] (used during "auto-configure" only)
  124. ; List of files to which the auto-configure file points based 
  125. ; on product code returned after the INQUIRE command (see NOTE[1]*
  126. ; at the end of this document)
  127.  
  128. ;=============================================================
  129.  
  130. [attributes]
  131.  
  132. ; This section of "A Sample Modem Command File" defines the 
  133. ; hardware attributes of the modem. 
  134.  
  135. MODELS=. A Sample Modem Command File
  136.  
  137. ; The MODELS attribute identifies the modem models this 
  138. ; command file controls. The information to the right of the 
  139. ; equal sign of the MODELS attribute is displayed in the Notes
  140. ; "Modem Type" listbox in the "Setup" dialog (in this case,
  141. ; "A Sample Modem Command File", as listed above). The 
  142. ; "MODELS=" information is for display purposes only, and is
  143. ; not used by the software for any other purpose. 
  144.  
  145. NULL MODEM=0
  146.  
  147. ; Setting the NULL MODEM attribute to 1 indicates that there 
  148. ; is no hardware to receive commands or issue responses. 
  149. ; Leaving the NULL MODEM line out or setting it to any other 
  150. ; value indicates that there really is a modem to receive the 
  151. ; commands and issue responses.
  152.  
  153. MAXIMUM SPEED=38400
  154.  
  155. ; The MAXIMUM SPEED attribute specifies the maximum speed 
  156. ; that can be used when the XPC driver is talking to the 
  157. ; modem locally, through the computer's COM port. 
  158.  
  159. ; The actual maximum speed used by the XPC driver is the 
  160. ; lesser of the MAXIMUM SPEED attribute specified in the 
  161. ; command file and the maximum port speed specified in 
  162. ; the UI "Setup" dialog. Command files for modems capable of 
  163. ; on-the-fly data compression (V.42 bis or MNP-5 protocols,
  164. ; for example) generally should have their MAXIMUM and DEFAULT 
  165. ; speeds set higher than the maximum carrier speed, in order 
  166. ; to gain the advantage of such compression.
  167.  
  168. DEFAULT SPEED=38400
  169.  
  170. ; The DEFAULT SPEED attribute is used to help the 
  171. ; software synchronize with the modem. It specifies the 
  172. ; port speed the XPC driver will use to talk to the modem. 
  173. ; The driver may try other speeds while initially trying to 
  174. ; get the modem's attention, but the default speed is the 
  175. ; speed that the driver tries first, and it is the speed that 
  176. ; the driver uses once the modem successfully responds 
  177. ; to the ATTENTION command described below.
  178.  
  179. ; The actual default speed used is the lesser of the 
  180. ; DEFAULT SPEED attribute and the maximum port speed 
  181. ; (see the MAXIMUM SPEED attribute).
  182.  
  183. FIXED SPEED=0
  184.  
  185. ; Needed only in null modem command files (in actual modems,
  186. ; speed should be controlled exclusively by appropriate modem 
  187. ; commands and responses; FIXED SPEED should be set to 0, or
  188. ; left out altogether). If the FIXED SPEED attribute is set 
  189. ; to a numeric value greater than 0, the driver will talk to 
  190. ; the modem at the maximum port speed (see the MAXIMUM SPEED 
  191. ; attribute) and will not adjust the port speed based on the 
  192. ; speed settings in the response parameters (discussed below).
  193.  
  194. CARRIER CONNECT=0
  195.  
  196. ; This attribute, recognized by Notes 3.2 and above on all
  197. ; platforms except the Macintosh (which does not recognize 
  198. ; actual carrier), is designed to allow Notes to recognize the 
  199. ; existence of a valid connection with a remote system on
  200. ; the basis of a high carrier signal from the modem via the
  201. ; RS-232 cable's carrier detect pin. If this attribute is set 
  202. ; equal to 1, any CONNECT responses become superfluous to the 
  203. ; function of Notes, and can be left as is, commented out, or 
  204. ; deleted without effect. The need for the addition of this 
  205. ; feature stems from the increasing use of Notes with assorted 
  206. ; types of "dumb" asynchronous communications equipment which 
  207. ; cannot be programmed to report a connection once achieved.
  208.  
  209. ;================================================================
  210.  
  211. [commands]
  212.  
  213. ; NOTE: Commands in this section are based on the basic AT--for 
  214. ; ATtention--command set developed by Hayes Microcomputer Products 
  215. ; Inc., a defacto standard recognized by most of today's modems, in
  216. ; which all commands are preceded by the letters AT. If your modem 
  217. ; recognizes commands other than Hayes commands, consult your user 
  218. ; manual or your modem vendor for equivalent commands.
  219.  
  220. ; This section lists the commands issued by the driver to the 
  221. ; modem for setup, dialing, etc. Unless otherwise specified, 
  222. ; at least one string should be specified for each command 
  223. ; type, and as many as 15 may be specified for each command 
  224. ; type. There are no defaults directly provided by the XPC driver
  225. ; for any commands, all commands come from the modem command file.
  226.  
  227. ; Note that, confusing though this may appear to the new user,
  228. ; most modems do not recognize commands after a space in a
  229. ; command string.  Thus an array of commands may be concatenated
  230. ; on one line, with no separation between them. To illustrate:
  231.  
  232. ;    ATE0V1
  233.  
  234. ; is actually two AT commands strung together: E0 (local Echo OFF) 
  235. ; and V1 (Verbose mode--or "word" mode--ON). The following string 
  236. ; would be considered illegal by most modems:
  237.  
  238. ;    AT E0 V1
  239.  
  240. ; Ordering of individual commands (e.g. &C1) within a command 
  241. ; file line (or horizontal string) is irrelevant, but all commands
  242. ; of a given type (e.g. ESCAPE, or SETUP) are issued by the Notes 
  243. ; XPC driver to the modem in the order specified (vertically, from
  244. ; the top down, each followed by a carriage return). Thus with the
  245. ; two discrete commands E0 and V1, the string:
  246.  
  247. ;    SETUP=ATE0VI
  248.  
  249. ; is interpreted by Notes and the modem the same as:
  250.  
  251. ;    SETUP=ATV1E0
  252.  
  253. ; would be interpreted. However,
  254.  
  255. ;    SETUP=ATEO
  256. ;    SETUP=ATV1
  257.  
  258. ; is not interpreted the same as:
  259.  
  260. ;    SETUP=ATV1
  261. ;    SETUP=ATEO
  262.  
  263. ; which is read as two discrete commands interpreted separately, 
  264. ; in reverse order to that of the previous set. Knowing this 
  265. ; becomes important when debugging a file which is producing an 
  266. ; error message resulting from issuing conflicting commands in
  267. ; separate command lines--it may be that the actual error is in 
  268. ; a line preceding the one which returns the apparent error.
  269.  
  270. ; The command type appears to the left of the equal sign and 
  271. ; tells the XPC driver which kind of command this is. The 
  272. ; command value appears to the right of the equal sign and is
  273. ; sent by the driver to the modem without case, white space 
  274. ; changes, or other modification; each command value should be 
  275. ; constructed such that it obeys the length, case, and 
  276. ; white-space rules particular to the modem for which the 
  277. ; command file is intended. 
  278.  
  279. ; The maximum number of characters permitted in a command 
  280. ; string can vary from one brand or model of modem to another. 
  281. ; This buffer may be anywhere between 40 and 255 (on a very 
  282. ; old modem the limit might be as low as 25). For ease of 
  283. ; editing, and to be on the safe side, it is advised 
  284. ; that strings to the right of the AT command not exceed 40 
  285. ; (usually more than adequate for normal purposes--if you need
  286. ; to exceed this, begin a new command line, with the command 
  287. ; string preceded by AT).
  288.  
  289. ; Some command strings may contain more than one equal sign. 
  290. ; When this is the case, the first equal sign is treated as 
  291. ; the type/value delimiter (to the Notes XPC driver) and all 
  292. ; additional equal signs are considered as part of the command
  293. ; value to the modem (as with S-Registers, all of which are 
  294. ; phrased as Sn=n, where the first n specifies--stores in a
  295. ; memory "register"--a modem feature setting, and the second
  296. ; letter n quantifies a selected parameter, or bitmaps a 
  297. ; desired group of settings).
  298.  
  299. ESCAPE=+++
  300.  
  301. ; The driver sends the ESCAPE command to put the modem 
  302. ; into command mode. (Only the first ESCAPE command listed 
  303. ; in the command file is sent to the modem. Any subsequent 
  304. ; ESCAPE commands are ignored.) Among modem manufacturers
  305. ; it is customary to use the symbols "+++" for the escape
  306. ; sequence, usually both preceded and followed by a one
  307. ; second delay so as not to confuse the modem into going
  308. ; back into command mode should the actual ASCII characters
  309. ; "+++" be embedded in text which is being transmitted.
  310.  
  311. ; Since this method of escape from online mode is patented
  312. ; by Hayes Microcomputer Products, Inc., a few other modem
  313. ; manufacturers have opted to avoid paying for the license
  314. ; to use this method, and have simply used a "time independent
  315. ; escape sequence" (in which case steps 1 and 3 in the 
  316. ; following paragraphs will not apply, but 2 and 4 remain
  317. ; true).
  318.  
  319. ATTENTION=ATE0V1
  320.  
  321. ; The XPC driver sends the ATTENTION command to elicit a 
  322. ; response from the modem so that the driver knows that it 
  323. ; has synchronized its port speed with the modem.
  324.  
  325. ; If the modem obeys the Hayes patented "time dependent 
  326. ; escape sequence," when the XPC driver tries to get the
  327. ; modem's attention in order to issue modem commands, it 
  328. ; performs the following steps:
  329.  
  330. ; 1. Waits one second.
  331.  
  332. ; 2. Issues the ESCAPE command string (+++) above described
  333. ;    (no response from the modem is required).
  334.  
  335. ; 3. Waits another second.
  336.  
  337. ; 4. Issues the first ATTENTION command listed in the 
  338. ;    command file (in most Notes .mdm command files, 
  339. ;    ATE0V1--ATtention, Echo OFF, Verbal mode ON, which
  340. ;    basic Hayes commands recognized by the vast majority
  341. ;    of modems).
  342.  
  343. ; If the modem responds to the ATTENTION command with 
  344. ; an OK response, the driver sets the modem speed to the 
  345. ; Default Speed (as described in the "attributes" section 
  346. ; above), and then continues with the next ATTENTION 
  347. ; command listed in the command file. If the modem fails
  348. ; to respond with an OK to any ATTENTION command, the
  349. ; driver sets the port to another speed and starts again 
  350. ; at Step 1 (or step 2 if the modem does not employ a time
  351. ; dependent escape sequence).
  352.  
  353. ; The first ATTENTION command is used by Notes to "acquire" 
  354. ; the modem's "attention" and to set the modem speed as 
  355. ; just described. Any additional commands are issued once 
  356. ; the speed has been set. The response to each command is 
  357. ; checked by Notes and any AT command or string resulting 
  358. ; in an ERROR response from the modem (or failure to detect
  359. ; an expected OK response) will cause the escape and
  360. ; synchronization sequence to be resumed. In a perfectly
  361. ; functioning configuration, this process will repeat over
  362. ; and over until dial timeout on a workstation, or until
  363. ; shutdown on a server. In real life, an occasional glitch
  364. ; in CPU timing or brief occurrence of electromagnetic
  365. ; interference (EMI) may cause a problem, thus it makes
  366. ; sense that Notes is programmed to try again in the event
  367. ; of initial failure to get the modem's attention.
  368.  
  369. ; If the Notes log is enabled via the UI, the word "ERROR"
  370. ; will appear in the desktop database log.nsf, Miscellaneous
  371. ; Events view subsequent to the failure point in the
  372. ; initialization attempt.
  373.  
  374. INQUIRE=ATI0
  375.  
  376. ; The INQUIRE command is specified only in the so called 
  377. ; "auto-configure" command files (described more completely in 
  378. ; NOTE[1] at the end of this document*). An auto-configure command 
  379. ; file (such as the auto.mdm) contains an INQUIRE command and a 
  380. ; "[file]" section (described in greater detail later in this 
  381. ; document). When the INQUIRE command is specified in a command 
  382. ; file, the driver issues the command immediately after the 
  383. ; ATTENTION command sequence. The modem's response to the INQUIRE
  384. ; command is used by the XPC driver to identify which of the 
  385. ; .mdm command files listed later in the "files" section of the 
  386. ; auto-configure command file is to be used to control the modem.
  387.  
  388. HANGUP=ATH0
  389.  
  390. ; After the last ATTENTION command (if no INQUIRE command 
  391. ; has been specified) the driver issues the HANGUP commands. 
  392. ; The HANGUP command is needed in case the modem has not yet 
  393. ; hung up from a previous call.  (Since not all modems may
  394. ; respond correctly to a hangup command if there is no current 
  395. ; call in progress, the XPC driver ignores all modem responses
  396. ; to the HANGUP command.)
  397.  
  398. SETUP=AT&F
  399. SETUP=ATE0V1
  400. SETUP=AT&D2&C1S0=00X4
  401.  
  402. ; Next, the driver issues each SETUP command or string in the 
  403. ; order specified in the command file. These commands set up 
  404. ; the modem's basic operating characteristics. The Notes XPC 
  405. ; driver requires that these characteristics include the 
  406. ; following:
  407.  
  408. ; 1. Under normal operation (irrespective of the previous ATH0 
  409. ; command, which forces HANGUP during modem initialization), 
  410. ; the XPC driver hangs up a call by lowering the DTR 
  411. ; (Data Terminal Ready) signal. Therefore, the modem must 
  412. ; be configured so that lowering DTR causes hangup and return 
  413. ; to command state (&D2 or, in a few cases, &D3).
  414.  
  415. ; 2. The modem senses that a call has hung up by noticing 
  416. ; that the carrier signal has dropped. Therefore, the modem 
  417. ; must be set up such that DCD (Data Carrier Detect) tracks 
  418. ; the carrier signal from the remote modem (&C1).
  419.  
  420. ; 3. Auto-answer must be disabled (S0=0). The XPC driver has 
  421. ; been designed to issue an ANSWER command when it 
  422. ; encounters a RING from the local modem. This makes 
  423. ; auto-answer unnecessary. Auto-answer is not desirable 
  424. ; since a modem in this mode will answer a ringing phone 
  425. ; even if the software is not running, thus incurring
  426. ; needless telephone charges. 
  427.  
  428. ; It is recommended that command echoing be disabled (E0), 
  429. ; that factory defaults be set before specifying the above
  430. ; three settings (&F, usually), and that verbose (word)
  431. ; responses be employed by the modem (V1) when working in 
  432. ; Notes Version 2 or later releases.
  433.  
  434. VOLUME OFF=ATM0
  435. VOLUME LOW=ATM1L1
  436. VOLUME MEDIUM=ATM1L2
  437. VOLUME HIGH=ATM1L3
  438.  
  439. ; After the SETUP command, the driver issues one VOLUME 
  440. ; command (M0 or M1). Any additional VOLUME commands listed 
  441. ; in the driver are ignored. 
  442.  
  443. ; The VOLUME command which is issued, either VOLUME OFF, 
  444. ; VOLUME LOW, VOLUME MEDIUM, or VOLUME HIGH (L1, L2, or L3),
  445. ; is set based upon the option specified in the UI "Setup" 
  446. ; dialog.
  447.  
  448. RTS/CTS ENABLED=AT&K3
  449. RTS/CTS IGNORED=AT&K0
  450.  
  451. ; After the VOLUME command sequence, the driver issues 
  452. ; either the RTS/CTS ENABLED or RTS/CTS IGNORED command, 
  453. ; depending upon the option specified in the UI "Setup" 
  454. ; dialog (hardware flow control between computer and
  455. ; modem).
  456.  
  457. ; After the RTS/CTS command, the driver waits either for 
  458. ; an incoming call (i.e., a RING response from the modem) 
  459. ; or for the local software to request a dial. 
  460.  
  461. ; MACINTOSH NOTE: Many Macintosh models do not support 
  462. ; hardware flow control between the computer and the 
  463. ; modem unless a special high-speed serial cable is 
  464. ; employed. Should remote data transfer fail using a 
  465. ; Macintosh, try lowering the speed to the maximum carrier
  466. ; speed possible between the local and remote modems.
  467.  
  468. ANSWER=ATA
  469.  
  470. ; On incoming calls, the driver issues a single ANSWER 
  471. ; command. Any additional ANSWER commands are ignored. 
  472. ; The driver then waits for the modem to respond with a 
  473. ; CONNECT response or with one of the error responses. 
  474. ; All other responses are regarded as merely informational 
  475. ; messages being sent by the modem for logging purposes, 
  476. ; and are ignored.
  477.  
  478. ; There are two types of outgoing calls: Manual and automatic. 
  479. ; Each will be discussed separately.
  480.  
  481. MANUAL DIAL=ATX3S9=1D,
  482.  
  483. ; The XPC driver issues the MANUAL DIAL command when the 
  484. ; user, rather than the modem, does the actual dialing. This 
  485. ; is necessary, for example, whenever operator assistance 
  486. ; is required, or whenever the phone system being used 
  487. ; does not recognize the tones generated by the modem.
  488.  
  489. ; MANUAL DIAL is not available on the server. It may only 
  490. ; be done via the workstation "Call..." option: the user instructs 
  491. ; the software to issue the MANUAL DIAL commands after 
  492. ; hearing the phone ring at the remote modem's end or after 
  493. ; hearing the remote modem generating carrier (depending 
  494. ; on the modem). Since the modem does not do the dialing 
  495. ; in this case, no telephone number will be appended to the 
  496. ; MANUAL DIAL command.
  497.  
  498. ; It has been found that some modems operating in this mode 
  499. ; have special requirements for sensing the carrier signal. 
  500. ; This is the reason for the "S9" setting shown in our example 
  501. ; shown below. 
  502.  
  503. ; Also, this mode requires that the modem must not wait for 
  504. ; the dial tone, as this is done by the user. This is the 
  505. ; reason for the "X3" setting shown in our example (check your
  506. ; modem vendor's manual for a more complete explanation of the 
  507. ; various parameters controlled by the "X" command).
  508.  
  509. ; The driver will issue only the first MANUAL DIAL command 
  510. ; contained in this file. Any additional MANUAL DIAL 
  511. ; commands will be ignored.
  512.  
  513. AUTO DIAL SETUP=ATS9=6
  514. AUTO PULSE DIAL=ATDP
  515. AUTO TONE DIAL=ATDT
  516. AUTO DIAL SUFFIX=,
  517.  
  518. ; Automatic dialing is the only form of dialing used by the 
  519. ; server. It may also be selected by a user at a workstation 
  520. ; via the "Call..." option.
  521.  
  522. ; Before issuing any of the auto-dialing commands, the 
  523. ; driver first initializes the modem, as outlined above, up 
  524. ; to and including the VOLUME command.
  525.  
  526. ; The driver issues each of the SETUP command strings
  527. ; included in the command file, waiting for the modem to issue 
  528. ; an OK response after each string. The driver then 
  529. ; constructs the actual dial command by appending the phone 
  530. ; number to either the AUTO PULSE DIAL or AUTO TONE 
  531. ; DIAL command, and then appending the AUTO DIAL SUFFIX 
  532. ; string. The pulse (ATDP) vs. tone (ATDT) command decision 
  533. ; is based on the dial mode selected via the workstation 
  534. ; Notes UI "Setup" dialog.
  535.  
  536. ; Note that the driver will issue only the first AUTO PULSE 
  537. ; DIAL or AUTO TONE DIAL command contained in the file.
  538. ; Note also that the AUTO DIAL SUFFIX is appended to that 
  539. ; dial command after the phone number, and is not a 
  540. ; separately issued command. It is intended to be used for 
  541. ; dial modifiers. (In the example given, one comma tells the 
  542. ; modem to pause two seconds after dialing, generally to 
  543. ; wait for line "noise" to diminish; this delay may be 
  544. ; extended by additional commas, or removed altogether, 
  545. ; depending on the needs of the local telephone system.)
  546.  
  547. [responses]
  548.  
  549. ; Responses are sent by the modem to the Notes XPC driver.
  550.  
  551. ; The response type appears on the left of the equal sign. 
  552. ; Each response type may be listed more than once, but 
  553. ; not more than 300 times. Ordering is irrelevant. 
  554.  
  555. ; The response value sent by the modem appears to the 
  556. ; right of the equal sign. The response value should be the 
  557. ; exact response issued by the modem (bearing in mind the
  558. ; case and white space sensitivity of the XPC driver). 
  559.  
  560. ; More than one occurrence of each response type may 
  561. ; be included in the command file. For example, some 
  562. ; modems may be set up to respond with either numeric 
  563. ; or word-oriented responses, and each of these responses 
  564. ; may be included in the command file, in the event that 
  565. ; future editors of the command file change the command 
  566. ; set-up string such that V1 (verbose, or word mode) 
  567. ; becomes V0 (terse, or numerical mode).
  568.  
  569. ; Optionally, a comma followed by a port speed may be 
  570. ; included after the response type. Where this occurs, the 
  571. ; driver sets the port to the speed after receiving the 
  572. ; specified response value. This is generally done only 
  573. ; for the CONNECT responses.
  574.  
  575. ; Note: The driver will not set its speed greater than the 
  576. ; value specified in the workstation UI "Setup" dialog.
  577.  
  578. ; Optionally, a comma followed by a carrier speed may 
  579. ; be included after the port speed (with many modems, the 
  580. ; port speed may be left blank). In files for those modems 
  581. ; which respond this way, the Notes XPC driver records the
  582. ; carrier speed for display purposes. This does not affect
  583. ; the port speed; it is generally done only for either 
  584. ; the CONNECT or CARRIER responses.
  585.  
  586. ; All responses received from the modem that are not in this 
  587. ; list are treated as response type INFORMATIONAL, and 
  588. ; are ignored by Notes' XPC driver.
  589.  
  590. OK=OK
  591.  
  592. ; (Verbose, or English word mode.)
  593.  
  594. OK=0
  595.  
  596. ; (Terse, or numeric mode. Required by Lotus Notes 
  597. ; Release 1.0, no longer needed for Release 2.0 and 
  598. ; above, but listed here for informational purposes.)
  599.  
  600. ; The OK response indicates a command correctly processed 
  601. ; by the modem.
  602.  
  603. BUSY=BUSY
  604. BUSY=7
  605.  
  606. ; The modem issues a BUSY response to indicate that the 
  607. ; remote phone was busy following a DIAL command.
  608.  
  609. NO ANSWER=NO ANSWER
  610. NO ANSWER=8
  611.  
  612. ; The modem issues a NO ANSWER response to indicate 
  613. ; that the remote phone did not answer in a reasonable time 
  614. ; (as defined by the modem SETUP commands) following 
  615. ; a DIAL command.
  616.  
  617. NO CARRIER=NO CARRIER
  618. NO CARRIER=3
  619.  
  620. ; The modem issues a NO CARRIER response to indicate that
  621. ; it could not establish a carrier within a reasonable 
  622. ; time (as defined by the modem SETUP commands or by 
  623. ; factory default) after the phone connection was established.
  624.  
  625. NO DIALTONE=NO DIALTONE
  626. NO DIALTONE=NO DIAL TONE
  627. NO DIALTONE=6
  628.  
  629. ; The modem issues a NO DIALTONE or NO DIALTONE response 
  630. ; to indicate that the modem could not detect a valid 
  631. ; dial tone after going off-hook to dial the remote system.
  632.  
  633. ; (Some modems respond with DIALTONE as one word, others 
  634. ; respond with "DIAL TONE". Both are included in many .mdm
  635. ; files to ensure that the XPC driver recognizes the 
  636. ; modem's phrasing in the event no dial tone is sensed,
  637. ; and the occurrence must be reported to the user or 
  638. ; administrator via the Notes program or its log.nsf.)
  639.  
  640. ERROR=ERROR
  641. ERROR=4
  642.  
  643. ; Seen in the Notes log.nsf, ERROR indicates that the modem 
  644. ; did not recognize the command last issued by the XPC driver. 
  645. ; This can result from an incorrect command within the file 
  646. ; (as often happens when the wrong command file is selected 
  647. ; via the Notes UI "Setup" dialog, when writing a file for a 
  648. ; new modem, or when CPU timing glitches or electromagnetic 
  649. ; interference garble the command between computer issuance 
  650. ; and modem receipt of same).
  651.  
  652. RING=RING
  653. RING=2
  654.  
  655. ; The modem issues a RING response locally when its internal 
  656. ; phone is ringing, i.e., upon receiving an incoming phone 
  657. ; call.
  658.  
  659. CONNECT, 38400=CONNECT 38400
  660. CONNECT, 38400=16
  661. CONNECT, 19200=CONNECT 19200
  662. CONNECT, 19200=14
  663. CONNECT, 9600=CONNECT 9600
  664. CONNECT, 9600=12
  665. CONNECT, 4800=CONNECT 4800
  666. CONNECT, 4800=11
  667. CONNECT, 2400=CONNECT 2400
  668. CONNECT, 2400=10
  669. CONNECT, 1200=CONNECT 1200
  670. CONNECT, 1200=5
  671.  
  672. ; The CONNECT responses are generated after a phone 
  673. ; connection has been made (either incoming or outgoing), 
  674. ; a carrier has been established, and any protocols to be 
  675. ; used internally by the modem have been negotiated with 
  676. ; the remote modem. (See NOTE[3] at the end of this 
  677. ; document for further information on CONNECT responses 
  678. ; for Notes Release 3 and later.***)
  679.  
  680. ; Note that the speed indicator to the left of the equal 
  681. ; sign is critical to the XPC driver's setting the port 
  682. ; speed properly.
  683.  
  684. ; Also note that if CARRIER CONNECT in the attributes
  685. ; section is set greater than 0, Notes will ignore all
  686. ; connect responses and will assume a valid connection on
  687. ; the basis of carrier signal alone. The only platform
  688. ; for which this will not be true is the Macintosh, which
  689. ; does not recognize loss of physical carrier.
  690.  
  691. CARRIER,, 9600=CARRIER 9600
  692. CARRIER,, 9600=50
  693. CARRIER,, 4800=CARRIER 4800
  694. CARRIER,, 4800=48
  695. CARRIER,, 2400=CARRIER 2400
  696. CARRIER,, 2400=47
  697. CARRIER,, 1200=CARRIER 1200
  698. CARRIER,, 1200=46
  699.  
  700. ; The CARRIER responses are generated by some modems (notably 
  701. ; Hayes, Practical Peripherals, and others which closely 
  702. ; follow Hayes' lead in AT command format) after the carrier 
  703. ; has been established, either incoming or outgoing. This 
  704. ; response is treated solely as information being sent by 
  705. ; the modem for logging purposes, and the only action taken
  706. ; by the Notes XPC driver is to remember the carrier speed 
  707. ; for display purposes. (This format, which includes the Hayes
  708. ; CARRIER responses, is less common among many other 
  709. ; manufacturers. More commonly the CONNECT syntax is (for 
  710. ; example): CONNECT=38400 (maximum DTE to DCE), 9600 (down 
  711. ; through lowest acceptable link rate--1200 for Notes), 
  712. ; (optionally followed by protocol syntax, e.g.:) 
  713. ; CONNECT 9600 LAP-M (etc.--see NOTE[3] at the end of this 
  714. ; document).  E.g.:
  715.  
  716. ;       CONNECT, 38400,9600=CONNECT 9600 LAP-M
  717.  
  718. ; (Review several non-Hayes Modem Command Files [response] 
  719. ; code sections for a broader overview.)
  720.  
  721. ; Note: The CONNECT speed listed in the I/O log is usually 
  722. ; the speed between a modem and the port it is connected to 
  723. ; (DCE to DTE). These speeds may be different on 
  724. ; modems that can internally buffer the incoming and 
  725. ; outgoing byte streams. In Notes, however, with certain
  726. ; modems, the listed speed may be the DTE speed, depending
  727. ; upon the design of the modem's firmware.
  728.  
  729. ; The carrier speed (also called the "link rate") is the 
  730. ; speed between the two modems over the telephone lines.
  731.  
  732. ; The last line of the command file must be followed by 
  733. ; a carriage return.  It is important to remember this when
  734. ; cutting and pasting a printed .mdm file from a word 
  735. ; processor.
  736.  
  737. ;=============================================================
  738.  
  739. ; * NOTE[1] on INQUIRE command: The following .mdm file section 
  740. ; is included only in the so-named "auto-configure" command 
  741. ; file, i.e., a file which contains an INQUIRE command.  Other 
  742. ; "auto-configured" TARGET command files than those below should
  743. ; never appear under an auto-configured .mdm file's "[file]" 
  744. ; section, since they would only point to yet an additional 
  745. ; command file. 
  746.  
  747. [file]
  748.  
  749. ;GEN12.MDM=12 (for 1200 bps modems)
  750. ;GEN12.MDM=13 (for 1200 bps modems)
  751. ;GEN24.MDM=24 (for 2400 bps modems)
  752.  
  753. ; And for modems that are capable of a carrier speed 4800 bps
  754. ; or greater:
  755.  
  756. ;GEN9614.MDM=9 (for V.32 4800-9600 bps modems)
  757. ;GEN9614.MDM=1 (for V 32.bis 14400 or greater bps modems)
  758. ;GEN9614.MDM=2 (for V.34 28800 bps modems)
  759. ;GEN9614.MDM=3 (for proposed V.34bis 30,000 plus modems)
  760.  
  761. ; The purpose of an auto-configure command file is to allow the 
  762. ; XPC driver to automatically select its "best guess" as to the 
  763. ; command file to be used in controlling the modem based on a 
  764. ; standard AT inquiry command. Among other things, this feature 
  765. ; can allow the modem attached to the port to be changed at any 
  766. ; time (even while Notes is running) without reconfiguring the 
  767. ; port control parameters via the "Setup Modem" dialog. 
  768. ; "Generic" .mdm command files were introduced in Notes 
  769. ; Release 3--see NOTE[3] at the end of this document.***)
  770.  
  771. ; This file section lists the command file to be loaded and used 
  772. ; by the Notes XPC driver based on the modem's response to the 
  773. ; INQUIRE command (ATI or ATI0). When a portion of the response 
  774. ; to the right of the equal sign is detected, the file named to 
  775. ; the left of the equal sign is used. Each command file may be 
  776. ; listed more than once (as with the GEN12.MDM, which might 
  777. ; return from the modem either a 12 or 13 in response to the ATI 
  778. ; command, or GEN9614.MDM which will select the utility generic
  779. ; file for modems which are capable of 4800 bps or greater).
  780.  
  781. ; In an auto-configure .mdm file, the response from the modem 
  782. ; does not have to exactly match the value to the right of the
  783. ; equal sign; the XPC driver reads only the first two digits 
  784. ; of the modem's response. In the example given above, a modem 
  785. ; response of "247" will cause the software to select the 
  786. ; GEN24.MDM command file. This is because, in most cases, the
  787. ; ATI command tells a modem to return the modem's product code, 
  788. ; the first two digits of which normally indicate the maximum
  789. ; carrier speed of which the modem is capable.  (This is not,
  790. ; of course, true of modems capable of better than 9600 bps,
  791. ; for which a correct high-speed file should normally be used.)
  792.  
  793. ;==================================================================
  794.  
  795. ; ** NOTE[2] on Special Characters: There are two special 
  796. ; characters, the backslash (\) and more rarely the caret, or 
  797. ; circumflex (^). These characters modify the interpretation 
  798. ; of the characters which immediately follow them.
  799.  
  800. ; The backslash character (\) is used to specify arbitrary 8 
  801. ; bit values. The three characters following the backslash 
  802. ; must each be digits between 0 and 7, and together 
  803. ; are treated as a 3 digit octal integer. For example, the 
  804. ; sequence \015 is treated as the value 15 (octal) or 13 
  805. ; (decimal) and is equivalent to a carriage return.
  806.  
  807. ; The two exceptions to the standard four character backslash 
  808. ; sequence (for example \015) are the sequences \\ and \^ 
  809. ; which are used to represent, respectively, the backslash 
  810. ; character and the circumflex character.
  811.  
  812. ; Any character following the caret, or circumflex character (^) 
  813. ; will have its bit 6 cleared. For example, the two character 
  814. ; sequence ^M (octal 15) becomes the carriage-return 
  815. ; character (octal 15). This rule is true for all characters 
  816. ; following the circumflex, including the circumflex itself. In 
  817. ; order to include a circumflex character as part of a parameter 
  818. ; value, use the backslash character escape sequence \^.
  819.  
  820. ;=================================================================
  821.  
  822. ; *** NOTE[3] on "Generic" Command Files:
  823.  
  824. ; The Generic 9600 bps Modem Command File (for V2) is intended
  825. ; to be used when no command file currently exists for the 
  826. ; available modem, and a reliable connection cannot be obtained 
  827. ; with command files for modems which seem closest to the model
  828. ; in question. It's possible this file will work as is, with no 
  829. ; editing required. Should initial attempts fail, turn on LOG I/O 
  830. ; and try to determine the problem's source.
  831.  
  832. ; The Generic 9600 bps Modem Command File contains CONNECT 
  833. ; responses phrased in the widest possible variety of ways in 
  834. ; an endeavor to match the exact syntax utilized by many 
  835. ; currently manufactured modems. As the CONNECT response 
  836. ; syntax may vary significantly from modem to modem there 
  837. ; is no guarantee that the result codes listed will prepare 
  838. ; the Notes XPC driver to communicate with an unsupported modem. 
  839. ; If the result codes which your modem "speaks" aren't listed, it 
  840. ; will be necessary to consult the manual or manufacturer for the 
  841. ; proper phrasing.
  842.  
  843. ; The two generic modem command files are listed in the sames Notes
  844. ; listbox as the rest of the modem command files. Highlight them
  845. ; and select Edit to review them.
  846.  
  847.  
  848. ;=============================================================
  849.  
  850. ;  ADDITIONAL LOTUS NOTES MODEM COMMAND FILES NOT SHIPPED WITH
  851. ;  THE POINT RELEASE WITH WHICH YOU ARE CURRENTLY WORKING MAY BE 
  852. ;  OBTAINED THROUGH THE LOTUS "NOTES MOBILE SURVIVAL KIT," A 
  853. ;  CONTINUOUSLY UPDATED LOTUS NOTES DATABASE PUBLISHED VIA:
  854.  
  855. ;  LOTUS NOTES NET (MOST RECENT REPLICA)
  856.  
  857. ;  LOTUS INFORMATION LIBRARY CD (UPDATED MONTHLY)
  858.  
  859. ;  LOTUS RE:QUEST BBS (UPDATED MONTHLY IN PKZIPPED FORM UNDER 
  860.     "NOTES" CATEGORY: DIAL 617-693-7000 WITH ANY COMS PROGRAM
  861. ;    SUCH AS WINDOWS TERMINAL OR PROCOMM)
  862.  
  863. ;  COMPUSERVE (UPDATED MONTHLY IN PKZIPPED FORM; TYPE GO LOTUS)