[pycsw] 02/03: Add manfile for pycsw-admin

[Johan Van de Wauw]

This is an automated email from the git hooks/post-receive script.

johanvdw-guest pushed a commit to branch master
in repository pycsw.

commit fdd99b8b285659782bacade6ea9f3cd4a9f44fe6
Author: Johan Van de Wauw <johan.vandewauw at gmail.com>
Date:   Sun Oct 12 08:31:09 2014 +0200

    Add manfile for pycsw-admin
    
    Install manfile
---
 debian/control               |  3 ++-
 debian/man/pycsw-admin.md    | 54 ++++++++++++++++++++++++--------------------
 debian/python-pycsw.manpages |  1 +
 debian/rules                 |  1 +
 4 files changed, 33 insertions(+), 26 deletions(-)

diff --git a/debian/control b/debian/control
index feeb240..0246227 100644
--- a/debian/control
+++ b/debian/control
@@ -11,7 +11,8 @@ Build-Depends: debhelper (>= 9),
                python-all,
                python-sphinx,
                dh-apache2,
-               apache2-dev
+               apache2-dev,
+               ruby-ronn
 Standards-Version: 3.9.6
 Vcs-Browser: https://anonscm.debian.org/cgit/pkg-grass/pycsw.git
 Vcs-Git: git://anonscm.debian.org/pkg-grass/pycsw.git
diff --git a/debian/man/pycsw-admin.md b/debian/man/pycsw-admin.md
index d5c9de1..fd1658f 100644
--- a/debian/man/pycsw-admin.md
+++ b/debian/man/pycsw-admin.md
@@ -1,8 +1,8 @@
-pycsw-admin - pycsw admin utility
+pycsw-admin(1) - pycsw admin utility
 =================================
 
 ##SYNOPSIS
-    pycsw-admin.py -c <command> -f <cfg> [-h] [-p /path/to/records] [-r]
+`pycsw-admin` -c <command> -f <cfg> [-h] [-p /path/to/records] [-r]
 
 ##OPTIONS
     -c    Command to be performed:
@@ -36,47 +36,51 @@ pycsw-admin - pycsw admin utility
     -x    XML document
     
 ##EXAMPLE
-    1.) setup_db: Creates repository tables and indexes
+1) setup_db: Creates repository tables and indexes
 
-        pycsw-admin.py -c setup_db -f default.cfg
+	pycsw-admin -c setup_db -f default.cfg
         
-    2.) load_records: Loads metadata records from directory into repository
+2.) load_records: Loads metadata records from directory into repository
 
-        pycsw-admin.py -c load_records -p /path/to/records -f default.cfg
+	pycsw-admin -c load_records -p /path/to/records -f default.cfg
 
-        Load records from directory recursively
+    Load records from directory recursively
 
-        pycsw-admin.py -c load_records -p /path/to/records -f default.cfg -r
+	pycsw-admin -c load_records -p /path/to/records -f default.cfg -r
 
-    3.) export_records: Dump metadata records from repository into directory
+3.) export_records: Dump metadata records from repository into directory
 
-        pycsw-admin.py -c export_records -p /path/to/records -f default.cfg
+	pycsw-admin -c export_records -p /path/to/records -f default.cfg
 
-    4.) rebuild_db_indexes: Rebuild repository database indexes
+4.) rebuild_db_indexes: Rebuild repository database indexes
 
-        pycsw-admin.py -c rebuild_db_indexes -f default.cfg
+	pycsw-admin -c rebuild_db_indexes -f default.cfg
 
-    5.) optimize_db: Optimize repository database
+5.) optimize_db: Optimize repository database
 
-        pycsw-admin.py -c optimize_db -f default.cfg
+	pycsw-admin -c optimize_db -f default.cfg
 
-    6.) refresh_harvested_records: Refresh repository records
-        which have been harvested
+6.) refresh_harvested_records: Refresh repository records
+    which have been harvested
 
-        pycsw-admin.py -c refresh_harvested_records -f default.cfg
+	pycsw-admin -c refresh_harvested_records -f default.cfg
 
-    7.) gen_sitemap: Generate XML Sitemap
+7.) gen_sitemap: Generate XML Sitemap
 
-        pycsw-admin.py -c gen_sitemap -f default.cfg -o /path/to/sitemap.xml
+	pycsw-admin -c gen_sitemap -f default.cfg -o /path/to/sitemap.xml
 
-    8.) post_xml: Execute a CSW request via HTTP POST
+8.) post_xml: Execute a CSW request via HTTP POST
 
-        pycsw-admin.py -c post_xml -u http://host/csw -x /path/to/request.xml
+	pycsw-admin -c post_xml -u http://host/csw -x /path/to/request.xml
 
-    9.) get_sysprof: Get versions of dependencies
+9.) get_sysprof: Get versions of dependencies
 
-        pycsw-admin.py -c get_sysprof
+	pycsw-admin -c get_sysprof
 
-   10.) validate_xml: Validate an XML document against an XML Schema
+10.) validate_xml: Validate an XML document against an XML Schema
 
-        pycsw-admin.py -c validate_xml -x file.xml -s file.xsd
+	pycsw-admin -c validate_xml -x file.xml -s file.xsd
+
+##MORE INFORMATION
+
+More information about pycsw can be obtained from _/usr/share/doc/python-pycsw-doc_ after installing the *python-pycsw-doc* package.
diff --git a/debian/python-pycsw.manpages b/debian/python-pycsw.manpages
new file mode 100644
index 0000000..0d55974
--- /dev/null
+++ b/debian/python-pycsw.manpages
@@ -0,0 +1 @@
+debian/man/pycsw-admin.1
diff --git a/debian/rules b/debian/rules
index 968ec5f..c5ac201 100755
--- a/debian/rules
+++ b/debian/rules
@@ -7,6 +7,7 @@
 override_dh_auto_build:
 	dh_auto_build
 	PYTHONPATH=. http_proxy='127.0.0.1:9' sphinx-build -N -bhtml docs/ build/html # HTML generator
+	ronn debian/man/pycsw-admin.md
 
 get-orig-source:
 	uscan --verbose --force-download --repack --compression xz

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/pycsw.git