summaryrefslogtreecommitdiff
path: root/man/gvfs-rm.xml
blob: bd9156c09e5222cafbd77252c67e26ff7011c1b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<?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>
                <refmiscinfo class="manual">User Commands</refmiscinfo>
        </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>