embedaddon/mpd/doc/mpd59.html - view

File: [ELWIX - Embedded LightWeight unIX -] / embedaddon / mpd / doc / mpd59.html
Revision 1.1.1.4 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Wed Mar 17 00:39:23 2021 UTC (3 years, 9 months ago) by misho
Branches: mpd, MAIN
CVS tags: v5_9p16, v5_9, HEAD

mpd 5.9

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> <TITLE>Script commands</TITLE> </HEAD> <BODY text="#000000" bgcolor="#ffffff"> <A HREF="mpd.html">Mpd 5.9 User Manual</A> : <A HREF="mpd50.html">Chat Scripting</A> : Script commands  Previous: <A HREF="mpd58.html">Special variables</A>  Next: <A HREF="mpd60.html">Errors</A> <HR NOSHADE> <H2><A NAME="59"></A>6.5. Script commands</H2>  <dl> <dt><code>set $variable-name string </code><dd>Set the <code>$variable-name</code> equal to <code>string</code>. The <code>string</code> is variable expanded first. <dt><code>match name string label </code><dd> <dt><code>match string label </code><dd> <dt><code>match string </code><dd> Add a new pending event to event set <code>name</code> such that when <code>string</code> is seen in the input, resume execution at <code>label</code>. The match must be exact. All arguments are variable expanded. If no <code>name</code> is given, or if <code>name</code> is the empty string, add the new event to the default set. If no <code>label</code> is given, or if <code>label</code> is the empty string, the event causes execution to resume starting with the statement following the <code>wait</code> command (i.e., use the default target). <dt><code>regex name pattern label </code><dd> <dt><code>regex pattern label </code><dd> <dt><code>regex pattern </code><dd> Same as the <code>match</code> command, but matches an extended regular expression instead of an exact string. If <code>pattern</code> is not a valid extended regular expression, the script fails. Regular expressions are matched on a line-by-line basis; the input matching the pattern cannot span more than one line. A line is terminated with either a newline or a carriage return-newline pair (the latter is more common). An end-of-line should be matched using a dollar sign rather than trying to match these characters directly, as mpd elides them from the input when testing the regular expression. See <code>re_format(7)</code> for more information about extended regular expressions. <dt><code>timer name seconds label </code><dd> <dt><code>timer seconds label </code><dd> <dt><code>timer seconds </code><dd> Add a new pending event to set <code>name</code> such that when <code>seconds</code> seconds have elapsed, resume execution at <code>label</code>. All arguments are variable expanded. If no <code>name</code> is given, or if <code>name</code> is the empty string, add the new event to the default set. If no <code>label</code> is given, or if <code>label</code> is the empty string, the event causes execution to resume starting with the statement following the <code>wait</code> command (i.e., use the default target). <dt><code>wait </code><dd> <dt><code>wait seconds </code><dd> In the first form, wait indefinitely for any event to happen. When an event happens, continue execution starting at the target label for that event. The second form is equivalent to:  <blockquote><code> <code>timer seconds  wait</code> </code></blockquote>  <dt><code>if string1 == string2 command </code><dd> <dt><code>if string1 != string2 command </code><dd> Executes <code>command</code> if the two variable expanded strings are equal or not equal. <dt><code>if string match pattern command </code><dd> <dt><code>if string !match pattern command </code><dd> Tests <code>string</code> against the regular expression <code>pattern</code> and executes <code>command</code> if <code>string</code> matches or does not match. Both <code>string</code> and <code>pattern</code> are variable expanded first. <dt><code>print string </code><dd>Ouput the <code>string</code> to the serial port. Variables are expanded, and the normal mpd C-style character escapes may be used. <dt><code>cancel name1 [ name2 ... ] </code><dd>Cancel all pending events in the sets <code>name1</code>, <code>name2</code>, etc. It is not an error to cancel a set which is already empty. <dt><code>goto label </code><dd>Jump to label <code>label</code>. <dt><code>call label </code><dd>Call a subroutine at <code>label</code>. <dt><code>return </code><dd>Return from subroutine. <dt><code>success </code><dd>Exit the script successfully. <dt><code>failure </code><dd>Exit the script unsuccessfully. <dt><code>log string </code><dd>Print <code>string</code>, variable expanded, to the log file under logging level CHAT. </dl>  <HR NOSHADE> <A HREF="mpd.html">Mpd 5.9 User Manual</A> : <A HREF="mpd50.html">Chat Scripting</A> : Script commands  Previous: <A HREF="mpd58.html">Special variables</A>  Next: <A HREF="mpd60.html">Errors</A> </BODY> </HTML>