embedaddon/mpd/doc/mpd59.html - view

File: [ELWIX - Embedded LightWeight unIX -] / embedaddon / mpd / doc / mpd59.html
Revision 1.1.1.2 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Mon Jul 22 08:44:30 2013 UTC (10 years, 11 months ago) by misho
Branches: mpd, MAIN
CVS tags: v5_7p0, v5_7, HEAD

5.7

1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> 2: <HTML> 3: <HEAD> 4: <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> 5: <TITLE>Script commands</TITLE> 6: </HEAD> 7: <BODY text="#000000" bgcolor="#ffffff"> 8: 9: <A HREF="mpd.html">Mpd 5.7 User Manual</A> 10: : <A HREF="mpd50.html">Chat Scripting</A> 11: : Script commands  12: Previous: <A HREF="mpd58.html">Special variables</A>  13: Next: <A HREF="mpd60.html">Errors</A> 14: 15: 16: <HR NOSHADE> 17: <H2><A NAME="59"></A>6.5. Script commands</H2> 18:  19: <dl> 20: 21: <dt><code>set $variable-name string </code><dd>Set the <code>$variable-name</code> equal to 22: <code>string</code>. The <code>string</code> is 23: variable expanded first. 24: 25: <dt><code>match name string label </code><dd> 26: <dt><code>match string label </code><dd> 27: <dt><code>match string </code><dd> 28: Add a new pending event to event set <code>name</code> 29: such that when <code>string</code> is seen in the input, 30: resume execution at <code>label</code>. The match must 31: be exact. All arguments are variable expanded. 32: If no <code>name</code> is given, or if <code>name</code> 33: is the empty string, add the new event to the default set. 34: If no <code>label</code> is given, or if <code>label</code> 35: is the empty string, the event causes execution to resume 36: starting with the statement following the <code>wait</code> command 37: (i.e., use the default target). 38: 39: <dt><code>regex name pattern label </code><dd> 40: <dt><code>regex pattern label </code><dd> 41: <dt><code>regex pattern </code><dd> 42: Same as the <code>match</code> command, but matches an extended 43: regular expression instead of an exact string. If 44: <code>pattern</code> is not a valid extended regular 45: expression, the script fails. 46: Regular expressions are matched on a line-by-line basis; the 47: input matching the pattern cannot span more than one line. A 48: line is terminated with either a newline or a carriage return-newline 49: pair (the latter is more common). An end-of-line should 50: be matched using a dollar sign rather than trying to match these 51: characters directly, as mpd elides them from the input when 52: testing the regular expression. 53: See <code>re_format(7)</code> for more information about extended 54: regular expressions. 55: 56: <dt><code>timer name seconds label </code><dd> 57: <dt><code>timer seconds label </code><dd> 58: <dt><code>timer seconds </code><dd> 59: Add a new pending event to set <code>name</code> such that 60: when <code>seconds</code> seconds have elapsed, 61: resume execution at <code>label</code>. 62: All arguments are variable expanded. 63: If no <code>name</code> is given, or if <code>name</code> 64: is the empty string, add the new event to the default set. 65: If no <code>label</code> is given, or if <code>label</code> 66: is the empty string, the event causes execution to resume 67: starting with the statement following the <code>wait</code> command 68: (i.e., use the default target). 69: 70: <dt><code>wait </code><dd> 71: <dt><code>wait seconds </code><dd> 72: In the first form, wait indefinitely for any event to happen. 73: When an event happens, continue execution starting at the target 74: label for that event. 75: The second form is equivalent to: 76:  77: <blockquote><code> 78: <code>timer seconds  79: wait</code> 80: </code></blockquote> 81:  82: 83: <dt><code>if string1 == string2 84: command </code><dd> 85: <dt><code>if string1 != string2 86: command </code><dd> 87: Executes <code>command</code> if the two variable expanded 88: strings are equal or not equal. 89: 90: <dt><code>if string match pattern 91: command </code><dd> 92: <dt><code>if string !match pattern 93: command </code><dd> 94: Tests <code>string</code> against the regular expression 95: <code>pattern</code> and executes <code>command</code> 96: if <code>string</code> matches or does not match. Both 97: <code>string</code> and <code>pattern</code> are 98: variable expanded first. 99: 100: <dt><code>print string </code><dd>Ouput the <code>string</code> to the serial port. 101: Variables are expanded, and the normal mpd C-style character 102: escapes may be used. 103: 104: <dt><code>cancel name1 [ name2 ... ] </code><dd>Cancel all pending events in the sets <code>name1</code>, 105: <code>name2</code>, etc. 106: It is not an error to cancel a set which is already empty. 107: 108: <dt><code>goto label </code><dd>Jump to label <code>label</code>. 109: 110: <dt><code>call label </code><dd>Call a subroutine at <code>label</code>. 111: 112: <dt><code>return </code><dd>Return from subroutine. 113: 114: <dt><code>success </code><dd>Exit the script successfully. 115: 116: <dt><code>failure </code><dd>Exit the script unsuccessfully. 117: 118: <dt><code>log string </code><dd>Print <code>string</code>, variable expanded, to the log 119: file under logging level CHAT. 120: 121: </dl> 122:  123: 124: <HR NOSHADE> 125: <A HREF="mpd.html">Mpd 5.7 User Manual</A> 126: : <A HREF="mpd50.html">Chat Scripting</A> 127: : Script commands  128: Previous: <A HREF="mpd58.html">Special variables</A>  129: Next: <A HREF="mpd60.html">Errors</A> 130: 131: 132: 133: </BODY> 134: </HTML>