docs/reference/xexpr.xml
author ali <ali@juiblex.co.uk>
Wed Oct 10 22:58:21 2012 +0100 (2012-10-10)
changeset 0 bc8c9a11cbfc
permissions -rw-r--r--
Initial version
     1 <refentry id="xexpr">
     2 
     3 <refmeta>
     4 <refentrytitle>xexpr</refentrytitle>
     5 <manvolnum>1</manvolnum>
     6 <refmiscinfo class="manual">User Commands</refmiscinfo>
     7 </refmeta>
     8 
     9 <refnamediv>
    10 <refname>xexpr</refname>
    11 <refpurpose>XEXPR Interpreter</refpurpose>
    12 </refnamediv>
    13 
    14 <refsynopsisdiv>
    15 <cmdsynopsis>
    16 <command>xexpr</command>
    17 <arg choice="opt" rep="repeat">OPTION</arg>
    18 <arg>script</arg>
    19 </cmdsynopsis>
    20 </refsynopsisdiv>
    21 
    22 <refsect1><title>Description</title>
    23 <para><command>xexpr</command> is an XEXPR interpreter. It loads and executes
    24 XEXPR programs.
    25 </para>
    26 </refsect1>
    27 
    28 <refsect1><title>Options</title>
    29 <variablelist>
    30 
    31 <varlistentry>
    32 <term><option>-h</option>, <option>--help</option></term>
    33 <listitem><para>
    34 print help and exit
    35 </para></listitem>
    36 </varlistentry>
    37 
    38 <varlistentry>
    39 <term><option>-d</option>, <option>--dump-tree</option></term>
    40 <listitem><para>
    41 Instead of executing the XEXPR program, dump the parsed tree after loading
    42 </para></listitem>
    43 </varlistentry>
    44 
    45 <varlistentry>
    46 <term><option>-D</option>, <option>--dump-result</option></term>
    47 <listitem><para>
    48 After executing the XEXPR program, dump the result
    49 </para></listitem>
    50 </varlistentry>
    51 
    52 <varlistentry>
    53 <term><option>-t</option>, <option>--test-result</option></term>
    54 <listitem><para>
    55 After executing the XEXPR program, test the result and exit 0 if it evaluates
    56 to &lt;true/&gt; and non-zero if it evaluates to &lt;false/&gt;
    57 </para></listitem>
    58 </varlistentry>
    59 
    60 <varlistentry>
    61 <term><option>-T=<replaceable>id</replaceable></option>, <option>--trace <replaceable>id</replaceable></option></term>
    62 <listitem><para>
    63 Adds <replaceable>id</replaceable> to the set of symbols to trace.
    64 
    65 When variables with the name of a traced symbol are created or changed,
    66 <command>xexpr</command> will output a suitable tracing message and a stack
    67 dump
    68 </para></listitem>
    69 </varlistentry>
    70 
    71 <varlistentry>
    72 <term><option>--xinclude</option></term>
    73 <listitem><para>
    74 Do XInclude processing
    75 </para></listitem>
    76 </varlistentry>
    77 
    78 <varlistentry>
    79 <term><option>--param <replaceable>name</replaceable>,<replaceable>number</replaceable></option></term>
    80 <listitem><para>
    81 Set a global XEXPR variable of the given <replaceable>name</replaceable> with a
    82 numeric value of <replaceable>number</replaceable>. A float or integer type
    83 will be selected automatically.
    84 </para></listitem>
    85 </varlistentry>
    86 
    87 <varlistentry>
    88 <term><option>--stringparam <replaceable>name</replaceable>,<replaceable>value</replaceable></option></term>
    89 <listitem><para>
    90 Set a global XEXPR variable of the given <replaceable>name</replaceable> with a
    91 string value of <replaceable>value</replaceable>.
    92 </para></listitem>
    93 </varlistentry>
    94 
    95 </variablelist>
    96 </refsect1>
    97 </refentry>