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