[Python-modules-commits] r12626 - in packages/python-ctypeslib/trunk/debian (5 files)

akumar at users.alioth.debian.org akumar at users.alioth.debian.org
Sat Apr 17 04:41:31 UTC 2010 

    Date: Saturday, April 17, 2010 @ 04:41:28
  Author: akumar
Revision: 12626

* Create and include a manual page.  There is one manual page accessible
  under the names `ctypeslib`, `h2xml`, and `xml2py` now.
* Add explicit source format 1.0 designation.

Added:
  packages/python-ctypeslib/trunk/debian/ctypeslib.1
  packages/python-ctypeslib/trunk/debian/python-ctypeslib.manpages
Modified:
  packages/python-ctypeslib/trunk/debian/changelog
  packages/python-ctypeslib/trunk/debian/control
  packages/python-ctypeslib/trunk/debian/rules

Modified: packages/python-ctypeslib/trunk/debian/changelog
===================================================================
--- packages/python-ctypeslib/trunk/debian/changelog	2010-04-16 21:35:15 UTC (rev 12625)
+++ packages/python-ctypeslib/trunk/debian/changelog	2010-04-17 04:41:28 UTC (rev 12626)
@@ -1,3 +1,11 @@
+python-ctypeslib (0.0.0+svn20100125-2) unstable; urgency=low
+
+  * Create and include a manual page.  There is one manual page accessible
+    under the names `ctypeslib`, `h2xml`, and `xml2py` now.
+  * Add explicit source format 1.0 designation.
+
+ -- Richard Darst <rkd at zgib.net>  Wed, 14 Apr 2010 15:56:04 -0400
+
 python-ctypeslib (0.0.0+svn20100125-1) unstable; urgency=low
 
   * Initial release (Closes: #566905)

Modified: packages/python-ctypeslib/trunk/debian/control
===================================================================
--- packages/python-ctypeslib/trunk/debian/control	2010-04-16 21:35:15 UTC (rev 12625)
+++ packages/python-ctypeslib/trunk/debian/control	2010-04-17 04:41:28 UTC (rev 12626)
@@ -14,7 +14,7 @@
 Architecture: all
 Depends: ${shlibs:Depends}, ${misc:Depends}, ${python:Depends}, gccxml
 Description: code generator to convert header files into ctypes interfaces
- ctypeslib is a code generator capable of converting C header files
+ Ctypeslib is a code generator capable of converting C header files
  into xml files (using gccxml), and then converting the xmlfiles into
  Python modules which define a ctypes interface to the corresponding C
  library.
@@ -24,3 +24,6 @@
  ctypes a lot and are tired of setting argtypes and restype of the
  called functions, you should look into ctypeslib.  Ctypeslib can also
  set up data types and structures from C header files automatically.
+ Ctypeslib could be used to integrate Python with an existing C project,
+ or from the start with a new project to ease development of a Python/C
+ interface.

Added: packages/python-ctypeslib/trunk/debian/ctypeslib.1
===================================================================
--- packages/python-ctypeslib/trunk/debian/ctypeslib.1	                        (rev 0)
+++ packages/python-ctypeslib/trunk/debian/ctypeslib.1	2010-04-17 04:41:28 UTC (rev 12626)
@@ -0,0 +1,231 @@
+.\" This file was originally generated by help2man 1.36, but
+.\" hand-edited to combine the pages for h2xml and xml2py together.
+.TH ctypeslib 1 "March 2010" "ctypeslib" "User Commands"
+
+.SH NAME
+.B h2xml
+- convert header files to XML intermediates
+.br
+.B xml2py
+- convert XML intermediates to Python ctypes interface
+
+
+.SH SYNOPSIS
+.B h2xml
+.I includefile\fR ... [\fIoptions\fR]
+.B -o
+.I outputxmlfile
+.br
+.B xml2py
+.I xmlfile\fR ... [\fIoptions\fR]
+.B -o
+.I outputpyfile
+
+.SH DESCRIPTION
+
+.B
+ctypeslib
+is a Python code generator capable of converting C header files
+into xml files (using gccxml), and then converting the xmlfiles into
+Python modules which define a ctypes interface to the corresponding C
+library.
+
+Ctypeslib is not ctypes.  Ctypes is included in Python 2.5+ and as an
+add-on for lower versions, while ctypeslib is a lesser known add-on
+written by the ctypes author.  If you use ctypes a lot and are tired
+of setting argtypes and restype of the called functions, you should
+look into ctypeslib.  Ctypeslib can also set up data types and
+structures from C header files automatically.
+
+.B h2xml
+and
+.B xml2py
+are the user interface scripts to ctypeslib. 
+.B h2xml
+converts C header files into xml intermediates (using \fBgccxml\fR) and
+.B xml2py
+converts these intermediates to Python files.  At the minimum, you can
+get automatic construction of the C types (structures, etc) in ctypes
+definitions.  With extra options, macro definitions can be expanded
+and the output Python file can be automatically linked (using ctypes)
+to the corresponding C library.
+
+The briefest example is:
+
+.RS
+.B h2xml \fIheader.h\fR -o \fIout_c.xml\fR
+.br
+.B xml2py \fIout_c.xml\fR -o \fIout_c.py\fR
+.RE
+
+Key options are 
+.B -c
+(include C preprocessor headers) to
+.B h2xml
+and
+.B -l
+.I library.so
+(automatically link to the C library using ctypes) to
+.B xml2py\fR.
+
+
+
+.SH OPTIONS
+
+.B h2xml
+options:
+.RS
+
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show brief help message
+.HP
+\fB\-q\fR, \fB\-\-quiet\fR
+
+.TP
+\fB\-D\fR NAME[=VALUE]
+macros to define
+.TP
+\fB\-U\fR NAME
+macros to undefine
+.TP
+\fB\-I\fR DIRECTORY
+additional include directories
+.TP
+\fB\-o\fR XMLFILE
+XML output filename
+.TP
+\fB\-c\fR, \fB\-\-cpp\-symbols\fR
+try to find #define symbols \- this may give compiler
+errors, so it's off by default.
+.TP
+\fB\-k\fR
+don't delete the temporary files created (useful for
+finding problems)
+.RE
+
+
+
+.B xml2py
+options:
+.RS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-c\fR
+include source file location in comments
+.TP
+\fB\-d\fR
+include docstrings containing C prototype and source file
+location
+.TP
+\fB\-k\fR TYPEKIND
+kind of type descriptions to include: d = #defines, e =
+enumerations, f = functions, s = structures, t = typedefs
+.TP
+\fB\-l\fR DLLS
+libraries to search for exported functions
+.TP
+\fB\-o\fR OUTPUT
+output filename (if not specified, standard output will be
+used)
+.TP
+\fB\-r\fR EXPRESSION
+regular expression for symbols to include (if neither symbols
+nor expressions are specified,everything will be included)
+.TP
+\fB\-s\fR SYMBOL
+symbol to include (if neither symbols nor expressions are
+specified,everything will be included)
+.TP
+\fB\-v\fR
+verbose output
+.TP
+\fB\-w\fR
+add all standard windows dlls to the searched dlls list
+.TP
+\fB\-m\fR module
+Python module(s) containing symbols which will be imported
+instead of generated
+.TP
+\fB\-\-preload\fR=\fIDLL\fR
+dlls to be loaded before all others (to resolve symbols)
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-c\fR
+include source file location in comments
+.TP
+\fB\-d\fR
+include docstrings containing C prototype and source file
+location
+.TP
+\fB\-k\fR TYPEKIND
+kind of type descriptions to include: d = #defines, e =
+enumerations, f = functions, s = structures, t = typedefs
+.TP
+\fB\-l\fR DLLS
+libraries to search for exported functions
+.TP
+\fB\-o\fR OUTPUT
+output filename (if not specified, standard output will be
+used)
+.TP
+\fB\-r\fR EXPRESSION
+regular expression for symbols to include (if neither symbols
+nor expressions are specified,everything will be included)
+.TP
+\fB\-s\fR SYMBOL
+symbol to include (if neither symbols nor expressions are
+specified,everything will be included)
+.TP
+\fB\-v\fR
+verbose output
+.TP
+\fB\-w\fR
+add all standard windows dlls to the searched dlls list
+.TP
+\fB\-m\fR module
+Python module(s) containing symbols which will be imported
+instead of generated
+.TP
+\fB\-\-preload\fR=\fIDLL\fR
+dlls to be loaded before all others (to resolve symbols)
+
+.RE
+
+
+
+
+.SH "EXAMPLES"
+
+Please see
+.I /usr/share/doc/python-ctypeslib/examples.Debian
+for examples and explanation.
+
+
+
+
+.SH "SEE ALSO"
+.I /usr/share/doc/python-ctypeslib/examples.Debian
+contains a brief tutorial on some key features
+
+Python docstrings (\fBpydoc ctypeslib\fR)
+
+Ctypeslib upstream is
+.I http://python.net/crew/theller/ctypes/
+(see "Related Projects").
+
+For ctypes information, see
+.I http://docs.python.org/library/ctypes.html
+
+
+
+.SH "AUTHOR"
+.B ctypeslib
+was written by Thomas Heller <theller at ctypes.org>.
+.PP
+This manual page was written by Richard Darst <rkd at zgib.net>,
+for the Debian project (and may be used by others).

Added: packages/python-ctypeslib/trunk/debian/python-ctypeslib.manpages
===================================================================
--- packages/python-ctypeslib/trunk/debian/python-ctypeslib.manpages	                        (rev 0)
+++ packages/python-ctypeslib/trunk/debian/python-ctypeslib.manpages	2010-04-17 04:41:28 UTC (rev 12626)
@@ -0,0 +1 @@
+debian/ctypeslib.1
\ No newline at end of file

Modified: packages/python-ctypeslib/trunk/debian/rules
===================================================================
--- packages/python-ctypeslib/trunk/debian/rules	2010-04-16 21:35:15 UTC (rev 12625)
+++ packages/python-ctypeslib/trunk/debian/rules	2010-04-17 04:41:28 UTC (rev 12626)
@@ -44,6 +44,11 @@
            debian/python-ctypeslib/usr/bin/h2xml
 	mv debian/python-ctypeslib/usr/bin/xml2py.py \
            debian/python-ctypeslib/usr/bin/xml2py
+	dh binary --until dh_installman
+	ln -s ctypeslib.1.gz \
+	      debian/python-ctypeslib/usr/share/man/man1/h2xml.1.gz
+	ln -s ctypeslib.1.gz \
+	      debian/python-ctypeslib/usr/share/man/man1/xml2py.1.gz
 	dh binary
 
 %:

More information about the Python-modules-commits mailing list