Index: third_party/xdg-utils/scripts/desc/xdg-copy.xml |
=================================================================== |
--- third_party/xdg-utils/scripts/desc/xdg-copy.xml (revision 0) |
+++ third_party/xdg-utils/scripts/desc/xdg-copy.xml (revision 0) |
@@ -0,0 +1,153 @@ |
+<?xml version="1.0"?> |
+<?xml-stylesheet type="text/xsl" |
+ href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?> |
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" |
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ |
+]> |
+<refentry id="xdg-copy"> |
+ <refentryinfo> |
+ <title>xdg-copy Manual</title> |
+ <copyright> |
+ <year>2006</year> |
+ </copyright> |
+ <author> |
+ <firstname>Kevin</firstname> |
+ <surname>Krammer</surname> |
+ </author> |
+ <address><email>kevin.krammer@gmx.at</email></address> |
+ <author> |
+ <firstname>Jeremy</firstname> |
+ <surname>White</surname> |
+ </author> |
+ <address><email>jwhite@codeweavers.com</email></address> |
+ <releaseinfo>This is release 0.5 of the xdg-copy Manual.</releaseinfo> |
+ </refentryinfo> |
+ |
+ <refmeta> |
+ <refentrytitle>xdg-copy</refentrytitle> |
+ <manvolnum>1</manvolnum> |
+ </refmeta> |
+ |
+ <refnamediv> |
+ <refname>xdg-copy</refname> |
+ <refpurpose>command line tool for copying files between desktop URIs</refpurpose> |
+ </refnamediv> |
+ |
+ <refsynopsisdiv> |
+ <cmdsynopsis> |
+ <command>xdg-copy</command> |
+ <arg choice="plain"><option><replaceable>source</replaceable></option></arg> |
+ <arg choice="plain"><option><replaceable>destination</replaceable></option></arg> |
+ </cmdsynopsis> |
+ <cmdsynopsis> |
+ <command>xdg-copy</command> |
+ <group choice="req"> |
+ <arg choice="plain"><option>--help</option></arg> |
+ <arg choice="plain"><option>--manual</option></arg> |
+ <arg choice="plain"><option>--version</option></arg> |
+ </group> |
+ </cmdsynopsis> |
+ </refsynopsisdiv> |
+ |
+ <refsect1 id="description"> |
+ <title>Description</title> |
+ <para> |
+ xdg-copy copies <replaceable>source</replaceable> to |
+ <replaceable>destination</replaceable> and provides visual feedback to |
+ the user during the operation. Both <replaceable>source</replaceable> |
+ and <replaceable>destination</replaceable> can either be a file or |
+ URL. Supported URL types are file, ftp, http and https. Additional |
+ URL types may be supported depending on the desktop environment. |
+ </para> |
+ <para> |
+ xdg-copy is for use inside a desktop session only. |
+ It is not recommended to use xdg-copy as root. |
+ </para> |
+ </refsect1> |
+ <refsect1 id="options"> |
+ <title>Options</title> |
+ <variablelist> |
+ <varlistentry> |
+ <term><option>--help</option></term> |
+ <listitem> |
+ <simpara> |
+ Show command synopsis. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ |
+ <varlistentry> |
+ <term><option>--manual</option></term> |
+ <listitem> |
+ <simpara> |
+ Show this manualpage. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ |
+ <varlistentry> |
+ <term><option>--version</option></term> |
+ <listitem> |
+ <simpara> |
+ Show the xdg-utils version information. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ |
+ </variablelist> |
+ </refsect1> |
+ <refsect1 id="exitcodes"> |
+ <title>Exit Codes</title> |
+ <para> |
+ An exit code of 0 indicates success while a non-zero exit code |
+ indicates failure. The following failure codes can be returned: |
+ </para> |
+ <variablelist> |
+ <varlistentry> |
+ <term><option>1</option></term> |
+ <listitem> |
+ <simpara> |
+ Error in command line syntax. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ <varlistentry> |
+ <term><option>2</option></term> |
+ <listitem> |
+ <simpara> |
+ One of the files passed on the command line did not exist. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ <varlistentry> |
+ <term><option>3</option></term> |
+ <listitem> |
+ <simpara> |
+ A required tool could not be found. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ <varlistentry> |
+ <term><option>4</option></term> |
+ <listitem> |
+ <simpara> |
+ The action failed. |
+ </simpara> |
+ </listitem> |
+ </varlistentry> |
+ </variablelist> |
+ </refsect1> |
+ <refsect1 id="examples"> |
+ <title>Examples</title> |
+ <para> |
+<programlisting> |
+xdg-copy "http://portland.freedesktop.org/png/freedesktop-logo.png" . |
+</programlisting> |
+ </para> |
+ <para> |
+<programlisting> |
+xdg-copy "/tmp/foobar.png" "/home/user/foobar-copy.png" |
+</programlisting> |
+ </para> |
+ </refsect1> |
+</refentry> |