diff options
Diffstat (limited to 'man/gvfs-trash.xml')
| -rw-r--r-- | man/gvfs-trash.xml | 99 |
1 files changed, 99 insertions, 0 deletions
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> |