summaryrefslogtreecommitdiff
path: root/scripts/man/xdg-copy.1
blob: a0ea24f7c440cb56b56a0008e6e13b831bf684c6 (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
93
94
95
96
97
98
99
100
101
102
103
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "XDG-COPY" 1 "" "" "xdg-copy Manual"
.SH NAME
xdg-copy \- command line tool for copying files between desktop URIs
.SH "SYNOPSIS"
.ad l
.hy 0
.HP 9
\fBxdg\-copy\fR \fB\fIsource\fR\fR \fB\fIdestination\fR\fR
.ad
.hy
.ad l
.hy 0
.HP 9
\fBxdg\-copy\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR}
.ad
.hy

.SH "DESCRIPTION"

.PP
xdg\-copy copies \fIsource\fR to \fIdestination\fR and provides visual feedback to the user during the operation\&. Both \fIsource\fR and \fIdestination\fR 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\&.

.PP
xdg\-copy is for use inside a desktop session only\&. It is not recommended to use xdg\-copy as root\&.

.SH "OPTIONS"

.TP
\fB\-\-help\fR
Show command synopsis\&.

.TP
\fB\-\-manual\fR
Show this manualpage\&.

.TP
\fB\-\-version\fR
Show the xdg\-utils version information\&.

.SH "EXIT CODES"

.PP
An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned:

.TP
\fB1\fR
Error in command line syntax\&.

.TP
\fB2\fR
One of the files passed on the command line did not exist\&.

.TP
\fB3\fR
A required tool could not be found\&.

.TP
\fB4\fR
The action failed\&.

.SH "EXAMPLES"

.PP
 

.nf

xdg\-copy "http://portland\&.freedesktop\&.org/png/freedesktop\-logo\&.png" \&.

.fi
 

.PP
 

.nf

xdg\-copy "/tmp/foobar\&.png" "/home/user/foobar\-copy\&.png"

.fi
 

.SH AUTHORS
Kevin Krammer, Jeremy White.