OLD | NEW |
1 .\" ** You probably do not want to edit this file directly ** | 1 '\" t |
2 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). | 2 .\" Title: xdg-desktop-icon |
3 .\" Instead of manually editing it, you probably should edit the DocBook XML | 3 .\" Author: Kevin Krammer |
4 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. | 4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> |
5 .TH "XDG\-DESKTOP\-ICON" "1" "06/24/2007" "xdg\-utils 1.0" "" | 5 .\" Date: 12/31/2010 |
| 6 .\" Manual: xdg-desktop-icon Manual |
| 7 .\" Source: xdg-utils 1.0 |
| 8 .\" Language: English |
| 9 .\" |
| 10 .TH "XDG\-DESKTOP\-ICON" "1" "12/31/2010" "xdg-utils 1.0" "xdg-desktop-icon Manu
al" |
| 11 .\" ----------------------------------------------------------------- |
| 12 .\" * Define some portability stuff |
| 13 .\" ----------------------------------------------------------------- |
| 14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 15 .\" http://bugs.debian.org/507673 |
| 16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 18 .ie \n(.g .ds Aq \(aq |
| 19 .el .ds Aq ' |
| 20 .\" ----------------------------------------------------------------- |
| 21 .\" * set default formatting |
| 22 .\" ----------------------------------------------------------------- |
6 .\" disable hyphenation | 23 .\" disable hyphenation |
7 .nh | 24 .nh |
8 .\" disable justification (adjust text to left margin only) | 25 .\" disable justification (adjust text to left margin only) |
9 .ad l | 26 .ad l |
| 27 .\" ----------------------------------------------------------------- |
| 28 .\" * MAIN CONTENT STARTS HERE * |
| 29 .\" ----------------------------------------------------------------- |
10 .SH "NAME" | 30 .SH "NAME" |
11 xdg\-desktop\-icon \- command line tool for (un)installing icons to the desktop | 31 xdg-desktop-icon \- command line tool for (un)installing icons to the desktop |
12 .SH "SYNOPSIS" | 32 .SH "SYNOPSIS" |
13 .HP 17 | 33 .HP \w'\fBxdg\-desktop\-icon\fR\ 'u |
14 \fBxdg\-desktop\-icon\fR install [\fB\-\-novendor\fR] \fIFILE\fR | 34 \fBxdg\-desktop\-icon\fR install [\fB\-\-novendor\fR] \fIFILE\fR |
15 .HP 17 | 35 .HP \w'\fBxdg\-desktop\-icon\fR\ 'u |
16 \fBxdg\-desktop\-icon\fR uninstall \fIFILE\fR | 36 \fBxdg\-desktop\-icon\fR uninstall \fIFILE\fR |
17 .HP 17 | 37 .HP \w'\fBxdg\-desktop\-icon\fR\ 'u |
18 \fBxdg\-desktop\-icon\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} | 38 \fBxdg\-desktop\-icon\fR {\fB\-\-help\fR | \fB\-\-manual\fR | \fB\-\-version\fR} |
19 .SH "DESCRIPTION" | 39 .SH "DESCRIPTION" |
20 .PP | 40 .PP |
21 The xdg\-desktop\-icon program can be used to install an application launcher or
other file on the desktop of the current user. | 41 The xdg\-desktop\-icon program can be used to install an application launcher or
other file on the desktop of the current user\&. |
22 .PP | 42 .PP |
23 An application launcher is represented by a *.desktop file. Desktop files are de
fined by the freedesktop.org Desktop Entry Specification. The most important asp
ects of *.desktop files are summarized below. | 43 An application launcher is represented by a *\&.desktop file\&. Desktop files ar
e defined by the freedesktop\&.org Desktop Entry Specification\&. The most impor
tant aspects of *\&.desktop files are summarized below\&. |
24 .SH "COMMANDS" | 44 .SH "COMMANDS" |
25 .TP | 45 .PP |
26 install | 46 install |
| 47 .RS 4 |
27 Installs | 48 Installs |
28 \fIFILE\fR | 49 \fIFILE\fR |
29 to the desktop of the current user. | 50 to the desktop of the current user\&. |
30 \fIFILE\fR | 51 \fIFILE\fR |
31 can be a *.desktop file or any other type of file. | 52 can be a *\&.desktop file or any other type of file\&. |
32 .TP | 53 .RE |
| 54 .PP |
33 uninstall | 55 uninstall |
| 56 .RS 4 |
34 Removes | 57 Removes |
35 \fIFILE\fR | 58 \fIFILE\fR |
36 from the desktop of the current user. | 59 from the desktop of the current user\&. |
| 60 .RE |
37 .SH "OPTIONS" | 61 .SH "OPTIONS" |
38 .TP | 62 .PP |
39 \fB\-\-novendor\fR | 63 \fB\-\-novendor\fR |
40 Normally, xdg\-desktop\-icon checks to ensure that a *.desktop file to be instal
led has a vendor prefix. This option can be used to disable that check. | 64 .RS 4 |
| 65 Normally, xdg\-desktop\-icon checks to ensure that a *\&.desktop file to be inst
alled has a vendor prefix\&. This option can be used to disable that check\&. |
41 .sp | 66 .sp |
42 A vendor prefix consists of alpha characters ([a\-zA\-Z]) and is terminated with
a dash ("\-"). Companies and organizations are encouraged to use a word or phra
se, preferably the organizations name, for which they hold a trademark as their
vendor prefix. The purpose of the vendor prefix is to prevent name conflicts. | 67 A vendor prefix consists of alpha characters ([a\-zA\-Z]) and is terminated with
a dash ("\-")\&. Companies and organizations are encouraged to use a word or ph
rase, preferably the organizations name, for which they hold a trademark as thei
r vendor prefix\&. The purpose of the vendor prefix is to prevent name conflicts
\&. |
43 .TP | 68 .RE |
| 69 .PP |
44 \fB\-\-help\fR | 70 \fB\-\-help\fR |
45 Show command synopsis. | 71 .RS 4 |
46 .TP | 72 Show command synopsis\&. |
| 73 .RE |
| 74 .PP |
47 \fB\-\-manual\fR | 75 \fB\-\-manual\fR |
48 Show this manualpage. | 76 .RS 4 |
49 .TP | 77 Show this manualpage\&. |
| 78 .RE |
| 79 .PP |
50 \fB\-\-version\fR | 80 \fB\-\-version\fR |
51 Show the xdg\-utils version information. | 81 .RS 4 |
| 82 Show the xdg\-utils version information\&. |
| 83 .RE |
52 .SH "DESKTOP FILES" | 84 .SH "DESKTOP FILES" |
53 .PP | 85 .PP |
54 An application launcher can be added to the desktop by installing a *.desktop fi
le. A *.desktop file consists of a | 86 An application launcher can be added to the desktop by installing a *\&.desktop
file\&. A *\&.desktop file consists of a |
55 \fI[Desktop Entry]\fR | 87 \fI[Desktop Entry]\fR |
56 header followed by several | 88 header followed by several |
57 \fIKey\fR=\fIValue\fR | 89 \fIKey\fR=\fIValue\fR |
58 lines. | 90 lines\&. |
59 .PP | 91 .PP |
60 A *.desktop file can provide a name and description for an application in severa
l different languages. This is done by adding a language code as used by LC_MESS
AGES in square brackets behind the | 92 A *\&.desktop file can provide a name and description for an application in seve
ral different languages\&. This is done by adding a language code as used by LC_
MESSAGES in square brackets behind the |
61 \fIKey\fR. This way one can specify different values for the same | 93 \fIKey\fR\&. This way one can specify different values for the same |
62 \fIKey\fR | 94 \fIKey\fR |
63 depending on the currently selected language. | 95 depending on the currently selected language\&. |
64 .PP | 96 .PP |
65 The following keys are often used: | 97 The following keys are often used: |
66 .TP | 98 .PP |
67 Value=1.0 | 99 Value=1\&.0 |
68 This is a mandatory field to indicate that the *.desktop file follows the 1.0 ve
rsion of the specification. | 100 .RS 4 |
69 .TP | 101 This is a mandatory field to indicate that the *\&.desktop file follows the 1\&.
0 version of the specification\&. |
| 102 .RE |
| 103 .PP |
70 Type=Application | 104 Type=Application |
71 This is a mandatory field that indicates that the *.desktop file describes an ap
plication launcher. | 105 .RS 4 |
72 .TP | 106 This is a mandatory field that indicates that the *\&.desktop file describes an
application launcher\&. |
| 107 .RE |
| 108 .PP |
73 Name=\fIApplication Name\fR | 109 Name=\fIApplication Name\fR |
74 The name of the application. For example | 110 .RS 4 |
| 111 The name of the application\&. For example |
75 \fIMozilla\fR | 112 \fIMozilla\fR |
76 .TP | 113 .RE |
| 114 .PP |
77 GenericName=\fIGeneric Name\fR | 115 GenericName=\fIGeneric Name\fR |
78 A generic description of the application. For example | 116 .RS 4 |
| 117 A generic description of the application\&. For example |
79 \fIWeb Browser\fR | 118 \fIWeb Browser\fR |
80 .TP | 119 .RE |
| 120 .PP |
81 Comment=\fIComment\fR | 121 Comment=\fIComment\fR |
82 Optional field to specify a tooltip for the application. For example | 122 .RS 4 |
| 123 Optional field to specify a tooltip for the application\&. For example |
83 \fIVisit websites on the Internet\fR | 124 \fIVisit websites on the Internet\fR |
84 .TP | 125 .RE |
| 126 .PP |
85 Icon=\fIIcon File\fR | 127 Icon=\fIIcon File\fR |
86 The icon to use for the application. This can either be an absolute path to an i
mage file or an icon\-name. If an icon\-name is provided an image lookup by name
is done in the user's current icon theme. The | 128 .RS 4 |
| 129 The icon to use for the application\&. This can either be an absolute path to an
image file or an icon\-name\&. If an icon\-name is provided an image lookup by
name is done in the user\*(Aqs current icon theme\&. The |
87 \fBxdg\-icon\-resource\fR | 130 \fBxdg\-icon\-resource\fR |
88 command can be used to install image files into icon themes. The advantage of us
ing an icon\-name instead of an absolute path is that with an icon\-name the app
lication icon can be provided in several different sizes as well as in several d
ifferently themed styles. | 131 command can be used to install image files into icon themes\&. The advantage of
using an icon\-name instead of an absolute path is that with an icon\-name the a
pplication icon can be provided in several different sizes as well as in several
differently themed styles\&. |
89 .TP | 132 .RE |
| 133 .PP |
90 Exec=\fICommand Line\fR | 134 Exec=\fICommand Line\fR |
91 The command line to start the application. If the application can open files the
%f placeholder should be specified. When a file is dropped on the application l
auncher the %f is replaced with the file path of the dropped file. If multiple f
iles can be specified on the command line the %F placeholder should be used inst
ead of %f. If the application is able to open URLs in addition to local files th
en %u or %U can be used instead of %f or %F. | 135 .RS 4 |
| 136 The command line to start the application\&. If the application can open files t
he %f placeholder should be specified\&. When a file is dropped on the applicati
on launcher the %f is replaced with the file path of the dropped file\&. If mult
iple files can be specified on the command line the %F placeholder should be use
d instead of %f\&. If the application is able to open URLs in addition to local
files then %u or %U can be used instead of %f or %F\&. |
| 137 .RE |
92 .PP | 138 .PP |
93 For a complete oveview of the *.desktop file format please visit http://www.free
desktop.org/wiki/Standards/desktop\-entry\-spec | 139 For a complete oveview of the *\&.desktop file format please visit http://www\&.
freedesktop\&.org/wiki/Standards/desktop\-entry\-spec |
94 .SH "ENVIRONMENT VARIABLES" | 140 .SH "ENVIRONMENT VARIABLES" |
95 .PP | 141 .PP |
96 xdg\-desktop\-icon honours the following environment variables: | 142 xdg\-desktop\-icon honours the following environment variables: |
97 .TP | 143 .PP |
98 XDG_UTILS_DEBUG_LEVEL | 144 XDG_UTILS_DEBUG_LEVEL |
99 Setting this environment variable to a non\-zero numerical value makes xdg\-desk
top\-icon do more verbose reporting on stderr. Setting a higher value increases
the verbosity. | 145 .RS 4 |
| 146 Setting this environment variable to a non\-zero numerical value makes xdg\-desk
top\-icon do more verbose reporting on stderr\&. Setting a higher value increase
s the verbosity\&. |
| 147 .RE |
100 .SH "EXIT CODES" | 148 .SH "EXIT CODES" |
101 .PP | 149 .PP |
102 An exit code of 0 indicates success while a non\-zero exit code indicates failur
e. The following failure codes can be returned: | 150 An exit code of 0 indicates success while a non\-zero exit code indicates failur
e\&. The following failure codes can be returned: |
103 .TP | 151 .PP |
104 \fB1\fR | 152 \fB1\fR |
105 Error in command line syntax. | 153 .RS 4 |
106 .TP | 154 Error in command line syntax\&. |
| 155 .RE |
| 156 .PP |
107 \fB2\fR | 157 \fB2\fR |
108 One of the files passed on the command line did not exist. | 158 .RS 4 |
109 .TP | 159 One of the files passed on the command line did not exist\&. |
| 160 .RE |
| 161 .PP |
110 \fB3\fR | 162 \fB3\fR |
111 A required tool could not be found. | 163 .RS 4 |
112 .TP | 164 A required tool could not be found\&. |
| 165 .RE |
| 166 .PP |
113 \fB4\fR | 167 \fB4\fR |
114 The action failed. | 168 .RS 4 |
115 .TP | 169 The action failed\&. |
| 170 .RE |
| 171 .PP |
116 \fB5\fR | 172 \fB5\fR |
117 No permission to read one of the files passed on the command line. | 173 .RS 4 |
| 174 No permission to read one of the files passed on the command line\&. |
| 175 .RE |
118 .SH "SEE ALSO" | 176 .SH "SEE ALSO" |
119 .PP | 177 .PP |
120 \fBxdg\-icon\-resource\fR(1) | 178 \fBxdg-icon-resource\fR(1) |
121 .SH "EXAMPLES" | 179 .SH "EXAMPLES" |
122 .PP | 180 .PP |
123 The company ShinyThings Inc. has developed an application named "WebMirror" and
would like to add a launcher for for on the desktop. The company will use "shiny
things" as its vendor id. In order to add the application to the desktop there n
eeds to be a .desktop file for the application: | 181 The company ShinyThings Inc\&. has developed an application named "WebMirror" an
d would like to add a launcher for for on the desktop\&. The company will use "s
hinythings" as its vendor id\&. In order to add the application to the desktop t
here needs to be a \&.desktop file for the application: |
124 .sp | 182 .sp |
| 183 .if n \{\ |
| 184 .RS 4 |
| 185 .\} |
125 .nf | 186 .nf |
126 shinythings\-webmirror.desktop: | 187 shinythings\-webmirror\&.desktop: |
127 | 188 |
128 [Desktop Entry] | 189 [Desktop Entry] |
129 Encoding=UTF\-8 | 190 Encoding=UTF\-8 |
130 Type=Application | 191 Type=Application |
131 | 192 |
132 Exec=webmirror | 193 Exec=webmirror |
133 Icon=shinythings\-webmirror | 194 Icon=shinythings\-webmirror |
134 | 195 |
135 Name=WebMirror | 196 Name=WebMirror |
136 Name[nl]=WebSpiegel | 197 Name[nl]=WebSpiegel |
137 .fi | 198 .fi |
| 199 .if n \{\ |
| 200 .RE |
| 201 .\} |
| 202 .PP |
| 203 Now the xdg\-desktop\-icon tool can be used to add the webmirror\&.desktop file
to the desktop: |
138 .sp | 204 .sp |
139 .PP | 205 .if n \{\ |
140 Now the xdg\-desktop\-icon tool can be used to add the webmirror.desktop file to
the desktop: | 206 .RS 4 |
141 .sp | 207 .\} |
142 .nf | 208 .nf |
143 xdg\-desktop\-icon install ./shinythings\-webmirror.desktop | 209 xdg\-desktop\-icon install \&./shinythings\-webmirror\&.desktop |
144 .fi | 210 .fi |
145 .sp | 211 .if n \{\ |
| 212 .RE |
| 213 .\} |
146 .PP | 214 .PP |
147 To add a README file to the desktop as well, the following command can be used: | 215 To add a README file to the desktop as well, the following command can be used: |
148 .sp | 216 .sp |
| 217 .if n \{\ |
| 218 .RS 4 |
| 219 .\} |
149 .nf | 220 .nf |
150 xdg\-desktop\-icon install ./shinythings\-README | 221 xdg\-desktop\-icon install \&./shinythings\-README |
151 .fi | 222 .fi |
| 223 .if n \{\ |
| 224 .RE |
| 225 .\} |
152 .sp | 226 .sp |
153 .SH "AUTHOR" | 227 .SH "AUTHORS" |
154 Kevin Krammer, Jeremy White. | 228 .PP |
| 229 \fBKevin Krammer\fR |
| 230 .RS 4 |
| 231 Author. |
| 232 .RE |
| 233 .PP |
| 234 \fBJeremy White\fR |
| 235 .RS 4 |
| 236 Author. |
| 237 .RE |
| 238 .SH "COPYRIGHT" |
155 .br | 239 .br |
156 <kevin.krammer@gmx.at> | 240 Copyright \(co 2006 |
157 .br | 241 .br |
158 <jwhite@codeweavers.com> | |
OLD | NEW |