Date: Tue Mar 5 22:31:23 CET 2002
User: Derick Rethans
Directory: srmdoc/api
Log Message:
[0.50]
- Make manual build again
- Adding some <link>s and <literal>s
- Fixing typoes and whitespace
Modified files:
srmdoc/manual.xml (version: 1.12)
srmdoc/admin/compiling.xml (version: 1.2)
srmdoc/admin/installation.xml (version: 1.5)
srmdoc/admin/intro.xml (version: 1.4)
srmdoc/api/modules.xml (version: 1.2)
[FILE: /srmdoc/manual.xml]
--- srmdoc/manual.xml:1.11 Sun Feb 10 18:22:51 2002 GMT
+++ srmdoc/manual.xml Tue Mar 05 20:31:22 2002 GMT
@@ -11,6 +11,7 @@
<!ENTITY srmdoc.user-classes SYSTEM "./user/classes.xml">
<!ENTITY srmdoc.admin-intro SYSTEM "./admin/intro.xml">
+ <!ENTITY srmdoc.admin-compiling SYSTEM "./admin/compiling.xml">
<!ENTITY srmdoc.admin-installation SYSTEM "./admin/installation.xml">
<!ENTITY srmdoc.admin-settings SYSTEM "./admin/settings.xml">
@@ -38,6 +39,7 @@
<part id="srmdoc-admin">
<title>Administration documentation</title>
&srmdoc.admin-intro;
+ &srmdoc.admin-compiling;
&srmdoc.admin-installation;
&srmdoc.admin-settings;
</part>
[FILE: /srmdoc/admin/compiling.xml]
--- srmdoc/admin/compiling.xml:1.1 Tue Mar 05 17:18:37 2002 GMT
+++ srmdoc/admin/compiling.xml Tue Mar 05 20:31:22 2002 GMT
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.85 $ -->
-<chapter id="admin.installation">
- <title>Installation</title>
+<chapter id="admin.compiling">
+ <title>Compiling</title>
<para>
- This section of the manual is designed to help you with installing
+ This section of the manual is designed to help you with compiling
Vulcan-Logic SRM. To show better examples, the configuration used in this
installation chapter is not identical to the default SRM configuration.
There will be a note where there is a deviation from the default
[FILE: /srmdoc/admin/installation.xml]
--- srmdoc/admin/installation.xml:1.4 Tue Mar 05 17:18:37 2002 GMT
+++ srmdoc/admin/installation.xml Tue Mar 05 20:31:22 2002 GMT
@@ -7,15 +7,22 @@
to it:
<itemizedlist>
<listitem>
- <para>The copying of the binary to desired permanent location.</para>
+ <para>
+ The <link linkend="admin.srm-binary">copying</link> of the binary to
+ desired permanent location.
+ </para>
</listitem>
<listitem>
- <para>The copying of the srm.ini file to the user-defined compiled
- location.</para>
+ <para>
+ The copying of the <literal>srm.ini</literal> file to the
+ user-defined compiled location.
+ </para>
</listitem>
<listitem>
- <para>The modification of the system to automatically begin the SRM
- daemon at bootstrap.</para>
+ <para>
+ The modification of the system to automatically begin the SRM
+ daemon at <link linkend="admin.bootstrap">bootstrap</link>.
+ </para>
</listitem>
</itemizedlist>
</para>
@@ -23,97 +30,151 @@
<section id="admin.srm-binary">
<title>Binary Home On The Range</title>
<para>
- Under the UNIX environment, the configure script ran at the beginning of
- this process defines the final location of the binaries for the Makefiles.
- Unless overridden by the user at configure time, the default location is
- /usr/local/srm/bin. To make life easier for the enduser, these Makefiles
- have an "install" option. Typing in
+ Under the UNIX environment, the <link linkend="admin.configure">configure
+ script</link> ran at the beginning of this process defines the final
+ location of the binaries for the Makefiles. Unless overridden by the user
+ at configure time, the default location is
+ <literal>/usr/local/srm/bin</literal>. To make life easier for the
+ enduser, these Makefiles have an <literal>install</literal> option. Typing
+ in
+ </para>
+ <para>
<programlisting role="shell">
- $ sudo make install
+ $ sudo make install
</programlisting>
- from the srm source directory, will cause the make system to copy the
+ </para>
+ <para>
+ from the SRM source directory, will cause the make system to copy the
freshly built binary files to the appropriate locations. This process will
- <b>NOT</b> copy the srm.ini though.
+ <emphasis>NOT</emphasis> copy the <literal>srm.ini</literal> though.
</para>
</section>
<section id="admin.srm-ini">
<title>The srm.ini</title>
+ <para>
+ The <literal>srm.ini</literal> is the file used by the SRM system, to
+ allow configuration changes to the daemon. For example, you can use it to
+ turn on or turn off the auth module. A more detailed explination of the
+ <literal>srm.ini</literal> file can be found in the <link
+ linkend="admin.ini-settings">ini-settings</link> section of the manual.
+ </para>
+ <para>
+ At this point in the installation process, copying the
+ <literal>srm.ini</literal> from the SRM source directory to
+ <literal>/etc</literal> will be sufficent. If at configure time, the user
+ defined a custom <literal>--prefix</literal> option, the
+ <literal>srm.ini</literal> will need to be modifed to reflect the new
+ paths.
+ </para>
+ </section>
+
+ <section id="admin.commandline">
+ <title>Commandline options</title>
+ <para>
+ The daemon can be started with a minimal number of arguments, which are
+ described here. Please note that a <link
+ linkend="admin.configure.debug">debug compile</link> of SRM changes the
+ meaning of some of those options.
+ </para>
+ <para>
+ <variablelist>
+ <varlistentry id="admin.commandline.l">
+ <term>
+ <parameter>-L</parameter>
+ </term>
+ <listitem>
+ <para>
+ This argument will cause the daemon to output all messages to the
+ logfile rather than to the screen.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="admin.commandline.h">
+ <term>
+ <parameter>-h</parameter>
+ </term>
+ <listitem>
+ <para>
+ This argument will cause the daemon to display a short description and
+ list of all the arguments it is capable of using. The daemon will
+ cease execution once it has finished displaying this information.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="admin.commandline.s">
+ <term>
+ <parameter>-S</parameter>
+ </term>
+ <listitem>
+ <para>
+ This argument will cause the daemon to ignore any signals sent EXCEPT
+ the SIGKILL signal.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry id="admin.commandline.v">
+ <term>
+ <parameter>-V</parameter>
+ </term>
+ <listitem>
+ <para>
+ This argument will cause the daemon to display it's version number and
+ information to the screen. The daemon will cease execution once it has
+ finished displaying this information.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </section>
+
+ <section id="admin.bootstrap">
+ <title>Ground Control To Major Tom</title>
+ <para>
+ The process of having the SRM daemon run at bootstrap is dependent upon the
+ host machines operating system. Note that the paths may be different on a
+ local installation. Please update any path related information to reflect
+ that which was defined at the configure time. These examples all follow
+ the defaults provided by the configure script.
+ </para>
+
+ <section>
+ <title>BSD based UNIX</title>
<para>
- The <literal>srm.ini</literal> is the file used by the SRM system, to
- allow configuration changes to the daemon. For example, you can use it to
- turn on or turn off the auth module. A more detailed explination of the
- srm.ini file can be found in the <link
- linkend="admin.ini-settings">ini-settings</link> section of the manual.
+ Under a BSD based UNIX, editing the <literal>/etc/rc</literal> file will
+ be sufficent (some BSD unicies prefer <literal>/etc/rc.local</literal>).
+ Adding the following lines to end of the appropriate rc file will begin
+ the SRM daemon at the next boot:
</para>
<para>
- At this point in the installation process, copying the srm.ini from the
- srm source directory to /etc will be sufficent. If at configure time, the
- user defined a custom <literal>--prefix</literal> option, the srm.ini
- will need to be modifed to reflect the new paths.
+ <programlisting role="shell">
+ if [ -d /usr/local/srm/bin/srmd ] && [ -f /etc/srm.ini ]; then
+ echo -n ' srmd' ; /usr/local/srm/bin/srmd -L
+ fi
+ </programlisting>
+ </para>
+ <para>
+ This small snippet checks for both the binary and the
+ <literal>srm.ini</literal> file, echos to the console that srmd is
+ starting, and runs the SRM daemon.
</para>
</section>
- <section id="admin.bootstrap">
- <title>Ground Control To Major Tom</title>
- <para>
- The process of having the SRM daemon run at bootstrap is dependent upon
- the host machines operating system. The daemon is able to take a
- minimal number of arguements at runtime. The arguements include:
- <itemizedlist>
- <listitem>
- <para><literal>-L</literal> This arguement will cause the daemon to
- output all messages to the logfile rather than to the screen.</para>
- </listitem>
- <listitem>
- <para><literal>-h</literal> This arguement will cause the daemon to
- display a short description and list of all the arguements it is
- capable of using. The daemon will cease execution once it has finished
- displaying this information.</para>
- </listitem>
- <listitem>
- <para><literal>-S</literal> This arguement will cause the daemon to
- ignore any signals sent EXCEPT the SIGKILL signal.</para>
- </listitem>
- <listitem>
- <para><literal>-V</literal> This arguement will cause the daemon to
- display it's version number and information to the screen. The daemon
- will cease execution once it has finished displaying this
- information.</para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- Note that the paths may be different on a local installation. Please
- update any path related information to reflect that which was defined
- at the configure time. These examples all follow the defaults provided
- by the configure script.
- </para>
-
- <para title="BSD based UNIX">
- Under a BSD based UNIX, editing the /etc/rc file will be sufficent (some
- BSD unicies prefer /etc/rc.local). Adding the following lines to end of
- the appropriate rc file will begin the SRM daemon at the next boot:
-
- <programlisting role="shell">
- if [ -d /usr/local/srm/bin/srmd ] && [ -f /etc/srm.ini ]; then
- echo -n ' srmd' ; /usr/local/srm/bin/srmd -L
- fi
- </programlisting>
-
- This small snippet checks for both the binary and the srm.ini file,
- echos to the console that srmd is starting, and runs the SRM daemon.
- </para>
-
- <para title="SysV based UNIX">
- Why in the hell would you want to be running this style unix anyways?
- </para>
-
- <para title="Windows based PCs">
- At this time the Windows port is not yet complete.
- </para>
+ <section>
+ <title>SysV based UNIX</title>
+ <para>
+ Why in the hell would you want to be running this style Unix anyways?
+ </para>
+ </section>
+
+ <section>
+ <title>Windows based PCs</title>
+ <para>
+ At this time the Windows port is not yet complete.
+ </para>
</section>
+ </section>
</chapter>
<!-- keep this comment at the end of the file
vim600: syn=xml fen fdm=syntax fdl=4 si
[FILE: /srmdoc/admin/intro.xml]
--- srmdoc/admin/intro.xml:1.3 Tue Mar 05 17:18:37 2002 GMT
+++ srmdoc/admin/intro.xml Tue Mar 05 20:31:22 2002 GMT
@@ -1,11 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: $ -->
- <title>Administrative Introduction</title>
+<chapter id="admin.intro">
+ <title>Introduction</title>
<para>
- This section of the manual is dedicated to the adminstrative tasks required
- for using the Vulcan-Logic SRM system. These typically include, compling,
- configuring, and installing the system. Each section will be explained in
- detail.
+ This section of the manual is dedicated to the adminstrative tasks required
+ for using the Vulcan-Logic SRM system. These typically include, <link
+ linkend="admin.compile">compiling</link>, <link
+ linkend="admin.installation">installation</link>, and <link
+ linkend="admin.ini-settings">configuring</link> the system. Each section
+ will be explained in detail.
</para>
</chapter>
<!-- keep this comment at the end of the file
[FILE: /srmdoc/api/modules.xml]
--- srmdoc/api/modules.xml:1.1 Wed Feb 06 23:20:03 2002 GMT
+++ srmdoc/api/modules.xml Tue Mar 05 20:31:23 2002 GMT
@@ -97,7 +97,7 @@
<literal>functions.h</literal>. These include files provide the
nessecairy macro's and structures to provide a module access to the
internal structures and data of <acronym>SRM</acronym>. If you want to
- use configuration settings from the srm.ini the file
+ use configuration settings from the <literal>srm.ini</literal> the file
<literal>ini_parser.h</literal> must also be included.
</para>
</section>
Received on Tue Mar 5 22:32:55 2002
This archive was generated by hypermail 2.1.8 : Tue Jan 06 2009 - 07:00:03 CET