Usenet 1994 January

home *** CD-ROM | disk | FTP | other *** search

/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / unix / volume26 / pcomm-2.0.2 / part06 / Doc.me

Wrap

Text File | 1993-04-13 | 67.5 KB | 2,638 lines

.\" format this thru tbl and the me macro package. .po 1.0i \" 1 inch page offset .ps 10 \" 10 point type .nh \" no hyphenation .ll 6.5i \" line length (8.5in -1.0in, -1.0in) .nr sf 3 \" section font is bold .nr tf 1 \" title font is roman .\" this macro is used to change the proportional font to 12 pitch .\" some folks may need ".cs CW" in lieu of ".cs R 22" .de CS .cs R 22 .. .\" and this one puts things back .de Cs .cs R .. .tp .sp 7 .CS .(l C PPPPPP CCCC OOOO MM MM MM MM P P C O O M M M M M M M M PPPPPP C O O M M M M M M P C O O M M M M P CCCC OOOO M M M M .)l .Cs .sp 7 .ce 11 Pcomm Reference Manual .sp version 2.0 .sp 3 written by .sp Emmet P. Gray .cc A ...!uunet!uiucuxc!fthood!egray Acc . fthood!egray@uxc.cso.uiuc.edu .ce 0 .sp 6 Pcomm is a public domain telecommunication program for Unix that is designed to operate similarly to the MSDOS program, ProComm. ProComm (TM) is copyrighted by Datastorm Technologies, Inc. This is a completely new program and contains no ProComm source code. This is not a Datastorm product. .bp .oh ''Pcomm Reference Manual'Page %' .eh 'Page %'Pcomm Reference Manual'' .pn 1 .ep .bp .sh 1 INTRODUCTION .(x \*($n INTRODUCTION .)x .lp Pcomm is a public domain, menu driven, telecommunication program designed to provide the same \*(lqease of use\*(rq as similar programs available in MSDOS. Some of its features are: .br .in +0.5i .(b L \(bu Large dialing directory \(bu Full scripting feature \(bu Automatic redial feature \(bu Six built-in file transfer protocols \(bu External file transfer program support \(bu Data logging (log of the terminal session) \(bu Printer logging \(bu Screen dump to a file \(bu Shell escapes to Unix \(bu Help screen \(bu Keyboard macros \(bu User customization \(bu Administrative logging of phone calls \(bu Optional modem configuration per dialing directory entry \(bu Administrative limits on long distance access .)b .in .lp Pcomm does not emulate any particular terminal. Whatever terminal you're on, is what the remote system \*(lqsees\*(rq. .sh 2 Abbreviations .(x \*($n Abbreviations .)x .lp Pcomm uses the notation \*(lq^A-X\*(rq to mean control-A followed by the letter X. The dash (\-) in the notation is just for clarity; it is not included in the actual command sequence. Also, there is no distinction between upper and lower case letters. .lp The following abbreviations appear in Pcomm: .br .in +0.5i .(b L .TS l l. <CR> carriage return key (sometimes labeled Enter) <ESC> escape key <SPACE> space bar <DEL> del key <up> up arrow key <down> down arrow key LF line feed character (control-J) CR carriage return character (control-M) .TE .)b .in .sh 2 Requirements .(x \*($n Requirements .)x .lp Pcomm will not run on terminals with a screen size of less than 80 columns by 24 lines or on terminals that lack cursor movement capabilities. For terminals without arrow keys, use the letter \*(lqU\*(rq in place of \*(lqup arrow\*(rq and the letter \*(lqN\*(rq in place of \*(lqdown arrow\*(rq (the letter \*(lqD\*(rq would have been a more obvious choice, but, unfortunately, it is used elsewhere). .sh 2 "Support files" .(x \*($n Support files .)x .lp Pcomm uses four support files, namely: .br .in +0.5i .(b L .TS l l. pcomm\^.\^dial_dir the dialing directory pcomm\^.\^extrnl the external file transfer programs pcomm\^.\^modem the modem/TTY database pcomm\^.\^param the start-up default parameters .TE .)b .in .lp There is a default directory (typically \*(lq/usr/local/lib/pcomm\*(rq) where the \*(lqstandard\*(rq support files live. Since the average user won't have write permission on these files, it's assumed that they will copy one or more of these standard files to their own directories and edit them to suit their needs. .lp Pcomm can use the environmental variable \*(lqPCOMM\*(rq to search for these \*(lqprivate\*(rq support files. If used, the variable must contain the path to the directory containing the files. You can \*(lqmix and match\*(rq the use of standard and private support files. For example, the pcomm\^.\^modem file is rarely changed by the user so there would be no need to copy that file to the private directory. .lp Pcomm also uses normal Unix shell scripts to perform the \*(lqchat\*(rq sequences necessary to automatically log a user onto a system. .lp The following directories are searched to find the support files and the shell scripts: .br .in +0.5i .(b L 1) directory given with the \*(lq\-d\*(rq option 2) directory in the PCOMM environmental variable 3) the current working directory 4) the default directory (compiled into Pcomm) .)b .in .bp .\" force "chapter" heading to odd page .if e \{ .ep .bp\} .sh 1 "RUNNING PCOMM" .\" put a blank line in the index .(x .)x _ .(x \*($n RUNNING PCOMM .)x .lp Pcomm has the following command line syntax. .sp .in +0.5i .(b L pcomm [\-d directory] [\-f system name] [\-a auxiliary file] .br .ti +\w'pcomm 'u [-e|o|n] [-w word length] [-b baud rate] [-p phone number] .)b .in .lp The \*(lq\-d\*(rq option allows you to specify an additional path to be used when searching for the Pcomm support files. This option is often useful for \*(lqborrowing\*(rq someone else's dialing directory. .lp The \*(lq\-f\*(rq option is used to specify automatic dialing of an entry in the dialing directory. The name field in the dialing directory (described later) is checked against the string given on the command line. If a match is found, that entry is automatically dialed. The match does not consider upper and lower case differences. .lp The \*(lq\-a\*(rq option is used to specify a script file to be \*(lqplayed\*(rq prior to dialing, to specify the TTY to be use, or to specify the modem to be used. This feature can be used to customize Pcomm options or perform unattended operations. .lp The remaining options are used to set the parity, data bits, baud rate, and telephone number from the command line. .br .in +0.5i .(b L .TS l l. \-e Set the parity to even \-o Set the parity to odd \-n Set the parity to none \-w Set the word length (number of data bits) \-b Set the baud rate \-p Dial this number .TE .)b .in .sh 2 "Hot key" .(x \*($n Hot key .)x .lp Pcomm uses a \*(lqhot key\*(rq to precede each command. (The value of the hot key is a user tunable parameter, but for the purpose of this document we'll assume the hot key is defined as control-A). .lp The hot key is used to put Pcomm in the command mode. For example, to get the help screen, you type control-A (to get to the command mode) then the number 0 (to display the help screen). When a command is completed, Pcomm returns to the terminal mode. .lp .ft I NOTE:\ \ While in the command mode, the communication with the remote system is temporarily suspended. .ft .sh 2 "Status line" .(x \*($n Status line .)x .lp Whenever Pcomm is in the command mode (or is not currently connected to a remote) a status line is displayed at the bottom of the screen. A typical status line might look like this: .br .if n .po 0 \" table may be more than 6.5in wide .if n .ll 8.5i .CS .(b L .TS box center; l|l|l|l|l|l|l|l. ^A-0 HELP No TTY FDX 1200 E71 LOG OFF PTR OFF CR CR .TE .)b .Cs .if n .po 1.0i .if n .ll 6.5i .lp The eight fields of the status line are: .br .in +0.5i .(b L \(bu help screen command (or a temporary message) \(bu name of the TTY device in use \(bu duplex mode (FDX = full duplex, HDX = half duplex) \(bu current connection settings (not necessarily DTE speed) \(bu status of data logging option \(bu status of printer logging option \(bu incoming CR translation \(bu outgoing CR translation .)b .in .lp .ft I NOTE:\ \ If the DTE (Data Terminal Equipment) interface speed is locked, the status line will show the \*(lqconnected\*(rq speed rather than the speed of the serial port. .ft .sh 2 "Help screen" .(x \*($n Help screen .)x .lp The help screen gives a brief review of all the available commands. To access the help screen type ^A and \*(lq0\*(rq (zero). The typical help screen will look like this: .br .if n .po 0 \" table may be more than 6.5in wide .if n .ll 8.5i .CS .(b L .TS box center; c s s c c c l l l. .sp P C O M M H E L P .sp _ .sp Major Functions Utility Functions File Functions .sp Dialing Directory. ^A-D Program Info .... ^A-I Send Files .... ^A-<up> Auto Redial ...... ^A-R Setup Screen .... ^A-S Receive Files . ^A-<down> Keyboard Macros .. ^A-M Change Directory. ^A-B Pass Thru Mode. ^A-T Line Settings .... ^A-P Clear Screen .... ^A-C Directory ..... ^A-F Exit Pcomm ....... ^A-X Toggle Duplex ... ^A-E Screen Dump ... ^A-G Unix Gateway ..... ^A-4 Hang Up Phone ... ^A-H Start Data Log. ^A-1 Command Files .... ^A-5 Printer On/Off .. ^A-L Toggle Log .... ^A-2 Toggle CR-CR/LF . ^A-3 Break Key ....... ^A-7 .sp .T& c s s. Press any key to continue .TE .)b .Cs .if n .po 1.0i .if n .ll 6.5i .sh 2 "Exit Pcomm" .(x \*($n Exit Pcomm .)x .lp To exit Pcomm, you type ^A and \*(lqx\*(rq to access the exit window. .br .in +0.5i .CS .(b L .TS box; l. Exit .sp .\" spaces out to here Exit to Unix? (y/n): _ .sp .TE .)b .Cs .in .lp To exit, you press the letter \*(lqy\*(rq (carriage return not required). .bp .if e \{ .ep .bp\} .sh 1 "SETUP SCREENS" .(x .)x _ .(x \*($n SETUP SCREENS .)x .lp Pcomm allows you to change many of the default parameters. The setup screen is accessed by typing ^A and \*(lqs\*(rq. The following screen shows the sub-menu choices: .br .CS .(b L .(c ------------------------- Setup Menu ---------------------------- .sp 1) TTY Setup 2) Modem Setup 3) Terminal Setup 4) General Setup 5) ASCII Transfer Setup 6) External Protocol Setup S) Save setup to disk .sp ----------------------------------------------------------------- OPTION ==> _ Press <ESC> to exit .)c .)b .Cs .lp To select one of the sub-menu choices, you type the number (or letter) at the \*(lqOPTION ==>\*(rq prompt. To exit from a sub-menu and return to this setup menu screen, you press the escape key. .lp Changes made affect the current Pcomm session only. To make the changes become the default, you select the \*(lqs\*(rq option. .sh 2 Prompting .(x \*($n Prompting .)x .lp There are several different types of prompts used in the setup screens. The prompts use the bottom two lines on the display for user input and to give more information on what is being asked. Pcomm will beep at any illegal input. The escape key <ESC> will abort any prompt. The prompt types are: .sp .in +0.5i \(bu Character prompt. Asks you to input a single character. .br .in +\w'\(bu 'u .ti -\w'\(bu 'u \(bu String prompt. Asks you to input a word or group of characters. .in 0.5i .br \(bu Numeric prompt. Asks you for a number. .br .in +\w'\(bu 'u .ti -\w'\(bu 'u \(bu Menu prompt. Shows a selection and allows you to choose the current selection by pressing the carriage return or change the selection by pressing the space bar. .in 0 .sh 2 "TTY setup" .(x \*($n TTY setup .)x .lp The TTY setup allows you to assign the serial ports that Pcomm is allowed to use, and what is attached to each port. A typical TTY setup screen might look like this: .br .CS .(b L .(c -------------------------- TTY Setup ---------------------------- .sp TTY name Modem name Locked speed .sp 1) tty10 HAYES 0 2) tty11 HAYES 0 3) tty12 DIRECT 0 4) tty13 TELEBIT 38400 5) tty13 TELEBIT_V.32 38400 6) tty13 TELEBIT_PEP 38400 7) 0 8) 0 9) 0 10) 0 .sp A) Add a TTY entry D) Delete a TTY entry .sp ----------------------------------------------------------------- OPTION ==> _ Press <ESC> to return .)c .)b .Cs .lp You may edit an entry by typing the entry number at the prompt. To add an entry, you type \*(lqA\*(rq at the prompt, etc. .lp The TTY setup fields are: .ba +0.5i .lp 1) TTY name. This is the name of the serial port that Pcomm will be allowed to use. Notice that the path component of the name, \*(lq/dev/\*(rq is not used. .lp 2) Modem name. This a key word that is used later to link the modem database with the TTY database. The name could be any combination of letters or numbers (both upper and lower case). .lp .ft I NOTE:\ \ All hard-wired ports (ports without modems attached) \fBmust\fP use the word \*(lqDIRECT\*(rq for the modem name. .ft R .lp 3) Locked speed. Normally Pcomm will use the baud rate in the dialing directory when talking to the modem. If the locked speed is non-zero, then the baud rate specified is the only one that will ever be use. The baud rate is selected from a \*(lqmenu prompt\*(rq. See Appendix C for more information about the use of this feature. .lp .ft I NOTE:\ \ It is often best to put the fastest modem/TTYs at the end of the TTY database. .ft .ba .sh 2 "Modem setup" .(x \*($n Modem setup .)x .lp The modem setup contains the commands to make the modem dial, hang up the phone, etc. A typical modem setup screen might look like this: .br .CS .(b L .(c -------------------------- Modem Setup -------------------------- .sp 1) Modem name (1 of 5) ... HAYES 2) Modem init string ..... ATS7=60S11=70E0Q0V1X4&D2! 3) Dialing command ....... ATDT 4) Dialing cmd suffix .... ! 5) Hang up string ........ ~~+++~~ATH0! 6) Auto baud detect ...... Y 7) 300 baud connect ...... CONNECT! 8) 1200 baud connect ..... CONNECT 1200 9) 2400 baud connect ..... CONNECT 2400 10) 4800 baud connect ..... 11) 9600 baud connect ..... 12) 19200 baud connect .... 13) 38400 baud connect .... 14) No connect string 1 ... BUSY 15) No connect string 2 ... VOICE 16) No connect string 3 ... NO CARRIER 17) No connect string 4 ... ----------------------------------------------------------------- OPTION ==> _ Press <ESC> to return .)c .)b .Cs .lp The fields of the modem setup are: .ba +0.5i .lp 1) Modem name. This is the key word that links the modem database with the TTY database. A menu prompt is used to select the modem name (and the remaining parameters that go with it). The \*(lq(1 of 5)\*(rq field indicates there are additional modems in the database. .lp 2) Modem initialization string. This is sent to the modem whenever the port is selected. Consult your modem manual for the codes to be used. Notice the use of the \*(lq!\*(rq character. This is the \*(lqcharacter synonym\*(rq for the carriage return. .lp .ft I NOTE:\ \ See section 3.5 for the complete list of character synonyms. To remove the special meaning of a character synonym, you must prepend a \*(lq\e\*(rq to the character. .ft .lp 3) Dialing command. The first part of the command to make the modem dial. It is assumed that the phone number will immediately follow. .lp 4) Dialing command suffix. The last part of the command to make the modem dial. Typically this will be the carriage return \*(lqcharacter synonym\*(rq. .lp 5) Hang up string. The command to make the modem hang up the phone. The character synonym for a 1 second pause is the tilde \*(lq~\*(rq character. .lp 6) Auto baud detect. Should Pcomm attempt to change the baud rate of the TTY to the baud rate matching the connect string? This feature requires the connect strings to be unique. This does not override the locked speed feature (discussed in section 3.2). .lp 7\-13) Connect strings. The return messages when the modem has connected to the remote. If different messages are returned for each baud rate at which the modem answers, then they should be specified. .lp .ft I NOTE:\ \ Pcomm uses the connect strings to determine which baud rates the modem is capable of supporting. For example, if the 4800 baud connect string is empty, Pcomm assumes the modem can not support 4800 baud. .sp NOTE:\ \ If two connect strings are very similar, (for example, \*(lqCONNECT\*(rq is entirely contained in \*(lqCONNECT 1200\*(rq), it is possible that the return code from the modem will match the incorrect string. To prevent this from happening, use the command synonym for the carriage return to terminate the shorter string (for example, use \*(lqCONNECT!\*(rq instead of \*(lqCONNECT\*(rq). .ft .lp 14\-17) No connect strings. The messages returned by the modem when no connection is made. .ba .sh 2 "Terminal setup" .(x \*($n Terminal setup .)x .lp The terminal setup allows you to define the hot key and the mapping of the end-of-line characters. A typical terminal setup menu will look like this: .br .CS .(b L .(c ---------------------- Terminal Setup --------------------------- .sp 1) Hot key (decimal) ...... 1 2) ASCII version of hot ... ^A .sp 3) Duplex ................. FULL 4) Flow control ........... XON/XOFF 5) CR translation (in) .... CR 6) CR translation (out) ... CR .sp ----------------------------------------------------------------- OPTION ==> _ Press <ESC> to return .)c .)b .Cs .lp The fields in the terminal setup are: .ba +0.5i .lp 1) Hot key. This is the decimal code for the user definable hot key. Consult an ASCII/decimal conversion chart for the decimal values of other characters. .lp 2) ASCII version of hot key. This is the printable version of the hot key used by Pcomm in the help screen and status line. .lp 3) Duplex. A menu prompt is shown to select between FULL duplex and HALF duplex. In the half duplex mode, characters sent to the remote system are also sent to the screen. (The duplex mode can also be changed \*(lqon the fly\*(rq by the ^A-E command.) .lp 4) Flow control. A menu prompt is shown to select between XON/XOFF flow control and NONE. A value of NONE assumes that the hardware (not Pcomm) will perform the flow control. .lp .ft I NOTE:\ \ If your terminal gets \*(lqstuck\*(rq due to a flow control problem, any ^A (hot key) sequence will resume the flow. .ft .lp 5\-6) CR translations. The end-of-line characters for both incoming and outgoing carriage returns can be altered to suit the remote system's needs. A menu prompt provides the following choices: .sp .in +0.5i .nf \(bu CR (no translation) \(bu CR/LF translate CR to CR/LF .fi .in .lp The incoming CR translation can also be changed \*(lqon the fly\*(rq with the ^A-3 command. .ba .sh 2 "General setup" .(x \*($n General setup .)x .lp The general setup allows you to define the character synonyms and the default files used by the screen dump and other features. A typical general setup screen might look like this: .br .CS .(b L .(c ------------------------- General Setup ------------------------- .sp 1) Default log file ....... pcomm.log 2) Screen dump file ....... pcomm.dump .sp 3) Strip high bit ........ YES .sp 4) Pause character ........ ~ 5) CR character ........... ! 6) CTRL character ......... ^ 7) ESC character .......... | 8) Break character ........ % .sp 9) Aborted downloads ...... KEEP .sp 10) Connect delay (sec) .... 35 11) Redial delay (sec) ..... 5 .sp ----------------------------------------------------------------- OPTION ==> _ Press <ESC> to return .)c .)b .Cs .lp The general setup fields are: .ba +0.5i .lp 1) Default log file. The file name to be used as the default when the data logging is activated (^A-1). The log file name can be changed \*(lqon the fly\*(rq by the ^A-1 command. .lp 2) Screen dump file. The file name to be used for the screen dump command (^A-G). .lp 3) Strip high bit. Should Pcomm strip the eighth bit on incoming and outgoing characters? A menu prompt allows you to select YES or NO. This feature is not used during file transfers. .lp 4\-8) Character synonyms. These are symbols that Pcomm uses to represent special characters (or perform special functions) when sending commands to the modem. Synonyms are useful for entering and displaying special characters in a human readable form. The synonyms are: .sp .in +0.5i .nf \(bu Pause for 1 second \(bu The carriage return character (control-M) \(bu Convert the next character to control-xx \(bu The escape character (control-[) \(bu Send a modem break .fi .in .lp .ft I NOTE:\ \ To prevent the special meaning of one of these characters prepend a \*(lq\e\*(rq to it. .ft .lp 9) Aborted downloads. When a download aborts (fails), should the partially completed file be kept? The menu prompt allows \*(lqKEEP\*(rq or \*(lqDELETE\*(rq. .lp 10) Connect delay. The number of seconds Pcomm will wait for the modem to return a status code. .lp 11) Redial delay. The number of seconds to wait before Pcomm tries to call the number again. .ba .sh 2 "ASCII transfer setup" .(x \*($n ASCII xfer setup .)x .lp This setup screen allows you to select options to be used for ASCII uploads and downloads. A typical ASCII transfer setup will look like this: .br .CS .(b L .(c ---------------------- ASCII Transfer Setup --------------------- .sp ASCII UPLOAD .sp 1) Echo locally ........... NO 2) Expand blank lines ..... NO 3) CR delay (ms) .......... 0 4) Pace the output ........ NO 5) CR translation ......... NONE 6) LF translation ......... ADD CR .sp ASCII DOWNLOAD .sp 7) Transfer timeout (sec) . 5 8) CR translation ......... STRIP 9) LF translation ......... NONE .sp ----------------------------------------------------------------- OPTION ==> _ Press <ESC> to return .)c .)b .Cs .lp The fields are: .ba +0.5i .lp 1) Echo locally. This is similar to the duplex option in that it copies outgoing characters to the screen. The options are YES and NO. .lp 2) Expand blank lines. Should a blank line (LF alone) be expanded to a space and LF? Some BBS systems use a blank line to signal the end of an ASCII upload. The options are YES and NO. .lp 3) CR delay. The delay in milliseconds to be used when sending a CR. The menu prompt limits the choice to 0, 100, or 150. .lp 4) Pace output. Should each character sent be delayed? Very old BBS systems may require this. The choice is YES or NO. .lp 5) CR translation. The menu prompt provides the following choices for upload translations: .br .in +0.5i .(b L \(bu NONE (no translation) \(bu ADD LF translate CR to CR/LF \(bu STRIP remove the CR character .)b .in .lp 6) LF translation. Same as above except the choices are: .br .in +0.5i .(b L \(bu NONE (no translation) \(bu ADD CR translate LF to CR/LF \(bu STRIP remove the LF character .)b .in .lp 7) Transfer timeout. The number of seconds to be used to determine the end of an ASCII download. You can halt the transfer before the timer goes off by hitting the <ESC> key. .lp 8\-9) Same as 5) and 6) above, except the translations apply to ASCII downloading. .ba .sh 2 "External protocol setup" .(x \*($n External protocol .)x .lp This setup screen allows you to embed the name of external file transfer programs into the list of available protocols. When transferring files, the external program name will appear on the list of options along with the built-in protocols. .br .CS .(b L .(c -------------------- External Protocol Setup -------------------- .sp UPLOAD .sp Name Command Line Requires file list? 1) zmodem sz Y 2) kermit kermit -ivs Y 3) N .sp DOWNLOAD .sp Name Command Line Requires file list? 4) zmodem rz N 5) kermit kermit -ivr Y 6) N .sp ----------------------------------------------------------------- OPTION ==> _ Press <ESC> to return .)c .)b .Cs .lp To change a line (or add a new one), enter the line number at the prompt. You will be prompted for the Name, the Command Line, and the \*(lqRequires file list?\*(rq flag. To remove an entry, enter a single space character at the Name prompt. .lp The Command Line is the Unix command that you would normally type in to invoke the program (minus the names of the files to be transferred). The last field in the setup is used to indicate whether or not Pcomm should prompt for a list of file names to be added to the command. .lp .ft I NOTE:\ \ Pcomm adds a single space character and the file names (if any) to the end of the command. .sp NOTE:\ \ The program itself isn't \*(lqembedded\*(rq into Pcomm (it still gets called like any other external program), only the name and invocation information is actually incorporated into Pcomm. .ft .bp .if e \{ .ep .bp\} .sh 1 "MAJOR FUNCTIONS" .(x .)x _ .(x \*($n MAJOR FUNCTIONS .)x .lp When Pcomm is invoked without the \*(lq\-f\*(rq or \*(lq\-a\*(rq command line option, you're placed in the terminal mode with a blank screen and a status line. However, since Pcomm hasn't yet selected a serial port to use, characters typed at the blank screen are ignored. Normally the first command you'll use is ^A-D to bring up the dialing directory menu. .sh 2 "Dialing directory" .(x \*($n Dialing directory .)x .lp To dial another system, you type ^A-D to access the dialing directory menu, then enter the entry number at the prompt. .lp The entry number could be preceded by a special long distance dialing code such as \*(lq#5\*(rq in lieu of \*(lq5\*(rq alone. Long distance codes could contain access numbers such as those that MCI and Sprint require. .lp A typical dialing directory will look like this: .br .if n .po 0 \" table may be more than 6.5in wide .if n .ll 8.5i .CS .(b L .TS box center; c s s s s c c r c l l r r c l. .sp D I A L I N G D I R E C T O R Y .sp _ .sp Name Number Baud P D S Dpx Auxiliary 1- Abbey Road 1 (512) 590-6036 2400-N-8-1 F 2- Tel-Med-Com 555-8686 9600-E-7-1 F TELEBIT_V.32 3- C Board 1 (619) 722-8724 2400-N-8-1 F 4- Crest 1 (213) 471-2518 2400-N-8-1 F Sample 5- Last Chance 1 (219) 762-8411 2400-E-7-1 F 6- Killer 1 (214) 827-1994 1200-E-7-1 F 7- System A (direct) 19200-N-8-1 F tty12 8- 1200-E-7-1 F 9- 1200-E-7-1 F 10- 1200-E-7-1 F .sp .T& l s s s s. .nf ==> _ R Revise M Manual Dialing Entry to Dial P LD Codes D Delete Entry <CR> Scroll Down <up>/<down> Page L Print Entries <ESC> Exit .sp LD Codes Active: @ # .fi .sp .TE .)b .Cs .if n .po 1.0i .if n .ll 6.5i .lp The fields of the dialing directory are: .ba +0.5i .lp Name) The name of the remote system. .lp Number) The telephone number to the remote system. .lp .ft I NOTE:\ \ The \*(lq(\*(rq, \*(lq)\*(rq, \*(lq-\*(rq, and space characters are just for looks, and don't get sent to the modem. To prevent the stripping of one of these characters, prepend a \*(lq\e\*(rq to it. .ft .lp Line settings) The communications settings to be used when dialing that entry. The range of values are: .br .in +0.5i .(b L .TS r c c c r l c c. Baud Parity Data bits Stop bits _ 300 N - none 7 1 1200 E - even 8 2 2400 O - odd 4800 9600 19200 38400 .TE .)b .in .lp Duplex) The duplex mode. Either \*(lqF\*(rq for full or \*(lqH\*(rq for half. .lp Auxiliary) This field contains the name of a file which has one of three uses: .lp .in +0.5i 1) A shell script to be used during the auto-login \*(lqchat\*(rq sequence. .br 2) A particular TTY to be used for hard-wired ports. .br 3) A customized modem configuration to be used for the entry. .in .lp .ft I NOTE:\ \ On all hard-wired ports, the script field is used to contain the name of the port. For example, if tty12 is a hard-wired port to \*(lqSystem A\*(rq, then the dialing directory entry for \*(lqSystem A\*(rq will have \*(lqtty12\*(rq in the script field. .ft .lp .ft I NOTE:\ \ The ability to specify a customized modem configuration allows you to tailor each dialing directory entry to meet the peculiar needs of the modem at the other end of the connection. See Appendix C for more details. .ft .ba .lp The commands at the dialing directory prompt are: .ba +0.5i .lp R) Revise (or add) a dialing directory entry or long distance dialing code. Prompts you to save the changes to disk. A typical revise screen would look like this: .br .CS .(b L .TS box center; l. .sp .\" spaces out to here Entry to revise? _ (Entry Number, +,-,@,#) .sp .TE .)b .Cs .lp If a dialing directory entry is selected, each field of the entry is shown with its current settings. You can enter a new value, press a carriage return to skip past a field, or enter a single space character to erase a field. An <ESC> at any field will abort the command. .lp P) Print (display) the long distance dialing codes. .lp <up>/<down>) Scroll the dialing directory up or down 10 lines. Use the up and down arrow keys to access this feature. .lp M) Manual dial. Prompts you for a phone number rather than using a number already in the dialing directory. .lp D) Delete an entry or a range of entries. Prompts you to save the changes to disk. .lp L) Print. Send the dialing directory to the printer or a file of your choice. .lp 1\-100) Entry number. Dial the phone for that entry number. If the script field contains the name of a valid Unix shell script, that script is \*(lqplayed\*(rq after the connection is made to perform the auto-login \*(lqchat\*(rq sequences. See section 8 of this manual for more details on the format and use of script commands. .lp .ft I NOTE:\ \ To access the port directly without dialing (perhaps to send the dial codes yourself), select an empty entry or enter a single space character at the phone number prompt of the manual dial option. .ft .lp <CR> Carriage return. Scroll the dialing directory down one line. .ba .sh 2 Redial .(x \*($n Redial .)x .lp The redial feature is a misnomer; it really is a queuing system that allows Pcomm to dial several numbers in a cycle until one of them answers. .lp When you invoke the redial command with ^A-R, you're prompted for a list of dialing directory numbers. (You may also prepend a long distance code to the entry number). .br .CS .(b L .TS box center; l. Redial Queue .sp .\" spaces out to here Directory Entry Number(s): _ .sp .T& c. (<CR> for previous numbers) .TE .)b .Cs .lp To redial the previous number, press a carriage return alone at the prompt. An <ESC> aborts this command. .sh 2 "Keyboard macros" .(x \*($n Keyboard macros .)x .lp Keyboard macros are used as a shortcut to send commonly used strings to the remote system with only a few keystrokes. The characters used to identify the macros are the shifted number keys. For example, if the string \*(lqls -alRF \e| more!\*(rq was assigned to the \*(lq!\*(rq key (the shifted number 1 key), then when you press ^A-!, the string \*(lqls -alRF | more\*(rq is sent to the remote (followed by a <CR> because of the \*(lq!\*(rq character synonym). Notice the use of the \*(lq\e\*(rq character to remove the special meaning of the \*(lg|\*(rq character synonym. .lp To review or edit the keyboard macros, you type ^A-M. The following screen will appear: .br .CS .(b L .TS box center; c l. Keyboard Macros .sp _ .sp .\" spaces out to here ^A-! ls -alRF \e| more! ^A-@ ^A-# ^A-$ ^A-% ^A-^ ^A-& ^A-* ^A-( ^A-) .sp Macro key to revise: _ .sp .T& c. Press <ESC> to continue .TE .)b .Cs .lp To edit a macro, you type the macro key character (without the leading hot key). After typing the new string information, you will be prompted to save the changes to disk. To erase an entry enter a single space character. .lp .ft I NOTE:\ \ All of the character synonyms described in section 3.5 are available for use with the keyboard macros. .ft .sh 2 "Line settings" .(x \*($n Line settings .)x .lp The line settings menu is invoked by ^A-P. A typical line settings menu will look like this: .br .CS .(b L .TS box center; c l. Line Settings _ .sp Current Settings: 1200,E,7,1 .sp 1) 300,E,7,1 8) 300,N,8,1 2) 1200,E,7,1 9) 1200,N,8,1 3) 2400,E,7,1 10) 2400,N,8,1 4) 4800,E,7,1 11) 4800,N,8,1 5) 9600,E,7,1 12) 9600,N,8,1 6) 19200,E,7,1 13) 19200,N,8,1 7) 38400,E,7,1 14) 38400,N,8,1 .sp Parity Data Bits Stop Bits 15) Odd 16) 7 bits 18) 1 bit 17) 8 bits 19) 2 bits .sp 20) Save Changes YOUR CHOICE: _ .sp .T& c. Press <ESC> to return .TE .)b .Cs .lp While dialing a remote, the line settings in the dialing directory entry are automatically used. Therefore the line settings menu is used to fine tune the values during a terminal session or to select the parameters for manual dialing. You can make the current setting the default by selecting the \*(lqSave Changes\*(rq option. .lp The current line settings are also displayed in the status line. .lp .ft I NOTE:\ \ During file transfers, certain parameters (namely the data bits and parity) will be temporarily changed. The status line will \fBnot\fP reflect these temporary promotions. .ft R .sh 2 "Exit Pcomm" .(x \*($n Exit Pcomm .)x .lp To exit Pcomm, you type ^A-X. The phone is hung up (if a call was in progress), the print and data logging features are closed, and the TTY resources are released. .lp .ft I NOTE:\ \ Pcomm drops the DTR (Data Terminal Ready) on the port before exiting to Unix. .ft .sh 2 "Unix gateway" .(x \*($n Unix gateway .)x .lp To temporarily suspend Pcomm and spawn a Unix shell, you type ^A-4. To return to Pcomm, you exit the shell normally, typically with ^D or \*(lqexit\*(rq. .lp .ft I NOTE:\ \ The SHELL environmental variable is used to determine which program to invoke. .ft .sh 2 "Command files" .(x \*($n Command files .)x .lp Command files (shell scripts) can be invoked by typing ^A-5 to automate keyboard input and to perform Pcomm command sequences. The following window will prompt for the file name. .br .CS .(b L .TS box center; l. Command Files .sp .\" spaces out to here Shell script: _ .sp .TE .)b .Cs .lp The use of shell scripts is discussed in section 8. .bp .if e \{ .ep .bp\} .sh 1 "UTILITY FUNCTIONS" .(x .)x _ .(x \*($n UTILITY FUNCTIONS .)x .lp The following commands perform secondary functions. .sh 2 "Program information" .(x \*($n Program info .)x .lp To display the opening information screen, you type ^A-I. Press any key to return to the terminal mode. .sh 2 "Setup screen" .(x \*($n Setup screen .)x .lp The setup screens are described in detail in section 3 of this manual. .sh 2 "Change directory" .(x \*($n Change directory .)x .lp To change the current working directory while still inside Pcomm, you type ^A-B. A screen similar to the following will appear: .br .CS .(b L .TS box center; l. Change Directory .sp .\" spaces out to here Current directory: /usr/egray New directory: _ .sp .TE .)b .Cs .lp Abbreviations known to the shell are acceptable; for example, the \*(lq~\*(rq character will be translated to the home directory in the csh or ksh shell. .sh 2 "Clear screen" .(x \*($n Clear screen .)x .lp To clear the local screen and home the cursor, you type ^A-C. .lp .ft I NOTE:\ \ The remote system may not \*(lqknow\*(rq the screen has been cleared, and may make assumptions about the screen that are incorrect. .ft .sh 2 "Toggle duplex" .(x \*($n Toggle duplex .)x .lp The ^A-E command changes the duplex mode from FULL to HALF, or from HALF to FULL. The status line shows the current duplex mode. Use the Terminal Setup to make permanent changes to the duplex mode. .sh 2 "Hang up the phone" .(x \*($n Hang up the phone .)x .lp To hang up the phone, you type ^A-H. The word \*(lqdisconnecting\*(rq will briefly show in the status line. .lp .ft I NOTE:\ \ Pcomm does not drop the DTR (Data Terminal Ready) during the hang up. .ft .sh 2 "Printer logging" .(x \*($n Printer logging .)x .lp The ^A-L command toggles the printer logging on or off. The current printer status is displayed in the status line. .lp .ft I NOTE:\ \ Since all printing goes to the normal Unix print spool program, the characters will not print on the printer as they appear on the screen. The printing will actually begin when the printer logging is turned \fBoff\fP and the complete print job is sent to the spool. .ft R .sh 2 "Toggle CR \- CR/LF" .(x \*($n Toggle CR \- CR/LF .)x .lp The ^A-3 command toggles the incoming line termination characters between CR and CR/LF. The status line shows the current settings (in the next to the last field). .sh 2 "Break" .(x \*($n Break .)x .lp The ^A-7 command sends a modem break to the remote system. The word \*(lqbreak\*(rq is (very) briefly displayed on the status line. .lp .ft I NOTE:\ \ This not the same as the break key on the keyboard (we don't want to send a break to the local system, we want to send it to the \fBremote\fP system). .ft R .bp .if e \{ .ep .bp\} .sh 1 "FILE FUNCTIONS" .(x .)x _ .(x \*($n FILE FUNCTIONS .)x .lp One of the most important features of a telecommunication program is the ability to transfer files. The following file transfer protocols are implemented: .br .in +0.5i .(b L .TS l l l l. Protocol Packet Error Multiple name size detection files? _ xmodem 128 checksum/CRC no xmodem-1k 128/1024 checksum/CRC no modem7 128 checksum yes \u1\d ymodem 128/1024 CRC yes \u2\d ymodem-g 128/1024 none \u3\d yes ASCII none none no zmodem \u4\d 128/1024 CRC yes (external) ? ? ? .TE .TS l l. Notes: 1 CP/M style file name 2 MSDOS style file name and file size 3 Not needed! 4 zmodem is implemented as an external program .TE .)b .in .lp .ft I NOTE:\ \ The built-in protocols that send file name information, convert the Unix style file name to fit the MSDOS name restrictions. .ft .sh 2 "External protocols" .(x \*($n External protocols .)x .lp The external \*(lqprotocol\*(rq is really a method of running an external program from Pcomm to accomplish a file transfer. The most common use of this feature would be to run Kermit or some proprietary program. .lp Frequently used external file transfer programs (such as zmodem) can have their names embedded into the list of available protocols by using the External Protocol Setup in section 3.7. .lp To abort an external file transfer, you hit the <ESC> key. All other characters typed at the keyboard are ignored. .lp .ft I NOTE:\ \ The external protocol feature can also be used to pipe the output of a Unix command to the remote. .ft .sh 2 "Send files" .(x \*($n Send files .)x .lp To send a file to the remote, you'll first have to instruct the remote system to receive the file, then type ^A-\*(lqup arrow\*(rq. The following screen will appear: .br .in 3.2i .CS .(b L .TS box; c l. Upload .sp 1) xmodem 2) xmodem-1k 3) modem7 4) ymodem 5) ymodem-g 6) ASCII 7) zmodem 8) kermit E) (external) .sp <ESC> to Abort .sp Protocol: _ .sp .TE .)b .Cs .in .lp You then select the type of protocol at the prompt, and another window similar to this will appear: .br .CS .(b L .TS box center; l. Send xmodem .sp .\" space out to here Enter filename: _ .sp .TE .)b .Cs .lp Now you type in the file name or names you'd like to send. Wildcards known to the shell are acceptable. .lp Now the file transfer actually begins. A screen similar to the following is displayed during the transfer: .br .in 2.4i .CS .(b L .TS box; c n. Uploading .sp .\" spaces out to here Protocol\&: xmodem File name\&: main.c File size\&: 4420 Error check method\&: CRC Est transfer time\&: 0:00:50 Block count\&: 5 Percent complete\&: 11.2% Bytes transferred\&: 640 Errors this block\&: 0 Total error count\&: 0 Last message\&: NONE .sp .T& c. Press <ESC> to abort .TE .)b .Cs .in .lp As the transfer progresses, the \*(lqblock count\*(rq, \*(lqpercent complete\*(rq, and \*(lqbytes transferred\*(rq fields will be continuously updated. If errors occur the \*(lqerrors this block\*(rq and \*(lqtotal error count\*(rq fields will be updated and the \*(lqlast message\*(rq field will contain a message about the error. .lp At the end of the transfer, Pcomm will beep and return to the terminal mode. If an error occurred and the transfer was aborted, you will be prompted to acknowledge the error by pressing a key before returning to the terminal mode. .sh 2 "Receive files" .(x \*($n Receive files .)x .lp To receive a file (or group of files) from a remote system, you'll have to first instruct the remote system, then type ^A-\*(lqdown arrow\*(rq. Receiving a file is basically the same as sending a file. .lp .ft I NOTE:\ \ Some systems do not pad the end of the file with control-Z's and therefore files might grow in length when received. .ft .sh 2 "Pass thru mode" .(x \*($n Pass thru mode .)x .lp The pass through mode is used when you have two or more machines in a communications daisy chain. The following diagram shows an example of this type of arrangement: .br .in +0.5i .(b L .TS |c|c|c|c|c|. _ _ _ IBM PC Unix IBM PC running <---- running <---- running ProComm ----> Pcomm ----> RBBS _ _ _ .TE .)b .in .lp If a file is to be transferred from the last machine to the first machine, the middle machine must appear completely transparent. The middle machine must \*(lqforward the data\*(rq without altering it in any way. The pass through mode \*(lqexpires\*(rq after a designated period of inactivity, after which the user is returned to the terminal mode. .lp To access the pass through mode, you type ^A-T. The following screen will appear: .br .CS .(b L .TS box center; l. Pass Thru Mode .sp .\" spaces out to here Enter the expiration time (5-60 sec) : _ .sp .TE .)b .Cs .lp .ft I NOTE:\ \ While in the pass through mode, no Pcomm command to the middle machine will be honored. Therefore, the \fBonly\fP way to exit this mode is to not type anything on the keyboard until the expiration period has elapsed. .sp NOTE:\ \ The baud rates to and from the middle machine need not be the same, however the slowest speed determines the overall speed of the transfer (the weakest link in the chain). .ft R .sh 2 Directory .(x \*($n Directory .)x .lp To obtain a listing of a directory on the local system while still running Pcomm, you type ^A-F. The following screen will appear: .br .CS .(b L .TS box center; l. List Directory .sp .\" spaces out to here Current directory: /usr/egray File spec (wildcards allowed): _ .sp .TE .)b .Cs .lp Abbreviations known to the shell are valid. Output is sent through a \*(lqmore\*(rq like program. .lp .ft I NOTE:\ \ Since we're really doing a popen() to the \*(lqls\*(rq command, additional command line options are also valid. .ft .sh 2 "Screen dump" .(x \*($n Screen dump .)x .lp To dump the contents of the current screen (minus any windows showing) you type ^A-G. The contents of the screen are written to the file specified in the general setup for this purpose. If the file already exists, the screen contents are appended to the file. The message \*(lqscreen dump\*(rq will briefly appear in the status line. .lp .ft I NOTE:\ \ The screen contents are subject to the available VCS (video command sequence) emulation, so an exact representation is not guaranteed. .ft .sh 2 "Start data logging" .(x \*($n Start data logging .)x .lp To start the data logging, or change the file used for data logging, you type ^A-1. The following screen will appear: .br .CS .(b L .TS box center; l. Start Data Logging .sp .\" spaces out to here Default log file: pcomm.log New log file: _ .sp .TE .)b .Cs .lp To keep the default file, just press a carriage return at the prompt, otherwise, enter a new file name. If the file already exits, the new data is appended to the file. .lp The status of the logging is shown in the status line. .lp .sh 2 "Toggle logging" .(x \*($n Toggle logging .)x .lp To temporarily suspend data logging or to start it again without being prompted for the file name, you type ^A-2. .bp .if e \{ .ep .bp\} .sh 1 "DIALING WINDOW" .(x .)x _ .(x \*($n DIALING WINDOW .)x .lp While Pcomm is dialing another system, a screen similar to the following is shown: .sp .if n .po 0 \" table may be wider than 6.5in .if n .ll 8.5i .CS .(b L .TS box center; c n. .sp D I A L I N G W I N D O W .sp _ .sp .\" spaces out to here System name\&: C Board Pass number\&: 1 Elapse time this try\&: 4 Time at start of dial\&: 14:53:36 Time at start of this try\&: 14:53:36 Connect delay time\&: 35 Redial delay time\&: 5 Auxiliary\&: Result of last try\&: .T& c. .sp <SPACE>: Recycle <DEL>: Remove from queue E: Change delays .sp Press <ESC> to abort .TE .)b .Cs .if n .po 1.0i .if n .ll 6.5i .lp Items in the window are continuously updated to show the progress of the dialing attempt. .lp The options available during the dialing window are: .ba +0.5i .lp SPACE) Press the space bar to stop the dialing of the current entry and go on to the next entry in the queue. If there is only one entry in the queue, that number is redialed. .lp DEL) Press the DEL key to remove the current number from the queue. .lp E) Press the letter \*(lqE\*(rq to change the connect delay time, or the redial delay time (the pause between dialing attempts). You will be prompted to save the changes to disk. .lp .CS .(b L .TS box center; l. Change Delay Times .sp .\" spaces out to here Current connect delay time: 35 Current redial delay time: 5 .sp New connect delay: _ New redial delay: .sp .TE .)b .Cs .ft I NOTE:\ \ While the DEL and E options are being processed, the dialing is temporarily suspended. .ft .ba .bp .if e \{ .ep .bp\} .sh 1 "SCRIPT COMMANDS" .(x .)x _ .(x \*($n SCRIPT COMMANDS .)x .lp Pcomm doesn't have a built-in script language, instead it uses Unix shell scripts (Bourne shell, C shell, Korn shell, etc) to perform the necessary \*(lqchat\*(rq sequences to log a user on to a remote system. .lp Since shell scripts are run \*(lqoutside\*(rq of Pcomm, the \*(lqpcomm_cmd\*(rq program is used to transmit command sequences to Pcomm. For example, a script can contain a line such as \*(lqpcomm_cmd data_log on\*(rq to turn on the data logging feature. .lp Shell scripts specified in the dialing directory are run \fBafter\fP the connection to the remote system, while script specified on the command line (with the \-a option) are run \fBbefore\fP the connection is made. You can make a shell script work under both situations by using the \*(lqpcomm_cmd is connected\*(rq command. See the third example in section 8.4. .lp You may hit the <ESC> key at any time to abort an auto-login script before it has completed. .lp .ft B WARNING:\ \ Any file that has a \*(lqclear text\*(rq (un-encrypted) version of your password is a significant security threat. You should remove the read permission to all others. .ft .lp In order to assist in the creation of auto-login scripts, the following external programs have been provided. .sh 2 "Pcomm_cmd command" .(x \*($n Pcomm_cmd command .)x .lp Pcomm_cmd is an external Pcomm support program. It is used from inside shell scripts to access Pcomm commands, such as \*(lqpcomm_cmd send xmodem junk\*(rq for sending the file \*(lqjunk\*(rq to the remote using the xmodem file transfer protocol. .lp The following command line options are supported. .in +1.0i .sp .ti -0.5i SET BAUD [ 300 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 ] .br Set the baud rate for the current connection. This feature is for use with the DIAL MANUAL command, since the baud rate information in the dialing directory entries overrides this value. .sp .ti -0.5i SET PARITY [ EVEN | ODD | NONE ] .br Set the parity for the current connection. For use with the DIAL MANUAL command. .sp .ti -0.5i SET DATA_BITS [ 7 | 8 ] .br The number of data bits (word length) used for the current connection. For use with the DIAL MANUAL command. .sp .ti -0.5i SET STOP_BITS [ 1 | 2 ] .br The number of stop bits for the current connection. For use with the DIAL MANUAL command. .sp .ti -0.5i SET DUPLEX [ HALF | FULL ] .br Set the duplex mode (local echo). The HALF option is used if the remote system does not echo characters as they are typed. .sp .ti -0.5i SET AUX filename .br Use the argument as the auxiliary file associated with the current connection. Since chaining of scripts is not supported, this feature would only be used to set the TTY or modem. .sp .ti -0.5i SET HOT_KEY [1-256] .br Change the decimal value of the \*(lqhot key\*(rq to this value. .sp .ti -0.5i SET ASCII_HOT string .br Change the ASCII representation of the hot key to the given argument. The length of the string must be no more than 4 characters wide. .sp .ti -0.5i SET FLOW_CTRL [ XON/XOFF | NONE ] .br Set the flow control between the local and remote systems to either XON/XOFF or NONE. .sp .ti -0.5i SET CR_IN [ CR | CR/LF ] .br Translate in-comming carriage returns carriage return followed by a line feed, or pass the carriage return through unchanged. .sp .ti -0.5i SET CR_OUT [ CR | CR/LF ] .br Translate out-going carriage returns to CR or CR/LF. .sp .ti -0.5i SET LOGFILE filename .br Change the name of the default log file. For use with the DATA_LOG command. .sp .ti -0.5i SET DUMPFILE filename .br Change the name of the screen dump file. For use with the SCREEN_DUMP command. .sp .ti -0.5i SET STRIP [ YES | NO ] .br Should the in-comming data be stripped to 7 bits? .sp .ti -0.5i SET LOCAL_ECHO [ YES | NO ] .br Should data be shown on the screen during ASCII uploads? .sp .ti -0.5i SET EXPAND [ YES | NO ] .br Should blank lines be \*(lqexpanded\*(rq to a line with a single space? For use only during ASCII uploads. .sp .ti -0.5i SET CR_DELAY [ 0 | 100 | 150 ] .br Set the delay for the carriage returns for ASCII uploads. .sp .ti -0.5i SET PACE [ YES | NO ] .br Should the entire upload be artificially slowed down? For use during ASCII uploads. .sp .ti -0.5i SET CR_UP [ NONE | ADD_LF | STRIP ] .br Controls the translation of carriage returns during ASCII uploads. .sp .ti -0.5i SET LF_UP [ NONE | ADD_CR | STRIP ] .br Controls the translation of line feeds during ASCII uploads. .sp .ti -0.5i SET TIMER [5-150] .br Controls the timer (in seconds) that detects the end of an ASCII download. .sp .ti -0.5i SET CR_DN [ NONE | ADD_LF | STRIP ] .br Controls the translation of carriage returns during ASCII downloads. .sp .ti -0.5i SET LF_DN [ NONE | ADD_CR | STRIP ] .br Controls the translation of line feeds during ASCII downloads. .sp .ti -0.5i QUERY TTY_NAME .br Returns the name of the current TTY in use or NONE. .sp .ti -0.5i QUERY MODEM_NAME .br Returns the name of the current modem in use or NONE. .sp .ti -0.5i IF CONNECTED .br Returns a 1 if Pcomm is currently connected to a remote, otherwise a 0. .sp .ti -0.5i IF LOG_STATUS .br Returns a 1 if the data logging feature is turned on, otherwise 0. .sp .ti -0.5i IF PRINTER_STATUS .br Returns a 1 if the printer is turned on, otherwise 0. .sp .ti -0.5i DIAL [ MANUAL phone_number ] entry_number .br Dial an entry from the dialing directory. The MANUAL option is used to optionally dial a phone number without the use of the dialing directory. DIAL returns after 1 attempt. A return code of 1 means a connection was made. .sp .ti -0.5i REDIAL entry_number .br Similar to the DIAL command, but 10 attempts are made. .sp .ti -0.5i EXIT .br Hang up the phone and exit from Pcomm. .sp .ti -0.5i CLEAR_SCREEN .br Clear the screen. .sp .ti -0.5i CHG_DIR directory .br Change the current working directory to the given directory. .sp .ti -0.5i HANG_UP .br Hang up the phone, but remain in Pcomm. .sp .ti -0.5i PRINTER [ ON | OFF ] .br Control the logging of data to the printer. .sp .ti -0.5i MODEM_BREAK .br Send a modem break to the remote system. This is typically used to tell the remote to switch to a different baud rate. .sp .ti -0.5i SEND protocol filename .br Send a file to the remote. The valid protocols are XMODEM, XMODEM_1K, MODEM7, YMODEM, YMODEM_G, ASCII, EXT_1, EXT_2, and EXT_3. .sp .ti -0.5i RECEIVE protocol filename .br Receive a file from the remote. The valid protocols are XMODEM, XMODEM_1K, MODEM7, YMODEM, YMODEM_G, ASCII, EXT_1, EXT_2, and EXT_3. .sp .ti -0.5i SCREEN_DUMP .br Dump the current contents of the screen to the DUMPFILE. If the file already exists, the new contents are appended to the file. .sp .ti -0.5i DATA_LOG [ ON | OFF ] .br Control logging of the terminal session to the LOGFILE. If the file already exists, the new contents are appended to the file. .in .sh 2 "Waitfor command" .(x \*($n Waitfor command .)x .lp The waitfor command has the following syntax: .sp .in +0.5i waitfor \-n string .in .lp where \*(lqn\*(rq is the number of seconds to wait and \*(lqstring\*(rq is the string to wait for. .lp Waitfor returns a 0 if the string was found, a 1 if it didn't find the string within the allotted time, and a \-1 if there was an error. Waitfor returns immediately if the string is found. .lp The waitfor command would typically be used in a script to indicate that the desired prompt has appeared. For example: .sp .in +0.5i .CS .(b L waitfor \-5 "ogin:" if [ "$?" \-eq 0 ] then .in +0.5i echo "egray" .in fi .)b .Cs .in .lp would wait up to 5 seconds for the string \*(lqogin:\*(rq. If the return code is 0 (the strings did appear), send the string \*(lqegray\*(rq (my user ID). .lp .ft I NOTE:\ \ Upper and lower case letters are considered different. If you are not sure if the prompt is \*(lqLogin:\*(rq or \*(lqlogin:\*(rq, then skip the first letter in the string and use \*(lqogin:\*(rq. .ft .sh 2 "Matches command" .(x \*($n Matches command .)x .lp The matches command has the following syntax: .in +0.5i .sp matches string1 string2 .in .lp Matches returns a 0 if string2 is contained in string1, and returns a 1 if it does not. Unlike waitfor, the matches command does not read the TTY port. .lp The matches command could be used to test string values such as: .sp .in +0.5i .CS .(b L read junk matches $junk "login failed" if [ "$?" \-eq 0 ] then .in +0.5i exit .in fi .)b .Cs .in .sh 2 "Examples" .(x \*($n Examples .)x .lp It is not my intention to teach the reader the fundamentals of Unix shell programming. There are several good books on the subject available in stores. .lp Remember to add execute permission to the file and remove the read permission to all others. .lp .(b L The simplest auto-login script may contain the following: .sp .in +0.5i .CS # send a <CR> echo "" # wait 5 seconds for the login prompt waitfor \-5 ogin: # send my user ID echo "egray" # wait 5 seconds for the password prompt waitfor \-5 assword: # send my password echo "abcdefg" # return to Pcomm exit 0 .Cs .)b .in .lp .(b L A more complex script is required if the user must send a modem break to synchronize the baud rate of the remote. For example: .sp .in +0.5i .CS echo "" try=0 # loop until done while true do .in +0.5i # wait 5 seconds for the login prompt waitfor \-5 ogin: # test the exit code of the waitfor command if [ "$?" \-eq 0 ] then .in +0.5i # send my user ID and exit the loop echo "egray" break .in fi .sp # increment the number of attempts try=\`expr $try + 1\` # test to see if we should give up if [ "$try" \-eq 5 ] then .in +0.5i exit 1 .in fi .sp # send a modem break and loop again pcomm_cmd modem_break echo "" .in 0.5i done # wait 5 seconds for the password prompt waitfor \-5 assword: # test the return code from waitfor if [ "$?" \-eq 0 ] then .in +0.5i # send my password echo "abcdefg" .in else .in +0.5i exit 1 .in fi # return to Pcomm exit 0 .Cs .)b .in 0 .lp .(b L The following is an example of a shell script that will dial a system, log a user on, transfer a file called junk using xmodem, log out, and exit Pcomm. .sp .in +0.5i .CS # are we already connected? answer=`pcomm_cmd if connected` if [ "$answer" -eq 0 ] then .in +0.5i # dial entry number 23 in my dialing directory pcomm_cmd dial 23 .in -0.5i fi # wait for the login prompt waitfor ogin: # send my user id echo egray # wait for the password prompt waitfor assword: # send my password echo abcdefg # wait for a Unix prompt waitfor $ # start up an xmodem file transfer echo sx junk # wait for the sx command to say its ready waitfor now sleep 1 # do a file transfer pcomm_cmd receive xmodem junk # wait for the prompt waitfor $ # log me out echo "^D" sleep 1 # exit pcomm pcomm_cmd exit .Cs .)b .in 0 .bp .if e \{ .ep .bp\} .uh "Appendix A \- Typical Modem Configuration" .(x .)x _ .(x Appendix A \- Typical Modem Configuration .)x .lp I can't begin to describe how to configure every modem to work with Pcomm. There are, however, several guidelines that will apply to virtually any modem. .ba +0.5i .lp 1) Pcomm doesn't care about the DCD (Data Carrier Detect) settings of the modem. .lp 2) It would be nice (but not essential) if the loss of the DTR (Data Terminal Ready) caused the modem to hang up. .lp 3) Pcomm doesn't care if commands are echoed back by the modem (it might save a few milliseconds if echoing was turned off). .lp 4) Some sort of result codes are required. Numeric result codes are ok... but since they are displayed on the screen, word result codes will make more sense. .lp 5) If the modem can return different result codes for each baud rate at which it answers, then by all means, use them. Match the odd-ball codes (such as CONNECT FAST for Telebit PEP) to the closet matching speed. .lp 6) Anything that is returned by the modem, but not listed in the modem setup, is ignored. .lp 7) Systems running older versions of uugetty (the bi-directional version of getty that comes with HDB uucp) may require extra commands in the initialization string to assure that uugetty switches to its dial out mode. Normally, \*(lqAT!~AT!~\*(rq causes enough dialogue to force uugetty to release the line. .ba .lp For example, a 2400 baud Hayes compatible modem might be configured with the following command: .sp .in +0.5i .nf AT\ S7=60\ S11=70\ E0\ Q0\ V1\ X4\ &D2 .fi .in +0.5i .(b L .TS l l. AT Hayes attention command S7=60 Wait 60 seconds for an answer S11=70 70 ms touch tone dialing E0 Don't echo commands (not essential) Q0 Turn result codes on V1 Return word result codes X4 Use as many result codes as you've got &D2 Hang up when DTR is lost (nice to have) .TE .)b .in 0 .bp .if e \{ .ep .bp\} .uh "Appendix B \- AT&T Unix PC 7300/3b1 Dial Codes" .(x .)x _ .(x Appendix B \- AT&T Unix PC 7300/3b1 Dial Codes .)x .lp The dialing codes used by the OBM (On Board Modem) are not straight-forward. The modem setup, as included in the Unixpc.shar file, looks like this: .br .CS .(b L .(c -------------------------- Modem Setup -------------------------- .sp 1) Modem name (1 of 2) ... OBM 2) Modem init string ..... 3) Dialing command ....... % 4) Dialing cmd suffix .... @ 5) Hang up string ........ 6) Auto baud detect ...... N 7) 300 baud connect ...... CONNECT 8) 1200 baud connect ..... CONNECT 9) 2400 baud connect ..... 10) 4800 baud connect ..... 11) 9600 baud connect ..... 12) 19200 baud connect .... 13) 38400 baud connect .... 14) No connect string 1 ... 15) No connect string 2 ... 16) No connect string 3 ... 17) No connect string 4 ... ----------------------------------------------------------------- OPTION ==> _ Press <ESC> to return .)c .)b .Cs .lp The relevant fields of the modem setup are: .ba +0.5i .lp 1) Modem name. This must be \*(lqOBM\*(rq. .lp .ft I NOTE:\ \ Pcomm uses the modem name as a flag to determine which dialing method to use. The string \*(lqOBM\*(rq is a \*(lqreserved word\*(rq that Pcomm uses to switch to the AT&T Unix PC 7300/3b1 dialing method. .ft .lp 3) Dialing command. This should be \*(lq%\*(rq for touch tone dialing or \*(lq^\*(rq for pulse dialing. .lp 4) Dialing cmd suffix. This must be the \*(lq@\*(rq character. .lp 6) Auto baud detect. The OBM cannot use the auto baud detect feature. .lp 7\-8) Connect strings. Although the OBM doesn't actually return any result codes, these fake fields are required. .ba .lp Additional OBM dialing codes from the phone(7) manual: .br .in +0.5i .(b L .TS l l. \*(lq~\*(rq wait for next dial tone \*(lq,\*(rq pause 2 seconds \*(lq:\*(rq pause 10 seconds \*(lq&\*(rq perform a hookflash \*(lq%\*(rq begin tone dialing \*(lq^\*(rq begin pulse dialing .TE .)b .in .lp These codes can be inserted into the phone number string, for example: .br .in +0.5i .(b L .TS l l. 555-1234~56 dial 555-1234, wait for tone, dial 56 9,555-1234 dial 9, wait 2 seconds, dial 555-1234 %555^1234 dial 555 using tone, 1234 using pulse .TE .)b .in .lp .ft I NOTE:\ \ The dialing codes for the OBM are not subject to character synonym translations, therefore the \*(lq%\*(rq, \*(lq^\*(rq, and \*(lq~\*(rq characters do NOT have to be preceded by the \*(lq\e\*(rq character to remove their special meaning. .ft .bp .if e \{ .ep .bp\} .uh "Appendix C \- Using High Speed Modems" .(x .)x _ .(x Appendix C \- Using High Speed Modems .)x .ba .lp The features and complexities of the newer high speed intelligent modems available today warrants a more detailed discussion. .lp 1) Locked interface speed .ba +0.5i .lp Newer modems have the ability to maintain a locked interface speed with the computer without regard to the connected baud rate. For example, it is a good idea to lock the interface speed at 19200 baud (or 38400) when the modem is \*(lqtalking\*(rq at 14400 baud. .lp The \*(lqlocked speed\*(rq field of the TTY database was created to solve this problem. If this value is non-zero, Pcomm will only use this baud rate when talking to the modem. The true connected baud rate (14400 for example) will continue to be displayed in the status line. .ba .lp 2) Multiple setups .ba +0.5i .lp Users of newer modems may require a different \*(lqinit string\*(rq or \*(lqdial string\*(rq depending on the target machine being called. For example, when trying to connect to older V.32 modems, the V.42 and V.42bis features may have to be disabled. In this case, the dial string would contain the command to disable the unwanted features. .lp This problem is solved by creating additional modem entries in the modem database. For example, you could have an entry called \*(lqTELEBIT\*(rq for normal connections, one called \*(lqTELEBIT_V.32\*(rq for connecting to older V.32 modems, and another called \*(lqTELEBIT_PEP\*(rq for connections to other PEP modems. .lp Pcomm uses the connect strings to determine if the modem can handle the requested baud rate. If there are multiple modems that satisfy that baud rate, then the first modem entry is used. You can influence the choice of suitable modems by placing the name of the modem in the Auxiliary field of the dialing directory. In this way, you can have a default modem and a specific modem for each dialing directory that my require one. .lp .ft I NOTE:\ \ The default modem configuration (in a multiple setup situation) must appear first in the modem database. .ft .lp Your choices are virtually unlimited... you can have a separate modem setup to control modem features such as error control, compression, protocol spoofing, etc. .ba .lp 3) Telebit WorldBlazer settings .ba +0.5i .lp The following configuration is what I personally use for my Telebit WorldBlazer on bi-directional lines (ones with uugetty). Your mileage may vary. .in +0.5i .(b L .TS l l. ~&F Restores factory settings L1 Low speaker volume Q2 Use result codes only when dialing out X2 Use detailed result codes (connect speeds) &C1 Set DCD to follow the carrier &D3 Hard reset on loss of DTR S0=1 Answer on first ring S7=60 Wait at least 60 seconds for a carrier S51=6 Set interface speed to 38400 baud S58=2 Full duplex RTS/CTS flow control S59=15 Use result code extensions S61=0 Pass modem breaks to the other end &W Save in NVM .TE .)b .ba .lp 4) Sample TTY database .ba +0.5i .lp The following is the contents of the sample TTY database: .br .in +0.5i .(b L .TS l l c l l l. TTY name Modem name Locked speed .sp 1) tty10 HAYES 0 2) tty11 HAYES 0 3) tty12 DIRECT 0 4) tty13 TELEBIT 38400 5) tty13 TELEBIT_V.32 38400 6) tty13 TELEBIT_PEP 38400 .TE .)b .in .lp Notice that the last three entries share the same TTY and are physically the same modem. .ba .lp 5) Sample modem database entry for TELEBIT .ba +0.5i .lp The third entry in the sample modem database is for the Telebit modem designated for use under normal conditions. .br .in +0.5i .CS .(b L .(c 1) Modem name (3 of 5) .... TELEBIT 2) Modem init string ...... ATZ!~~ 3) Dialing command ........ ATDT 4) Dialing cmd suffix ..... ! 5) Hang up string ......... ~~+++~~ATH0! 6) Auto baud detect ....... Y 7) 300 baud connect ....... CONNECT 300 8) 1200 baud connect ...... CONNECT 1200 9) 2400 baud connect ...... CONNECT 2400 10) 4800 baud connect ...... CONNECT 4800 11) 9600 baud connect ...... CONNECT 9600 12) 19200 baud connect ..... CONNECT FAST 13) 38400 baud connect ..... 14) No connect string 1 .... BUSY 15) No connect string 2 .... ERROR 16) No connect string 3 .... NO CARRIER 17) No connect string 4 .... NO DIALTONE .)c .)b .Cs .in .ba .lp 6) Sample modem database entry for TELEBIT_V.32 .ba +0.5i .lp The 4th entry is for the Telebit modem designated for use with older V.32 modems that are confused by V.42 and V.42bis. .br .in +0.5i .CS .(b L .(c 1) Modem name (4 of 5) .... TELEBIT_V.32 2) Modem init string ...... ATZ!~~ 3) Dialing command ........ ATS180=0S50=6DT 4) Dialing cmd suffix ..... ! 5) Hang up string ......... ~~+++~~ATH0! 6) Auto baud detect ....... Y 7) 300 baud connect ....... CONNECT 300 8) 1200 baud connect ...... CONNECT 1200 9) 2400 baud connect ...... CONNECT 2400 10) 4800 baud connect ...... CONNECT 4800 11) 9600 baud connect ...... CONNECT 9600 12) 19200 baud connect ..... 13) 38400 baud connect ..... 14) No connect string 1 .... BUSY 15) No connect string 2 .... ERROR 16) No connect string 3 .... NO CARRIER 17) No connect string 4 .... NO DIALTONE .)c .)b .Cs .ba .lp 7) Sample modem database entry for TELEBIT_PEP .ba +0.5i .lp The 5th entry is for the Telebit modem designated for use with other Telebit PEP modems. .br .in +0.5i .CS .(b L .(c 1) Modem name (5 of 5) .... TELEBIT_PEP 2) Modem init string ...... ATZ!~~ 3) Dialing command ........ ATS50=255DT 4) Dialing cmd suffix ..... ! 5) Hang up string ......... ~~+++~~ATH0! 6) Auto baud detect ....... Y 7) 300 baud connect ....... 8) 1200 baud connect ...... 9) 2400 baud connect ...... 10) 4800 baud connect ...... 11) 9600 baud connect ...... 12) 19200 baud connect ..... CONNECT FAST 13) 38400 baud connect ..... 14) No connect string 1 .... BUSY 15) No connect string 2 .... ERROR 16) No connect string 3 .... NO CARRIER 17) No connect string 4 .... NO DIALTONE .)c .)b .Cs .in 0 .ba 0 .\" the index page .hx .bp .pl -10v .(b C Table of Contents .)b .sp 3 .\" Not all versions of {t,n}roff can handle a 2 column index .2c .nr xu 0.2i .xp