summaryrefslogtreecommitdiff
path: root/man/gvfs-rename.xml
blob: b82a36ac77345eb7ba8c5d291368df090e4a7bbe (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
<?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>
                <refmiscinfo class="manual">User Commands</refmiscinfo>
        </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>

                        <varlistentry>
                                <term><option>--version</option></term>

                                <listitem><para>Shows the version number 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>