summaryrefslogtreecommitdiff
path: root/man/gvfs-rename.xml
diff options
context:
space:
mode:
Diffstat (limited to 'man/gvfs-rename.xml')
-rw-r--r--man/gvfs-rename.xml81
1 files changed, 81 insertions, 0 deletions
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>