Bonobo-Activation docs

[Martin Kretzschmar <m_kretzschmar gmx net>]

Hi list,

Yesterday, I was going to work on the server-xml-reference.sgml
(standard oaf_attributes etc.) but than got distracted by IRC. So
suddenly I was fixing the wrong file, configuring.sgml ;-)

May I commit the attached patch?

I couldn't answer the real question of the guy on IRC: He has a
bonobo-activation with prefix=/usr. Can he make it look for server files
in /usr/local/lib/bonobo/servers before /usr/lib/bonobo/servers?

And I want to reformulate my second question from monday:

Are repo_ids, name, and description really mandatory attributes, or is
the description from doc/activation/standard-attributes.txt correct?

Regards,
	Martin

Index: doc/activation-api/configuring.sgml
===================================================================
RCS file: /cvs/gnome/libbonobo/doc/activation-api/configuring.sgml,v
retrieving revision 1.4
diff -u -r1.4 configuring.sgml
--- doc/activation-api/configuring.sgml	11 Dec 2001 00:28:39 -0000	1.4
+++ doc/activation-api/configuring.sgml	7 May 2003 19:48:26 -0000
@@ -1,61 +1,99 @@
 <chapter id="configuring">
-<title>Configuring Bonobo Activation</title>
+  <title>Configuring Bonobo Activation</title>
 
-<sect1>
-<title>.server search path.</title>
-<para>
-To know the list of available CORBA servers on your local machine, the OAF daemon
-searches a number of directories for .server XML files which contain the description
-of the services offered by these servers.
-By default, OAF will try to find them in ${prefix}/share/oaf which may be a problem
-if users install other applications using OAF in different prefixes.
-</para>
-
-<para>
-To work around this problem, OAF will parse a number of other directories.
-It will parse the directories listed in the OAF_INFO_PATH env variable.
-It will parse the prefixes listed in the GNOME_PATH env variable.
-If, for example, <emphasis>OAF_INFO_PATH=/opt/gnome/share/oaf:/opt/gnome/oaf/share/oaf</emphasis>,
-OAF will parse <emphasis>/opt/gnome/share/oaf</emphasis> and <emphasis>/opt/gnome/oaf/share/oaf</emphasis>
-If <emphasis>GNOME_PATH=/opt/gnome:/opt/gnome/oaf</emphasis>, OAF will parse
-<emphasis>/opt/gnome/share/oaf</emphasis> and <emphasis>/opt/gnome/oaf/share/oaf</emphasis>.
-</para>
-
-<para>
-The above env variables are kept for compatibility purposes with older versions of 
-OAF and for GNOME integration. OAF has a much nicer configuration file which allows 
-you to control which directories are parsed by OAF. This XML configuration file
-is located in ${prefix}/etc/oaf/oaf-config.xml. An empty oaf-config.xml and 
-a sample oaf-config.xml.sample file should be installed on your system.
-</para>
-
-<para>
-It is recommended to use the <emphasis>oaf-sysconf</emphasis> command-line configuration 
-tool to edit this file. However, here is an example of its format.
-</para>
+  <sect1>
+    <title><filename>.server</filename> search path.</title>
+    <para>
+      To know the list of available <acronym>CORBA</acronym> servers on your
+      local machine, the Bonobo-Activation daemon searches a number of
+      directories for <filename>.server</filename> <acronym>XML</acronym>
+      files which contain the description of the services offered by these
+      servers.
+
+      By default, Bonobo-Activation will try to find them in 
+      <filename>${prefix}/lib/bonobo/servers</filename> which may be a problem
+      if users install other applications using Bonobo-Activation in different
+      prefixes.
+    </para>
+
+    <para>
+      To work around this problem, Bonobo-Activation will parse a number of
+      other directories.
+      It will parse the directories listed in the 
+      <envar>BONOBO_ACTIVATION_PATH</envar> environment variable.
+      It will parse the prefixes listed in the <envar>GNOME2_PATH</envar>
+      environment variable.
+
+      If, for example,
+      <emphasis>BONOBO_ACTIVATION_PATH=/opt/gnome2/lib/bonobo/servers:/opt/gnome2/bonobo-activation/lib/bonobo/servers</emphasis>,
+      Bonobo-Activation will parse
+      <emphasis>/opt/gnome2/lib/bonobo/servers</emphasis> and 
+      <emphasis>/opt/gnome2/bonobo-activation/lib/bonobo/servers</emphasis>
+
+      If <emphasis>GNOME2_PATH=/opt/gnome2:/opt/gnome2/bonobo-activation</emphasis>,
+      Bonobo-Activation will parse
+      <emphasis>/opt/gnome2/lib/bonobo/servers</emphasis> and
+      <emphasis>/opt/gnome2/bonobo-activation/lib/bonobo/servers</emphasis>.
+    </para>
+
+    <!-- FIXME in which order does it search exactly
+         (question on IRC on 2003-05-06) -->
+
+    <para>
+      The above environment variables are kept to ease development with
+      Bonobo-Activation and for <acronym>GNOME</acronym> integration.
+      Bonobo-Activation has a much nicer configuration file which allows 
+      you to control which directories are parsed by Bonobo-Activation.
+      This <acronym>XML</acronym> configuration file is located in
+      <filename>/etc/bonobo-activation/bonobo-activation-config.xml</filename>
+      or
+      <filename>${prefix}/etc/bonobo-activation/bonobo-activation-config.xml</filename>.
+      An empty <filename>bonobo-activation-config.xml</filename> and a sample
+      <filename>bonobo-activation-config.xml.sample</filename> file should be
+      installed on your system.
+    </para>
+
+    <para>
+      It is recommended to use the
+      <command>bonobo-activation-sysconf</command> command-line
+      configuration tool to edit this file. However, here is an example of its
+      format.
+    </para>
 
-<programlisting>
+    <programlisting>
 &lt;?xml version="1.0"?>
 
 &lt;oafconfig>
 
 &lt;searchpath>
-&lt;item>/opt/gnome/share/oaf&lt;/item>
-&lt;item>/usr/local/gnome/share/oaf&lt;/item>
-&lt;item>/usr/local/share/oaf&lt;/item>
-&lt;item>/opt/gnome/oaf/share/oaf&lt;/item>
+&lt;item>/opt/gnome2/lib/bonobo/servers&lt;/item>
+&lt;item>/usr/local/gnome2/lib/bonobo/servers&lt;/item>
+&lt;item>/usr/local/lib/bonobo/servers&lt;/item>
+&lt;item>/opt/gnome2/bonobo-activation/lib/bonobo/servers&lt;/item>
 &lt;/searchpath>
 
 &lt;searchpath>
-&lt;item>/opt/gnome/oaf/share/oaf&lt;/item>
+&lt;item>/opt/gnome2/bonobo-activation/lib/bonobo/servers&lt;/item>
 &lt;/searchpath>
 
-&lt;/oafconfig>
-</programlisting>
+&lt;/oafconfig></programlisting>
 
-<para>There can be any number of &lt;item> tags in a &lt;searchpath> tag and any number of 
-&lt;searchpath tags in the &lt;oafconfig> tag.</para>
+    <para>
+      There can be any number of <sgmltag>item</sgmltag> tags in a
+      <sgmltag>searchpath</sgmltag> tag and any number of
+      <sgmltag>searchpath</sgmltag> tags in the <sgmltag>oafconfig</sgmltag>
+      tag.
+    </para>
 
-</sect1>
+  </sect1>
 
 </chapter>
+
+<!--
+Local Variables:
+mode: xml
+sgml-namecase-general: t
+sgml-general-insert-case: lower
+sgml-parent-document: ("bonobo-activation-docs.sgml" "BOOK" "CHAPTER")
+End:
+-->