runscript.1
上传用户:tianjinjs
上传日期:2007-01-05
资源大小:309k
文件大小:6k
源码类别:

Modem编程

开发平台:

Unix_Linux

  1. ." This file Copyright 1992,93,94 Miquel van Smoorenburg
  2. ." 1998-1999 Jukka Lahtinen
  3. ." It may be distributed under the GNU Public License, version 2, or
  4. ." any higher version.  See section COPYING of the GNU Public license
  5. ." for conditions under which this file may be redistributed.
  6. .TH RUNSCRIPT 1 "5 Apr 1998" "User's Manual"
  7. .SH NAME
  8. runscript - script interpreter for minicom
  9. .SH SYNOPSIS
  10. .B runscript
  11. .RI "scriptname [logfile [homedir]]"
  12. .SH DESCRIPTION
  13. .B runscript
  14. is a simple script interpreter that can be called from within the minicom
  15. communications program to automate tasks like logging in to a unix system
  16. or your favorite bbs.
  17. .SH INVOCATION
  18. The program expects a script name and optionally a filename and the 
  19. user's home directory as arguments, and it expects that it's input and 
  20. output are connected to the ^"remote end^", the system you are 
  21. connecting to. All messages from fBrunscriptfP ment for the local screen 
  22. are directed to the fBstderrfP output. All this is automatically taken 
  23. care of if you run it from fBminicomfP.
  24. The logfile and home directory parameters are only used to tell the log 
  25. command the name of the logfile and where to write it. If the homedir is 
  26. omitted, runscript uses the directory found in the $HOME environment 
  27. variable. If also the logfile name is omitted, the log commands are ignored.
  28. .SH KEYWORDS
  29. .TP 0.5i
  30. Runscript recognizes the following commands:
  31. .br
  32. .RS
  33. .nf
  34. expect   send     goto     gosub    return   ^!
  35. exit     print    set      inc      dec      if
  36. timeout  verbose  sleep    break    call     log
  37. .fi
  38. .RE
  39. .SH "OVERVIEW OF KEYWORDS"
  40. .TP 0.5i
  41. .B "send <string>"
  42. <string> is sent to the modem. It is followed by a '\r'.
  43. <string> can be:
  44.   - regular text, eg 'send hello'
  45.   - text enclosed in quotes, eg 'send ^"hello world^"'
  46. .TP 0.5i
  47.      Within <string> the following sequences are recognized:
  48.     \n - newline
  49.     \r - carriage return
  50.     \a - bell
  51.     \b - backspace
  52.     \c - don't send the default '\r'.
  53.     \f - formfeed
  54.     \o - send character fBofP (fBofP is an octal number)
  55. .br
  56. Also $(environment_variable) can be used, for example $(TERM).
  57. Minicom passes three special environment variables: $(LOGIN),
  58. which is the username, $(PASS), which is the password, as
  59. defined in the proper entry of the dialing directory, and 
  60. $(TERMLIN) which is the number of actual terminal lines on your
  61. screen (that is, the statusline excluded).
  62. .TP 0.5i
  63. .B "print <string>"
  64. Prints <string> to the local screen. Default followed by '\r\n'.
  65. See the description of 'send' above.
  66. .TP 0.5i
  67. .B "label:"
  68. Declares a label (with the name 'label') to use with
  69. goto or gosub.
  70. .TP 0.5i
  71. .B "goto <label>"
  72. Jump to another place in the program.
  73. .TP 0.5i
  74. .B "gosub <label>"
  75. Jumps to another place in the program. When the statement 'return'
  76. is encountered, control returns to the statement after the gosub.
  77. Gosub's can be nested.
  78. .TP 0.5i
  79. .BR "return"
  80. Return from a gosub.
  81. .TP 0.5i
  82. .BR "! <command>"
  83. Runs a shell for you in which 'command' is executed. On return,
  84. the variable '$?' is set to the exit status of this command,
  85. so you can subsequently test it using 'if'.
  86. .TP 0.5i
  87. .B "exit [value]"
  88. Exit from ^"runscript^" with an optional exit status. (default 1)
  89. .TP 0.5i
  90. .B "set <variable> <value>"
  91. Sets the value of <variable> (which is a single letter a-z) to the
  92. value <value>. If <variable> does not exist, it will be created.
  93. <value> can be a integer value or another variable.
  94. .TP 0.5i
  95. .B "inc <variable>"
  96. Increments the value of <variable> by one.
  97. .TP 0.5i
  98. .B "dec <variable>"
  99. Decrements the value of <variable> by one.
  100. .TP 0.5i
  101. .B "if <value> <operator> <value> <statement>"
  102. Conditional execution of <statement>. <operator> can be <, >, != or =.
  103. Eg, 'if a > 3 goto exitlabel'.
  104. .TP 0.5i
  105. .B "timeout <value>"
  106. Sets the global timeout. By default, 'runscript' will exit after
  107. 120 seconds. This can be changed with this command. Warning: this
  108. command acts differently within an 'expect' statement, but more
  109. about that later.
  110. .TP 0.5i
  111. .B "verbose <on|off>"
  112. By default, this is 'on'. That means that anything that is being
  113. read from the modem by 'runscript', gets echoed to the screen.
  114. This is so that you can see what 'runscript' is doing.
  115. .TP 0.5i
  116. .B "sleep <value>"
  117. Suspend execution for <value> seconds.
  118. .TP 0.5i
  119. .B "expect"
  120. .nf
  121.   expect {
  122.     pattern  [statement]
  123.     pattern  [statement]
  124.     [timeout <value> [statement] ]
  125.     ....
  126.   }
  127. .fi
  128. The most important command of all. Expect keeps reading from the
  129. input until it reads a pattern that matches one of the
  130. specified ones.  If expect encounters an optional statement
  131. after that pattern, it will execute it. Otherwise the default is
  132. to just break out of the expect. 'pattern' is a string, just as
  133. in 'send' (see above).  Normally, expect will timeout in 60
  134. seconds and just exit, but this can be changed with the timeout
  135. command.
  136. .TP 0.5i
  137. .B "break"
  138. Break out of an 'expect' statement. This is normally only useful
  139. as argument to 'timeout' within an expect, because the default
  140. action of timeout is to exit immediately.
  141. .TP 0.5i
  142. .B "call <scriptname>"
  143. Transfers control to another scriptfile. When that scriptfile
  144. finishes without errors, the original script will continue.
  145. .TP 0.5i
  146. .B "log <text>"
  147. Write text to the logfile.
  148. .SH NOTES
  149. If you want to make your script to exit minicom (for example when
  150. you use minicom to dial up your ISP, and then start a ppp or slip 
  151. session from a script), try the command "! killall -9 minicom" as
  152. the last script command. The -9 option should prevent minicom from
  153. hanging up the line and resetting the modem before exiting.
  154. .br
  155. .br
  156. Well, I don't think this is enough information to make you an
  157. experienced 'programmer' in 'runscript', but together with the
  158. examples it shouldn't be too hard to write some useful script
  159. files. Things will be easier if you have experience with BASIC.
  160. The fBminicomfP source code comes together with two example
  161. scripts, fBscriptdemofP and fBunixloginfP. Especially the
  162. last one is a good base to build on for your own scripts.
  163. .SH BUGS
  164. Runscript should be built in to minicom.
  165. .SH AUTHOR
  166. Miquel van Smoorenburg, <miquels@drinkel.ow.org>
  167. Jukka Lahtinen, <walker@clinet.fi>