| OLD | NEW |
|---|
| (Empty) | |
| 1 .\" ** You probably do not want to edit this file directly ** |
| 2 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). |
| 3 .\" Instead of manually editing it, you probably should edit the DocBook XML |
| 4 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. |
| 5 .TH "XDG\-ICON\-RESOURCE" "1" "06/24/2007" "xdg\-utils 1.0" "" |
| 6 .\" disable hyphenation |
| 7 .nh |
| 8 .\" disable justification (adjust text to left margin only) |
| 9 .ad l |
| 10 .SH "NAME" |
| 11 xdg\-icon\-resource \- command line tool for (un)installing icon resources |
| 12 .SH "SYNOPSIS" |
| 13 .HP 18 |
| 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] |
| 15 .HP 18 |
| 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 |
| 17 .HP 18 |
| 18 \fBxdg\-icon\-resource\fR forceupdate [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\
-\-mode\ \fR\fB\fImode\fR\fR] |
| 19 .HP 18 |
| 20 \fBxdg\-icon\-resource\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} |
| 21 .SH "DESCRIPTION" |
| 22 .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. |
| 24 .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. |
| 26 .PP |
| 27 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" |
| 29 .TP |
| 30 install |
| 31 Installs the icon file indicated by |
| 32 \fIicon\-file\fR |
| 33 to the desktop icon system under the name |
| 34 \fIicon\-name\fR. Icon names do not have an extension. If |
| 35 \fIicon\-name\fR |
| 36 is not provided the name is derived from |
| 37 \fIicon\-file\fR. The icon file must have |
| 38 \fI.png\fR |
| 39 or |
| 40 \fI.xpm\fR |
| 41 as extension. If a corresponding |
| 42 \fI.icon\fR |
| 43 file exists in the same location as |
| 44 \fIicon\-file\fR |
| 45 it will be installed as well. |
| 46 .TP |
| 47 uninstall |
| 48 Removes the icon indicated by |
| 49 \fIicon\-name\fR |
| 50 from the desktop icon system. Note that icon names do not have an extension. |
| 51 .TP |
| 52 forceupdate |
| 53 Force an update of the desktop icon system. This is only useful if the last call
to xdg\-icon\-resource included the |
| 54 \fB\-\-noupdate\fR |
| 55 option. |
| 56 .SH "OPTIONS" |
| 57 .TP |
| 58 \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. |
| 60 .TP |
| 61 \fB\-\-novendor\fR |
| 62 Normally, xdg\-icon\-resource checks to ensure that an icon file to be installed
in the |
| 63 \fIapps\fR |
| 64 context has a proper vendor prefix. This option can be used to disable that chec
k. |
| 65 .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. |
| 67 .TP |
| 68 \fB\-\-theme\fR \fItheme\fR |
| 69 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 |
| 71 \fIhicolor\fR |
| 72 theme. Applications may install icons under multiple themes but should at least
install icons for the default |
| 73 \fIhicolor\fR |
| 74 theme. |
| 75 .TP |
| 76 \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 |
| 78 \fIapps\fR |
| 79 as context which is the default context. Icons to be used as file icons should u
se |
| 80 \fImimetypes\fR |
| 81 as context. Other common contexts are |
| 82 \fIactions\fR, |
| 83 \fIdevices\fR, |
| 84 \fIemblems\fR, |
| 85 \fIfilesystems\fR |
| 86 and |
| 87 \fIstock\fR. |
| 88 .TP |
| 89 \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 |
| 91 .TP |
| 92 \fB\-\-mode\fR \fImode\fR |
| 93 \fImode\fR |
| 94 can be |
| 95 \fIuser\fR |
| 96 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. |
| 98 .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. |
| 100 .TP |
| 101 \fB\-\-help\fR |
| 102 Show command synopsis. |
| 103 .TP |
| 104 \fB\-\-manual\fR |
| 105 Show this manualpage. |
| 106 .TP |
| 107 \fB\-\-version\fR |
| 108 Show the xdg\-utils version information. |
| 109 .SH "ENVIRONMENT VARIABLES" |
| 110 .PP |
| 111 xdg\-icon\-resource honours the following environment variables: |
| 112 .TP |
| 113 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. |
| 115 .TP |
| 116 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 |
| 118 \fIuser\fR |
| 119 and |
| 120 \fIsystem\fR. |
| 121 .SH "EXIT CODES" |
| 122 .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: |
| 124 .TP |
| 125 \fB1\fR |
| 126 Error in command line syntax. |
| 127 .TP |
| 128 \fB2\fR |
| 129 One of the files passed on the command line did not exist. |
| 130 .TP |
| 131 \fB3\fR |
| 132 A required tool could not be found. |
| 133 .TP |
| 134 \fB4\fR |
| 135 The action failed. |
| 136 .TP |
| 137 \fB5\fR |
| 138 No permission to read one of the files passed on the command line. |
| 139 .SH "SEE ALSO" |
| 140 .PP |
| 141 \fBxdg\-desktop\-icon\fR(1), |
| 142 \fBxdg\-desktop\-menu\fR(1), |
| 143 \fBxdg\-mime\fR(1) |
| 144 .SH "EXAMPLES" |
| 145 .PP |
| 146 To install an icon resource to depict a launcher for the application myfoobar, t
he company ShinyThings Inc. can use: |
| 147 .sp |
| 148 .nf |
| 149 xdg\-icon\-resource install \-\-size 64 shinythings\-myfoobar.png |
| 150 .fi |
| 151 .sp |
| 152 .PP |
| 153 To install an icon for a new application/x\-foobar file type one can use: |
| 154 .sp |
| 155 .nf |
| 156 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 |
| 158 .fi |
| 159 .sp |
| 160 This will install two icons with the name application\-x\-foobar but with differ
ent sizes. |
| 161 .SH "AUTHOR" |
| 162 Kevin Krammer, Jeremy White. |
| 163 .br |
| 164 <kevin.krammer@gmx.at> |
| 165 .br |
| 166 <jwhite@codeweavers.com> |
| OLD | NEW |
|---|
Chromium Code Reviews
