summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarcelo Lira <marcelo.lira@openbossa.org>2011-01-03 11:10:32 -0300
committerMarcelo Lira <marcelo.lira@openbossa.org>2011-01-03 11:10:32 -0300
commit7563560d32c91d0cf58567358a0f0f85c590056f (patch)
treeafdec9eb8b4432ecd6ca8a463b73bfa890c8d926 /doc
parenta24e6bcd2251b6cbd78ec4e69a2b6b591738e697 (diff)
downloadshiboken-7563560d32c91d0cf58567358a0f0f85c590056f.tar.gz
shiboken-7563560d32c91d0cf58567358a0f0f85c590056f.tar.xz
shiboken-7563560d32c91d0cf58567358a0f0f85c590056f.zip
Added a Linux man page for Shiboken.
The man page was copied from the 'ubuntu' directory on the old 'packaging' repository.
Diffstat (limited to 'doc')
-rw-r--r--doc/CMakeLists.txt7
-rw-r--r--doc/shiboken.173
2 files changed, 79 insertions, 1 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index d78844dc..57c8fa75 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -7,4 +7,9 @@ if (SPHINX)
add_custom_target(doc ${SPHINX} -b html -c . ${CMAKE_CURRENT_SOURCE_DIR} html )
else()
message("-- sphinx-build - not found! doc target disabled")
-endif() \ No newline at end of file
+endif()
+
+if (NOT win32)
+ file(GLOB manpages "${CMAKE_CURRENT_SOURCE_DIR}/*.1")
+ install(FILES ${manpages} DESTINATION share/man/man1)
+endif()
diff --git a/doc/shiboken.1 b/doc/shiboken.1
new file mode 100644
index 00000000..8aa25a7d
--- /dev/null
+++ b/doc/shiboken.1
@@ -0,0 +1,73 @@
+.TH SHIBOKEN "1" "March 2010" "shiboken v0.2.0" "User Commands"
+.SH NAME
+shiboken \- CPython bindings generator for C++ libraries
+.SH DESCRIPTION
+.SS "Usage:"
+.IP
+shiboken [options] header\-file typesystem\-file
+.SS "General options:"
+.TP
+\fB\-\-debug\-level\fR=\fI[sparse\fR|medium|full]
+Set the debug level
+.TP
+\fB\-\-documentation\-only\fR
+Do not generates any code, just the documentation
+.TP
+\fB\-\-generatorSet\fR
+generatorSet to be used. e.g. qtdoc
+.TP
+\fB\-\-help\fR
+Display this help and exit
+.TP
+\fB\-\-include\-paths=\fR<path>[:<path>:...]
+Include paths used by the C++ parser
+.TP
+\fB\-\-license\-file\fR=\fI[licensefile]\fR
+File used for copyright headers of generated files
+.TP
+\fB\-\-no\-suppress\-warnings\fR
+Show all warnings
+.TP
+\fB\-\-output\-directory\fR=\fI[dir]\fR
+The directory where the generated files will be written
+.TP
+\fB\-\-silent\fR
+Avoid printing any message
+.TP
+\fB\-\-typesystem\-paths=\fR<path>[:<path>:...]
+Paths used when searching for typesystems
+.TP
+\fB\-\-version\fR
+Output version information and exit
+.SS "Shiboken options:"
+.TP
+\fB\-\-disable\-verbose\-error\-messages\fR
+Disable verbose error messages. Turn the python code hard to debug but safe few kB on the generated bindings.
+.TP
+\fB\-\-enable\-parent\-ctor\-heuristic\fR
+Enable heuristics to detect parent relationship on constructors.
+.TP
+\fB\-\-enable\-pyside\-extensions\fR
+Enable PySide extensions, such as support for signal/slots, use this if you are creating a binding for a Qt\-based library.
+.TP
+\fB\-\-enable\-return\-value\-heuristic\fR
+Enable heuristics to detect parent relationship on return values (USE WITH CAUTION!)
+.SS "Shiboken options:"
+.TP
+\fB\-\-disable\-verbose\-error\-messages\fR
+Disable verbose error messages. Turn the python code hard to debug but safe few kB on the generated bindings.
+.TP
+\fB\-\-enable\-parent\-ctor\-heuristic\fR
+Enable heuristics to detect parent relationship on constructors.
+.TP
+\fB\-\-enable\-pyside\-extensions\fR
+Enable PySide extensions, such as support for signal/slots, use this if you are creating a binding for a Qt\-based library.
+.TP
+\fB\-\-enable\-return\-value\-heuristic\fR
+Enable heuristics to detect parent relationship on return values (USE WITH CAUTION!)
+.SH COPYRIGHT
+Copyright \(co 2009\-2010 Nokia Corporation and/or its subsidiary(\fB\-ies\fR)
+.SH AUTHOR
+.PP
+This manpage was written for Debian, starting with a help2man output, by
+Didier Raboud <didier@raboud.com>, on the 26. March 2010.