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-icon-resource |
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\-ICON\-RESOURCE" "1" "06/24/2007" "xdg\-utils 1.0" "" | 5 .\" Date: 12/31/2010 |
| 6 .\" Manual: xdg-icon-resource Manual |
| 7 .\" Source: xdg-utils 1.0 |
| 8 .\" Language: English |
| 9 .\" |
| 10 .TH "XDG\-ICON\-RESOURCE" "1" "12/31/2010" "xdg-utils 1.0" "xdg-icon-resource Ma
nual" |
| 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\-icon\-resource \- command line tool for (un)installing icon resources | 31 xdg-icon-resource \- command line tool for (un)installing icon resources |
12 .SH "SYNOPSIS" | 32 .SH "SYNOPSIS" |
13 .HP 18 | 33 .HP \w'\fBxdg\-icon\-resource\fR\ 'u |
14 \fBxdg\-icon\-resource\fR install [\fB\-\-noupdate\fR] [\fB\-\-novendor\fR] [\fB
\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\-\-context\ \fR\fB\fIcontext\fR\fR] [\fB\-
\-mode\ \fR\fB\fImode\fR\fR] \fB\-\-size\ \fR\fB\fIsize\fR\fR \fIicon\-file\fR [
\fIicon\-name\fR] | 34 \fBxdg\-icon\-resource\fR install [\fB\-\-noupdate\fR] [\fB\-\-novendor\fR] [\fB
\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\-\-context\ \fR\fB\fIcontext\fR\fR] [\fB\-
\-mode\ \fR\fB\fImode\fR\fR] \fB\-\-size\ \fR\fB\fIsize\fR\fR \fIicon\-file\fR [
\fIicon\-name\fR] |
15 .HP 18 | 35 .HP \w'\fBxdg\-icon\-resource\fR\ 'u |
16 \fBxdg\-icon\-resource\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fR\fB\f
Itheme\fR\fR] [\fB\-\-context\ \fR\fB\fIcontext\fR\fR] [\fB\-\-mode\ \fR\fB\fImo
de\fR\fR] \fB\-\-size\ \fR\fB\fIsize\fR\fR \fIicon\-name\fR | 36 \fBxdg\-icon\-resource\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fR\fB\f
Itheme\fR\fR] [\fB\-\-context\ \fR\fB\fIcontext\fR\fR] [\fB\-\-mode\ \fR\fB\fImo
de\fR\fR] \fB\-\-size\ \fR\fB\fIsize\fR\fR \fIicon\-name\fR |
17 .HP 18 | 37 .HP \w'\fBxdg\-icon\-resource\fR\ 'u |
18 \fBxdg\-icon\-resource\fR forceupdate [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\
-\-mode\ \fR\fB\fImode\fR\fR] | 38 \fBxdg\-icon\-resource\fR forceupdate [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\
-\-mode\ \fR\fB\fImode\fR\fR] |
19 .HP 18 | 39 .HP \w'\fBxdg\-icon\-resource\fR\ 'u |
20 \fBxdg\-icon\-resource\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} | 40 \fBxdg\-icon\-resource\fR {\fB\-\-help\fR | \fB\-\-manual\fR | \fB\-\-version\fR
} |
21 .SH "DESCRIPTION" | 41 .SH "DESCRIPTION" |
22 .PP | 42 .PP |
23 The xdg\-icon\-resource program can be used to install icon resources into the d
esktop icon system in order to illustrate menu entries, to depict desktop icons
or to graphically represent file types. | 43 The xdg\-icon\-resource program can be used to install icon resources into the d
esktop icon system in order to illustrate menu entries, to depict desktop icons
or to graphically represent file types\&. |
24 .PP | 44 .PP |
25 The desktop icon system identifies icons by name. Depending on the required size
, the choice of icon theme and the context in which the icon is used, the deskto
p icon system locates an appropriate icon resource to depict an icon. Icon resou
rces can be XPM files or PNG files. | 45 The desktop icon system identifies icons by name\&. Depending on the required si
ze, the choice of icon theme and the context in which the icon is used, the desk
top icon system locates an appropriate icon resource to depict an icon\&. Icon r
esources can be XPM files or PNG files\&. |
26 .PP | 46 .PP |
27 The desktop icon system works according to the XDG Icon Theme Specification at h
ttp://www.freedesktop.org/Standards/icon\-theme\-spec | 47 The desktop icon system works according to the XDG Icon Theme Specification at h
ttp://www\&.freedesktop\&.org/Standards/icon\-theme\-spec |
28 .SH "COMMANDS" | 48 .SH "COMMANDS" |
29 .TP | 49 .PP |
30 install | 50 install |
| 51 .RS 4 |
31 Installs the icon file indicated by | 52 Installs the icon file indicated by |
32 \fIicon\-file\fR | 53 \fIicon\-file\fR |
33 to the desktop icon system under the name | 54 to the desktop icon system under the name |
34 \fIicon\-name\fR. Icon names do not have an extension. If | 55 \fIicon\-name\fR\&. Icon names do not have an extension\&. If |
35 \fIicon\-name\fR | 56 \fIicon\-name\fR |
36 is not provided the name is derived from | 57 is not provided the name is derived from |
37 \fIicon\-file\fR. The icon file must have | 58 \fIicon\-file\fR\&. The icon file must have |
38 \fI.png\fR | 59 \fI\&.png\fR |
39 or | 60 or |
40 \fI.xpm\fR | 61 \fI\&.xpm\fR |
41 as extension. If a corresponding | 62 as extension\&. If a corresponding |
42 \fI.icon\fR | 63 \fI\&.icon\fR |
43 file exists in the same location as | 64 file exists in the same location as |
44 \fIicon\-file\fR | 65 \fIicon\-file\fR |
45 it will be installed as well. | 66 it will be installed as well\&. |
46 .TP | 67 .RE |
| 68 .PP |
47 uninstall | 69 uninstall |
| 70 .RS 4 |
48 Removes the icon indicated by | 71 Removes the icon indicated by |
49 \fIicon\-name\fR | 72 \fIicon\-name\fR |
50 from the desktop icon system. Note that icon names do not have an extension. | 73 from the desktop icon system\&. Note that icon names do not have an extension\&. |
51 .TP | 74 .RE |
| 75 .PP |
52 forceupdate | 76 forceupdate |
53 Force an update of the desktop icon system. This is only useful if the last call
to xdg\-icon\-resource included the | 77 .RS 4 |
| 78 Force an update of the desktop icon system\&. This is only useful if the last ca
ll to xdg\-icon\-resource included the |
54 \fB\-\-noupdate\fR | 79 \fB\-\-noupdate\fR |
55 option. | 80 option\&. |
| 81 .RE |
56 .SH "OPTIONS" | 82 .SH "OPTIONS" |
57 .TP | 83 .PP |
58 \fB\-\-noupdate\fR | 84 \fB\-\-noupdate\fR |
59 Postpone updating the desktop icon system. If multiple icons are added in sequen
ce this flag can be used to indicate that additional changes will follow and tha
t it is not necessary to update the desktop icon system right away. | 85 .RS 4 |
60 .TP | 86 Postpone updating the desktop icon system\&. If multiple icons are added in sequ
ence this flag can be used to indicate that additional changes will follow and t
hat it is not necassery to update the desktop icon system right away\&. |
| 87 .RE |
| 88 .PP |
61 \fB\-\-novendor\fR | 89 \fB\-\-novendor\fR |
| 90 .RS 4 |
62 Normally, xdg\-icon\-resource checks to ensure that an icon file to be installed
in the | 91 Normally, xdg\-icon\-resource checks to ensure that an icon file to be installed
in the |
63 \fIapps\fR | 92 \fIapps\fR |
64 context has a proper vendor prefix. This option can be used to disable that chec
k. | 93 context has a proper vendor prefix\&. This option can be used to disable that ch
eck\&. |
65 .sp | 94 .sp |
66 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. | 95 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
\&. |
67 .TP | 96 .RE |
| 97 .PP |
68 \fB\-\-theme\fR \fItheme\fR | 98 \fB\-\-theme\fR \fItheme\fR |
| 99 .RS 4 |
69 Installs or removes the icon file as part of | 100 Installs or removes the icon file as part of |
70 \fItheme\fR. If no theme is specified the icons will be installed as part of the
default | 101 \fItheme\fR\&. If no theme is specified the icons will be installed as part of t
he default |
71 \fIhicolor\fR | 102 \fIhicolor\fR |
72 theme. Applications may install icons under multiple themes but should at least
install icons for the default | 103 theme\&. Applications may install icons under multiple themes but should at leas
t install icons for the default |
73 \fIhicolor\fR | 104 \fIhicolor\fR |
74 theme. | 105 theme\&. |
75 .TP | 106 .RE |
| 107 .PP |
76 \fB\-\-context\fR \fIcontext\fR | 108 \fB\-\-context\fR \fIcontext\fR |
77 Specifies the context for the icon. Icons to be used in the application menu and
as desktop icon should use | 109 .RS 4 |
| 110 Specifies the context for the icon\&. Icons to be used in the application menu a
nd as desktop icon should use |
78 \fIapps\fR | 111 \fIapps\fR |
79 as context which is the default context. Icons to be used as file icons should u
se | 112 as context which is the default context\&. Icons to be used as file icons should
use |
80 \fImimetypes\fR | 113 \fImimetypes\fR |
81 as context. Other common contexts are | 114 as context\&. Other common contexts are |
82 \fIactions\fR, | 115 \fIactions\fR, |
83 \fIdevices\fR, | 116 \fIdevices\fR, |
84 \fIemblems\fR, | 117 \fIemblems\fR, |
85 \fIfilesystems\fR | 118 \fIfilesystems\fR |
86 and | 119 and |
87 \fIstock\fR. | 120 \fIstock\fR\&. |
88 .TP | 121 .RE |
| 122 .PP |
89 \fB\-\-size\fR \fIsize\fR | 123 \fB\-\-size\fR \fIsize\fR |
90 Specifies the size of the icon. All icons must be square. Common sizes for icons
in the apps context are: 16, 22, 32, 48, 64 and 128. Common sizes for icons in
the mimetypes context are: 16, 22, 32, 48, 64 and 128 | 124 .RS 4 |
91 .TP | 125 Specifies the size of the icon\&. All icons must be square\&. Common sizes for i
cons in the apps context are: 16, 22, 32, 48, 64 and 128\&. Common sizes for ico
ns in the mimetypes context are: 16, 22, 32, 48, 64 and 128 |
| 126 .RE |
| 127 .PP |
92 \fB\-\-mode\fR \fImode\fR | 128 \fB\-\-mode\fR \fImode\fR |
| 129 .RS 4 |
93 \fImode\fR | 130 \fImode\fR |
94 can be | 131 can be |
95 \fIuser\fR | 132 \fIuser\fR |
96 or | 133 or |
97 \fIsystem\fR. In user mode the file is (un)installed for the current user only.
In system mode the file is (un)installed for all users on the system. Usually on
ly root is allowed to install in system mode. | 134 \fIsystem\fR\&. In user mode the file is (un)installed for the current user only
\&. In system mode the file is (un)installed for all users on the system\&. Usua
lly only root is allowed to install in system mode\&. |
98 .sp | 135 .sp |
99 The default is to use system mode when called by root and to use user mode when
called by a non\-root user. | 136 The default is to use system mode when called by root and to use user mode when
called by a non\-root user\&. |
100 .TP | 137 .RE |
| 138 .PP |
101 \fB\-\-help\fR | 139 \fB\-\-help\fR |
102 Show command synopsis. | 140 .RS 4 |
103 .TP | 141 Show command synopsis\&. |
| 142 .RE |
| 143 .PP |
104 \fB\-\-manual\fR | 144 \fB\-\-manual\fR |
105 Show this manualpage. | 145 .RS 4 |
106 .TP | 146 Show this manualpage\&. |
| 147 .RE |
| 148 .PP |
107 \fB\-\-version\fR | 149 \fB\-\-version\fR |
108 Show the xdg\-utils version information. | 150 .RS 4 |
| 151 Show the xdg\-utils version information\&. |
| 152 .RE |
109 .SH "ENVIRONMENT VARIABLES" | 153 .SH "ENVIRONMENT VARIABLES" |
110 .PP | 154 .PP |
111 xdg\-icon\-resource honours the following environment variables: | 155 xdg\-icon\-resource honours the following environment variables: |
112 .TP | 156 .PP |
113 XDG_UTILS_DEBUG_LEVEL | 157 XDG_UTILS_DEBUG_LEVEL |
114 Setting this environment variable to a non\-zero numerical value makes xdg\-icon
\-resource do more verbose reporting on stderr. Setting a higher value increases
the verbosity. | 158 .RS 4 |
115 .TP | 159 Setting this environment variable to a non\-zero numerical value makes xdg\-icon
\-resource do more verbose reporting on stderr\&. Setting a higher value increas
es the verbosity\&. |
| 160 .RE |
| 161 .PP |
116 XDG_UTILS_INSTALL_MODE | 162 XDG_UTILS_INSTALL_MODE |
117 This environment variable can be used by the user or administrator to override t
he installation mode. Valid values are | 163 .RS 4 |
| 164 This environment variable can be used by the user or administrator to override t
he installation mode\&. Valid values are |
118 \fIuser\fR | 165 \fIuser\fR |
119 and | 166 and |
120 \fIsystem\fR. | 167 \fIsystem\fR\&. |
| 168 .RE |
121 .SH "EXIT CODES" | 169 .SH "EXIT CODES" |
122 .PP | 170 .PP |
123 An exit code of 0 indicates success while a non\-zero exit code indicates failur
e. The following failure codes can be returned: | 171 An exit code of 0 indicates success while a non\-zero exit code indicates failur
e\&. The following failure codes can be returned: |
124 .TP | 172 .PP |
125 \fB1\fR | 173 \fB1\fR |
126 Error in command line syntax. | 174 .RS 4 |
127 .TP | 175 Error in command line syntax\&. |
| 176 .RE |
| 177 .PP |
128 \fB2\fR | 178 \fB2\fR |
129 One of the files passed on the command line did not exist. | 179 .RS 4 |
130 .TP | 180 One of the files passed on the command line did not exist\&. |
| 181 .RE |
| 182 .PP |
131 \fB3\fR | 183 \fB3\fR |
132 A required tool could not be found. | 184 .RS 4 |
133 .TP | 185 A required tool could not be found\&. |
| 186 .RE |
| 187 .PP |
134 \fB4\fR | 188 \fB4\fR |
135 The action failed. | 189 .RS 4 |
136 .TP | 190 The action failed\&. |
| 191 .RE |
| 192 .PP |
137 \fB5\fR | 193 \fB5\fR |
138 No permission to read one of the files passed on the command line. | 194 .RS 4 |
| 195 No permission to read one of the files passed on the command line\&. |
| 196 .RE |
139 .SH "SEE ALSO" | 197 .SH "SEE ALSO" |
140 .PP | 198 .PP |
141 \fBxdg\-desktop\-icon\fR(1), | 199 \fBxdg-desktop-icon\fR(1), |
142 \fBxdg\-desktop\-menu\fR(1), | 200 \fBxdg-desktop-menu\fR(1), |
143 \fBxdg\-mime\fR(1) | 201 \fBxdg-mime\fR(1) |
144 .SH "EXAMPLES" | 202 .SH "EXAMPLES" |
145 .PP | 203 .PP |
146 To install an icon resource to depict a launcher for the application myfoobar, t
he company ShinyThings Inc. can use: | 204 To install an icon resource to depict a launcher for the application myfoobar, t
he company ShinyThings Inc\&. can use: |
147 .sp | 205 .sp |
| 206 .if n \{\ |
| 207 .RS 4 |
| 208 .\} |
148 .nf | 209 .nf |
149 xdg\-icon\-resource install \-\-size 64 shinythings\-myfoobar.png | 210 xdg\-icon\-resource install \-\-size 64 shinythings\-myfoobar\&.png |
150 .fi | 211 .fi |
151 .sp | 212 .if n \{\ |
| 213 .RE |
| 214 .\} |
152 .PP | 215 .PP |
153 To install an icon for a new application/x\-foobar file type one can use: | 216 To install an icon for a new application/x\-foobar file type one can use: |
154 .sp | 217 .sp |
| 218 .if n \{\ |
| 219 .RS 4 |
| 220 .\} |
155 .nf | 221 .nf |
156 xdg\-icon\-resource install \-\-context mimetypes \-\-size 48 ./mime\-foobar\-48
.png application\-x\-foobar | 222 xdg\-icon\-resource install \-\-context mimetypes \-\-size 48 \&./mime\-foobar\-
48\&.png application\-x\-foobar |
157 xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 ./mime\-foobar\-64
.png application\-x\-foobar | 223 xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 \&./mime\-foobar\-
64\&.png application\-x\-foobar |
158 .fi | 224 .fi |
159 .sp | 225 .if n \{\ |
160 This will install two icons with the name application\-x\-foobar but with differ
ent sizes. | 226 .RE |
161 .SH "AUTHOR" | 227 .\} |
162 Kevin Krammer, Jeremy White. | 228 .sp |
| 229 This will install two icons with the name application\-x\-foobar but with differ
ent sizes\&. |
| 230 .SH "AUTHORS" |
| 231 .PP |
| 232 \fBKevin Krammer\fR |
| 233 .RS 4 |
| 234 Author. |
| 235 .RE |
| 236 .PP |
| 237 \fBJeremy White\fR |
| 238 .RS 4 |
| 239 Author. |
| 240 .RE |
| 241 .SH "COPYRIGHT" |
163 .br | 242 .br |
164 <kevin.krammer@gmx.at> | 243 Copyright \(co 2006 |
165 .br | 244 .br |
166 <jwhite@codeweavers.com> | |
OLD | NEW |