Bugzilla – Attachment 12688 Details for
Bug 8568
Fix some errors in docs for scripts provided by the Debian packages
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Bug 8568 - Fix some errors in docs for scripts provided by the Debian packages
Bug-8568---Fix-some-errors-in-docs-for-scripts-pro.patch (text/plain), 5.14 KB, created by
Frédéric Demians
on 2012-10-04 16:51:51 UTC
(
hide
)
Description:
Bug 8568 - Fix some errors in docs for scripts provided by the Debian packages
Filename:
MIME Type:
Creator:
Frédéric Demians
Created:
2012-10-04 16:51:51 UTC
Size:
5.14 KB
patch
obsolete
>From 143eb2b482a9fb95f6911f4ea314eec37558d976 Mon Sep 17 00:00:00 2001 >From: Magnus Enger <magnus@enger.priv.no> >Date: Sun, 30 Sep 2012 09:57:37 +0200 >Subject: [PATCH] Bug 8568 - Fix some errors in docs for scripts provided by > the Debian packages >MIME-Version: 1.0 >Content-Type: text/plain; charset=UTF-8 >Content-Transfer-Encoding: 8bit > >1. Create a page for koha-run-backups >2. Fix the synopsis for koha-foreach >3. Add koha-create and koha-run-backups to koha-common > >To test >- Convert the changed xml files to man pages with >$ xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl koha-x.xml >- View generated pages with e.g. >$ man -l koha-x.8" > (Replace x with the names of the changed files) >- Check that the changes make sense > >Signed-off-by: Frédéric Demians <f.demians@tamil.fr> > >Works as described. I was able to produce the 3 man files, load them with man >command, and see the added information properly formated. >--- > debian/docs/koha-common.xml | 14 ++++++++ > debian/docs/koha-foreach.xml | 2 +- > debian/docs/koha-run-backups.xml | 69 ++++++++++++++++++++++++++++++++++++++++ > 3 files changed, 84 insertions(+), 1 deletion(-) > create mode 100644 debian/docs/koha-run-backups.xml > >diff --git a/debian/docs/koha-common.xml b/debian/docs/koha-common.xml >index 0e70595..bbef4f2 100644 >--- a/debian/docs/koha-common.xml >+++ b/debian/docs/koha-common.xml >@@ -32,6 +32,13 @@ > <variablelist> > > <varlistentry> >+ <term><option>koha-create</option></term> >+ <listitem> >+ <para>Create new Koha instances.</para> >+ </listitem> >+ </varlistentry> >+ >+ <varlistentry> > <term><option>koha-disable</option></term> > <listitem> > <para>Disable a Koha instance.</para> >@@ -60,6 +67,13 @@ > </varlistentry> > > <varlistentry> >+ <term><option>koha-run-backups</option></term> >+ <listitem> >+ <para>Performs backups of the koha installations on the system, except an instance called 'demo'.</para> >+ </listitem> >+ </varlistentry> >+ >+ <varlistentry> > <term><option>koha-remove</option></term> > <listitem> > <para>Remove a Koha instance.</para> >diff --git a/debian/docs/koha-foreach.xml b/debian/docs/koha-foreach.xml >index 869e9c7..733ddd9 100644 >--- a/debian/docs/koha-foreach.xml >+++ b/debian/docs/koha-foreach.xml >@@ -23,7 +23,7 @@ > > <refsynopsisdiv> > <cmdsynopsis> >- <command>koha-list</command> <arg><option>--enabled</option></arg> <arg><option>--email</option>|<option>--noemail</option></arg> <arg><option>command</option></arg> >+ <command>koha-foreach</command> <arg><option>--enabled</option></arg> <arg><option>--email</option>|<option>--noemail</option></arg> <arg><option>command</option></arg> > </cmdsynopsis> > </refsynopsisdiv> > >diff --git a/debian/docs/koha-run-backups.xml b/debian/docs/koha-run-backups.xml >new file mode 100644 >index 0000000..ba00d54 >--- /dev/null >+++ b/debian/docs/koha-run-backups.xml >@@ -0,0 +1,69 @@ >+<article xmlns='http://docbook.org/ns/docbook'> >+<title>koha-run-backups</title> >+<info> >+<productname>Koha</productname> is the first free software library automation package. >+<author> >+ <orgname>The Koha Communnity</orgname> >+ <uri>http://koha-community.org/</uri> >+</author> >+</info> >+ >+<refentry xml:id="koha-run-backups"> >+ >+ <refmeta> >+ <refentrytitle>koha-run-backups</refentrytitle> >+ <manvolnum>8</manvolnum> >+ </refmeta> >+ >+ <refnamediv> >+ <refname>koha-run-backups</refname> >+ <refpurpose>Performs backups of the koha installations on the system, except an instance called 'demo'.</refpurpose> >+ <refclass>UNIX/Linux</refclass> >+ </refnamediv> >+ >+ <refsynopsisdiv> >+ <cmdsynopsis> >+ <command>koha-run-backups</command> >+ <arg><option>--output</option> /some/path</arg> >+ <arg><option>--days</option> 2</arg> >+ </cmdsynopsis> >+ </refsynopsisdiv> >+ >+ <refsect1><title>Options</title> >+ <variablelist> >+ >+ <varlistentry> >+ <term><option>--output</option></term> >+ <listitem> >+ <para>The directory that the resulting files will be placed into (default: /var/spool/koha).</para> >+ </listitem> >+ </varlistentry> >+ >+ <varlistentry> >+ <term><option>--days</option></term> >+ <listitem> >+ <para>The number of days to keep backups around for (default: 2).</para> >+ </listitem> >+ </varlistentry> >+ >+ </variablelist> >+ </refsect1> >+ >+ <refsect1><title>Description</title> >+ <para><command>koha-run-backups</command> allows automation of backing up the koha data and configuration to the filesystem. It will keep the past so many backups, discarding older ones. This script uses <command>koha-dump</command> to do the actual backup.</para> >+ <para>If there is an instance called 'demo', it will be skipped by this script.</para> >+ <para>Note: backups produced using this tool can be restored using <command>koha-restore</command>.</para> >+ </refsect1> >+ >+ <refsect1><title>See also</title> >+ >+ <simplelist type="inline"> >+ <member><command>koha-dump(8)</command></member> >+ <member><command>koha-restore(8)</command></member> >+ </simplelist> >+ >+ </refsect1> >+ >+</refentry> >+ >+</article> >-- >1.7.11.1
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
|
Splinter Review
Attachments on
bug 8568
:
12611
| 12688