[gnome-disk-utility] Add gnome-disks(1) and gnome-disk-image-mounter(1) man pages



commit d00f7e69bb18934a27d461d9a5c0eaaffa621a51
Author: David Zeuthen <davidz redhat com>
Date:   Fri May 4 17:58:09 2012 -0400

    Add gnome-disks(1) and gnome-disk-image-mounter(1) man pages
    
    Signed-off-by: David Zeuthen <davidz redhat com>

 Makefile.am                          |    2 +-
 configure.ac                         |    7 +++
 doc/Makefile.am                      |    4 ++
 doc/man/Makefile.am                  |   22 ++++++++++
 doc/man/gnome-disk-image-mounter.xml |   77 ++++++++++++++++++++++++++++++++++
 doc/man/gnome-disks.xml              |   50 ++++++++++++++++++++++
 6 files changed, 161 insertions(+), 1 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 1acd002..f2761d7 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = src data po
+SUBDIRS = src data po doc
 
 clean-local :
 	rm -f *~ po/*~
diff --git a/configure.ac b/configure.ac
index 7b76dc1..17b513e 100644
--- a/configure.ac
+++ b/configure.ac
@@ -62,6 +62,11 @@ AM_CONDITIONAL(USE_LIBSYSTEMD_LOGIN, [test "$msg_libsystemd_login" = "yes"])
 # Internationalization
 # ********************
 
+AC_PATH_PROG([XSLTPROC], [xsltproc])
+if test -z "$XSLTPROC"; then
+  AC_MSG_ERROR([xsltproc is needed])
+fi
+
 IT_PROG_INTLTOOL([$INTLTOOL_REQUIRED])
 
 GETTEXT_PACKAGE=gnome-disk-utility
@@ -90,6 +95,8 @@ data/icons/48x48/Makefile
 data/icons/256x256/Makefile
 data/icons/scalable/Makefile
 data/ui/Makefile
+doc/Makefile
+doc/man/Makefile
 ])
 
 AC_OUTPUT
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..68534c0
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,4 @@
+SUBDIRS = man
+
+clean-local :
+	rm -f *~
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
new file mode 100644
index 0000000..92e2686
--- /dev/null
+++ b/doc/man/Makefile.am
@@ -0,0 +1,22 @@
+
+NULL =
+
+man_MANS = 				\
+	gnome-disks.1			\
+	gnome-disk-image-mounter.1	\
+	$(NULL)
+
+gnome-disks.1 : gnome-disks.xml
+	$(XSLTPROC) -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+gnome-disk-image-mounter.1 : gnome-disk-image-mounter.xml
+	$(XSLTPROC) -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+
+EXTRA_DIST= 				\
+	gnome-disks.xml			\
+	gnome-disk-image-mounter.xml    \
+	$(NULL)
+
+clean-local:
+	rm -f *~ *.1
diff --git a/doc/man/gnome-disk-image-mounter.xml b/doc/man/gnome-disk-image-mounter.xml
new file mode 100644
index 0000000..22d0a69
--- /dev/null
+++ b/doc/man/gnome-disk-image-mounter.xml
@@ -0,0 +1,77 @@
+<refentry id="gnome-disk-image-mounter">
+  <refentryinfo>
+    <title>gnome-disk-utility</title>
+    <date>May 2012</date>
+    <productname>GNOME</productname>
+  </refentryinfo>
+
+  <refnamediv>
+    <refname>gnome-disk-image-mounter</refname>
+    <refpurpose>Attach and mount disk images</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv><title>SYNOPSIS</title>
+    <cmdsynopsis>
+      <command>gnome-disk-image-mounter</command>
+      <arg choice="opt">--writable</arg>
+      <arg choice="opt" rep="repeat"><replaceable>URI</replaceable></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1><title>DESCRIPTION</title>
+    <para>
+      <command>gnome-disk-image-mounter</command> can be used to mount
+      disk images. Both regular files and <emphasis>GVfs</emphasis>
+      URIs (such as <filename>smb://filer/media/file.iso</filename>)
+      can be used in the <parameter>URI</parameter> parameter. If no
+      <parameter>URI</parameter>s are given and a window server is
+      running, a graphical file chooser will be presented.
+    </para>
+    <para>
+      If a disk image is partitioned, all mountable partitions in the
+      image will be mounted (except for e.g. firmware
+      partitions). Otherwise the whole disk image will be mounted.
+    </para>
+    <para>
+      If a disk image is not mountable or mounting fails, an error
+      will be presented either on <emphasis>standard error</emphasis>
+      or in a dialog box if a window server is running.
+    </para>
+    <para>
+      By default the disk images are attached read-only, use
+      <option>--writable</option> to change this.
+    </para>
+  </refsect1>
+
+  <refsect1><title>RETURN VALUE</title>
+    <para>
+      <command>gnome-disk-image-mounter</command> returns 0 on success
+      and non-zero on failure.
+    </para>
+  </refsect1>
+
+  <refsect1><title>AUTHOR</title>
+    <para>
+      Written by David Zeuthen <email>zeuthen gmail com</email> with
+      a lot of help from many others.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>BUGS</title>
+    <para>
+      Please send bug reports to either the distribution bug tracker
+      or the upstream bug tracker at
+      <ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-disk-utility"/>.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <link linkend="gnome-disks.1"><citerefentry><refentrytitle>gnome-disks</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>,
+      <citerefentry><refentrytitle>udisks</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>losetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    </para>
+  </refsect1>
+</refentry>
diff --git a/doc/man/gnome-disks.xml b/doc/man/gnome-disks.xml
new file mode 100644
index 0000000..055a40c
--- /dev/null
+++ b/doc/man/gnome-disks.xml
@@ -0,0 +1,50 @@
+<refentry id="gnome-disks">
+  <refentryinfo>
+    <title>gnome-disk-utility</title>
+    <date>May 2012</date>
+    <productname>GNOME</productname>
+  </refentryinfo>
+
+  <refnamediv>
+    <refname>gnome-disks</refname>
+    <refpurpose>View, modify and configure disks and media</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv><title>SYNOPSIS</title>
+    <cmdsynopsis>
+      <command>gnome-disks</command>
+      <arg choice="opt">OPTIONS</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1><title>DESCRIPTION</title>
+    <para>
+      <command>gnome-disks</command> is the GNOME disk partitioning
+      and management application.
+    </para>
+  </refsect1>
+
+  <refsect1><title>AUTHOR</title>
+    <para>
+      Written by David Zeuthen <email>zeuthen gmail com</email> with
+      a lot of help from many others.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>BUGS</title>
+    <para>
+      Please send bug reports to either the distribution bug tracker
+      or the upstream bug tracker at
+      <ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=gnome-disk-utility"/>.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <link linkend="gnome-disk-image-mounter.1"><citerefentry><refentrytitle>gnome-disk-image-mounter</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>,
+      <citerefentry><refentrytitle>udisks</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    </para>
+  </refsect1>
+</refentry>



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