diff options
author | Matthias Clasen <mclasen@redhat.com> | 2012-06-29 17:45:56 -0400 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2012-06-29 17:45:56 -0400 |
commit | 5e839711a36b4e145f3ba3033f2d0e3128df5f7a (patch) | |
tree | 931eebf3902f7e9734af2b0a7387a1450f0a7d83 /man | |
parent | c070566d67c0059bce5e0d3484339c9547254ffe (diff) | |
download | gvfs-5e839711a36b4e145f3ba3033f2d0e3128df5f7a.tar.gz |
Add man pages for all the utilities
Diffstat (limited to 'man')
-rw-r--r-- | man/Makefile.am | 27 | ||||
-rw-r--r-- | man/gvfs-cat.xml | 83 | ||||
-rw-r--r-- | man/gvfs-copy.xml | 117 | ||||
-rw-r--r-- | man/gvfs-info.xml | 116 | ||||
-rw-r--r-- | man/gvfs-ls.xml | 119 | ||||
-rw-r--r-- | man/gvfs-mime.xml | 101 | ||||
-rw-r--r-- | man/gvfs-mkdir.xml | 85 | ||||
-rw-r--r-- | man/gvfs-monitor-dir.xml | 81 | ||||
-rw-r--r-- | man/gvfs-monitor-file.xml | 81 | ||||
-rw-r--r-- | man/gvfs-mount.xml | 142 | ||||
-rw-r--r-- | man/gvfs-move.xml | 111 | ||||
-rw-r--r-- | man/gvfs-open.xml | 80 | ||||
-rw-r--r-- | man/gvfs-rename.xml | 81 | ||||
-rw-r--r-- | man/gvfs-rm.xml | 91 | ||||
-rw-r--r-- | man/gvfs-save.xml | 106 | ||||
-rw-r--r-- | man/gvfs-set-attribute.xml | 95 | ||||
-rw-r--r-- | man/gvfs-trash.xml | 99 | ||||
-rw-r--r-- | man/gvfs-tree.xml | 94 |
18 files changed, 1709 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 00000000..e00c38ea --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,27 @@ +.xml.1: + $(AM_V_GEN) $(XSLTPROC) -o $@ --nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< + +man_MANS = \ + gvfs-cat.1 \ + gvfs-copy.1 \ + gvfs-info.1 \ + gvfs-ls.1 \ + gvfs-mime.1 \ + gvfs-mkdir.1 \ + gvfs-monitor-dir.1 \ + gvfs-monitor-file.1 \ + gvfs-mount.1 \ + gvfs-move.1 \ + gvfs-open.1 \ + gvfs-rename.1 \ + gvfs-rm.1 \ + gvfs-save.1 \ + gvfs-set-attribute.1 \ + gvfs-trash.1 \ + gvfs-tree.1 + +xml_files = $(man_MANS:.1=.xml) + +EXTRA_DIST = $(xml_files) + +DISTCLEANFILES = $(man_MANS) diff --git a/man/gvfs-cat.xml b/man/gvfs-cat.xml new file mode 100644 index 00000000..e5af7957 --- /dev/null +++ b/man/gvfs-cat.xml @@ -0,0 +1,83 @@ +<?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-cat"> + + <refentryinfo> + <title>gvfs-cat</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-cat</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-cat</refname> + <refpurpose>Concatenate files</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-cat <arg choice="opt" rep="repeat">OPTION</arg> <arg rep="repeat">LOCATION</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-cat</command> concatenates the given + files and prints them to the standard output.</para> + + <para><command>gvfs-cat</command> works just like the + traditional cat utility, but using gvfs locations instead + of local files: for example you can use something like + smb://server/resource/file.txt as location.</para> + + <para>Note: just pipe through cat if you need its formatting + options like -n, -T or other.</para> + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <variablelist> + <varlistentry> + <term><option>-?</option>, <option>--help</option></term> + + <listitem><para>Prints a short help + text and exits.</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>cat</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-copy.xml b/man/gvfs-copy.xml new file mode 100644 index 00000000..b60a1cb2 --- /dev/null +++ b/man/gvfs-copy.xml @@ -0,0 +1,117 @@ +<?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-copy"> + + <refentryinfo> + <title>gvfs-copy</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-copy</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-copy</refname> + <refpurpose>Copy files</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-copy <arg choice="opt" rep="repeat">OPTION</arg> <arg>SOURCE</arg> <arg>DEST</arg></command> + </cmdsynopsis> + <cmdsynopsis> + <command>gvfs-copy <arg choice="opt" rep="repeat">OPTION</arg> <arg rep="repeat">SOURCE</arg> <arg>DIRECTORY</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-copy</command> copies a file from SOURCE to + DEST, or multiple SOURCEs to DIRECTORY.</para> + <para><command>gvfs-copy</command> is similar to the traditional + cp utility, but using gvfs locations instead of local files: + for example you can use something like + smb://server/resource/file.txt as location.</para> + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <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>-T</option>, <option>--no-target-directory</option></term> + + <listitem><para>Don't copy into DEST even if it is a directory.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-p</option>, <option>--progress</option></term> + + <listitem><para>Show progress.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-i</option>, <option>--interactive</option></term> + + <listitem><para>Prompt before overwriting files.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--preserve</option></term> + + <listitem><para>Preserve all attributes.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-b</option>, <option>--backup</option></term> + + <listitem><para>Backup existing destination files.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-P</option>, <option>--no-dereference</option></term> + + <listitem><para>Never follow symlinks.</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>cp</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-info.xml b/man/gvfs-info.xml new file mode 100644 index 00000000..6bf55dbe --- /dev/null +++ b/man/gvfs-info.xml @@ -0,0 +1,116 @@ +<?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-info"> + + <refentryinfo> + <title>gvfs-info</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-info</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-info</refname> + <refpurpose>Show information about files</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-info <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="repeat">LOCATION</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-info</command> shows information about + the given locations.</para> + + <para><command>gvfs-info</command> is similar to the traditional + ls utility, but using gvfs locations instead of local files: + for example you can use something like + smb://server/resource/file.txt as location.</para> + + <para>File attributes can be specified with their gvfs name, + e.g. standard::icon, or just by namespace, e.g. unix, or by + '*' which matches all attributes. Several attributes or groups + can be specified, separated by comma.</para> + + <para>By default, <command>gvfs-info</command> shows all + attributes.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <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>-w</option>, <option>--query-writable</option></term> + + <listitem><para>Show writable attributes and their types.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-f</option>, <option>--filesystem</option></term> + + <listitem><para>Show information about the filesystem on which the files reside.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-a</option>, <option>--attributes=ATTRIBUTES</option></term> + + <listitem><para>The attributes to get, specified + as a comma-separated list of gvfs file attribute + names.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-n</option>, <option>--no-follow-symlinks</option></term> + + <listitem><para>Don't follow symlinks.</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>ls</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>gvfs-ls</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <ulink url="http://developer.gnome.org/gio/2.32/gio-GFileAttribute.html">GIO file attributes</ulink> + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-ls.xml b/man/gvfs-ls.xml new file mode 100644 index 00000000..399390bf --- /dev/null +++ b/man/gvfs-ls.xml @@ -0,0 +1,119 @@ +<?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-ls"> + + <refentryinfo> + <title>gvfs-ls</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-ls</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-ls</refname> + <refpurpose>List files</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-ls <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="repeat">LOCATION</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-ls</command> lists information about + the given locations. If no location is given, it defaults + to the current directory.</para> + + <para><command>gvfs-ls</command> is similar to the traditional + ls utility, but using gvfs locations instead of local files: + for example you can use something like + smb://server/resource/file.txt as location.</para> + + <para>File attributes can be specified with their gvfs name, + e.g. standard::icon, or just by namespace, e.g. unix, or by + '*' which matches all attributes. Several attributes or groups + can be specified, separated by comma.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <variablelist> + <varlistentry> + <term><option>-?</option>, <option>--help</option></term> + + <listitem><para>Prints a short help + text and exits.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-a</option>, <option>--attributes=ATTRIBUTES</option></term> + + <listitem><para>The attributes to get, specified + as a comma-separated list of gvfs file attribute + names.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-h</option>, <option>--hidden</option></term> + + <listitem><para>Show hidden files.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-l</option>, <option>--long</option></term> + + <listitem><para>Use a long listing format.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-c</option>, <option>--show-completions=PREFIX</option></term> + + <listitem><para>Show only filenames starting with PREFIX.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-n</option>, <option>--no-follow-symlinks</option></term> + + <listitem><para>Don't follow symlinks.</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>ls</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>gvfs-info</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-mime.xml b/man/gvfs-mime.xml new file mode 100644 index 00000000..3320ce93 --- /dev/null +++ b/man/gvfs-mime.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-mime"> + + <refentryinfo> + <title>gvfs-mime</title> + <productname>gvfs</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Bastien</firstname> + <surname>Nocera</surname> + <email>hadess@hadess.net</email> + </author> + </authorgroup> + + </refentryinfo> + + <refmeta> + <refentrytitle>gvfs-mime</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-mime</refname> + <refpurpose>Get or set mime handlers</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-mime --query <arg choice="req">MIMETYPE</arg></command> + </cmdsynopsis> + <cmdsynopsis> + <command>gvfs-mime --set <arg choice="req">MIMETYPE</arg> <arg choice="req">HANDER</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-mime</command> can query information + about applications that are registered to handle a mime-type, + or set the default handler for a mime-type.</para> + + <para>Gvfs obtains this information from the shared-mime-info + database. The default handler is stored per-user, in the file + <filename><envar>$XDG_DATA_HOME</envar>/applications/mimeapps.list</filename>.</para> + + <para>MIMETYPE should be a mime-type such as text/plain or + application/mbox. HANDLER should be the name of an existing + desktop file such as gedit.desktop.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <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>--query</option></term> + + <listitem><para>Query the handler for MIMETYPE.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--set</option></term> + + <listitem><para>Set the default handler for MIMETYPE to HANDLER.</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-open</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <ulink url="http://freedesktop.org/wiki/Specifications/shared-mime-info-spec">Shared MIME-Info specification</ulink> + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-mkdir.xml b/man/gvfs-mkdir.xml new file mode 100644 index 00000000..f3a6a3cb --- /dev/null +++ b/man/gvfs-mkdir.xml @@ -0,0 +1,85 @@ +<?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-mkdir"> + + <refentryinfo> + <title>gvfs-mkdir</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-mkdir</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-mkdir</refname> + <refpurpose>Create directories</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-mkdir <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="repeat">LOCATION</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-mkdir</command> creates directories.</para> + + <para><command>gvfs-mkdir</command> is similar to the traditional + mkdir utility, but using gvfs locations instead of local files: + for example you can use something like + smb://server/resource/mydir as location.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <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>-p</option>, <option>--parent</option></term> + + <listitem><para>Create parent directories when necessary.</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>mkdir</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-monitor-dir.xml b/man/gvfs-monitor-dir.xml new file mode 100644 index 00000000..a92bea13 --- /dev/null +++ b/man/gvfs-monitor-dir.xml @@ -0,0 +1,81 @@ +<?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-monitor-dir"> + + <refentryinfo> + <title>gvfs-monitor-dir</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-monitor-dir</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-monitor-dir</refname> + <refpurpose>Monitor directories for changes</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-monitor-dir <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="repeat">LOCATION</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para>As long as <command>gvfs-monitor-dir</command> is running, + it will print information about file creation, deletion, file + content and attribute changes and mount and unmount operations + inside the specified directories.</para> + + <para><command>gvfs-monitor-dir</command> uses the GIOs + directory monitoring APIs to monitor the given directories. + GIO uses different implementations depending on the platform. + The most common implementation Linux uses inotify. + </para> + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <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>-N</option>, <option>--no-pair</option></term> + + <listitem><para>Don't send single MOVED events.</para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Exit status</title> + + <para>On success 0 is returned, a non-zero failure + code otherwise.</para> + </refsect1> + +</refentry> diff --git a/man/gvfs-monitor-file.xml b/man/gvfs-monitor-file.xml new file mode 100644 index 00000000..0c7ba316 --- /dev/null +++ b/man/gvfs-monitor-file.xml @@ -0,0 +1,81 @@ +<?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-monitor-file"> + + <refentryinfo> + <title>gvfs-monitor-file</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-monitor-file</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-monitor-file</refname> + <refpurpose>Monitor files for changes</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-monitor-file <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="repeat">LOCATION</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para>As long as <command>gvfs-monitor-file</command> is running, + it will print information about creation, deletion, content and + attribute changes and mount and unmount operations affecting + the monitored files.</para> + + <para><command>gvfs-monitor-file</command> uses the GIOs + file monitoring APIs to monitor the given files. + GIO uses different implementations depending on the platform. + The most common implementation Linux uses inotify. + </para> + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <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>-N</option>, <option>--no-pair</option></term> + + <listitem><para>Don't send single MOVED events.</para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Exit status</title> + + <para>On success 0 is returned, a non-zero failure + code otherwise.</para> + </refsect1> + +</refentry> diff --git a/man/gvfs-mount.xml b/man/gvfs-mount.xml new file mode 100644 index 00000000..e6993928 --- /dev/null +++ b/man/gvfs-mount.xml @@ -0,0 +1,142 @@ +<?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-mount"> + + <refentryinfo> + <title>gvfs-mount</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-mount</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-mount</refname> + <refpurpose>Mounts the locations</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-mount <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="repeat">LOCATION</arg></command> + </cmdsynopsis> + <cmdsynopsis> + <command>gvfs-mount --unmount-scheme=SCHEME</command> + </cmdsynopsis> + <cmdsynopsis> + <command>gvfs-mount --list <arg choice="opt" rep="repeat">OPTION</arg></command> + </cmdsynopsis> + <cmdsynopsis> + <command>gvfs-mount --monitor <arg choice="opt" rep="repeat">OPTION</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-mount</command> provides commandline + access to various aspects of GIOs mounting functionality.</para> + + <para>Mounting refers to the traditional concept of arranging + multiple file systems and devices in a single tree, rooted at /. + Classical mounting happens in the kernel and is controlled + by the <command>mount</command> utility. GIO expands this + concept by introducing mount daemons that can make file + systems available to GIO applications without kernel + involvement.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <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>-m</option>, <option>--mountable</option></term> + + <listitem><para>Mount as a mountable.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-d</option>, <option>--device=DEVICE</option></term> + + <listitem><para>Mount the volume with the given device file.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-u</option>, <option>--unmount</option></term> + + <listitem><para>Unmount the locations.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-e</option>, <option>--eject</option></term> + + <listitem><para>Eject the locations.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-s</option>, <option>--unmount-scheme=SCHEME</option></term> + + <listitem><para>Unmount all mounts with the given scheme.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-l</option>, <option>--list</option></term> + + <listitem><para>List all known mounts.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-o</option>, <option>--monitor</option></term> + + <listitem><para>Monitor mount and unmount events.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-i</option>, <option>--detail</option></term> + + <listitem><para>Show extra information for --list and --monitor.</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>ls</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>gvfs-info</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-move.xml b/man/gvfs-move.xml new file mode 100644 index 00000000..7f239db4 --- /dev/null +++ b/man/gvfs-move.xml @@ -0,0 +1,111 @@ +<?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-move"> + + <refentryinfo> + <title>gvfs-move</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-move</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-move</refname> + <refpurpose>Copy files</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-move <arg choice="opt" rep="repeat">OPTION</arg> <arg>SOURCE</arg> <arg>DEST</arg></command> + </cmdsynopsis> + <cmdsynopsis> + <command>gvfs-move <arg choice="opt" rep="repeat">OPTION</arg> <arg rep="repeat">SOURCE</arg> <arg>DIRECTORY</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-move</command> moves a file from SOURCE to + DEST, or multiple SOURCEs to DIRECTORY.</para> + <para><command>gvfs-move</command> is similar to the traditional + mv utility, but using gvfs locations instead of local files: + for example you can use something like + smb://server/resource/file.txt as location.</para> + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <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>-T</option>, <option>--no-target-directory</option></term> + + <listitem><para>Don't move into DEST even if it is a directory.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-p</option>, <option>--progress</option></term> + + <listitem><para>Show progress.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-i</option>, <option>--interactive</option></term> + + <listitem><para>Prompt before overwriting files.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--preserve</option></term> + + <listitem><para>Preserve all attributes.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-b</option>, <option>--backup</option></term> + + <listitem><para>Backup existing destination files.</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>mv</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-open.xml b/man/gvfs-open.xml new file mode 100644 index 00000000..e7087e01 --- /dev/null +++ b/man/gvfs-open.xml @@ -0,0 +1,80 @@ +<?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-open"> + + <refentryinfo> + <title>gvfs-open</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-open</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-open</refname> + <refpurpose>Open files with the default handler</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-open <arg choice="opt" rep="repeat">OPTION</arg> <arg rep="repeat">FILE</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-open</command> opens files with the default + application that is registered to handle files of this type.</para> + + <para>Gvfs obtains this information from the shared-mime-info + database. The default handler is stored per-user, in the file + <filename><envar>$XDG_DATA_HOME</envar>/applications/mimeapps.list</filename>.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <variablelist> + <varlistentry> + <term><option>-h</option>, <option>--help</option></term> + + <listitem><para>Prints a short help + text and exits.</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-mime</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-rename.xml b/man/gvfs-rename.xml new file mode 100644 index 00000000..555ec451 --- /dev/null +++ b/man/gvfs-rename.xml @@ -0,0 +1,81 @@ +<?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-rename"> + + <refentryinfo> + <title>gvfs-rename</title> + <productname>gvfs</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Christian</firstname> + <surname>Kellner</surname> + <email>gicmo@gnome.org</email> + </author> + </authorgroup> + + </refentryinfo> + + <refmeta> + <refentrytitle>gvfs-rename</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-rename</refname> + <refpurpose>Rename a file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-rename <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="req">LOCATION</arg> <arg choice="req">NEW-NAME</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-rename</command> renames a file.</para> + + <para><command>gvfs-rename</command> is similar to the traditional + rename utility, but using gvfs locations instead of local files: + for example you can use something like + smb://server/resource/file.txt as location.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <variablelist> + <varlistentry> + <term><option>-h</option>, <option>--help</option></term> + + <listitem><para>Prints a short help + text and exits.</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>rename</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>gvfs-move</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-rm.xml b/man/gvfs-rm.xml new file mode 100644 index 00000000..4833ff98 --- /dev/null +++ b/man/gvfs-rm.xml @@ -0,0 +1,91 @@ +<?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-rm"> + + <refentryinfo> + <title>gvfs-rm</title> + <productname>gvfs</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Alexander</firstname> + <surname>Larsson</surname> + </author> + </authorgroup> + + </refentryinfo> + + <refmeta> + <refentrytitle>gvfs-rm</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-rm</refname> + <refpurpose>Delete files</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-rm <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="repeat">FILE</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-rm</command> deletes each given + file.</para> + + <para>The files can be specified as paths or as URIs + with a scheme that is understood by gvfs. Note that + not all URI schemes may allow deletion of files.</para> + + <para><command>gvfs-rm</command> deletes files irreversibly. + If you want a reversible way to trash files, see + <command>gvfs-trash</command>.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <variablelist> + <varlistentry> + <term><option>-?</option>, <option>--help</option></term> + + <listitem><para>Prints a short help + text and exits.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-f</option>, <option>--force</option></term> + + <listitem><para>Ignore nonexistent and + non-deletable files.</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>rm</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>gvfs-trash</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-save.xml b/man/gvfs-save.xml new file mode 100644 index 00000000..895b5a64 --- /dev/null +++ b/man/gvfs-save.xml @@ -0,0 +1,106 @@ +<?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-save"> + + <refentryinfo> + <title>gvfs-save</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-save</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-save</refname> + <refpurpose>Save standard input</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-save <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="req">DEST</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-save</command> reads from the standard + input and saves the data to the given location.</para> + + <para>This is similar to just redirecting output to a file + using traditional shell syntax, but <command>gvfs-save</command> + allows using gvfs locations instead of local files: + for example you can use something like + smb://server/resource/file.txt as location.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <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>-b</option>, <option>--backup</option></term> + + <listitem><para>If the destination file already exists, save a backup.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-c</option>, <option>--create</option></term> + + <listitem><para>Only create the destination file if it does not exist yet.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-a</option>, <option>--append</option></term> + + <listitem><para>Append to the end of the destination file, if it already exists.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-p</option>, <option>--private</option></term> + + <listitem><para>When creating a new file, restrict access to the current user only.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-v</option>, <option>--print-etag</option></term> + + <listitem><para>Print the new etag at the end.</para></listitem> + </varlistentry> + + + </variablelist> + </refsect1> + + <refsect1> + <title>Exit status</title> + + <para>On success 0 is returned, a non-zero failure + code otherwise.</para> + </refsect1> + +</refentry> diff --git a/man/gvfs-set-attribute.xml b/man/gvfs-set-attribute.xml new file mode 100644 index 00000000..8de61a75 --- /dev/null +++ b/man/gvfs-set-attribute.xml @@ -0,0 +1,95 @@ +<?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-set-attribute"> + + <refentryinfo> + <title>gvfs-set-attribute</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-set-attribute</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-set-attribute</refname> + <refpurpose>Set file attributes</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-set-attribute <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="req">LOCATION</arg> <arg choice="req">ATTRIBUTE</arg> <arg choice="req" rep="repeat">VALUE</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-set-attribute</command> allows to set + a file attribute on a file.</para> + + <para>File attributes can be specified with their gvfs name, + e.g. standard::icon. Note that not all file attributes that + are supported by gvfs are writable. + <command>gvfs-info --query-writable</command> lists writable + file attributes.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <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>-t</option>, <option>--type=TYPE</option></term> + + <listitem><para>Specifies the type of the attribute. Supported types are string, stringv, bytestring, boolean, uint32, int32, uint64, int64, object and unset.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-n</option>, <option>--no-follow-symlinks</option></term> + + <listitem><para>Don't follow symlinks.</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-info</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <ulink url="http://developer.gnome.org/gio/2.32/gio-GFileAttribute.html">GIO file attributes</ulink> + + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-trash.xml b/man/gvfs-trash.xml new file mode 100644 index 00000000..0c7dd525 --- /dev/null +++ b/man/gvfs-trash.xml @@ -0,0 +1,99 @@ +<?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-trash"> + + <refentryinfo> + <title>gvfs-trash</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-trash</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-trash</refname> + <refpurpose>Move files or directories to the trash</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-trash <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="repeat">LOCATION</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-trash</command> sends files or directories + to the "Trashcan". This can be a different folder depending + on where the file is located, and not all file systems support + this concept. In the common case that the file lives inside a + users home directory, the trash folder is + <filename><envar>$XDG_DATA_HOME</envar>/Trash</filename>.</para> + + <para>Note that moving files to the trash does not free up + space on the file system until the "Trashcan" is emptied. + If you are interested in deleting a file irreversibly, + see <command>gvfs-rm</command>.</para> + + <para>Inspecting and emptying the "Trashcan" is normally + supported by graphical file managers such as nautilus, + but you can also see the trash with the command + <command>gvfs-ls trash://</command>.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <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>-f</option>, <option>--force</option></term> + + <listitem><para>Ignore nonexistent and + non-deletable files.</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>ls</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>gvfs-rm</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <ulink url="http://freedesktop.org/wiki/Specifications/trash-spec">Desktop Trash Can specification</ulink> + </para> + </refsect1> + +</refentry> diff --git a/man/gvfs-tree.xml b/man/gvfs-tree.xml new file mode 100644 index 00000000..b4c682d6 --- /dev/null +++ b/man/gvfs-tree.xml @@ -0,0 +1,94 @@ +<?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-tree"> + + <refentryinfo> + <title>gvfs-tree</title> + <productname>gvfs</productname> + + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>David</firstname> + <surname>Zeuthen</surname> + <email>davidz@redhat.com</email> + </author> + </authorgroup> + + </refentryinfo> + + <refmeta> + <refentrytitle>gvfs-tree</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>gvfs-tree</refname> + <refpurpose>List contents of directories in a tree-like format</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>gvfs-tree <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="repeat">LOCATION</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>gvfs-tree</command> lists the contents + of the given directories recursively, in a tree-like format. + If no location is given, it defaults to the current directory.</para> + + <para><command>gvfs-tree</command> is similar to the traditional + tree utility, but using gvfs locations instead of local files: + for example you can use something like + smb://server/resource/mydir as location.</para> + + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <variablelist> + <varlistentry> + <term><option>-?</option>, <option>--help</option></term> + + <listitem><para>Prints a short help + text and exits.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-h</option>, <option>--hidden</option></term> + + <listitem><para>Show hidden files.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-l</option>, <option>--follow-symlinks</option></term> + + <listitem><para>Follow symbolic links, mounts and shortcuts.</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>tree</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>gvfs-ls</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> |