This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-daemon.git
commit a87cda8f52cd9459c78d180e3f8c3a12ce565b69 Author: Gary D. Gregory <garydgreg...@gmail.com> AuthorDate: Fri Jan 17 15:27:47 2025 -0500 Bump org.apache.commons:commons-parent from 78 to 79 Update site XML files to Doxia 2 --- pom.xml | 2 +- src/changes/changes.xml | 5 +++-- src/site/xdoc/binaries.xml | 7 +++++-- src/site/xdoc/faq.xml | 7 ++++--- src/site/xdoc/index.xml | 18 +++++++++--------- src/site/xdoc/jsvc.xml | 21 ++++++++++++--------- src/site/xdoc/procrun.xml | 37 ++++++++----------------------------- 7 files changed, 42 insertions(+), 55 deletions(-) diff --git a/pom.xml b/pom.xml index 73196ed..231b256 100644 --- a/pom.xml +++ b/pom.xml @@ -22,7 +22,7 @@ <parent> <groupId>org.apache.commons</groupId> <artifactId>commons-parent</artifactId> - <version>78</version> + <version>79</version> </parent> <modelVersion>4.0.0</modelVersion> <groupId>commons-daemon</groupId> diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 114ecba..ad472d6 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -33,9 +33,9 @@ The <action> type attribute can be add,update,fix,remove. --> -<document xmlns="http://maven.apache.org/changes/1.0.0" +<document xmlns="http://maven.apache.org/changes/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 https://maven.apache.org/xsd/changes-1.0.0.xsd"> + xsi:schemaLocation="http://maven.apache.org/changes/2.0.0 https://maven.apache.org/xsd/changes-2.0.0.xsd"> <properties> <title>Apache Commons Daemon Release Notes</title> </properties> @@ -44,6 +44,7 @@ <!-- FIX --> <!-- ADD --> <!-- UPDATE --> + <action dev="ggregory" type="update" due-to="Gary Gregory">Bump org.apache.commons:commons-parent from 78 to 79.</action> </release> <release version="1.4.1" date="2025-01-13" description="Bug fix release"> <!-- FIX --> diff --git a/src/site/xdoc/binaries.xml b/src/site/xdoc/binaries.xml index fb38e91..a4498b2 100644 --- a/src/site/xdoc/binaries.xml +++ b/src/site/xdoc/binaries.xml @@ -16,8 +16,9 @@ limitations under the License. --> -<document> - +<document xmlns="http://maven.apache.org/XDOC/2.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd"> <properties> <title>Daemon : binaries</title> <author email="jfrederic.cl...@fujitsu-siemens.con">Jean-Frederic Clere</author> @@ -37,10 +38,12 @@ corresponding to your operating system. Only the Windows builds are provided as <subsection name="procrun"> <p> The Windows archive (e.g. commons-daemon-1.4.1-bin-windows.zip) contains 2 different executables: +</p> <ul> <li>prunsrv.exe - service application for running applications as services.</li> <li>prunmgr.exe - the GUI manager application used to monitor and configure installed services.</li> </ul> +<p> There is only one <code>prunmgr.exe</code> application for all architectures. The <code>prunsrv.exe</code> executable is available in 2 different versions for different architectures. The version in the top-level directory is for 32-bit (x86) architectures. diff --git a/src/site/xdoc/faq.xml b/src/site/xdoc/faq.xml index de9547b..c803d2e 100644 --- a/src/site/xdoc/faq.xml +++ b/src/site/xdoc/faq.xml @@ -16,8 +16,9 @@ limitations under the License. --> -<document> - +<document xmlns="http://maven.apache.org/XDOC/2.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd"> <properties> <title>Daemon : FAQ</title> <author email="jfrederic.cl...@fujitsu-siemens.con">Jean-Frederic Clere</author> @@ -69,6 +70,7 @@ jsvc.exec error: syscall failed in set_caps jsvc.exec error: Service exit with a return value of 4 </source> CONFIG_SECURITY_CAPABILITIES in missing in your kernel try the following in the kernel sources: +</p> <ul> <li> Configure the kernel with "Default Linux Capabilities" and reboot @@ -81,7 +83,6 @@ modprobe capability </source> </li> </ul> -</p> </section> <section name="Cygwin configuration problems"> diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index c118985..5da29ca 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -15,9 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - -<document> - +<document xmlns="http://maven.apache.org/XDOC/2.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd"> <properties> <title>Daemon : Java based daemons or services</title> <author email="jfrederic.cl...@fujitsu-siemens.con">Jean-Frederic Clere</author> @@ -31,14 +31,14 @@ opposed to just applets and client applications. The major disadvantage of the Java platform is that still today the only portable way to start a Java application relies on a single point of entry: the - <CODE><EM CLASS="key">public static void</EM> - main(<EM CLASS="ref">String</EM>[])</CODE> method. + <code><em class="key">public static void</em> + main(<em class="ref">String</em>[])</code> method. </p> <p> Having a single-point of entry is a valid solution for client applications, where interactively a user can command to the application to quit (which can terminate the Virtual Machine process at calling the - <CODE><EM CLASS="ref">System</EM>.exit(<EM CLASS="key">int</EM>)</CODE> + <code><em class="ref">System</em>.exit(<em class="key">int</em>)</code> method), but in those cases where the application is not interactive (server applications) there is currently no portable way to notify the Virtual Machine of its imminent shutdown. @@ -52,12 +52,13 @@ </p> <p> One common solution to this problem is to create (for example) a - <CODE><EM CLASS="ref">ServerSocket</EM></CODE> and wait for a particular + <code><em class="ref">ServerSocket</em></code> and wait for a particular message to be issued. When the message is received, all operations required to shut down the server applications are performed and at the - end the <CODE><EM CLASS="ref">System</EM>.exit</CODE> method is called + end the <code><em class="ref">System</em>.exit</code> method is called to terminate the Virtual Machine process. This method however, has several disadvantages and risks: +</p> <ul> <li> In case of a system-wide shutdown, the Virtual Machine process may be @@ -71,7 +72,6 @@ implemented in the operating system. </li> </ul> -</p> <p> Most multi-user operating systems already have a way in which server applications are started and stopped. Under Unix based operating systems diff --git a/src/site/xdoc/jsvc.xml b/src/site/xdoc/jsvc.xml index d8884be..57e33a9 100644 --- a/src/site/xdoc/jsvc.xml +++ b/src/site/xdoc/jsvc.xml @@ -15,9 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - -<document> - +<document xmlns="http://maven.apache.org/XDOC/2.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd"> <properties> <title>Daemon : Java Service</title> <author email="jfrederic.cl...@fujitsu-siemens.con">Jean-Frederic Clere</author> @@ -49,20 +49,20 @@ <section name="Building from source"> <p> To build under a UNIX operating system you will need: +</p> <ul> <li>GNU AutoConf (at least version 2.53)</li> <li>An ANSI-C compliant compiler (GCC is good)</li> <li>GNU Make</li> <li>A Java Platform 2 compliant SDK</li> </ul> - - +<p> You need to build the "configure" program with: - +</p> <source> sh support/buildconf.sh </source> - +<p> (Note it is possible to replace sh by any compatible shell like bash, ksh). The result should be something like: @@ -77,12 +77,13 @@ Once the configure script is generated, follow the next section. <section name="Building from a release tarball"> <p> To build the binary under a UNIX operating system you will need: +</p> <ul> <li>An ANSI-C compliant compiler (GCC is good)</li> <li>GNU Make</li> <li>A Java Platform 2 compliant SDK</li> </ul> - +<p> 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: @@ -236,6 +237,7 @@ whereas Tomcat-5.0.x provides a Class whose methods are called by jsvc directly. <subsection name="Via Daemon interface"> <p> Do the following: +</p> <ul> <li>Write a Class that implements the Daemon interface (MyClass).</li> <li>Put it in a jarfile (my.jar).</li> @@ -245,11 +247,11 @@ Do the following: </source> </li> </ul> -</p> </subsection> <subsection name="Directly"> <p> Write a Class (MyClass) that implements the following methods: +</p> <ul> <li>void init(String[] arguments): Here open configuration files, create a trace file, create ServerSockets, Threads</li> @@ -257,6 +259,7 @@ Write a Class (MyClass) that implements the following methods: <li>void stop(): Inform the Thread to terminate the run(), close the ServerSockets</li> <li><code>void destroy()</code>: Destroy any object created in init()</li> </ul> +<p> Store it in a jarfile and use as above: <source> ./jsvc -cp my.jar MyClass diff --git a/src/site/xdoc/procrun.xml b/src/site/xdoc/procrun.xml index abaa294..8d30a0f 100644 --- a/src/site/xdoc/procrun.xml +++ b/src/site/xdoc/procrun.xml @@ -15,8 +15,9 @@ See the License for the specific language governing permissions and limitations under the License. --> - -<document> +<document xmlns="http://maven.apache.org/XDOC/2.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd"> <properties> <title>Daemon : Procrun</title> <author email="mt...@apache.org">Mladen Turk</author> @@ -54,7 +55,6 @@ then the default service name is <code>TestService</code>. </p> <p>The available command line options are:</p> -<p> <table> <tr><th>//ES</th> <td>Edit service configuration</td> @@ -81,7 +81,6 @@ </td> </tr> </table> -</p> </section> <section name="Procrun service application"> @@ -102,7 +101,6 @@ then the default service name is <code>TestService</code>. </p> <p>The available command line options are:</p> -<p> <table> <tr><th>//TS</th> <td>Run the service as a console application</td> @@ -150,11 +148,9 @@ <td>Print usage and exit (since version 1.0.3)</td> </tr> </table> -</p> <p>Starting with version <b>1.0.8</b> a more traditional command line can be used in the form: <b>command [ServiceName]</b>. </p> -<p> <table> <tr><th>run</th> <td>Run the service as a console application</td> @@ -203,7 +199,6 @@ <td>Print usage and exit</td> </tr> </table> -</p> </subsection> <subsection name="Command line parameters"> <p> @@ -295,7 +290,6 @@ will replace any existing parameter with the new setting. For multivalued parameters, using the <b><code>++</code></b> option qualifier will add the new value(s) to any existing value(s). </p> -<p> <table> <tr> <th>Parameter Name  </th> @@ -332,14 +326,16 @@ will add the new value(s) to any existing value(s). <td>++DependsOn</td> <td></td> <td>List of services that this service depends on. Services are separated - using either <b>#</b> or <b>;</b> characters</td> - <br /> + using either <b>#</b> or <b>;</b> characters. + <p> <b>Note:</b> At installation, additional dependencies will be created on the services <i>Tcpip</i> and <i>Afd</i> if not explicitly specified. These additional dependencies will not be created automatically when updating the service configuration with <i>--DependsOn</i> and must be explicitly defined if required in that case. + </p> + </td> </tr> <tr> <td>++Environment</td> @@ -458,7 +454,6 @@ will add the new value(s) to any existing value(s). </td> </tr> <tr> - <tr> <td>--StartImage</td> <td></td> <td>Executable that will be run. Only applies to <b>exe</b> mode.</td> @@ -500,6 +495,7 @@ will add the new value(s) to any existing value(s). See <b>--StartMode</b> for further details. </td> </tr> + <tr> <td>--StopImage</td> <td></td> <td>Executable that will be run on Stop service signal. Only applies to <b>exe</b> mode.</td> @@ -586,14 +582,11 @@ will add the new value(s) to any existing value(s). Actual file is created in the <b>LogPath</b> directory</td> </tr> </table> -</p> </subsection> <subsection name="Installing services"> <p> To install the service, you need to use the <b>//IS</b> parameter. </p> -<p> -<screen> <h4>Install the service named 'TestService'</h4> <source> prunsrv //IS//TestService --DisplayName="Test Service" \ @@ -601,34 +594,24 @@ prunsrv //IS//TestService --DisplayName="Test Service" \ --StartClass=org.apache.SomeStartClass --StartParams=arg1;arg2;arg3 \ --StopClass=org.apache.SomeStopClass --StopParams=arg1#arg2 </source> -</screen> -</p> </subsection> <subsection name="Updating services"> <p> To update the service parameters, you need to use the <b>//US</b> parameter. </p> -<p> -<screen> <h4>Update the service named 'TestService'</h4> <source> prunsrv //US//TestService --Description="Some Dummy Test Service" \ --Startup=auto --Classpath=%CLASSPATH%;test.jar </source> -</screen> -</p> </subsection> <subsection name="Removing services"> <p> To remove the service, you need to use the <b>//DS</b> parameter. If the service is running it will be stopped and then deleted. </p> -<p> -<screen> <h4>Remove the service named 'TestService'</h4> <source>prunsrv //DS//TestService</source> -</screen> -</p> </subsection> <subsection name="Debugging services"> @@ -639,12 +622,8 @@ The service shutdown can be initiated by pressing <b>CTRL+C</b> or If you rename the prunsrv.exe to testservice.exe then you can just execute the testservice.exe and this command mode will be executed by default. </p> -<p> -<screen> <h4>Run the service named 'TestService' in console mode</h4> <source>prunsrv //TS//TestService [additional arguments]</source> -</screen> -</p> </subsection> </section>