Author: dennisl
Date: Thu Jan 10 04:36:29 2008
New Revision: 610776
URL: http://svn.apache.org/viewvc?rev=610776&view=rev
Log:
Fix typos and add formating.
Modified:
commons/proper/daemon/trunk/xdocs/binaries.xml
commons/proper/daemon/trunk/xdocs/jsvc.xml
Modified: commons/proper/daemon/trunk/xdocs/binaries.xml
URL:
http://svn.apache.org/viewvc/commons/proper/daemon/trunk/xdocs/binaries.xml?rev=610776&r1=610775&r2=610776&view=diff
==============================================================================
--- commons/proper/daemon/trunk/xdocs/binaries.xml (original)
+++ commons/proper/daemon/trunk/xdocs/binaries.xml Thu Jan 10 04:36:29 2008
@@ -15,29 +15,29 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
+
<document>
-
+
<properties>
<title>Daemon : binaries</title>
<author email="[EMAIL PROTECTED]">Jean-Frederic Clere</author>
</properties>
<body>
-<section name="What to download">
+<section name="What to download?">
<p>
In the directory
<a href="http://www.apache.org/dist/commons/daemon/binaries/";>binaries</a>
-you found subdirectories containing executables
-corresponding to your operating system. If your machine is not in the list
-mail us we will try to make it available or try to build it on your own.
-The files are compressed tar files. They are named jvm_name-os_name.
-For example: In the directory freebsd we have jdk1.4.1-FreeBSD_4.9.tar.gz
-That a file build on FreeBSD 4.9 using the FreeBSD JVM 1.4.1.
+you find subdirectories containing executables
+corresponding to your operating system. If your machine is not in the list,
+please mail us and we will try to make it available or try to build it on your
own.
+The files are compressed tar files. They are named
<code>jvm_name-os_name</code>.
+For example: In the directory <code>freebsd</code> we have
<code>jdk1.4.1-FreeBSD_4.9.tar.gz</code>
+That is a file built on FreeBSD 4.9 using the FreeBSD JVM 1.4.1.
</p>
</section>
-<section name="What to do to get the excutable">
+<section name="How do I get the excutable?">
<subsection name="jsvc">
<p>
You have to do the following:
@@ -46,8 +46,8 @@
<li>Download it.</li>
<li>Uncompress the tar file and extract it (better with a gnu tar).</li>
<li>Copy the executable in the location where you want to run it.</li>
- <li>Write a rc shell
- (see in src/samples and src/native/unix/native/Tomcat.sh)
+ <li>Write an rc shell
+ (see in <code>src/samples</code> and
<code>src/native/unix/native/Tomcat.sh</code>)
to get your java application started as a daemon.
</li>
</ul>
@@ -55,8 +55,8 @@
</subsection>
<subsection name="procrun">
<p>
-The procrun.exe has to be installed as a service.
-(See <a href="procrun.html">procrun</a> for more information.
+The <code>procrun.exe</code> has to be installed as a service.
+See <a href="procrun.html">procrun</a> for more information.
</p>
</subsection>
</section>
Modified: commons/proper/daemon/trunk/xdocs/jsvc.xml
URL:
http://svn.apache.org/viewvc/commons/proper/daemon/trunk/xdocs/jsvc.xml?rev=610776&r1=610775&r2=610776&view=diff
==============================================================================
--- commons/proper/daemon/trunk/xdocs/jsvc.xml (original)
+++ commons/proper/daemon/trunk/xdocs/jsvc.xml Thu Jan 10 04:36:29 2008
@@ -26,21 +26,21 @@
<body>
<section name="Introduction">
<p>
- Actualy only the UNIX like platforms are supported.
- The sources are located in the src/native/unix subdirectory of the
+ Actually only the UNIX like platforms are supported.
+ The sources are located in the <code>src/native/unix</code> subdirectory
of the
project sources.
- For win32 platfroms the cygwin emulation layer is used. See
- <a href="http://www.cygwin.com/";> cygwin</a> for more informations.
+ For win32 platforms the cygwin emulation layer is used. See
+ <a href="http://www.cygwin.com/";>cygwin</a> for more information.
</p>
<p>
- In the futur <a href="http://apr.apache.org/";> APR </a> may be used
- to provide more convinient platform support.
+ In the future <a href="http://apr.apache.org/";>APR</a> may be used
+ to provide more convenient platform support.
</p>
</section>
-<section name="Building from cvs">
+<section name="Building from source">
<p>
-To build under an UNIX operating system you will need:
+To build under a UNIX operating system you will need:
<ul>
<li>GNU AutoConf (at least version 2.53)</li>
<li>An ANSI-C compliant compiler (GCC is good)</li>
@@ -51,7 +51,10 @@
You need to build the "configure" program with:
- sh support/buildconf.sh
+<source>
+sh support/buildconf.sh
+</source>
+
(Note it is possible to replace sh by any compatible shell like bash, ksh).
The result should be something like:
@@ -63,25 +66,25 @@
</p>
</section>
-<section name="Building for a release tarball">
+<section name="Building from a release tarball">
<p>
-To build the binary under an UNIX operating system you will need:
+To build the binary under a UNIX operating system you will need:
<ul>
<li>An ANSI-C compliant compiler (GCC is good)</li>
<li>GNU Make</li>
<li>A Java Platform 2 compliant SDK</li>
</ul>
-You have to specify the JAVA_HOME of the SDK
-either the --with-java=<dir> parameter or set the JAVA_HOME environment
+You have to specify the <code>JAVA_HOME</code> of the SDK
+either with the <code>--with-java=<dir></code> parameter or set the
<code>JAVA_HOME</code> environment
to point to your SDK installation. For example:
<source>
- ./configure --with-java=/usr/java
+./configure --with-java=/usr/java
</source>
or
<source>
- export JAVA_HOME
- ./configure
+export JAVA_HOME
+./configure
</source>
If your operating system is supported, configure will go thru cleanly,
@@ -89,9 +92,9 @@
OS/JDK, or a patch against the sources). To build the binaries and
libraries simply do:
<source>
- make
+make
</source>
-This will generate the executable file jsvc.
+This will generate the executable file <code>jsvc</code>.
</p>
</section>
@@ -165,7 +168,7 @@
<li>Put it in the jarfile (my.jar).</li>
<li>Call jsvc like:
<source>
- ./jsvc -cp commons-daemon.jar:my.jar MyClass
+./jsvc -cp commons-daemon.jar:my.jar MyClass
</source>
</li>
</ul>
@@ -175,15 +178,15 @@
<p>
You have to write a Class (MyClass) that implements the following methods:
<ul>
- <li>void load(String[] arguments): Here open the configuration files, create
the trace file, create
+ <li><code>void load(String[] arguments)</code>: Here open the configuration
files, create the trace file, create
the ServerSockets, the Threads</li>
- <li>void start(): Start the Thread, accept incomming connections</li>
- <li>void stop(): Inform the Thread to live the run(), close the
ServerSockets</li>
- <li>void destroy(): Destroy any object created in init()</li>
+ <li><code>void start()</code>: Start the Thread, accept incoming
connections</li>
+ <li><code>void stop()</code>: Inform the Thread to live the run(), close the
ServerSockets</li>
+ <li><code>void destroy()</code>: Destroy any object created in init()</li>
</ul>
Store it in a jarfile and use as above:
<source>
- ./jsvc -cp commons-daemon.jar:my.jar MyClass
+./jsvc -cp commons-daemon.jar:my.jar MyClass
</source>
</p>
</subsection>
@@ -193,13 +196,13 @@
Jsvc uses 3 processes: a launcher process, a controller process and a
controlled process.
The controlled process is also the main java thread, if the JVM crashes
the controller will restart it in the next minute.
-Jsvc is a daemon process so it should be started as root and the -user
parameter
+Jsvc is a daemon process so it should be started as root and the
<code>-user</code> parameter
allows to downgrade to an unprivilegded user.
-When -wait parameter is used, the launcher process waits until the controller
says
+When the <code>-wait</code> parameter is used, the launcher process waits
until the controller says
"I am ready", otherwise it returns after creating the controller process.
</p>
-<subsection name="Forks in jakarta-daemon">
+<subsection name="Forks in commons-daemon">
<p>
Launcher process:
<source>
@@ -240,9 +243,9 @@
<subsection name="Downgrading user">
<p>
-On linux setuid()/setgid() + capabilities are used on other unix
setgid/initgroups are used.
+On linux <code>setuid()</code>/<code>setgid()</code> + capabilities are used.
On other unix <code>setgid</code>/<code>initgroups</code> are used.
-we have something like:
+We have something like:
<source>
/* as root */
init_JVM().
