[gvfs] Add more man pages
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gvfs] Add more man pages
- Date: Sat, 4 Aug 2012 13:10:36 +0000 (UTC)
commit e66a2c1006e0a4de88eb154223015c73cfa5947c
Author: Matthias Clasen <mclasen redhat com>
Date: Tue Jul 31 13:35:45 2012 +0200
Add more man pages
This patch adds man pages for gvfsd, gvfsd-fuse, gvfsd-metadata,
as well as a gvfs overview page in section 7.
man/Makefile.am | 25 +++++++--
man/gvfs.xml | 143 ++++++++++++++++++++++++++++++++++++++++++++++++
man/gvfsd-fuse.xml | 102 ++++++++++++++++++++++++++++++++++
man/gvfsd-metadata.xml | 101 ++++++++++++++++++++++++++++++++++
man/gvfsd.xml | 122 +++++++++++++++++++++++++++++++++++++++++
5 files changed, 488 insertions(+), 5 deletions(-)
---
diff --git a/man/Makefile.am b/man/Makefile.am
index e00c38e..1ce980b 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,5 +1,16 @@
-.xml.1:
- $(AM_V_GEN) $(XSLTPROC) -o $@ --nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+XSLTPROC_FLAGS = \
+ --nonet \
+ --stringparam man.output.quietly 1 \
+ --stringparam funcsynopsis.style ansi \
+ --stringparam man.th.extra1.suppress 1 \
+ --stringparam man.authors.section.enabled 0 \
+ --stringparam man.copyright.section.enabled 0
+
+%.1: %.xml
+ $(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+%.7: %.xml
+ $(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
man_MANS = \
gvfs-cat.1 \
@@ -18,10 +29,14 @@ man_MANS = \
gvfs-save.1 \
gvfs-set-attribute.1 \
gvfs-trash.1 \
- gvfs-tree.1
+ gvfs-tree.1 \
+ gvfs.7 \
+ gvfsd.1 \
+ gvfsd-fuse.1 \
+ gvfsd-metadata.1
-xml_files = $(man_MANS:.1=.xml)
+xml_files = ${patsubst %.1,%.xml,${patsubst %.7,%.xml,$(man_MANS)}}
EXTRA_DIST = $(xml_files)
-DISTCLEANFILES = $(man_MANS)
+CLEANFILES = $(man_MANS)
diff --git a/man/gvfs.xml b/man/gvfs.xml
new file mode 100644
index 0000000..cc52716
--- /dev/null
+++ b/man/gvfs.xml
@@ -0,0 +1,143 @@
+<?xml version='1.0'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd";>
+
+<refentry id="gvfs">
+
+ <refentryinfo>
+ <title>gvfs</title>
+ <productname>gvfs</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Alexander</firstname>
+ <surname>Larsson</surname>
+ <email>alexl redhat com</email>
+ </author>
+ </authorgroup>
+
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>gvfs</refentrytitle>
+ <manvolnum>7</manvolnum>
+ <refmiscinfo class="manual">Conventions and miscellaneous</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+ <refname>gvfs</refname>
+ <refpurpose>GIO virtual file system</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>GIO provides a VFS API to GLib applications. It
+ includes a 'local' implementation using POSIX. gvfs
+ provides implementations that go beyond that and allow
+ to access files and storage using many protocols, such
+ as ftp, http, sftp, dav, obexftp, etc. It also provides
+ support for trash folders, for cd burning and for monitoring
+ interesting devices and volumes on the computer.</para>
+
+ <para>Applications use gvfs indirectly, by means of GIO
+ loading the gvfs module that implements the GIO extension
+ points. The gvfs support for volume monitoring is included
+ in a separate loadable module.</para>
+
+ <para>The actual gvfs implementation is distributed over
+ a number of processes. None of these are expected to be
+ started from the commandline, except for debugging
+ purposes.</para>
+
+ <para>Main processes:
+ <itemizedlist>
+ <listitem><para>gvfsd - the main gvfs daemon</para></listitem>
+ <listitem><para>gvfs-fuse-daemon - mounts gvfs as a fuse filesystem</para></listitem>
+ <listitem><para>gvfsd-metadata - writes gvfs metadata</para></listitem>
+ </itemizedlist>
+ Volume monitors:
+ <itemizedlist>
+ <listitem><para>gvfs-udisks2-volume-monitor - a udisks-based volume monitor</para></listitem>
+ <listitem><para>gvfs-afc-volume-monitor - a volume monitor for Apple iPhone/iPod Touch devices</para></listitem>
+ </itemizedlist>
+ Mount backends:
+ <itemizedlist>
+ <listitem><para>gvfsd-afc - mounts iPhone/iPod touch volumes</para></listitem>
+ <listitem><para>gvfsd-afp - mounts Apple Filing Protocol volumes</para></listitem>
+ <listitem><para>gvfsd-afp-browse - browses Apple Filing Protocol volumes</para></listitem>
+ <listitem><para>gvfsd-archive - mounts archive files in various formats</para></listitem>
+ <listitem><para>gvfsd-burn - provides a location for burning CDs</para></listitem>
+ <listitem><para>gvfsd-cdda - mounts audio CDs</para></listitem>
+ <listitem><para>gvfsd-computer - provides computer://</para></listitem>
+ <listitem><para>gvfsd-dav - mounts DAV filesystems</para></listitem>
+ <listitem><para>gvfsd-dnssd - browses dnssd</para></listitem>
+ <listitem><para>gvfsd-ftp - mounts over FTP</para></listitem>
+ <listitem><para>gvfsd-http - mounts over HTTP</para></listitem>
+ <listitem><para>gvfsd-localtest - a test backend</para></listitem>
+ <listitem><para>gvfsd-network - provides network://</para></listitem>
+ <listitem><para>gvfsd-obexftp - mounts over obexftp</para></listitem>
+ <listitem><para>gvfsd-recent - provides recent://</para></listitem>
+ <listitem><para>gvfsd-sftp - mounts over sftp</para></listitem>
+ <listitem><para>gvfsd-smb - mounts Windows Shares Filesystem volumes</para></listitem>
+ <listitem><para>gvfsd-smb-browse - browses Windows Shares Filesystem volumes</para></listitem>
+ <listitem><para>gvfsd-trash - provides trash://</para></listitem>
+ </itemizedlist>
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Environment</title>
+
+ <varlistentry>
+ <term><envar>GIO_USE_VFS</envar></term>
+
+ <listitem><para>If set, specifies the GIO vfs
+ implementation to use. Possible values include
+ 'local' and 'gvfs'.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><envar>GIO_USE_VOLUME_MONITOR</envar></term>
+
+ <listitem><para>If set, specifies the GIO volume
+ monitor implementation to use. Possible values include
+ 'unix', 'GProxyVolumeMonitorUDisks2', as well as
+ other native volume monitors that are described in
+ the key files in
+ <filename><envar>$XDG_DATA_DIRS</envar>/gvfs/remote-volume-monitors</filename>.</para></listitem>
+ </varlistentry>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Files</title>
+
+ <varlistentry>
+ <term><filename><envar>$XDG_DATA_DIRS</envar>/gvfs/mounts</filename></term>
+
+ <listitem><para>This directory contains key files
+ describing mount daemons.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename><envar>$XDG_DATA_DIRS</envar>/gvfs/remote-volume-monitors</filename></term>
+
+ <listitem><para>This directory contains key files
+ describing remote volume monitors.</para></listitem>
+ </varlistentry>
+
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <ulink url="http://developer.gnome.org/gio";>GIO documentation</ulink>,
+ <citerefentry><refentrytitle>gvfsd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>gvfsd-fuse</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>gvfsd-metadata</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
diff --git a/man/gvfsd-fuse.xml b/man/gvfsd-fuse.xml
new file mode 100644
index 0000000..a8b11ea
--- /dev/null
+++ b/man/gvfsd-fuse.xml
@@ -0,0 +1,102 @@
+<?xml version='1.0'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd";>
+
+<refentry id="gvfsd-fuse">
+
+ <refentryinfo>
+ <title>gvfsd-fuse</title>
+ <productname>gvfs</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Alexander</firstname>
+ <surname>Larsson</surname>
+ <email>alexl redhat com</email>
+ </author>
+ </authorgroup>
+
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>gvfsd-fuse</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>gvfsd-fuse</refname>
+ <refpurpose>Fuse daemon for gvfs</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>gvfsd-fuse</command>
+ <arg choice="plain">PATH</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para><command>gvfsd-fuse</command> maintains
+ a fuse mount to make gvfs backends available to
+ POSIX applications. The mount point for the fuse
+ filesystem is provided by the <arg>PATH</arg>
+ argument.</para>
+
+ <para><command>gvfsd-fuse</command> is normally
+ started by
+ <citerefentry><refentrytitle>gvfsd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
+ In this case, the mount point is
+ <filename><envar>$XDG_RUNTIME_DIR</envar>/gvfs</filename> or
+ <filename><envar>$HOME</envar>/.gvfs</filename>.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-d</option></term>
+
+ <listitem><para>Enable fuse debug output.
+ This implies <option>-f</option>.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-f</option></term>
+
+ <listitem><para>Run in the foreground.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-s</option></term>
+
+ <listitem><para>Run single-threaded.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o OPTION</option></term>
+
+ <listitem><para>Set a fuse-specific option.
+ See the fuse documentation for a list of these.</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Exit status</title>
+
+ <para>On success 0 is returned, a non-zero failure
+ code otherwise.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>gvfs</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
diff --git a/man/gvfsd-metadata.xml b/man/gvfsd-metadata.xml
new file mode 100644
index 0000000..774a4ce
--- /dev/null
+++ b/man/gvfsd-metadata.xml
@@ -0,0 +1,101 @@
+<?xml version='1.0'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd";>
+
+<refentry id="gvfs-metadata-daemon">
+
+ <refentryinfo>
+ <title>gvfsd-metadata</title>
+ <productname>gvfs</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Alexander</firstname>
+ <surname>Larsson</surname>
+ <email>alexl redhat com</email>
+ </author>
+ </authorgroup>
+
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>gvfsd-metadata</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>gvfsd-metadata</refname>
+ <refpurpose>Metadata daemon for gvfs</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>gvfs-metadata</command>
+ <arg choice="opt" rep="repeat">OPTION</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para><command>gvfsd-metadata</command> is a daemon acting
+ as a write serialiser to the internal gvfs metadata storage.
+ It is autostarted by GIO clients when they make metadata
+ changes. Read operations are done by client-side GIO code
+ directly, and don't require the daemon to be running.</para>
+
+ <para>The gvfs metadata capabilities are used by
+ the nautilus file manager, for example.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-h</option>, <option>--help</option></term>
+
+ <listitem><para>Prints a short help
+ text and exits.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-r</option>, <option>--replace</option></term>
+
+ <listitem><para>Replace the currently running instance.</para></listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Exit status</title>
+
+ <para>On success 0 is returned, a non-zero failure
+ code otherwise.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Files</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename><envar>$XDG_DATA_HOME</envar>/gvfs-metadata</filename></term>
+
+ <listitem><para>The directory where the gvfs
+ metadata database files are stored</para></listitem>
+ </varlistentry>
+ </variablelist>
+
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>gvfs</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>nautilus</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
diff --git a/man/gvfsd.xml b/man/gvfsd.xml
new file mode 100644
index 0000000..f3f7e86
--- /dev/null
+++ b/man/gvfsd.xml
@@ -0,0 +1,122 @@
+<?xml version='1.0'?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd";>
+
+<refentry id="gvfsd">
+
+ <refentryinfo>
+ <title>gvfsd</title>
+ <productname>gvfs</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Alexander</firstname>
+ <surname>Larsson</surname>
+ <email>alexl redhat com</email>
+ </author>
+ </authorgroup>
+
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>gvfsd</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>gvfsd</refname>
+ <refpurpose>Main daemon for gvfs</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>gvfsd</command>
+ <arg choice="opt" rep="repeat">OPTION</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para><command>gvfsd</command> is the main daemon for
+ the gvfs virtual filesystem. It provides the
+ <emphasis>org.gtk.vfs.Daemon</emphasis> name on the
+ session bus. gvfsd is autostarted by GIO clients if it
+ is not running.</para>
+
+ <para>The primary task of <command>gvfsd</command> is to
+ act as a mount tracker/manager. It spawns new backends
+ when requested and keeps track fo their lifecycle,
+ maintaining a list of active mounts and creates direct
+ connections to them.</para>
+
+ <para>Since gvfs backends are running as children of the
+ gvfsd process, it is possible to start gvfsd in
+ a terminal and set environment variables to get
+ debug output from individual backends.</para>
+
+ <para><command>gvfsd</command> also starts the
+ <citerefentry><refentrytitle>gvfsd-fuse</refentrytitle><manvolnum>1</manvolnum></citerefentry>, and provides it the mount point
+ where the fuse file system should be mounted.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>-h</option>, <option>--help</option></term>
+
+ <listitem><para>Prints a short help
+ text and exits.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-r</option>, <option>--replace</option></term>
+
+ <listitem><para>Replace the currently running gvfsd instance.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--no-fuse</option></term>
+
+ <listitem><para>Don't start the fuse filesystem.</para></listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Environment</title>
+
+ <variablelist>
+
+ <varlistentry>
+ <term><envar>GVFS_DISABLE_FUSE</envar></term>
+
+ <listitem><para>If this environment variable
+ is set, gvfsd will not start the fuse
+ filesystem.</para></listitem>
+ </varlistentry>
+
+ </variablelist>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Exit status</title>
+
+ <para>On success 0 is returned, a non-zero failure
+ code otherwise.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>gvfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>gvfsd-fuse</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
