.\" This file Copyright 1992,93,94 Miquel van Smoorenburg.\" 1998-2002 Jukka Lahtinen.\" It may be distributed under the GNU Public License, version 2, or.\" any higher version.  See section COPYING of the GNU Public license.\" for conditions under which this file may be redistributed..TH RUNSCRIPT 1 "$Date: 2003/03/30 18:55:42 $" "User's Manual".SH NAMErunscript \- script interpreter for minicom.SH SYNOPSIS.B runscript.RI "scriptname [logfile [homedir]]".SH DESCRIPTION.B runscriptis a simple script interpreter that can be called from within the minicomcommunications program to automate tasks like logging in to a unix systemor your favorite bbs..SH INVOCATIONThe program expects a script name and optionally a filename and the user's home directory as arguments, and it expects that it's input and output are connected to the \^"remote end\^", the system you are connecting to. All messages from \fBrunscript\fP ment for the local screen are directed to the \fBstderr\fP output. All this is automatically taken care of if you run it from \fBminicom\fP.The logfile and home directory parameters are only used to tell the log command the name of the logfile and where to write it. If the homedir is omitted, runscript uses the directory found in the $HOME environment variable. If also the logfile name is omitted, the log commands are ignored..SH KEYWORDS.TP 0.5iRunscript recognizes the following commands:.br.RS.nfexpect   send     goto     gosub    return   \^!exit     print    set      inc      dec      iftimeout  verbose  sleep    break    call     log.fi.RE.SH "OVERVIEW OF KEYWORDS".TP 0.5i.B "send <string>"<string> is sent to the modem. It is followed by a '\\r'.<string> can be:  - regular text, eg 'send hello'  - text enclosed in quotes, eg 'send \^"hello world\^"'.TP 0.5i     Within <string> the following sequences are recognized:    \\n - newline    \\r - carriage return    \\a - bell    \\b - backspace    \\c - don't send the default '\\r'.    \\f - formfeed    \\^ - the ^ character    \\o - send character \fBo\fP (\fBo\fP is an octal number).brControl characters can be used in the string with the ^ prefix (^A to ^Z, ^[, ^\, ^], ^^ and ^_). If you need to send the ^ chracter,you must prefix it with the \\ escape character..brAlso $(environment_variable) can be used, for example $(TERM).Minicom passes three special environment variables: $(LOGIN),which is the username, $(PASS), which is the password, asdefined in the proper entry of the dialing directory, and $(TERMLIN) which is the number of actual terminal lines on yourscreen (that is, the statusline excluded)..TP 0.5i.B "print <string>"Prints <string> to the local screen. Default followed by '\\r\\n'.See the description of 'send' above..TP 0.5i.B "label:"Declares a label (with the name 'label') to use withgoto or gosub..TP 0.5i.B "goto <label>"Jump to another place in the program..TP 0.5i.B "gosub <label>"Jumps to another place in the program. When the statement 'return'is encountered, control returns to the statement after the gosub.Gosub's can be nested..TP 0.5i.BR "return"Return from a gosub..TP 0.5i.BR "! <command>"Runs a shell for you in which 'command' is executed. On return,the variable '$?' is set to the exit status of this command,so you can subsequently test it using 'if'..TP 0.5i.B "exit [value]"Exit from \^"runscript\^" with an optional exit status. (default 1).TP 0.5i.B "set <variable> <value>"Sets the value of <variable> (which is a single letter a-z) to thevalue <value>. If <variable> does not exist, it will be created.<value> can be a integer value or another variable..TP 0.5i.B "inc <variable>"Increments the value of <variable> by one..TP 0.5i.B "dec <variable>"Decrements the value of <variable> by one..TP 0.5i.B "if <value> <operator> <value> <statement>"Conditional execution of <statement>. <operator> can be <, >, != or =.Eg, 'if a > 3 goto exitlabel'..TP 0.5i.B "timeout <value>"Sets the global timeout. By default, 'runscript' will exit after120 seconds. This can be changed with this command. Warning: thiscommand acts differently within an 'expect' statement, but moreabout that later..TP 0.5i.B "verbose <on|off>"By default, this is 'on'. That means that anything that is beingread from the modem by 'runscript', gets echoed to the screen.This is so that you can see what 'runscript' is doing..TP 0.5i.B "sleep <value>"Suspend execution for <value> seconds..TP 0.5i.B "expect".nf  expect {    pattern  [statement]    pattern  [statement]    [timeout <value> [statement] ]    ....  }.fiThe most important command of all. Expect keeps reading from theinput until it reads a pattern that matches one of thespecified ones.  If expect encounters an optional statementafter that pattern, it will execute it. Otherwise the default isto just break out of the expect. 'pattern' is a string, just asin 'send' (see above).  Normally, expect will timeout in 60seconds and just exit, but this can be changed with the timeoutcommand..TP 0.5i.B "break"Break out of an 'expect' statement. This is normally only usefulas argument to 'timeout' within an expect, because the defaultaction of timeout is to exit immediately..TP 0.5i.B "call <scriptname>"Transfers control to another scriptfile. When that scriptfilefinishes without errors, the original script will continue..TP 0.5i.B "log <text>"Write text to the logfile..SH NOTESIf you want to make your script to exit minicom (for example whenyou use minicom to dial up your ISP, and then start a ppp or slip session from a script), try the command "! killall -9 minicom" asthe last script command. The -9 option should prevent minicom fromhanging up the line and resetting the modem before exiting..br.brWell, I don't think this is enough information to make you anexperienced 'programmer' in 'runscript', but together with theexamples it shouldn't be too hard to write some useful scriptfiles. Things will be easier if you have experience with BASIC.The \fBminicom\fP source code comes together with two examplescripts, \fBscriptdemo\fP and \fBunixlogin\fP. Especially thelast one is a good base to build on for your own scripts..SH BUGSRunscript should be built in to minicom..SH AUTHORMiquel van Smoorenburg, <miquels@drinkel.ow.org>Jukka Lahtinen, <walker@netsonic.fi>