[Python-modules-commits] r9412 - in packages/pywbem/trunk/debian (5 files)

Fri Aug 21 12:57:25 UTC 2009

Date: Friday, August 21, 2009 @ 12:57:24
  Author: bzed
Revision: 9412

Adding manpage, finishing packagaging.

Added:
  packages/pywbem/trunk/debian/clean
  packages/pywbem/trunk/debian/manpages
  packages/pywbem/trunk/debian/wbemcli.1.xml
Modified:
  packages/pywbem/trunk/debian/control
  packages/pywbem/trunk/debian/rules

Added: packages/pywbem/trunk/debian/clean
===================================================================

--- packages/pywbem/trunk/debian/clean	                        (rev 0)
+++ packages/pywbem/trunk/debian/clean	2009-08-21 12:57:24 UTC (rev 9412)
@@ -0,0 +1 @@
+wbemcli.1

Modified: packages/pywbem/trunk/debian/control
===================================================================
--- packages/pywbem/trunk/debian/control	2009-08-21 11:47:47 UTC (rev 9411)
+++ packages/pywbem/trunk/debian/control	2009-08-21 12:57:24 UTC (rev 9412)
@@ -3,8 +3,8 @@
 Priority: extra
 Maintainer: Debian Python Modules Team <python-modules-team at lists.alioth.debian.org>
 Uploaders: Bernd Zeimetz <bzed at debian.org>
-Build-Depends: debhelper (>= 7), python
-Build-Depends-Indep: python-support (>= 0.4)
+Build-Depends: debhelper (>= 7), python-all
+Build-Depends-Indep: python-support (>= 0.4), docbook-xsl, xsltproc
 Vcs-Svn: svn://svn.debian.org/python-modules/packages/pywbem/trunk/
 Vcs-Browser: http://svn.debian.org/viewsvn/python-modules/packages/pywbem/trunk/
 Homepage: http://pywbem.sourceforge.net/

Added: packages/pywbem/trunk/debian/manpages
===================================================================
--- packages/pywbem/trunk/debian/manpages	                        (rev 0)
+++ packages/pywbem/trunk/debian/manpages	2009-08-21 12:57:24 UTC (rev 9412)
@@ -0,0 +1 @@
+wbemcli.1

Modified: packages/pywbem/trunk/debian/rules
===================================================================
--- packages/pywbem/trunk/debian/rules	2009-08-21 11:47:47 UTC (rev 9411)
+++ packages/pywbem/trunk/debian/rules	2009-08-21 12:57:24 UTC (rev 9412)
@@ -3,7 +3,16 @@
 # Uncomment this to turn on verbose mode.
 #export DH_VERBOSE=1
 
+DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl
+XP     = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
+
+%.1: debian/%.1.xml
+	$(XP) $(DB2MAN) $<
+
+
 %:
 	dh $@
 
+build: wbemcli.1
+	dh $@
 

Added: packages/pywbem/trunk/debian/wbemcli.1.xml
===================================================================
--- packages/pywbem/trunk/debian/wbemcli.1.xml	                        (rev 0)
+++ packages/pywbem/trunk/debian/wbemcli.1.xml	2009-08-21 12:57:24 UTC (rev 9412)
@@ -0,0 +1,153 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+
+<!--
+
+`xsltproc -''-nonet \
+          -''-param man.charmap.use.subset "0" \
+          -''-param make.year.ranges "1" \
+          -''-param make.single.year.ranges "1" \
+          /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
+          manpage.xml'
+
+A manual page <package>.<section> will be generated. You may view the
+manual page with: nroff -man <package>.<section> | less'. A typical entry
+in a Makefile or Makefile.am is:
+
+DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl
+XP     = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
+
+manpage.1: manpage.xml
+        $(XP) $(DB2MAN) $<
+
+The xsltproc binary is found in the xsltproc package. The XSL files are in
+docbook-xsl. A description of the parameters you can use can be found in the
+docbook-xsl-doc-* packages. Please remember that if you create the nroff
+version in one of the debian/rules file targets (such as build), you will need
+to include xsltproc and docbook-xsl in your Build-Depends control field.
+Alternatively use the xmlto command/package. That will also automatically
+pull in xsltproc and docbook-xsl.
+
+Notes for using docbook2x: docbook2x-man does not automatically create the
+AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
+<refsect1> ... </refsect1>.
+
+To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
+read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
+found in the docbook-xsl-doc-html package.
+
+Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
+
+General documentation about man-pages and man-page-formatting:
+man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
+
+-->
+
+  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
+  <!ENTITY dhfirstname "Bernd">
+  <!ENTITY dhsurname   "Zeimetz">
+  <!-- dhusername could also be set to "&firstname; &surname;". -->
+  <!ENTITY dhusername  "&dhfirstname; &dhsurname;">
+  <!ENTITY dhemail     "bzed at debian.org">
+  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
+       allowed: see man(7), man(1) and
+       http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
+  <!ENTITY dhsection   "1">
+  <!-- TITLE should be something like "User commands" or similar (see
+       http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
+  <!ENTITY dhtitle     "wbemcli User Manual">
+  <!ENTITY dhucpackage "PYWBEM">
+  <!ENTITY dhpackage   "PYWBEM">
+]>
+
+<refentry>
+  <refentryinfo>
+    <title>&dhtitle;</title>
+    <productname>&dhpackage;</productname>
+    <authorgroup>
+      <author>
+       <firstname>&dhfirstname;</firstname>
+        <surname>&dhsurname;</surname>
+        <contrib>Wrote this manpage for the Debian system.</contrib>
+        <address>
+          <email>&dhemail;</email>
+        </address>
+      </author>
+    </authorgroup>
+    <copyright>
+      <year>2009</year>
+      <holder>&dhusername;</holder>
+    </copyright>
+    <legalnotice>
+      <para>This manual page was written for the Debian system
+        (and may be used by others).</para>
+      <para>Permission is granted to copy, distribute and/or modify this
+        document under the terms of the GNU Lesser General Public License,
+        Version 2 or (at your option) any later version published by
+        the Free Software Foundation.</para>
+      <para>On Debian systems, the complete text of the GNU General Public
+        License can be found in
+        <filename>/usr/share/common-licenses/LGPL-2</filename>.</para>
+    </legalnotice>
+  </refentryinfo>
+  <refmeta>
+    <refentrytitle>&dhucpackage;</refentrytitle>
+    <manvolnum>&dhsection;</manvolnum>
+  </refmeta>
+  <refnamediv>
+    <refname>&dhpackage;</refname>
+    <refpurpose>utility to wrap up a PyWBEM session in a Python interactive console</refpurpose>
+  </refnamediv>
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+      <arg choice="plain"><option><replaceable>HOSTNAME</replaceable></option></arg>
+      <arg choice="opt">
+        <group choice="req">
+          <arg choice="plain"><option>-u<replaceable>USERNAME</replaceable></option></arg>
+          <arg choice="plain"><option>-p<replaceable>PASSWORD</replaceable></option></arg>
+        </group>
+      </arg>
+      <arg choice="opt"><option>-n<replaceable>NAMESPACE</replaceable></option></arg>
+      <arg choice="opt"><option>--no-ssl</option></arg>
+      <arg choice="opt"><option>--port<replaceable>PORT</replaceable></option></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+  <refsect1 id="description">
+    <title>DESCRIPTION</title>
+    <para>This manual page documents briefly the
+      <command>&dhpackage;</command> command.</para>
+    <para>This manual page was written for the Debian distribution
+      because the original program does not have a manual page.</para>
+    <para><command>&dhpackage;</command> is small utility to wrap up
+      a PyWBEM session in a Python interactive console.</para>
+    <para>CIM operations can be executed by using the PyWBEM connection object
+      called 'cli' in the global scope.  There are two sets of aliases
+      available for usage in the interpreter. For example the following
+      three commands are equivalent:
+    </para>
+    <blockquote>
+    <para>
+>>> cli.EnumerateInstanceNames('SMX_ComputerSystem')
+>>> EnumerateInstanceNames('SMX_ComputerSystem')
+>>> ein('SMX_ComputerSystem')
+    </para>
+    </blockquote>
+    <para>Pretty-printing of results is also available using the 'pp'
+       function. For example:
+    </para>
+    <blockquote>
+    <para>
+>>> cs = ei('SMX_ComputerSystem')[0]
+>>> pp(cs.items())
+[(u'RequestedState', 12L),
+(u'Dedicated', [1L]),
+(u'StatusDescriptions', [u'System is Functional']),
+(u'IdentifyingNumber', u'6F880AA1-F4F5-11D5-8C45-C0116FBAE02A'),
+..
+    </para>
+    </blockquote>
+  </refsect1>
+</refentry>
+


