[cheese] Add man page, generated with xsltproc



commit d83303c3d5ae9bac9e0da8d1b206d53dd947003c
Author: David King <amigadave amigadave com>
Date:   Sun Oct 30 20:01:21 2011 +0100

    Add man page, generated with xsltproc

 Makefile.am                    |    1 +
 configure.ac                   |   10 ++++
 docs/reference/Makefile.am     |    7 +++
 docs/reference/cheese-docs.xml |    5 ++
 docs/reference/cheese.xml      |   94 ++++++++++++++++++++++++++++++++++++++++
 5 files changed, 117 insertions(+), 0 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index a8dc53f..93d876f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -416,6 +416,7 @@ dist_noinst_DATA = \
 	$(service_in_files) \
 	$(gtkdoc_srcdir)/cheese-docs.xml \
 	$(gtkdoc_srcdir)/cheese-sections.txt \
+	$(gtkdoc_srcdir)/cheese.xml \
 	$(gtkdoc_srcdir)/version.xml.in \
 	gtk-doc.make \
 	intltool-extract.in \
diff --git a/configure.ac b/configure.ac
index a931dd5..f07072d 100644
--- a/configure.ac
+++ b/configure.ac
@@ -165,6 +165,16 @@ GOBJECT_INTROSPECTION_CHECK([0.6.7])
 # API documentation
 GTK_DOC_CHECK([1.14], [--flavour no-tmpl])
 
+# Manpage, generated with gtk-doc and xsltproc from DocBook XML.
+AC_ARG_ENABLE([man],
+  [AS_HELP_STRING([--disable-man], [Disable building the man page])])
+
+AS_IF([test "x$enable_man" != "xno"],
+  [AC_CHECK_PROG([have_xsltproc], [xsltproc], [yes], [no])],
+  [have_xsltproc=no])
+
+AM_CONDITIONAL([ENABLE_MAN], [test "x$have_xxsltproc" = "xyes"])
+
 # User manual
 GNOME_DOC_INIT([0.20])
 
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 4cae7b0..dac58ee 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -90,5 +90,12 @@ TESTS_ENVIRONMENT = cd $(srcdir) &&
 TESTS = $(GTKDOC_CHECK)
 endif
 
+if ENABLE_MAN
+cheese.1: cheese.xml
+	$(AM_V_GEN)xsltproc -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+nodist_man_MANS = cheese.1
+endif
+
 sgml.stamp: $(DOC_MODULE)-sections.txt
 $(DOC_MAIN_SGML_FILE): sgml.stamp
diff --git a/docs/reference/cheese-docs.xml b/docs/reference/cheese-docs.xml
index de2d1fb..2a687b4 100644
--- a/docs/reference/cheese-docs.xml
+++ b/docs/reference/cheese-docs.xml
@@ -48,6 +48,11 @@
     <xi:include href="xml/cheese-widget.xml"/>
   </chapter>
 
+  <chapter>
+    <title>Running Cheese</title>
+    <xi:include href="cheese.xml"/>
+  </chapter>
+
   <chapter id="object-tree">
     <title>Object Hierarchy</title>
      <xi:include href="xml/tree_index.sgml"/>
diff --git a/docs/reference/cheese.xml b/docs/reference/cheese.xml
new file mode 100644
index 0000000..56a22a1
--- /dev/null
+++ b/docs/reference/cheese.xml
@@ -0,0 +1,94 @@
+<refentry id="cheese">
+
+<refmeta>
+<refentrytitle>cheese</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class="manual">User Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>Cheese</refname>
+<refpurpose>tool to take pictures and videos from your webcam</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>cheese</command>
+<arg choice="opt" rep="repeat">option</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+<command>cheese</command> uses your webcam to take photos and videos, applies
+fancy special effects and lets you share the fun with others. It was written as
+part of Google's 2007 Summer of Code lead by daniel g. siegel and mentored by
+RaphaÃl Slinckx. Under the hood, Cheese uses GStreamer to apply fancy effects
+to photos and videos. With Cheese it is easy to take photos of you, your
+friends, pets or whatever you want and share them with others. After the
+success of the Summer of Code, the development continued and we are still
+looking for people with nice ideas and patches ;)
+</para>
+</refsect1>
+
+<refsect1><title>Invocation</title>
+<para><command>cheese</command> takes a list of options as arguments.</para>
+
+<refsect2><title>Options</title>
+<variablelist>
+
+<varlistentry>
+<term><option>--wide</option>, <option>-w</option></term>
+<listitem><para>
+Start in wide mode, with the thumbnails to the right of the video preview.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--device=DEVICE</option>, <option>-d DEVICE</option></term>
+<listitem><para>
+Use the supplied DEVICE as the video capture device.
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--fullscreen</option>, <option>-f</option></term>
+<listitem><para>Start in fullscreen mode.</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--help</option>, <option>-h</option></term>
+<listitem><para>Print brief help and exit.</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--version</option>, <option>-v</option></term>
+<listitem><para>Print the version and exit.</para></listitem>
+</varlistentry>
+
+</variablelist>
+</refsect2>
+
+</refsect1>
+
+<refsect1><title>See also</title>
+<para>Cheese help manual</para>
+</refsect1>
+
+<refsect1><title>Author</title>
+<para>
+<command>cheese</command> was written by Daniel G. Siegel
+<email>dgsiegel gnome org</email>, Jaap A. Haitsma
+<email>jaap haitsma org</email>, Filippo Argiolas
+<email>fargiolas gnome org</email>, Yuvaraj Pandian T
+<email>yuvipanda yuvi in</email>, Luciana Fujii Pontello
+<email>luciana fujii eti br</email> and David King
+<email>amigadave amigadave com</email>.
+</para>
+
+<para>
+This manual page was written by David King
+<email>amigadave amigadave com</email>.
+</para>
+</refsect1>
+</refentry>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]