Beijing Paradise BBS Backup

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

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / ZCOMMDOC.ZIP / ZCOMMDOC.AD < prev next >

Wrap

Text File | 1995-03-21 | 69.2 KB | 1,771 lines

Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 91 COMSPEC ZCOMM uses the DOS COMSPEC environment variable to load COMMAND.COM or similar program to parse and execute DOS gateways (shell escapes). Normally DOS sets this variable for you. DIRRX, DIRSX, DIRCX, DIRPX, DIRFX Contain optional receive (DIRRX), send (DIRSX), capture (DIRCX), paste (DIRPX), and file (DIRFX) directory presets. When ZCOMM starts, these environment variables preset the dirrx, dirsx, dircx, dirpx and dirfx string variables respectively.[1] DIRSIZE controls the number of directory items that may be sorted with each wildcard. It should be set to 23 * times the desired number of entries (default = 200). If more directory entries are encountered, they are processed without sorting. EXAMPLE: C>set DIRSIZE=8000 DPORT overrides the default modem port (COM1) initially accessed by ZCOMM. EXAMPLE: C>set DPORT=2 The DPORT environment variable can also be specified as a hex port address,vector number pair. EXAMPLE: C>set DPORT=2f8,5 SEE ALSO: portx command EGA Stting this to MONO causes ZCOMM to use video mode 7 for 80x25 column text instead of the default video mode 3. This is needed only when using some EGA cards with an Monochrome MDA compatible monitor. EXAMPLE: C>set EGA=MONO HOTPORT Suppresses the "Warning: Old dport=" message (q.v.) seen when Zcomm is called from certain operating systems or programs. EXAMPLE: C>set HOTPORT=1 __________ 1. Or, these may be set in your phones.t or phones.ts file. (C) 1994 Omen Tech Inc Chapter 16 Running ZCOMM Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 92 SEE ALSO: port, portx commands MODEM Selects the dialer script file appropriate to your modem. This may also be set in your phones.t or phones.ts file. See Chapter 8 for details. EXAMPLE: C>set MODEM=mm224e.t PATH must include the directories containing ZCOMM and the help processor YHP. PHONES overrides the default pathname used to fetch ZCOMM's telephone directory. Forward slashes should be used to indicate directories. EXAMPLE: C>set PHONES=c:/yam/phones.t YAMQUIET Inhibits the display and locks the keyboard, preventing ZCOMM from writing on the screen. * This is useful when calling ZCOMM from another program. EXAMPLE: C>set YAMQUIET=257 Performs the equivalent of an initial kbdlock 257 command. SEE ALSO: kbdlock command ZONE sets the z numeric parameter to the number of minutes the current local time lags GMT time. EXAMPLE: C>set ZONE=420 SEE ALSO: z numeric parameter This may also be set in your phones.t or phones.ts file. Before running the X.PC* version of Pro-YAM, you must run the Tymnet X.PC driver to make it resident by calling the driver from DOS. The driver announces itself and returns control to DOS. The Tymnet X.PC driver uses approximately 40kb memory. EXAMPLE: xpcmain 16.1.2 Help Processor Environment Variables The flash-up help processor program YHP examines the environment for the NORMATTR, REVATTR, and UNDLATTR variables. These set help screen parameters for normal, reverse video, and underline attributes corresponding to the (C) 1994 Omen Tech Inc Chapter 16 Running ZCOMM Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 93 n,r, and u numeric parameters. EXAMPLE: C>set NORMATTR=3 16.2 Dialing out from Unix ZCOMM is called from Unix as [DPORT=S] yam [command ...] DPORT=S is an optional override to the initial default serial line. If another program is using the line, ZCOMM complains that the port is busy and will refuse to open it. Command may be any desired combination of ZCOMM commands. EXAMPLE: yam call cissig invokes ZCOMM and executes the commands in the "cissig" telephone directory entry.[2] EXAMPLE: DPORT=tty77 yam call othersys Selects /dev/tty77 before executing the othersys telephone directory entry. If ZCOMM is run in the background, it will exit if it reaches the main command prompt. EXAMPLE: yam call cissig& As a form of shorthand, ZCOMM may be invoked as call if that is the command to be executed. EXAMPLE: call cissig 16.2.1 X Windows When run under the X Windows xterm(1) interface program (indicated by the Unix TERM environment variable), ZCOMM understands xterm's keyboard mappings for function and ALT keys. __________ 2. The cissig and allsig entries are in the phones2.t file. (C) 1994 Omen Tech Inc Chapter 16 Running ZCOMM Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 94 16.2.2 UNIX/XENIX Environment Variables Unix/Xenix ZCOMM flavors search the Environment for the following variables: CBSIZE overrides the default allocation for the circular buffer. On 32 bit systems, the maximum CBSIZE is limited only by the operating system's process size limit. EXAMPLE: CBSIZE=300000; export CBSIZE DIRRX, DIRSX, DIRCX, DIRPX, DIRFX Perform the same function as described for the DOS flavor above. (Since Unix does not use colon (:) as a device specifier, Unix flavors do not treat colon(s) in pathnames in any special way.) DPORT overrides the default modem port initially accessed by ZCOMM. EXAMPLE: DPORT=tty12; export DPORT HZ Indicates the number of kernel "clock ticks" per second. This calibrates terminal function timeouts, protocol timeouts, and the sleep command. The HZ environment variable must be set if the value used by your system is not 100 clock ticks per second. LOGFILE Specifies the pathname for the log file (default: /tmp/yamlog.tmp) created by the -v option when invoking ZCOMM as xyam, rz, sz, rb, sb, rx, or sx. SEE ALSO: v option MODEM Describes the type of modem used by the mm224 script. See Chapter 8 for details. EXAMPLE: MODEM=MM224E; export MODEM PATH must include the directories containing yam and the help processor yhp. PHONES overrides the default pathname used to fetch ZCOMM's telephone directory. EXAMPLE: PHONES=/usr/lib/local/localphone.t; export PHONES SHELL ZCOMM uses this environment variable to select the appropriate program for its shell escapes. TERM If the TERM environment variable contains xterm, xterms or anything else beginning with xterm, ZCOMM assumes it is (C) 1994 Omen Tech Inc Chapter 16 Running ZCOMM Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 95 operating as a subprocess to the Xwindows xterm(1) program, enabling a term function status line if the X numeric parameter allows. SEE ALSO: X numeric parameter The LINES and COLUMNS environment variables preset the # and $ numeric parameters respectively. This assumption may be overridden by setting the X numeric parameter. If the TERM environment parameter contains the string 401 indicating emulation of a Tektronix 4010 series storage tube terminal, status line updates are inhibited when Tek graphics is active. If the TERM environment parameter begins with "wy" (as in "wy60") ZCOMM will use and recognize Wyse escape sequences. The TERM environment variable is also checked for AT386 which enables a different decoding of keyboard escape sequences. UUCPLOCK If UUCPLOCK contains "/usr/spool/locks/LCK.." ZCOMM uses "Honey Danber" uucp port arbitration conventions. 16.3 Dialing in to Unix Unix flavors may be used for dial-in applications to transfer files and commands with programs logged in to terminal ports. The commands rz, sz, rb, sb, rx, rc, sx, zcommand, and zcommandi perform the same functions as the corresponding ZCOMM commands. They may be given directly to the shell or executed from a shell script or Makefile. EXAMPLE: sz -Yn *.c *.h The Makefile fragment below commands a DOS ZCOMM logged into a serial port to clear its dirrx string parameter, change to its root directory, and then sends a new version of the executable to the DOS machine. EXAMPLE: cpsz:/tmp/yam.exe @zcommand 'set dirrx ""' @zcommand "c:;cd /" @sz -y /tmp/yam.exe More general command sequences or other protocols such as Kermit may be accessed with the xyam command. EXAMPLE: xyam kermit sb *.c *.h (C) 1994 Omen Tech Inc Chapter 16 Running ZCOMM Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 96 EXAMPLE: xyam z pl256 sz -Yn *.c *.h If a many files are specified with wild cards, the shell may not be able to pass them to ZCOMM. The following error will appear: /usr/bin/sz: arg list too long ZCOMM users can avoid this problem by letting ZCOMM do the wild card expansion internally. EXAMPLE: sz '*' 16.3.1 Initialized Logins When a user logs in, the Unix shell executes commands in .profile in the user's home directory. This can be used to accept file(s) from callers, send file(s), perform suitable processing, and log out the user automatically. The following .profile disables hangup and interrupt signals, then invokes xyam to execute commands in a script. set -e trap "" 1 2 3 xyam source inbound.t exit The following inbound.t receives a file from a hand held aviation recorder. echo "Send XMODEM file" ena -d rx -y airlink.tmp if ? echo "File Received" if !? echo "Sorry." (C) 1994 Omen Tech Inc Chapter 16 Commands Outline Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 97 17. OUTLINE OF COMMANDS 17.1 Setup port 1 ..........................Select the modem port portx hbase,vec .................Select non standard modem speed 1200 ......................Set the "baud rate" handshake {on|off|cts|dsr|dcd|both|slow}Hardware flow control 17.2 Data Call queue............................Manipulate a dialing queue call [-N] system ................[N retries] 234-5678 ........................Dial a local number 234-5678/mnp ....................Dial a local number with MNP %l-503-621-3746 .................Dial long distance learn lfile .....................TurboLearn information to lfile xpc C ... .......................Enable and control virtual channels with X.PC bye .............................Disconnect current call off .............................Disconnect and exit String parameters: phones, mcommand, mprefix, msuffix, mconnect 17.3 Interactive Operation F2, t [-options] ................Begin terminal conversation learn lfile .....................TurboLearn information to lfile conf ............................Online conference with edit window F8 ..............................Generate a password enable -options .................Modify term function characteristics history histfile.................Enable command recall history set .............................Assigns a string or command to a function key String parameters: break, bs, esc, etx, xpassword, entstr, lpnono 17.4 Message Transfer Commands Normal Interactive Transfers f [-options] file ...............Send file with the term function t [-options] file ...............Terminal conversation with capture to file kill ............................Erase the contents of the circular buffer w, ALT-W ........................Write the circular buffer close, ALT-C ....................Close the capture file Term Function Options ...........(capture/send modifiers) (C) 1994 Omen Tech Inc Chapter 17 Commands Outline Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 98 String parameters: eolstr, blankfill Special File Transfers fput ............................High Speed file dump to modem fpute ...........................Send file with Echoplex check fget ............................High speed modem to disk data dump 17.5 Protocol File Transfer Commands F3, rb [-options] [dir] [file ...] Receive files with YMODEM or Clink rz [-options] [dir] [file ...] ..Receive files with ZMODEM kermit rb [-options] ............Receive files with Kermit rx [-options] rxfile ............Receive a file with XMODEM rt [-options] [dir] [file ...] ..Receive files with Telink/FIDO r7 [-options] [dir] [file ...] ..Receive files with MODEM7 ro [-options] rxfile ............Receive a file with XMODEM OverThruster rw [-options] rxfile ............Receive a file with WXMODEM rc [-options] rxfile ............Receive a file with XMODEM/CRC sz [-options] txfile ... ........Send file(s) with ZMODEM sb [-options] txfile ... ........Send file(s) with YMODEM or Clink sx [-options] txfile ............Send a file with XMODEM or XMODEM/CRC st [-options] txfile ... ........Send file(s) with Telink/FIDO s7 [-options] txfile ... ........Send file(s) with MODEM7 zcommand COMMAND ................Remote COMMAND with ZMODEM !!COMMAND........................Remote COMMAND with Kermit or ZMODEM kermit sb [-options] txfile ... .Send file(s) with Kermit Kermit Server Access Commands AUTOMATIC File Transfers.........(Compuserve-B, Kermit, ZMODEM) String parameters: adlopts Options for Protocol File Transfers Numeric Parameters for XMODEM/YMODEM/ZMODEM Transfers Special Keys for Protocol Transfers 17.6 Macro Commands call system .....................Execute telephone directory entry r [oldcmd] ......................Reenter previous command Up, Down ........................Select previous commands for reentry source scriptfile ...............Call subroutine set .............................Assign a string or command to a function key keys ............................Display soft key definitions reskeys .........................Clear soft key definitions SOFT KEYS .......................Transmit strings or execute commands. (C) 1994 Omen Tech Inc Chapter 17 Commands Outline Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 99 17.7 Display Commands / Terminal Emulation display displaymodes ............Set CRT parameters, screen emulation cl, cls .........................Clear the Screen mk...............................Map keys for terminal emulation videobios N .....................Set video BIOS mode N (for 132 cols) 17.8 Disk/File Access Commands a: ..............................Change default disk ap file1 file2 ..................Append file1 to file2 apd file1 file2 .................Append file1 to file2, delete file1 cd directory ....................Change directory cdd D:dir .......................Change disk and directory dir[rlstx] ......................Sorted directory listings !DOS-command ....................DOS Gateway to another program browse file .....................Browse a set of files crc file ... ....................Display 32 bit file CRC's del file ........................Delete files from disk dump file ... ...................Side by Side HEX/ASCII file dump egrep regular-expression file ... Pattern matching file searching egrepq regular-expression file ... String extraction find string file ... ............Case insensitive file searching findq string file ... ...........String extraction list file ... ...................List files on DOS standard output page file ... ...................Pauses after each screenful read file .......................Fill circular buffer from open file seek [-]offset ..................Seek to location in file Home, End, PgUp .................Enter review function sum file ... ....................Display Unix style file checksum typ file ... ....................Type (display) files on screen wc file ... .....................File character, word, line count <file ...........................Simulate keyboard input from file >outfile ........................Redirect utility command output >>file ..........................Add utility command output to file 17.9 Remote Takeover / Control host ............................Enter Host Operation link ............................Connect to another computer message .........................Leave a public message private .........................Leave a private message remote ..........................Accept remote commands unrestrict.......................Allow caller unrestricted access (C) 1994 Omen Tech Inc Chapter 17 Commands Outline Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 100 17.10 Support Commands bdump file ......................Dump interrupt input buffer to file display displaymodes ............List or change CRT operation enable -options..................Modify term function operation exit ............................Exit to DOS help ............................Activate help database kbdlock on|off ..................Lock/Unlock keyboard kbdmon [file] ...................Monitor keystrokes in file p ...............................Set/display numeric parameters reset............................Reset display and disk system set .............................Set string parameters / soft keys 17.11 Record Keeping Commands nolog ...........................Inhibit next log entry timestamp .......................Display/write time and other info restime .........................Reset elapsed time counter to 0 String parameters: calllog, txlog, rxlog, plog, rxcnt 17.12 Script Commands abort ...........................Returns to command prompt accept ..........................Read keyboard response to string variable bg...............................Indicate background operation createx file ....................Exclusive file creation (for semaphores) echo ............................Display message fg...............................Indicate foreground operation kill [-signum] procnum ..........Interprocess communications lput string .....................Local screen write lputp string ....................Output string to printer expand script pathspec ..........Execute script for each file in pathspec fail ............................Failure return from script gosub name[.file] ...............Script subroutine call goto ............................Branch to label in same script. grab svar .......................Read line from file to string variable if, else.........................Execute rest of line conditionally kbdlock on|off ..................Lock/Unlock keyboard ki ..............................Reset capture buffer search area on ..............................Conditional execution, tested after each command pattern .........................Specify string searches in modem data purge{k|l} ......................Purge typeahead or modem input buffer put[v] ..........................Send string [variable] to modem return...........................Return to previous script level (C) 1994 Omen Tech Inc Chapter 17 Commands Outline Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 101 set[c|s] ........................Set string parameters / soft keys setn ............................Set string param to Arithmetic expression set? ............................Set string param to test value sleep ...........................Let the world pass by source scriptfile ...............Call scriptfile as a subroutine split ...........................Split (parse) a string to tokens ss ..............................Regular Expression pattern match string parse trs .............................Translate characters in a string wait ............................Wait for pattern(s) in modem data while ...........................Looping control (C) 1994 Omen Tech Inc Chapter 17 Special Keys Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 102 18. SPECIAL KEYS Ctrl-Break clears typeahead, unlocks the keyboard, and stops the function ZCOMM is doing in a reasonably orderly manner.[1] Ctrl-Break cancels kbdlock. Ctrl-Break is not so abrupt as the NUKE key. The B test condition tests whether Ctrl-Break has been struck since the last purgek command. Keyboarding ALT-N will NUKE (abort) the current command and return to ZCOMM's command prompt.[2] If one or more scripts are active, the current line number (counting from the first line in the script file) for each level of script is displayed.* NUKE will terminate any script. NUKE closes any transmit file, but not a receive capture file. (A receive capture file may be closed with the "close" command.) NUKE does not disconnect the modem by dropping DTR.[3] Keyboarding ALT-Z appends the contents of the display screen to a DOS file. The pathname is contained in the picture string parameter. The exact contents of the screen memory are written to the file, with each screen character followed by its attribute. A separate program, unpic is used to convert the screen dump to a normal file that may be printed or displayed. SEE ALSO: picture string parameter, unpic program 18.1 Special Keys during Protocol Transfers Certain keys perform special functions when keyboarded during protocol file transfers (XMODEM, Kermit, etc.). Some of these keys are inhibited when a non error correcting protocol (YMODEM-g) is active. F1 Keyboarding F1 causes a protocol timeout and forces a retry. ALT-A Displays Kermit file transfer status. ALT-B Cancels the current Kermit or ZMODEM batch transfer. __________ 1. In the term function, Ctrl-Break sends a break to the remote unless it has been redefined with a set command. 2. Use of this term, popularized in the J.F.K. administration, does not imply endorsement of preemptive nuclear attacks on innocent populations. 3. When in host operation waiting for a call, NUKE drops DTR. (C) 1994 Omen Tech Inc Chapter 18 Special Keys Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 103 ALT-C Cancels the ZMODEM or Kermit session. ALT-F Skips the current ZMODEM or Kermit file transfer. SEE ALSO: zmodem w numeric parameter ALT-Q Keyboarding Alt-Q during a protocol file transfer toggles a flag that causes ZCOMM to disconnect when the transfer is completed. This is most useful when downloading a long file. As soon as the file is transferred, ZCOMM will execute the string parameter quitcmd (if set) and then disconnect the modem. If keyboarded during a Host Operation file transfer, ZCOMM will exit Host Operation at the conclusion of the transfer. The state of the quit flag is displayed each time ALT-Q is keyboarded. ALT-S Keyboarding Alt-S displays status information on the console screen only (even if in Host Operation). The pattern number of the last successful search (-1 if no match), the active search patterns (if any), and the line numbers of the active scripts (if any) are displayed to aid script debugging. ALT-V Keyboarding ALT-V will toggle the view option affecting the rb, rc, rz, sb, sc, sx, and sz commands, and data transfers using the Compuserve B protocol. ASCII Keyboarding a normal ASCII character (in the range of 00 to 7F) will send that character to the modem. This may be used for protocol testing, or to terminate a modem's autodial handshake without terminating ZCOMM's call retry count. Ctrl-X All ZMODEM and many YMODEM and XMODEM protocol programs recognize a dozen successive Ctrl-X characters as a session abort command. If the remote computer appears to be "stuck" in a YMODEM or ZMODEM transfer, keyboard ten Ctrl-X characters to abort the protocol transfer. During a protocol transfer, normal keys are sent to the modem when Zcomm is waiting for or receiving a packet. This may be used to reissue a file transfer command to the other computer if it becomes apparent the original command was not accepted. Other uses for this pass thru capability include protocol testing. 18.2 Local Editing Keys Emacs style character editing reduces the number of keystrokes needed to enter and edit commands and strings. Normally the cursor is at the end of the line of text being keyboarded. Printing characters insert themselves at the cursor location. The <ENTER> key enters/transmits the entire line of text. (C) 1994 Omen Tech Inc Chapter 18 Local Editing Keys Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 104 Left, Ctrl-B moves the cursor to the left Right, Ctrl-F moves the cursor to the right Ctrl-Left cursor WORD left Ctrl-Right cursor WORD right Ctrl-A cursor to beginning of line Ctrl-E cursor to end of line Del, Ctrl-D delete character at cursor Backspace delete character to left of cursor Ctrl-W delete word to left of cursor Ctrl-End, Ctrl-K delete to end of line Ctrl-R refresh (redisplay) the line Ctrl-X delete entire line Down, Ctrl-N next history line Up, Ctrl-P previous history line Ctrl-U Argument Count (not available in term function) An initial Ctrl-U sets an argument count of 4. Successive Ctrl-U characters multiply the argument count by 4. A decimal number may be entered after Ctrl-U, and this number becomes the argument count. EXAMPLE: ^U^U Left moves the cursor 16 left EXAMPLE: ^U5X inserts 5 "X" characters EXAMPLE: ^U5^U? inserts 20 "?" characters. Unix/Xenix flavors do not support Emacs style editing in the term function. (C) 1994 Omen Tech Inc Chapter 18 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 105 19. MAIN COMMANDS All commands and arguments must be entered in lower case except where stated. You may shorten some commands by typing just the first portion that is shown in caps. For example, the "break" command may be entered as "br". Whether or not you abbreviate the command, it must be entered in lower case. User defined Soft Keys are executed from the command prompt iff they do not conflict with the permanent definitions described below. Except where stated, multiple commands can be written on one line separated by ; (semicolon). Commands that take a constant number of arguments do not need a semicolon to delimit the end of the command. If in doubt, use a semicolon to separate multiple commands.[1] @ The at sign may be used to indicate a telephone number starting with the Touch-Tone(TM) A B C D * or # codes or a character escape. If the phone number contains spaces, it must be enclosed in double quotes. The leading @ is not sent to the modem. EXAMPLE: @#*-123-4567 Dials #*-123-4567. %l-234-567-8901 (%l:letter l) For normal long distance dialing, the string parameter l (letter l) defaults to "1" (digit 1). To use an alternative long distance service, set the l string parameter with a modem command to dial the local access number, wait for the second dial tone, and transmit the account number. SEE ALSO: "setsavenet" telephone directory entry A string of alternate phone numbers may be specified with the "+" construction shown below. 234-5678 A number given as a command invokes the dial script to attempt a connection with the specified number. Iff the modem is currently connected to a remote modem, and the B numeric parameter is non zero, ZCOMM pulses Data Terminal Ready, terminating the connection. ZCOMM character escapes may be used within the number string to represent special characters. __________ 1. A space or two after each semicolon makes scripts easier for humans to read. (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 106 EXAMPLE: 234-5678 When carrier is detected, ZCOMM executes the mconnect string (if set). If there is no next command, ZCOMM returns to the command prompt. One or several alternate phone numbers may be specified by appending the previous number with +234-5678 for as many alternate numbers as are desired.[2] When a connection is made, undialed alternates are forgotten. Alternate phone numbers need not support the same speeds. A redial count given to the call command repeats the sequence of alternate numbers. EXAMPLE: cis speed 2400 239-6124/mnp_s+239-6126/mnp_s+232-1032/300 This script line attempts a MNP (with software flow control) call to the first two numbers, then a 300 bps call to the third number if neither of the first two connected. Iff no connection is made, script processing at the current level is terminated. A number of modifiers are available depending on the type of modem and the choice of dialing script used. These are described in Chapter 8. SEE ALSO: nolog command, calllog string parameter, mcommand string parameter a: Change the default disk to a:. ZCOMM then prints the free storage remaining on the selected disk. The specified disk must be included in the string parameter disks. abort Aborts any command or script in progress. Closes all script files that may be open. Abort returns to the command prompt. SEE ALSO: quit command accept[[l]1] stringvar prompt (letter l, digit 1) Scripts often need to prompt the user for file names and menu choices. Accept displays Prompt[3] to the user. ZCOMM then reads keyboard __________ 2. When using the mm224 dialing script. 3. Prompt must be enclosed in quotes if it contains spaces. (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 107 input into the specified string variable. Backspace and Ctrl-U perform editing functions. Characters are accepted from the user until <ENTER> is typed. If the H numeric parameter is non zero, an empty string is returned if <ENTER> is not typed within the time limit set by that parameter. Acceptl translates the user's response to lower case. Acceptl1 returns a 1 character string in lower case after the single character is keyboarded. Prompt is processed for string substitution and character escapes. If the result begins with an ESC character, ZCOMM does not reposition the cursor before accepting the string. In writing scripts, it may be useful to save the current screen location with an escape sequence, then restore it with an escape sequence encoded in the prompt string. EXAMPLE: accept s1 File: Displays the prompt File: and reads the keyboarded response to string parameter s1. EXAMPLE: acceptl1 s0 "Enter Menu Choice" Reads a single character from the user, translates it to lower case, and assigns it to s0. EXAMPLE: accept s0 "\E[20;60H\E[KFile Name: " Places the cursor at line 20 column 60, clears the rest of the CRT line, displays the prompt, and accepts input. EXAMPLE: accept s6 " Your \E[1mFirst\E[0m name please " Uses boldface video to highlight First as it appears in the prompt. EXAMPLE: accept s2 "File "; rc %s2 Prompts the user for a file name, then receives that file with XMODEM/CRC protocol. EXAMPLE: accept xpassword "\E[mMaster Password: \E[8m"; lput "\E[m" Uses invisible video (ESC [ 8 m) to allow a password to be entered without visible echo. The ESC [ m sequences reset the display to normal (visible). SEE ALSO: obey command, scripts ap file1 file2* (Append) Appends the contents of file1 to file2. If file2 does not exist, it is created. Wildcards are not allowed. The ap command may close files that have been opened by the create, f, open, t or > commands. File1 and file2 are processed for string parameter substitution. (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 108 apd file1 file2* (Append-Delete) Appends the contents of file1 to file2, then deletes file1. If file2 does not exist, it is created. If an error is detected writing file2, file1 is not deleted. Wildcards are not allowed. The apd command may close files that have been opened by the create, f, open, t or > commands. File1 and file2 are processed for string parameter substitution. EXAMPLE: apd %item Z%item.tmp bdump outfile Dumps the contents of the modem interrupt input buffer to outfile. This command is useful for debugging as outfile will contain the last characters received from the remote regardless of what ZCOMM commands have been executed. The most recently received data appears at the end of outfile. This command "tells it as it is", writing all 8 bits of each character to outfile. If only a few characters have been received from the remote sine ZCOMM was started, some of outfile will consist of nulls. The bdump command is often used as a post mortem diagnostic dump after a failed script or unsatisfactory file transfer. Try sending a 256 byte file containing each code (0 to 255), then examine the results to see what the comm link did to the data. This command is not available on OS/2 and X.PC flavors of ZCOMM. bg Indicates ZCOMM is running in the background with no user at the keyboard. SEE ALSO: fg command, df test condition BReak Sends a 200 millisecond break signal. N.B.: Some modems do not correctly pass the break signal to the remote. SEE ALSO: Ctrl-Break key, break string parameter, zmodem B numeric parameter BROwse pathspec Browse through the files specified in pathspec. If pathspec is empty, all files are presented. For each matched pathname, the filename, date, and length of the file are displayed. The status line displays some of the commands which may be applied to each file. Chapter 19.4 describes the browse subcommands, which provide extensive capabilities for individually selected files. bye Terminate the connection in progress by sending a long space and then dropping DTR (Data Terminal Ready).[4] After a pause, DTR is __________ 4. The modem must be configured to use Data Terminal Ready (DTR). (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 109 reasserted to allow the modem to originate or answer another call.[5] SEE ALSO: o, off commands call [-N] [name][.directory][,modifier] Prepare ZCOMM for a new task and invoke an entry in the Phone Directory. If directory is specified, it is searched instead of the regular Phone Directory. An optional modifier (string with a leading comma), may be added; it is passed to the script. The 7, A, a, b, C, c, E, e, g, H, h, i, j, n, o, P, p, q, r, S, s, t, u, v, w, X, x, Z, and z term options are reset. The d term option is set. The e, f, g, k, m, p, q, t, w, Kermit 8, zmodem C, e, l, L, p, t, T, w, and W parameters are reset to their default values. The search patterns are erased. Permanent string parameters set with the set _svar command are set to empty. If the search is successful, the entire directory entry name is copied to the remote string parameter. The complete argument entered on the command line is stored in the args string parameter visible to the called script. If the script has a READ ONLY attribute, ZCOMM is unrestricted during execution of the script. ZCOMM then executes the commands on the rest of the line (if any), and on succeeding lines beginning with a space or tab. If the v numeric parameter is greater than zero, each command from the file is displayed on the screen before it is executed. It is not necessary to type the entire name as it appears in the telephone directory, as ZCOMM will find the first entry that name is a prefix of. Iff name is empty, execution begins with the first line of path. EXAMPLE: call cis1200 call cis1 call cis.C:/newscript EXAMPLE: call genie,upl Invokes the genie telephone directory entry with the modifier ,upl available to the called script. The call command is not limited to making connections. For example, "call host" in the distribution PHODIR.t file conditions a Hayes compatible modem to answer incoming calls silently, set parameters, __________ 5. Most dialing scripts include an initial bye command to make sure any previous call is disconnected. (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 110 and activates ZCOMM's host operation. Most directory entries include a telephone number to dial. If ZCOMM is used with an autodial modem, the number of retries N (default none) may be specified. EXAMPLE: call -40 cbbs-r Attempts 40 retries before giving up. The interval between retries is set by the i numeric parameter. EXAMPLE: pi4 Sets the interval between retries to 4 seconds. Words To the Wise: Abuse of the retry feature by continually calling busy numbers may incur the wrath of the Telephone Company. Especially with Message Unit Accounting, Big Brother may be watching your telecommunications habits. Some long distance services (MCI, Sprint, AT&T, etc.) charge for unsuccessful calls, especially if the phone is allowed to ring (or ring busy) for more than a few seconds. Consult your telephone company about legal limits to the number and frequency of retries. Since some computer services will disconnect within a short time if no login is attempted, you should start communicating as soon as the modems are connected. ZCOMM sounds the bell after making the connection if retries have been specified. The source, gosub and call commands may be nested with up to six command/phones file descriptors open at once.[6] A label may be the target of a call command provided the trailing colon is included in name. cat pathspec For Unix users, a synonym to the type command (q.v.). cd [dir] Change to directory dir. If Restricted, dir is checked for a parent directory ("cd .."), and absolute paths ("cd /src") not prefixed by the home string parameter. Giving cd without an argument changes to the directory stored in the home string parameter.[7] ZCOMM then stores the current directory in the pwd string parameter and displays it unless the v numeric parameter is less than 0. __________ 6. Deep nesting may require a decrease in the circular buffer memory allocation, see Chapter 16. 7. The home parameter is set to the current directory when ZCOMM is invoked, but may be changed with the set command. (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 111 EXAMPLE: cd /tmp N.B.: When operating restricted, the home string parameter must point to a valid directory in order to enforce the intended directory path restriction. SEE ALSO: cdd and pwd commands, home and pwd string parameters cd D:dir When a disk drive is specified with the cd command, the current directory on that drive is changed but ZCOMM remains logged in on the current drive and directory. If Restricted, dir is checked for a disk drive ("cd b:/foo") not contained in the disks string parameter. EXAMPLE: cd D:/tmp cdd D:dir Change to (log in to) disk D and then to directory dir on the specified disk. If dir is not specified, the root directory is assumed. ** This is a shorthand equivalent to a D: command followed by a chdir dir command. SEE ALSO: cd command chat Enter the term function to chat keyboard to keyboard. Characters typed by either keyboard are echoed to both ends, and RETURNS echo as RETURN/LINEFEED. In Host Operation, chat exits if the caller types Ctrl-Z. Chat will become hostile if the other end also echoes characters. (Try it sometime on a timesharing system; it's fun.) close Writes the contents of the circular buffer iff a receive file is open, then closes the receive and transmit files. ZCOMM complains if no files were open. SEE ALSO: nolog command closerx Iff a receive file is open, writes the circular buffer then closes the receive file. SEE ALSO: nolog command closetx Closes the transmit file, if it is open. SEE ALSO: nolog command cl Clears the screen. cls Resets display modes and clears the screen. (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 112 CONFerence Enters the term function with a 1 line window for composing commands and text. Chapter 21.5 gives details. crc pathspec Print the CRC-32 and character count for the specified files. The crc command verifies the identity of two (or more) copies of a file. Iff the lengths and CRC-32's of two files are the same, the files are almost certainly identical. Comparing files with the crc command is faster than transmitting a second copy for character by character comparisons. EXAMPLE: "crc", "crc *.c" HINT: To generate a file containing the CRC's of the files in the current directory: >crc.lst crc *.* close After the files are copied, run the commands above (with a different file name), then compare the two files with DIF.EXE to detect any that have changed. SEE ALSO: sum, wc commands Source for a public domain Unix/DOS version of CRC is available. create [-term_options] outfile If a receive capture file is open as the result of a create or t filename command, write the circular buffer and close it. Then create outfile for use with the term function with options. The create command is especially useful when you don't want to enter the term function immediately. EXAMPLE: create -ys /tmp/cbbs.tmp[8] SEE ALSO: > command createx outfile Similar to the create command, but does not open outfile if a file with the same pathname already exists. The resulting error message may be suppressed by setting the v numeric parameter negative. Scripts may test for success with the r test condition. The createx command may be used to manage semaphores to lock resources or work entries used by multiple instances of a __________ 8. The y option overwrites any existing file with the same name. The s term option strips most control characters from the resulting disk file. (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 113 program. The createx command is available on Unix and OS/2 flavors. SEE ALSO: kill command del pathspec Delete the specified files. No message is printed if one or more of the specified files could not be deleted. No confirmation is requested for mass deletes. WARNING: As with all ZCOMM pathspec specifications, a directory name expands to all files in that directory. N.B.: Do not attempt to delete an open file on DOS, especially the history file. SEE ALSO: browse command demand password Scripts must often verify a caller's identity by asking for a password. The ZCOMM password command allows a caller three chances to enter a given password. Failure results in disconnection. Password is processed for character escapes and string substitutions. All security restrictions on string parameters are enforced. If the result is empty, no password is demanded. Otherwise the user is prompted to enter a string matching password in the correct case. Keyboard input is not echoed. Three attempts to enter password are allowed. If the password is not correctly entered, DTR is pulsed to force the modem to disconnect the caller, and the ? numeric parameter is set negative. EXAMPLE: demand %password Requires the caller to enter a string matching the contents of the password string parameter. dir pathspec Display pathnames matching pathspec alphabetized across the page. Wildcard filename expansions are alphabetical. EXAMPLE: dir EXAMPLE: dir y*.c *.h dirr pathspec Displays the directory with length and creation date of each file. dirr displays the number of files matched, number of blocks, number of kb in those files, and estimated transmission time at the current transmission speed assuming the fastest protocol available (ZMODEM or YMODEM-g). XMODEM and Kermit transfers take longer than the displayed estimates. Wildcard filename expansions (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 114 are alphabetical. dird pathspec Long Form directory, sorted by date. dirt pathspec Long Form directory, reverse sorted by date. dirl pathspec Long Form directory, sorted by file length. dirs pathspec Long Form directory, reverse sorted by file length. dirx pathspec Long Form directory, sorted by file extension. DISable{-term_options} Disable options(s) affecting the term function. Chapter 22 describes options affecting the term function. EXAMPLE: dis -t Disables throttle (t term option). display [[no]dismode] ... Without an argument, prints the display modes. Display modes preceded by NO are turned off. With one or more arguments, turn on the specified display mode(s). If an argument is preceded by no, the specified display mode is turned off. If an emulation is specified, it must be the first argument. display command argument changing the terminal emulation (vt100, dasher, lsi-adm3a, 3101, wyse, dumb) disables nlmode and overstrike. The display modes are: vt100 Emulate VT-100, VT-102, SCO Console, and most VT-220 and Teletype 5425 codes. VT-52 and Zenith H-19 codes are the default. SEE ALSO: 101.MK,STD.MK, script files lsi-adm3a Emulate Lear Siegler ADM3a and Televideo 9xx control codes. dasher Emulate Data General Dasher terminals. 3101 Executes IBM 3101 and TI 940 escape codes. wyse Emulate Wyse terminals in native mode, allow switching the keyboard to keyscan mode. SEE ALSO: WYS.MK script file dumb Only null, bs, tab, cr and lf are executed, all others display. As in real life, dumb takes precedence over vt100, vt52, and lsi-adm3a emulation. (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 115 inhibit Inhibits the display (nothing prints). SEE ALSO: Q term option nlmode Received newlines (linefeed) display as return/linefeed. The Enter key is sent as CR/LF. bell=visual Instead of sounding on the speaker, bell characters cause flashing notes to appear on the screen. overstrike Overstruck characters are displayed in bold face or underline (reverse video on CGA) as appropriate. autowrap The 81st character prints on a new line with possible scrollup. rautowrap Allow a backspace from the lest margin to reverse wrap to the last character position on the previous line. 8bit Decode 8bit control characters and G1 character set. stat=off Disables ZCOMM's status line. warpdrive Provides higher display speed without scrolling flicker, but causes noise (snow/chromablizzard) with CGA display adapters. mapkb Allow escape codes from the remote or a file to active alternate keyboard mapping. The keyboard mapping is defined with a series of mk commands, such as those contained in the std.mk (standard keyboard) or 101.mk (101 key extended keyboard) files. Other XXX.mk files may be provided; the first few lines of these files indicate the keyboard configuration they set up. ZCOMM comes initialized with the std.mk mapping, which requires NumLock to be on. EXAMPLE: source std.mk Defines a VT100 keyboard mapping for standard PC and PC-AT keyboards. The term function keyboard mapping enabled by the mapkb command may override some ZCOMM functions. A display nlmode nobell=visual Turns on nlmode display mode and turns off the visual bell. EXAMPLE: display vt100 Enables VT100/VT102 emulation used by many computer systems. SEE ALSO: tcs command (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 116 dump pathspec Dump the named files in a side by side hex/ASCII format, similar to the CP/M users' group DUMP program. The ending character number is also displayed. Zero length files are not displayed. echo[c|f] [-n] string Echo a line containing a single argument string in reverse video. The optional -n suppresses reverse video and linefeeds. Tabs should not be used with the echo command. The echoc command also echoes its argument to the capture file (if open), without reverse video. The echof command echoes its argument to the capture file only. EXAMPLE: echoc "File not Accepted" Outputs a line to the screen and to the capture file. EXAMPLE: echo "Dave, This conversation can serve no further purpose." Displays a line on the screen only. SEE ALSO: lput command, r numeric parameter, character escapes egrep[m] regular-expression pathspec ** Display lines in the specified files matching regular-expression. Regular Expressions are discussed in Chapter 26. The egrepm command finds a line matching regular-expression in each of the specified files, and then pages through the file beginning with the matched line. At the end of each screen, ZCOMM accepts the same subcommands used with the findm command. EXAMPLE: egrep "^Subject:" *.* Displays all lines that begin with "Subject:". SEE ALSO: findmore command The egrep implementation does not strip the trailing CR/LF from lines read from the disk. This affects use of the $ regular expression magic character. When using the $ magic character, the CR/LF at the end of normal lines must be represented as "..$". egrepq regular-expression pathspec ** Silently searches the specified files for the first line matching regular-expression. Upon a successful search, the contents of this line are stored in the z0 string variable and the ? numeric parameter is incremented. The egrepq command is useful for fetching password information from a disk file. SEE ALSO: obey command, findq command (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 117 else Execute the command(s) on the rest of the line if the last if test performed on the current script level was false. N.B.: While else statements in programming languages are connected to a particular if statement according to syntax, the connection in ZCOMM is to the last if statement executed on the level, regardless of goto's. ENAble {-term_options} Enable options affecting the term function. Chapter 22 describes options affecting the term function. EXAMPLE: ena -h Enables half-duplex (local echo) Half-duplex option causes the term function to display keyboarded characters. estimate length [speed] Use the specified length and optional specified effective speed when displaying information for the next receive file. A length of 0 bypasses the length substitution. Once a speed (in effective bits per second) is given, it is used for all locally displayed transmission time calculations until the next speed or port command. EXAMPLE: estimate z2 Uses the file length stored in string variable z2 in calculating the transmission time estimate for the next received file. EXAMPLE: speed 19200; estimate 0 2400 Use an effective transmission speed of 2400 for transmission time estimates instead of the 19200 bps interface speed. exit [code] Exit to the operating system with optional code. SEE ALSO: x, o, off commands EXPand sourcefile pathspec ** For each pathname in pathspec, execute the commands in sourcefile with the string parameter item set to the current pathname. The commands in sourcefile must not themselves contain wildcards (* or ?) or directory pathnames. If no files match pathspec, sourcefile is not executed. If the script executed has a READ ONLY attribute, ZCOMM is unrestricted during execution of the script. EXAMPLE: expand plxupl 001* Executes the script plxupl once for each file matching the wild card specification 001*. EXAMPLE: expand a *.arc where the file a contains: obey "!pkxarc -v %item >> arclist" lists the contents of all .arc files to arclist. (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 118 Chapter 99 explains the use of this command in more detail. f [-term_options] file The f (think of "file") command initiates transmission of file with the term function. One or more term function options (described in Chapter 22) may be enabled with the optional term_options flag. If q (TWX) option is enabled, transmission pauses until the called system's answerback restarts it with an XON, or until g option is set. Otherwise, any XOFF induced transmission pause is reset. Once the file has been opened with the f command, a pattern match or keyboarding F1 or ALT-X will exit the term function with file incompletely transmitted. The rest of the file may be transmitted by the t, F2, or wait commands. EXAMPLE: f -px message Uploads message paced by the p term option, which sends a carriage return and pauses at the end of each transmitted line until the remote responds with the prompt character (default line feed). The x term option makes the term function return to the script after the file has been transmitted. EXAMPLE: set eolstr "\r."; pp1000; pg58; f -p file Is useful for uploading a prepared message to a CompuServe bulletin boards using the "SIG" editor (not FILGE). The eolstr setting sends a carriage return and period after each line to prevent the CompuServe software from reformatting the message. Pp10000 Sets the pause timeout to a long time. Pg58 Sets the prompt character to ":". f -p file Transmits the file. SEE ALSO: b, g, p, r, n, t, w, x, X term options, eolstr string parameter, t and wait commands fail Terminate the current expand command, otherwise return from the current script level. If called directly by another level of script, that level is terminated. The fail command also causes the term function to exit, to allow a function key to be programmed with a macro that exits the term function. If called implicitly by a number presented for dialing, fail terminates the current dialing attempt. If no retries are left, the call is abandoned. fg Indicates ZCOMM is running in the foreground with a user at the keyboard. (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 119 SEE ALSO: bg command, df test condition fget outfile * Gets 8 bit raw data from the modem to outfile without any protocol. No data is displayed on the screen. Keyboarding F1 terminates recording; any other keyboarded character is sent to the remote. Iff the g numeric parameter is set to to some value other than its default of 10 (line feed), the fget command terminates upon reading and storing a character matching the g numeric parameter. The fget command also terminates recording on loss of carrier detect signal. This command can be used when the flow of data from the remote cannot be regulated. Do not set the I numeric parameter to a large value if flow control is not used. The maximum rate attainable without loss of data is limited by the maximum interrupt latency of the operating system and active device drivers. The time required to write a 512 character buffer to disk may also limit the maximum average data rate. Each 512 character block must be written before the modem interrupt input buffer overflows with new data. If the startup time for a floppy disk is excessive, better results will be obtained writing to a hard disk or ramdisk[9] if a suitable device is available. Tests with an IBM Personal Computer, DOS 2.1, and a Maynard Electronics hard disk suggest that no characters are lost at 9600 baud. (Your results will vary depending on your configuration and programming habits. California estimates lower.) EXAMPLE: fget rawdata find string pathspec Find and display lines containing matches to string in the specified files. Lower case characters in string match either case; upper case characters in string match upper case characters only. If string contains spaces, tabs, or semicolon, it must be enclosed by double quote characters. ZCOMM C style escapes may be used to represent control characters and string parameters to be searched for. Assuming normal DOS files (with CR/LF at the end of each line), a \n at the beginning of string forces a match to the beginning of a line. A \r at the end of string (\n if the file(s) have no returns in them) forces a match at the end of the line. The file name being searched and its length are displayed in the status line. For each line that contains a match to string, the file name (if more than one file), line number, and the text of the __________ 9. See comments on Extended Memory ramdisks in Chapter 34. (C) 1994 Omen Tech Inc Chapter 19 Main Commands Version 18.18 TurboDial 2.41 Universal Line Printer Edition ZCOMM User Manual 120 line are displayed. EXAMPLE: find count *.c Finds all occurrences of count or COUNT in the named files. SEE ALSO: egrep command FINDMore string pathspec Findmore finds a line matching string in each of the specified files, and then pages through the file beginning with the matched line. Otherwise, it is similar to the find command. When the screen is filled up, the prompt More? appears. Typing space displays another screenfull. Typing n skips to the next instance of string that has not yet been displayed. Typing ^Q or ^S displays one more character from the file. Typing ^X skips to the next file. SEE ALSO: egrepm, page commands findq string pathspec Silently searches the specified files for the first line matching string. The processing of string is identical to the find command described above. Upon a successful search, the contents of this line are stored in the z0 string variable and the ? numeric parameter is incremented. The findq command is useful for fetching password information from a disk file. SEE ALSO: egrepq command finish Terminates Kermit server operation on the remote system. fput file * Puts data from file to the remote at maximum speed without any protocol. Flow control as determined by the handshake command and the S numeric parameter is respected. After each 256 characters, the number of characters transmitted is displayed, and the keyboard is polled. Hitting any key will abort the transfer. This command is useful for testing RS232 peripherals at high rates. EXAMPLE: fput datafile fpute file * Echoplex transmit a file to the remote, waiting for the correct echo to each character transmitted (for Throttle/10 seconds). The echoed character is sent to the CRT screen. If fpute receives a space as an echo to a tab, fpute waits for the spaces to stop echoing for at least 100 milliseconds before resuming transmission. Transfer speed thus suffers when tabs are present in the transmitted file unless the remote can be set to echo tabs as tab characters instead of expanding them to spaces. Throughput is less than 1/3 of normal because of the echo delay. Fpute counts each time the correct character is not echoed as an (C) 1994 Omen Tech Inc Chapter 19 Main Commands