1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/reference/xexpr.xml	Wed Oct 10 22:58:48 2012 +0100
     1.3 @@ -0,0 +1,97 @@
     1.4 +<refentry id="xexpr">
     1.5 +
     1.6 +<refmeta>
     1.7 +<refentrytitle>xexpr</refentrytitle>
     1.8 +<manvolnum>1</manvolnum>
     1.9 +<refmiscinfo class="manual">User Commands</refmiscinfo>
    1.10 +</refmeta>
    1.11 +
    1.12 +<refnamediv>
    1.13 +<refname>xexpr</refname>
    1.14 +<refpurpose>XEXPR Interpreter</refpurpose>
    1.15 +</refnamediv>
    1.16 +
    1.17 +<refsynopsisdiv>
    1.18 +<cmdsynopsis>
    1.19 +<command>xexpr</command>
    1.20 +<arg choice="opt" rep="repeat">OPTION</arg>
    1.21 +<arg>script</arg>
    1.22 +</cmdsynopsis>
    1.23 +</refsynopsisdiv>
    1.24 +
    1.25 +<refsect1><title>Description</title>
    1.26 +<para><command>xexpr</command> is an XEXPR interpreter. It loads and executes
    1.27 +XEXPR programs.
    1.28 +</para>
    1.29 +</refsect1>
    1.30 +
    1.31 +<refsect1><title>Options</title>
    1.32 +<variablelist>
    1.33 +
    1.34 +<varlistentry>
    1.35 +<term><option>-h</option>, <option>--help</option></term>
    1.36 +<listitem><para>
    1.37 +print help and exit
    1.38 +</para></listitem>
    1.39 +</varlistentry>
    1.40 +
    1.41 +<varlistentry>
    1.42 +<term><option>-d</option>, <option>--dump-tree</option></term>
    1.43 +<listitem><para>
    1.44 +Instead of executing the XEXPR program, dump the parsed tree after loading
    1.45 +</para></listitem>
    1.46 +</varlistentry>
    1.47 +
    1.48 +<varlistentry>
    1.49 +<term><option>-D</option>, <option>--dump-result</option></term>
    1.50 +<listitem><para>
    1.51 +After executing the XEXPR program, dump the result
    1.52 +</para></listitem>
    1.53 +</varlistentry>
    1.54 +
    1.55 +<varlistentry>
    1.56 +<term><option>-t</option>, <option>--test-result</option></term>
    1.57 +<listitem><para>
    1.58 +After executing the XEXPR program, test the result and exit 0 if it evaluates
    1.59 +to &lt;true/&gt; and non-zero if it evaluates to &lt;false/&gt;
    1.60 +</para></listitem>
    1.61 +</varlistentry>
    1.62 +
    1.63 +<varlistentry>
    1.64 +<term><option>-T=<replaceable>id</replaceable></option>, <option>--trace <replaceable>id</replaceable></option></term>
    1.65 +<listitem><para>
    1.66 +Adds <replaceable>id</replaceable> to the set of symbols to trace.
    1.67 +
    1.68 +When variables with the name of a traced symbol are created or changed,
    1.69 +<command>xexpr</command> will output a suitable tracing message and a stack
    1.70 +dump
    1.71 +</para></listitem>
    1.72 +</varlistentry>
    1.73 +
    1.74 +<varlistentry>
    1.75 +<term><option>--xinclude</option></term>
    1.76 +<listitem><para>
    1.77 +Do XInclude processing
    1.78 +</para></listitem>
    1.79 +</varlistentry>
    1.80 +
    1.81 +<varlistentry>
    1.82 +<term><option>--param <replaceable>name</replaceable>,<replaceable>number</replaceable></option></term>
    1.83 +<listitem><para>
    1.84 +Set a global XEXPR variable of the given <replaceable>name</replaceable> with a
    1.85 +numeric value of <replaceable>number</replaceable>. A float or integer type
    1.86 +will be selected automatically.
    1.87 +</para></listitem>
    1.88 +</varlistentry>
    1.89 +
    1.90 +<varlistentry>
    1.91 +<term><option>--stringparam <replaceable>name</replaceable>,<replaceable>value</replaceable></option></term>
    1.92 +<listitem><para>
    1.93 +Set a global XEXPR variable of the given <replaceable>name</replaceable> with a
    1.94 +string value of <replaceable>value</replaceable>.
    1.95 +</para></listitem>
    1.96 +</varlistentry>
    1.97 +
    1.98 +</variablelist>
    1.99 +</refsect1>
   1.100 +</refentry>