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-menu |
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\-MENU" "1" "06/24/2007" "xdg\-utils 1.0" "" | 5 .\" Date: 12/31/2010 |
| 6 .\" Manual: xdg-desktop-menu Manual |
| 7 .\" Source: xdg-utils 1.0 |
| 8 .\" Language: English |
| 9 .\" |
| 10 .TH "XDG\-DESKTOP\-MENU" "1" "12/31/2010" "xdg-utils 1.0" "xdg-desktop-menu 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\-menu \- command line tool for (un)installing desktop menu items | 31 xdg-desktop-menu \- command line tool for (un)installing desktop menu items |
12 .SH "SYNOPSIS" | 32 .SH "SYNOPSIS" |
13 .HP 17 | 33 .HP \w'\fBxdg\-desktop\-menu\fR\ 'u |
14 \fBxdg\-desktop\-menu\fR install [\fB\-\-noupdate\fR] [\fB\-\-novendor\fR] [\fB\
-\-mode\ \fR\fB\fImode\fR\fR] \fIdirectory\-file(s)\fR \fIdesktop\-file(s)\fR | 34 \fBxdg\-desktop\-menu\fR install [\fB\-\-noupdate\fR] [\fB\-\-novendor\fR] [\fB\
-\-mode\ \fR\fB\fImode\fR\fR] \fIdirectory\-file(s)\fR \fIdesktop\-file(s)\fR |
15 .HP 17 | 35 .HP \w'\fBxdg\-desktop\-menu\fR\ 'u |
16 \fBxdg\-desktop\-menu\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-mode\ \fR\fB\fIm
ode\fR\fR] \fIdirectory\-file(s)\fR \fIdesktop\-file(s)\fR | 36 \fBxdg\-desktop\-menu\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-mode\ \fR\fB\fIm
ode\fR\fR] \fIdirectory\-file(s)\fR \fIdesktop\-file(s)\fR |
17 .HP 17 | 37 .HP \w'\fBxdg\-desktop\-menu\fR\ 'u |
18 \fBxdg\-desktop\-menu\fR forceupdate [\fB\-\-mode\ \fR\fB\fImode\fR\fR] | 38 \fBxdg\-desktop\-menu\fR forceupdate [\fB\-\-mode\ \fR\fB\fImode\fR\fR] |
19 .HP 17 | 39 .HP \w'\fBxdg\-desktop\-menu\fR\ 'u |
20 \fBxdg\-desktop\-menu\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} | 40 \fBxdg\-desktop\-menu\fR {\fB\-\-help\fR | \fB\-\-manual\fR | \fB\-\-version\fR} |
21 .SH "DESCRIPTION" | 41 .SH "DESCRIPTION" |
22 .PP | 42 .PP |
23 The xdg\-desktop\-menu program can be used to install new menu entries to the de
sktop's application menu. | 43 The xdg\-desktop\-menu program can be used to install new menu entries to the de
sktop\*(Aqs application menu\&. |
24 .PP | 44 .PP |
25 The application menu works according to the XDG Desktop Menu Specification at ht
tp://www.freedesktop.org/Standards/menu\-spec | 45 The application menu works according to the XDG Desktop Menu Specification at ht
tp://www\&.freedesktop\&.org/Standards/menu\-spec |
26 .SH "COMMANDS" | 46 .SH "COMMANDS" |
27 .TP | 47 .PP |
28 install | 48 install |
29 Install one or more applications in a submenu of the desktop menu system. | 49 .RS 4 |
30 .sp | 50 Install one or more applications in a submenu of the desktop menu system\&. |
31 \fIdesktop\-file\fR: A desktop file represents a single menu entry in the menu.
Desktop files are defined by the freedesktop.org Desktop Entry Specification. Th
e most important aspects of *.desktop files are summarized below. | 51 .sp |
32 .sp | 52 \fIdesktop\-file\fR: A desktop file represents a single menu entry in the menu\&
. Desktop files are defined by the freedesktop\&.org Desktop Entry Specification
\&. The most important aspects of *\&.desktop files are summarized below\&. |
33 Menu entries can be added to the menu system in two different ways. They can eit
her be added to a predefined submenu in the menu system based on one or more cat
egory keywords, or they can be added to a new submenu. | 53 .sp |
34 .sp | 54 Menu entries can be added to the menu system in two different ways\&. They can e
ither be added to a predefined submenu in the menu system based on one or more c
ategory keywords, or they can be added to a new submenu\&. |
35 To add a menu entry to a predefined submenu the desktop file that represents the
menu entry must have a Categories= entry that lists one or more keywords. The m
enu item will be included in an appropriate submenu based on the included keywor
ds. | 55 .sp |
36 .sp | 56 To add a menu entry to a predefined submenu the desktop file that represents the
menu entry must have a Categories= entry that lists one or more keywords\&. The
menu item will be included in an appropriate submenu based on the included keyw
ords\&. |
37 To add menu items to a new submenu the desktop\-files must be preceded by a dire
ctory\-file that describes the submenu. If multiple desktop\-files are specified
, all entries will be added to the same menu. If entries are installed to a menu
that has been created with a previous call to | 57 .sp |
| 58 To add menu items to a new submenu the desktop\-files must be preceded by a dire
ctory\-file that describes the submenu\&. If multiple desktop\-files are specifi
ed, all entries will be added to the same menu\&. If entries are installed to a
menu that has been created with a previous call to |
38 \fBxdg\-desktop\-menu\fR | 59 \fBxdg\-desktop\-menu\fR |
39 the entries will be installed in addition to any already existing entries. | 60 the entries will be installed in addition to any already existing entries\&. |
40 .sp | 61 .sp |
41 \fIdirectory\-file\fR: The *.directory file indicated by | 62 \fIdirectory\-file\fR: The *\&.directory file indicated by |
42 \fIdirectory\-file\fR | 63 \fIdirectory\-file\fR |
43 represents a submenu. The directory file provides the name and icon for a submen
u. The name of the directory file is used to identify the submenu. | 64 represents a submenu\&. The directory file provides the name and icon for a subm
enu\&. The name of the directory file is used to identify the submenu\&. |
44 .sp | 65 .sp |
45 If multiple directory files are provided each file will represent a submenu with
in the menu that preceeds it, creating a nested menu hierarchy (sub\-sub\-menus)
. The menu entries themselves will be added to the last submenu. | 66 If multiple directory files are provided each file will represent a submenu with
in the menu that preceeds it, creating a nested menu hierarchy (sub\-sub\-menus)
\&. The menu entries themselves will be added to the last submenu\&. |
46 .sp | 67 .sp |
47 Directory files follow the syntax defined by the freedesktop.org Desktop Entry S
pecification. | 68 Directory files follow the syntax defined by the freedesktop\&.org Desktop Entry
Specification\&. |
48 .TP | 69 .RE |
| 70 .PP |
49 uninstall | 71 uninstall |
| 72 .RS 4 |
50 Remove applications or submenus from the desktop menu system previously installe
d with | 73 Remove applications or submenus from the desktop menu system previously installe
d with |
51 \fBxdg\-desktop\-menu install\fR. | 74 \fBxdg\-desktop\-menu install\fR\&. |
52 .sp | 75 .sp |
53 A submenu and the associated directory file is only removed when the submenu no
longer contains any menu entries. | 76 A submenu and the associated directory file is only removed when the submenu no
longer contains any menu entries\&. |
54 .TP | 77 .RE |
| 78 .PP |
55 forceupdate | 79 forceupdate |
56 Force an update of the menu system. | 80 .RS 4 |
| 81 Force an update of the menu system\&. |
57 .sp | 82 .sp |
58 This command is only useful if the last call to xdg\-desktop\-menu included the | 83 This command is only useful if the last call to xdg\-desktop\-menu included the |
59 \fB\-\-noupdate\fR | 84 \fB\-\-noupdate\fR |
60 option. | 85 option\&. |
| 86 .RE |
61 .SH "OPTIONS" | 87 .SH "OPTIONS" |
62 .TP | 88 .PP |
63 \fB\-\-noupdate\fR | 89 \fB\-\-noupdate\fR |
64 Postpone updating the menu system. If multiple updates to the menu system are ma
de in sequence this flag can be used to indicate that additional changes will fo
llow and that it is not necassery to update the menu system right away. | 90 .RS 4 |
65 .TP | 91 Postpone updating the menu system\&. If multiple updates to the menu system are
made in sequence this flag can be used to indicate that additional changes will
follow and that it is not necassery to update the menu system right away\&. |
| 92 .RE |
| 93 .PP |
66 \fB\-\-novendor\fR | 94 \fB\-\-novendor\fR |
67 Normally, xdg\-desktop\-menu checks to ensure that any *.directory and *.desktop
files to be installed has a vendor prefix. This option can be used to disable t
hat check. | 95 .RS 4 |
68 .sp | 96 Normally, xdg\-desktop\-menu checks to ensure that any *\&.directory and *\&.des
ktop files to be installed has a vendor prefix\&. This option can be used to dis
able that check\&. |
69 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. | 97 .sp |
70 .TP | 98 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
\&. |
| 99 .RE |
| 100 .PP |
71 \fB\-\-mode\fR \fImode\fR | 101 \fB\-\-mode\fR \fImode\fR |
| 102 .RS 4 |
72 \fImode\fR | 103 \fImode\fR |
73 can be | 104 can be |
74 \fIuser\fR | 105 \fIuser\fR |
75 or | 106 or |
76 \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. | 107 \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\&. |
77 .sp | 108 .sp |
78 The default is to use system mode when called by root and to use user mode when
called by a non\-root user. | 109 The default is to use system mode when called by root and to use user mode when
called by a non\-root user\&. |
79 .TP | 110 .RE |
| 111 .PP |
80 \fB\-\-help\fR | 112 \fB\-\-help\fR |
81 Show command synopsis. | 113 .RS 4 |
82 .TP | 114 Show command synopsis\&. |
| 115 .RE |
| 116 .PP |
83 \fB\-\-manual\fR | 117 \fB\-\-manual\fR |
84 Show this manualpage. | 118 .RS 4 |
85 .TP | 119 Show this manualpage\&. |
| 120 .RE |
| 121 .PP |
86 \fB\-\-version\fR | 122 \fB\-\-version\fR |
87 Show the xdg\-utils version information. | 123 .RS 4 |
| 124 Show the xdg\-utils version information\&. |
| 125 .RE |
88 .SH "DESKTOP FILES" | 126 .SH "DESKTOP FILES" |
89 .PP | 127 .PP |
90 An application item in the application menu is represented by a *.desktop file.
A *.desktop file consists of a | 128 An application item in the application menu is represented by a *\&.desktop file
\&. A *\&.desktop file consists of a |
91 \fI[Desktop Entry]\fR | 129 \fI[Desktop Entry]\fR |
92 header followed by several | 130 header followed by several |
93 \fIKey\fR=\fIValue\fR | 131 \fIKey\fR=\fIValue\fR |
94 lines. | 132 lines\&. |
95 .PP | 133 .PP |
96 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 | 134 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 |
97 \fIKey\fR. This way one can specify different values for the same | 135 \fIKey\fR\&. This way one can specify different values for the same |
98 \fIKey\fR | 136 \fIKey\fR |
99 depending on the currently selected language. | 137 depending on the currently selected language\&. |
100 .PP | 138 .PP |
101 The following keys are often used: | 139 The following keys are often used: |
102 .TP | 140 .PP |
103 Value=1.0 | 141 Value=1\&.0 |
104 This is a mandatory field to indicate that the *.desktop file follows the 1.0 ve
rsion of the specification. | 142 .RS 4 |
105 .TP | 143 This is a mandatory field to indicate that the *\&.desktop file follows the 1\&.
0 version of the specification\&. |
| 144 .RE |
| 145 .PP |
106 Type=Application | 146 Type=Application |
107 This is a mandatory field that indicates that the *.desktop file describes an ap
plication launcher. | 147 .RS 4 |
108 .TP | 148 This is a mandatory field that indicates that the *\&.desktop file describes an
application launcher\&. |
| 149 .RE |
| 150 .PP |
109 Name=\fIApplication Name\fR | 151 Name=\fIApplication Name\fR |
110 The name of the application. For example | 152 .RS 4 |
| 153 The name of the application\&. For example |
111 \fIMozilla\fR | 154 \fIMozilla\fR |
112 .TP | 155 .RE |
| 156 .PP |
113 GenericName=\fIGeneric Name\fR | 157 GenericName=\fIGeneric Name\fR |
114 A generic description of the application. For example | 158 .RS 4 |
| 159 A generic description of the application\&. For example |
115 \fIWeb Browser\fR | 160 \fIWeb Browser\fR |
116 .TP | 161 .RE |
| 162 .PP |
117 Comment=\fIComment\fR | 163 Comment=\fIComment\fR |
118 Optional field to specify a tooltip for the application. For example | 164 .RS 4 |
| 165 Optional field to specify a tooltip for the application\&. For example |
119 \fIVisit websites on the Internet\fR | 166 \fIVisit websites on the Internet\fR |
120 .TP | 167 .RE |
| 168 .PP |
121 Icon=\fIIcon File\fR | 169 Icon=\fIIcon File\fR |
122 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 | 170 .RS 4 |
| 171 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 |
123 \fBxdg\-icon\-resource\fR | 172 \fBxdg\-icon\-resource\fR |
124 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. | 173 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\&. |
125 .TP | 174 .RE |
| 175 .PP |
126 Exec=\fICommand Line\fR | 176 Exec=\fICommand Line\fR |
127 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. | 177 .RS 4 |
128 .TP | 178 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\&. |
| 179 .RE |
| 180 .PP |
129 Categories=\fICategories\fR | 181 Categories=\fICategories\fR |
130 A list of categories separated by semi\-colons. A category is a keyword that des
cribes and classifies the application. By default applications are organized in
the application menu based on category. When menu entries are explicitly assigne
d to a new submenu it is not necassery to list any categories. | 182 .RS 4 |
131 .sp | 183 A list of categories separated by semi\-colons\&. A category is a keyword that d
escribes and classifies the application\&. By default applications are organized
in the application menu based on category\&. When menu entries are explicitly a
ssigned to a new submenu it is not necassery to list any categories\&. |
132 When using categories it is recommended to include one of the following categori
es: AudioVideo, Development, Education, Game, Graphics, Network, Office, Setting
s, System, Utility. | 184 .sp |
133 .sp | 185 When using categories it is recommended to include one of the following categori
es: AudioVideo, Development, Education, Game, Graphics, Network, Office, Setting
s, System, Utility\&. |
134 See Appendix A of the XDG Desktop Menu Specification for information about addit
ional categories. http://standards.freedesktop.org/menu\-spec/menu\-spec\-1.0.ht
ml | 186 .sp |
135 .TP | 187 See Appendix A of the XDG Desktop Menu Specification for information about addit
ional categories\&. http://standards\&.freedesktop\&.org/menu\-spec/menu\-spec\-
1\&.0\&.html |
| 188 .RE |
| 189 .PP |
136 MimeType=\fIMimetypes\fR | 190 MimeType=\fIMimetypes\fR |
137 A list of mimetypes separated by semi\-colons. This field is used to indicate wh
ich file types the application is able to open. | 191 .RS 4 |
138 .PP | 192 A list of mimetypes separated by semi\-colons\&. This field is used to indicate
which file types the application is able to open\&. |
139 For a complete oveview of the *.desktop file format please visit http://www.free
desktop.org/wiki/Standards/desktop\-entry\-spec | 193 .RE |
| 194 .PP |
| 195 For a complete oveview of the *\&.desktop file format please visit http://www\&.
freedesktop\&.org/wiki/Standards/desktop\-entry\-spec |
140 .SH "DIRECTORY FILES" | 196 .SH "DIRECTORY FILES" |
141 .PP | 197 .PP |
142 The appearance of submenu in the application menu is provided by a *.directory f
ile. In particular it provides the title of the submenu and a possible icon. A *
.directory file consists of a | 198 The appearance of submenu in the application menu is provided by a *\&.directory
file\&. In particular it provides the title of the submenu and a possible icon\
&. A *\&.directory file consists of a |
143 \fI[Desktop Entry]\fR | 199 \fI[Desktop Entry]\fR |
144 header followed by several | 200 header followed by several |
145 \fIKey\fR=\fIValue\fR | 201 \fIKey\fR=\fIValue\fR |
146 lines. | 202 lines\&. |
147 .PP | 203 .PP |
148 A *.directory file can provide a title (name) for the submenu in several differe
nt languages. This is done by adding a language code as used by LC_MESSAGES in s
quare brackets behind the | 204 A *\&.directory file can provide a title (name) for the submenu in several diffe
rent languages\&. This is done by adding a language code as used by LC_MESSAGES
in square brackets behind the |
149 \fIKey\fR. This way one can specify different values for the same | 205 \fIKey\fR\&. This way one can specify different values for the same |
150 \fIKey\fR | 206 \fIKey\fR |
151 depending on the currently selected language. | 207 depending on the currently selected language\&. |
152 .PP | 208 .PP |
153 The following keys are relevqnt for submenus: | 209 The following keys are relevqnt for submenus: |
154 .TP | 210 .PP |
155 Value=1.0 | 211 Value=1\&.0 |
156 This is a mandatory field to indicate that the *.directory file follows the 1.0
version of the Desktop Entry specification. | 212 .RS 4 |
157 .TP | 213 This is a mandatory field to indicate that the *\&.directory file follows the 1\
&.0 version of the Desktop Entry specification\&. |
| 214 .RE |
| 215 .PP |
158 Type=Directory | 216 Type=Directory |
159 This is a mandatory field that indicates that the *.directory file describes a s
ubmenu. | 217 .RS 4 |
160 .TP | 218 This is a mandatory field that indicates that the *\&.directory file describes a
submenu\&. |
| 219 .RE |
| 220 .PP |
161 Name=\fIMenu Name\fR | 221 Name=\fIMenu Name\fR |
162 The title of submenu. For example | 222 .RS 4 |
| 223 The title of submenu\&. For example |
163 \fIMozilla\fR | 224 \fIMozilla\fR |
164 .TP | 225 .RE |
| 226 .PP |
165 Comment=\fIComment\fR | 227 Comment=\fIComment\fR |
166 Optional field to specify a tooltip for the submenu. | 228 .RS 4 |
167 .TP | 229 Optional field to specify a tooltip for the submenu\&. |
| 230 .RE |
| 231 .PP |
168 Icon=\fIIcon File\fR | 232 Icon=\fIIcon File\fR |
169 The icon to use for the submenu. 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's current icon theme. The | 233 .RS 4 |
| 234 The icon to use for the submenu\&. This can either be an absolute path to an ima
ge 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 |
170 \fBxdg\-icon\-resource\fR | 235 \fBxdg\-icon\-resource\fR |
171 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 sub
menu icon can be provided in several different sizes as well as in several diffe
rently themed styles. | 236 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 s
ubmenu icon can be provided in several different sizes as well as in several dif
ferently themed styles\&. |
| 237 .RE |
172 .SH "ENVIRONMENT VARIABLES" | 238 .SH "ENVIRONMENT VARIABLES" |
173 .PP | 239 .PP |
174 xdg\-desktop\-menu honours the following environment variables: | 240 xdg\-desktop\-menu honours the following environment variables: |
175 .TP | 241 .PP |
176 XDG_UTILS_DEBUG_LEVEL | 242 XDG_UTILS_DEBUG_LEVEL |
177 Setting this environment variable to a non\-zero numerical value makes xdg\-desk
top\-menu do more verbose reporting on stderr. Setting a higher value increases
the verbosity. | 243 .RS 4 |
178 .TP | 244 Setting this environment variable to a non\-zero numerical value makes xdg\-desk
top\-menu do more verbose reporting on stderr\&. Setting a higher value increase
s the verbosity\&. |
| 245 .RE |
| 246 .PP |
179 XDG_UTILS_INSTALL_MODE | 247 XDG_UTILS_INSTALL_MODE |
180 This environment variable can be used by the user or administrator to override t
he installation mode. Valid values are | 248 .RS 4 |
| 249 This environment variable can be used by the user or administrator to override t
he installation mode\&. Valid values are |
181 \fIuser\fR | 250 \fIuser\fR |
182 and | 251 and |
183 \fIsystem\fR. | 252 \fIsystem\fR\&. |
| 253 .RE |
184 .SH "EXIT CODES" | 254 .SH "EXIT CODES" |
185 .PP | 255 .PP |
186 An exit code of 0 indicates success while a non\-zero exit code indicates failur
e. The following failure codes can be returned: | 256 An exit code of 0 indicates success while a non\-zero exit code indicates failur
e\&. The following failure codes can be returned: |
187 .TP | 257 .PP |
188 \fB1\fR | 258 \fB1\fR |
189 Error in command line syntax. | 259 .RS 4 |
190 .TP | 260 Error in command line syntax\&. |
| 261 .RE |
| 262 .PP |
191 \fB2\fR | 263 \fB2\fR |
192 One of the files passed on the command line did not exist. | 264 .RS 4 |
193 .TP | 265 One of the files passed on the command line did not exist\&. |
| 266 .RE |
| 267 .PP |
194 \fB3\fR | 268 \fB3\fR |
195 A required tool could not be found. | 269 .RS 4 |
196 .TP | 270 A required tool could not be found\&. |
| 271 .RE |
| 272 .PP |
197 \fB4\fR | 273 \fB4\fR |
198 The action failed. | 274 .RS 4 |
199 .TP | 275 The action failed\&. |
| 276 .RE |
| 277 .PP |
200 \fB5\fR | 278 \fB5\fR |
201 No permission to read one of the files passed on the command line. | 279 .RS 4 |
| 280 No permission to read one of the files passed on the command line\&. |
| 281 .RE |
202 .SH "SEE ALSO" | 282 .SH "SEE ALSO" |
203 .PP | 283 .PP |
204 \fBxdg\-desktop\-icon\fR(1), | 284 \fBxdg-desktop-icon\fR(1), |
205 \fBxdg\-icon\-resource\fR(1), | 285 \fBxdg-icon-resource\fR(1), |
206 \fBxdg\-mime\fR(1) | 286 \fBxdg-mime\fR(1) |
207 .SH "EXAMPLES" | 287 .SH "EXAMPLES" |
208 .PP | 288 .PP |
209 The company ShinyThings Inc. has developed an application named "WebMirror" and
would like to add it to the application menu. The company will use "shinythings"
as its vendor id. In order to add the application to the menu there needs to be
a .desktop file with a suitable | 289 The company ShinyThings Inc\&. has developed an application named "WebMirror" an
d would like to add it to the application menu\&. The company will use "shinythi
ngs" as its vendor id\&. In order to add the application to the menu there needs
to be a \&.desktop file with a suitable |
210 \fICategories\fR | 290 \fICategories\fR |
211 entry: | 291 entry: |
212 .sp | 292 .sp |
| 293 .if n \{\ |
| 294 .RS 4 |
| 295 .\} |
213 .nf | 296 .nf |
214 shinythings\-webmirror.desktop: | 297 shinythings\-webmirror\&.desktop: |
215 | 298 |
216 [Desktop Entry] | 299 [Desktop Entry] |
217 Encoding=UTF\-8 | 300 Encoding=UTF\-8 |
218 Type=Application | 301 Type=Application |
219 | 302 |
220 Exec=webmirror | 303 Exec=webmirror |
221 Icon=webmirror | 304 Icon=webmirror |
222 | 305 |
223 Name=WebMirror | 306 Name=WebMirror |
224 Name[nl]=WebSpiegel | 307 Name[nl]=WebSpiegel |
225 | 308 |
226 Categories=Network;WebDevelopment; | 309 Categories=Network;WebDevelopment; |
227 .fi | 310 .fi |
| 311 .if n \{\ |
| 312 .RE |
| 313 .\} |
| 314 .PP |
| 315 Now the xdg\-desktop\-menu tool can be used to add the shinythings\-webmirror\&.
desktop file to the desktop application menu: |
228 .sp | 316 .sp |
| 317 .if n \{\ |
| 318 .RS 4 |
| 319 .\} |
| 320 .nf |
| 321 xdg\-desktop\-menu install \&./shinythings\-webmirror\&.desktop |
| 322 .fi |
| 323 .if n \{\ |
| 324 .RE |
| 325 .\} |
229 .PP | 326 .PP |
230 Now the xdg\-desktop\-menu tool can be used to add the shinythings\-webmirror.de
sktop file to the desktop application menu: | 327 Note that for the purpose of this example the menu items are available in two la
nguages, English and Dutch\&. The language code for Dutch is nl\&. |
| 328 .PP |
| 329 In the next example the company ShinyThings Inc\&. will add its own submenu to t
he desktop application menu consisting of a "WebMirror" menu item and a "WebMirr
or Admin Tool" menu item\&. |
| 330 .PP |
| 331 First the company needs to create two \&.desktop files that describe the two men
u items\&. Since the items are to be added to a new submenu it is not necassery
to include a Categories= line: |
231 .sp | 332 .sp |
| 333 .if n \{\ |
| 334 .RS 4 |
| 335 .\} |
232 .nf | 336 .nf |
233 xdg\-desktop\-menu install ./shinythings\-webmirror.desktop | 337 shinythings\-webmirror\&.desktop: |
234 .fi | |
235 .sp | |
236 .PP | |
237 Note that for the purpose of this example the menu items are available in two la
nguages, English and Dutch. The language code for Dutch is nl. | |
238 .PP | |
239 In the next example the company ShinyThings Inc. will add its own submenu to the
desktop application menu consisting of a "WebMirror" menu item and a "WebMirror
Admin Tool" menu item. | |
240 .PP | |
241 First the company needs to create two .desktop files that describe the two menu
items. Since the items are to be added to a new submenu it is not necassery to i
nclude a Categories= line: | |
242 .sp | |
243 .nf | |
244 shinythings\-webmirror.desktop: | |
245 | 338 |
246 [Desktop Entry] | 339 [Desktop Entry] |
247 Encoding=UTF\-8 | 340 Encoding=UTF\-8 |
248 Type=Application | 341 Type=Application |
249 | 342 |
250 Exec=webmirror | 343 Exec=webmirror |
251 Icon=shinythings\-webmirror | 344 Icon=shinythings\-webmirror |
252 | 345 |
253 Name=WebMirror | 346 Name=WebMirror |
254 Name[nl]=WebSpiegel | 347 Name[nl]=WebSpiegel |
255 | 348 |
256 | 349 |
257 shinythings\-webmirror\-admin.desktop: | 350 shinythings\-webmirror\-admin\&.desktop: |
258 | 351 |
259 [Desktop Entry] | 352 [Desktop Entry] |
260 Encoding=UTF\-8 | 353 Encoding=UTF\-8 |
261 Type=Application | 354 Type=Application |
262 | 355 |
263 Exec=webmirror\-admintool | 356 Exec=webmirror\-admintool |
264 Icon=shinythings\-webmirror\-admintool | 357 Icon=shinythings\-webmirror\-admintool |
265 | 358 |
266 Name=WebMirror Admin Tool | 359 Name=WebMirror Admin Tool |
267 Name[nl]=WebSpiegel Administratie Tool | 360 Name[nl]=WebSpiegel Administratie Tool |
268 .fi | 361 .fi |
| 362 .if n \{\ |
| 363 .RE |
| 364 .\} |
| 365 .PP |
| 366 In addition a \&.directory file needs to be created to provide a title and icon
for the sub\-menu itself: |
269 .sp | 367 .sp |
270 .PP | 368 .if n \{\ |
271 In addition a .directory file needs to be created to provide a title and icon fo
r the sub\-menu itself: | 369 .RS 4 |
272 .sp | 370 .\} |
273 .nf | 371 .nf |
274 shinythings\-webmirror.directory: | 372 shinythings\-webmirror\&.directory: |
275 | 373 |
276 [Desktop Entry] | 374 [Desktop Entry] |
277 Encoding=UTF\-8 | 375 Encoding=UTF\-8 |
278 | 376 |
279 Icon=shinythings\-webmirror\-menu | 377 Icon=shinythings\-webmirror\-menu |
280 | 378 |
281 Name=WebMirror | 379 Name=WebMirror |
282 Name[nl]=WebSpiegel | 380 Name[nl]=WebSpiegel |
283 .fi | 381 .fi |
284 .sp | 382 .if n \{\ |
| 383 .RE |
| 384 .\} |
285 .PP | 385 .PP |
286 These file can now be installed with: | 386 These file can now be installed with: |
287 .sp | 387 .sp |
| 388 .if n \{\ |
| 389 .RS 4 |
| 390 .\} |
288 .nf | 391 .nf |
289 xdg\-desktop\-menu install ./shinythings\-webmirror.directory \\ | 392 xdg\-desktop\-menu install \&./shinythings\-webmirror\&.directory \e |
290 ./shinythings\-webmirror.desktop ./shinythings\-webmirror\-admin.desktop | 393 \&./shinythings\-webmirror\&.desktop \&./shinythings\-webmirror\-admin\&.d
esktop |
291 .fi | 394 .fi |
292 .sp | 395 .if n \{\ |
| 396 .RE |
| 397 .\} |
293 .PP | 398 .PP |
294 The menu entries could also be installed one by one: | 399 The menu entries could also be installed one by one: |
295 .sp | 400 .sp |
| 401 .if n \{\ |
| 402 .RS 4 |
| 403 .\} |
296 .nf | 404 .nf |
297 xdg\-desktop\-menu install \-\-noupdate ./shinythings\-webmirror.directory \\ | 405 xdg\-desktop\-menu install \-\-noupdate \&./shinythings\-webmirror\&.directory \
e |
298 ./shinythings\-webmirror.desktop | 406 \&./shinythings\-webmirror\&.desktop |
299 xdg\-desktop\-menu install \-\-noupdate ./shinythings\-webmirror.directory \\ | 407 xdg\-desktop\-menu install \-\-noupdate \&./shinythings\-webmirror\&.directory \
e |
300 ./shinythings\-webmirror\-admin.desktop | 408 \&./shinythings\-webmirror\-admin\&.desktop |
301 xdg\-desktop\-menu forceupdate | 409 xdg\-desktop\-menu forceupdate |
302 .fi | 410 .fi |
| 411 .if n \{\ |
| 412 .RE |
| 413 .\} |
| 414 .PP |
| 415 Although the result is the same it is slightly more efficient to install all fil
es at the same time\&. |
| 416 .PP |
| 417 The *\&.desktop and *\&.directory files reference icons with the names webmirror
, webmirror\-admin and webmirror\-menu which should also be installed\&. In this
example the icons are installed in two different sizes, once with a size of 22x
22 pixels and once with a size of 64x64 pixels: |
303 .sp | 418 .sp |
| 419 .if n \{\ |
| 420 .RS 4 |
| 421 .\} |
| 422 .nf |
| 423 xdg\-icon\-resource install \-\-size 22 \&./wmicon\-22\&.png shinythings\-webmir
ror |
| 424 xdg\-icon\-resource install \-\-size 22 \&./wmicon\-menu\-22\&.png shinythings\-
webmirror\-menu |
| 425 xdg\-icon\-resource install \-\-size 22 \&./wmicon\-admin\-22\&.png shinythings\
-webmirror\-admin |
| 426 xdg\-icon\-resource install \-\-size 64 \&./wmicon\-64\&.png shinythings\-webmir
ror |
| 427 xdg\-icon\-resource install \-\-size 64 \&./wmicon\-menu\-64\&.png shinythings\-
webmirror\-menu |
| 428 xdg\-icon\-resource install \-\-size 64 \&./wmicon\-admin\-64\&.png shinythings\
-webmirror\-admin |
| 429 .fi |
| 430 .if n \{\ |
| 431 .RE |
| 432 .\} |
| 433 .sp |
| 434 .SH "AUTHORS" |
304 .PP | 435 .PP |
305 Although the result is the same it is slightly more efficient to install all fil
es at the same time. | 436 \fBKevin Krammer\fR |
| 437 .RS 4 |
| 438 Author. |
| 439 .RE |
306 .PP | 440 .PP |
307 The *.desktop and *.directory files reference icons with the names webmirror, we
bmirror\-admin and webmirror\-menu which should also be installed. In this examp
le the icons are installed in two different sizes, once with a size of 22x22 pix
els and once with a size of 64x64 pixels: | 441 \fBJeremy White\fR |
308 .sp | 442 .RS 4 |
309 .nf | 443 Author. |
310 xdg\-icon\-resource install \-\-size 22 ./wmicon\-22.png shinythings\-webmirror | 444 .RE |
311 xdg\-icon\-resource install \-\-size 22 ./wmicon\-menu\-22.png shinythings\-webm
irror\-menu | 445 .SH "COPYRIGHT" |
312 xdg\-icon\-resource install \-\-size 22 ./wmicon\-admin\-22.png shinythings\-web
mirror\-admin | |
313 xdg\-icon\-resource install \-\-size 64 ./wmicon\-64.png shinythings\-webmirror | |
314 xdg\-icon\-resource install \-\-size 64 ./wmicon\-menu\-64.png shinythings\-webm
irror\-menu | |
315 xdg\-icon\-resource install \-\-size 64 ./wmicon\-admin\-64.png shinythings\-web
mirror\-admin | |
316 .fi | |
317 .sp | |
318 .SH "AUTHOR" | |
319 Kevin Krammer, Jeremy White. | |
320 .br | 446 .br |
321 <kevin.krammer@gmx.at> | 447 Copyright \(co 2006 |
322 .br | 448 .br |
323 <jwhite@codeweavers.com> | |
OLD | NEW |