Attachment 117550 Details for Bug 27839 – Bug 27839: (follow-up) Update docs for koha-worker

[patch] Bug 27839: (follow-up) Update docs for koha-worker

Bug-27839-follow-up-Update-docs-for-koha-worker.patch (text/plain), 3.56 KB, created by Tomás Cohen Arazi (tcohen) on 2021-03-02 19:36:16 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Tomás Cohen Arazi (tcohen)

Created: 2021-03-02 19:36:16 UTC

Size: 3.56 KB

patch

obsolete

>From 12c3f4de6d90724ed3f07af33c6e75ee6e883b72 Mon Sep 17 00:00:00 2001
>From: Tomas Cohen Arazi <tomascohen@theke.io>
>Date: Tue, 2 Mar 2021 16:33:29 -0300
>Subject: [PATCH] Bug 27839: (follow-up) Update docs for koha-worker
>
>Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
>---
> debian/docs/koha-worker.xml | 82 +++++++++++++++++++++++++++++++++++++
> debian/scripts/koha-worker  |  1 +
> 2 files changed, 83 insertions(+)
> create mode 100644 debian/docs/koha-worker.xml
>
>diff --git a/debian/docs/koha-worker.xml b/debian/docs/koha-worker.xml
>new file mode 100644
>index 00000000000..3cb19e63cf4
>--- /dev/null
>+++ b/debian/docs/koha-worker.xml
>@@ -0,0 +1,82 @@
>+<article xmlns='http://docbook.org/ns/docbook'>
>+<title>koha-worker</title>
>+<info>
>+<productname>Koha</productname> is the first free software library automation package.
>+<author>
>+  <orgname>The Koha Community</orgname>
>+  <uri>https://koha-community.org/</uri>
>+</author>
>+</info>
>+
>+<refentry xml:id="koha-worker">
>+
>+  <refmeta>
>+    <refentrytitle>koha-worker</refentrytitle>
>+    <manvolnum>8</manvolnum>
>+  </refmeta>
>+
>+  <refnamediv>
>+    <refname>koha-worker</refname>
>+    <refpurpose>Handle worker daemon for named Koha instances.</refpurpose>
>+    <refclass>UNIX/Linux</refclass>
>+  </refnamediv>
>+
>+  <refsynopsisdiv>
>+    <cmdsynopsis>
>+      <command>koha-worker</command>
>+      <arg><option>--start</option>|<option>--stop</option>|<option>--restart</option></arg>
>+      <arg><option>--status</option></arg>
>+      <arg><option>--quiet</option>|<option>-q</option></arg>
>+      <arg><option>-h</option>|<option>--help</option></arg>
>+    </cmdsynopsis>
>+  </refsynopsisdiv>
>+
>+  <refsect1><title>Options</title>
>+  <para>All option switches are mutually exclusive</para>
>+  <variablelist>
>+    <varlistentry>
>+      <term><option>--start</option></term>
>+      <listitem>
>+        <para>Start worker daemon for named Koha instances.</para>
>+      </listitem>
>+    </varlistentry>
>+    <varlistentry>
>+      <term><option>--stop</option></term>
>+      <listitem>
>+        <para>Stop worker daemon for named Koha instances.</para>
>+      </listitem>
>+    </varlistentry>
>+    <varlistentry>
>+      <term><option>--restart</option></term>
>+      <listitem>
>+        <para>Restart worker daemon for named Koha instances.</para>
>+      </listitem>
>+    </varlistentry>
>+    <varlistentry>
>+      <term><option>--status</option></term>
>+      <listitem>
>+        <para>Show status information about worker daemon for named Koha instances.</para>
>+      </listitem>
>+    </varlistentry>
>+    <varlistentry>
>+      <term><option>-v</option>|<option>--verbose</option></term>
>+      <listitem>
>+        <para>Enable verbose output.</para>
>+      </listitem>
>+    </varlistentry>
>+    <varlistentry>
>+      <term><option>-h</option>|<option>--help</option></term>
>+      <listitem>
>+        <para>This help.</para>
>+      </listitem>
>+    </varlistentry>
>+  </variablelist>
>+  </refsect1>
>+
>+  <refsect1><title>Description</title>
>+  <para>This script handles worker daemons for Koha instances.</para>
>+  </refsect1>
>+
>+</refentry>
>+
>+</article>
>diff --git a/debian/scripts/koha-worker b/debian/scripts/koha-worker
>index b4df12859fb..207d503b557 100755
>--- a/debian/scripts/koha-worker
>+++ b/debian/scripts/koha-worker
>@@ -41,6 +41,7 @@ This script lets you manage the worker daemon for your Koha instances.
> 
> Usage:
> $scriptname [--start|--stop|--restart] [--quiet|-q] instancename1 [instancename2...]
>+$scriptname --status instancename1 [instancename2...]
> $scriptname -h|--help
> 
>     --start               Start the worker daemon for the specified instances
>-- 
>2.30.1

Actions: View | Diff | Splinter Review

Attachments on bug 27839: 117549 | 117550 | 117557 | 117558 | 119426 | 119427