docs: add extra section describing the env-vars.

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 1de8cd8..770b755 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -66,7 +66,7 @@ HTML_IMAGES=
 
 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=building.xml concepts.xml opcode_table.xml opcodes.xml tutorial.xml table.xml
+content_files=building.xml concepts.xml opcode_table.xml opcodes.xml running.xml tutorial.xml table.xml
 
 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
 # These files must be listed here *and* in content_files

diff --git a/doc/orc-docs.sgml b/doc/orc-docs.sgml
index a9170ae..f8aee88 100644 (file)
--- a/doc/orc-docs.sgml
+++ b/doc/orc-docs.sgml
@@ -17,6 +17,7 @@
   <chapter>
     <title>Overview</title>
     <xi:include href="building.xml"/>
+    <xi:include href="running.xml"/>
     <xi:include href="concepts.xml"/>
     <xi:include href="tutorial.xml"/>
   </chapter>

diff --git a/doc/running.xml b/doc/running.xml
new file mode 100644 (file)
index 0000000..dfb0ccf
--- /dev/null
+++ b/doc/running.xml
@@ -0,0 +1,59 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!ENTITY % version-entities SYSTEM "version.entities">
+%version-entities;
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<refentry id="orc-runninging" revision="10 jan 2011">
+<refmeta>
+<refentrytitle>Running Orc Applications</refentrytitle>
+<manvolnum>3</manvolnum>
+<refmiscinfo>Orc</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>Running Orc Applications</refname>
+<refpurpose>
+How to run applications using ORC.
+</refpurpose>
+</refnamediv>
+
+<refsect1>
+<title>Running Orc Applications</title>
+
+<para>
+At runtime several environment variables can be used to control ORC.
+</para>
+
+<formalpara id="ORC_DEBUG">
+  <title><envar>ORC_DEBUG</envar></title>
+
+  <para>
+    This environment variable can be set to a number indicating the level for
+    debug logging. A value of 0 (default) results in no debug logging. The
+    higher the value to more detail is logged.
+  </para>
+</formalpara>
+
+<formalpara id="ORC_CODE">
+  <title><envar>ORC_CODE</envar></title>
+
+  <para>
+    This variable can be set to a comma separated list of flags to control the
+    code selection and execution. Supported values are: backup, emulate and
+    debug. 'Backup' would instruct ORC to select the C based backup functions.
+    'Emulate' will run the ORC code through an interpreter.
+  </para>
+</formalpara>
+
+<formalpara id="ORC_CPU_FLAGS">
+  <title><envar>ORC_CPU_FLAGS</envar></title>
+    This environment variable can be used to manually specify cpu capabilities.
+  <para>
+  </para>
+</formalpara>
+
+</refsect1>
+
+</refentry>