| 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\-DESKTOP\-ICON" "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\-desktop\-icon \- command line tool for (un)installing icons to the desktop |
| 12 .SH "SYNOPSIS" |
| 13 .HP 17 |
| 14 \fBxdg\-desktop\-icon\fR install [\fB\-\-novendor\fR] \fIFILE\fR |
| 15 .HP 17 |
| 16 \fBxdg\-desktop\-icon\fR uninstall \fIFILE\fR |
| 17 .HP 17 |
| 18 \fBxdg\-desktop\-icon\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} |
| 19 .SH "DESCRIPTION" |
| 20 .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. |
| 22 .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. |
| 24 .SH "COMMANDS" |
| 25 .TP |
| 26 install |
| 27 Installs |
| 28 \fIFILE\fR |
| 29 to the desktop of the current user. |
| 30 \fIFILE\fR |
| 31 can be a *.desktop file or any other type of file. |
| 32 .TP |
| 33 uninstall |
| 34 Removes |
| 35 \fIFILE\fR |
| 36 from the desktop of the current user. |
| 37 .SH "OPTIONS" |
| 38 .TP |
| 39 \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. |
| 41 .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. |
| 43 .TP |
| 44 \fB\-\-help\fR |
| 45 Show command synopsis. |
| 46 .TP |
| 47 \fB\-\-manual\fR |
| 48 Show this manualpage. |
| 49 .TP |
| 50 \fB\-\-version\fR |
| 51 Show the xdg\-utils version information. |
| 52 .SH "DESKTOP FILES" |
| 53 .PP |
| 54 An application launcher can be added to the desktop by installing a *.desktop fi
le. A *.desktop file consists of a |
| 55 \fI[Desktop Entry]\fR |
| 56 header followed by several |
| 57 \fIKey\fR=\fIValue\fR |
| 58 lines. |
| 59 .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 |
| 61 \fIKey\fR. This way one can specify different values for the same |
| 62 \fIKey\fR |
| 63 depending on the currently selected language. |
| 64 .PP |
| 65 The following keys are often used: |
| 66 .TP |
| 67 Value=1.0 |
| 68 This is a mandatory field to indicate that the *.desktop file follows the 1.0 ve
rsion of the specification. |
| 69 .TP |
| 70 Type=Application |
| 71 This is a mandatory field that indicates that the *.desktop file describes an ap
plication launcher. |
| 72 .TP |
| 73 Name=\fIApplication Name\fR |
| 74 The name of the application. For example |
| 75 \fIMozilla\fR |
| 76 .TP |
| 77 GenericName=\fIGeneric Name\fR |
| 78 A generic description of the application. For example |
| 79 \fIWeb Browser\fR |
| 80 .TP |
| 81 Comment=\fIComment\fR |
| 82 Optional field to specify a tooltip for the application. For example |
| 83 \fIVisit websites on the Internet\fR |
| 84 .TP |
| 85 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 |
| 87 \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. |
| 89 .TP |
| 90 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. |
| 92 .PP |
| 93 For a complete oveview of the *.desktop file format please visit http://www.free
desktop.org/wiki/Standards/desktop\-entry\-spec |
| 94 .SH "ENVIRONMENT VARIABLES" |
| 95 .PP |
| 96 xdg\-desktop\-icon honours the following environment variables: |
| 97 .TP |
| 98 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. |
| 100 .SH "EXIT CODES" |
| 101 .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: |
| 103 .TP |
| 104 \fB1\fR |
| 105 Error in command line syntax. |
| 106 .TP |
| 107 \fB2\fR |
| 108 One of the files passed on the command line did not exist. |
| 109 .TP |
| 110 \fB3\fR |
| 111 A required tool could not be found. |
| 112 .TP |
| 113 \fB4\fR |
| 114 The action failed. |
| 115 .TP |
| 116 \fB5\fR |
| 117 No permission to read one of the files passed on the command line. |
| 118 .SH "SEE ALSO" |
| 119 .PP |
| 120 \fBxdg\-icon\-resource\fR(1) |
| 121 .SH "EXAMPLES" |
| 122 .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: |
| 124 .sp |
| 125 .nf |
| 126 shinythings\-webmirror.desktop: |
| 127 |
| 128 [Desktop Entry] |
| 129 Encoding=UTF\-8 |
| 130 Type=Application |
| 131 |
| 132 Exec=webmirror |
| 133 Icon=shinythings\-webmirror |
| 134 |
| 135 Name=WebMirror |
| 136 Name[nl]=WebSpiegel |
| 137 .fi |
| 138 .sp |
| 139 .PP |
| 140 Now the xdg\-desktop\-icon tool can be used to add the webmirror.desktop file to
the desktop: |
| 141 .sp |
| 142 .nf |
| 143 xdg\-desktop\-icon install ./shinythings\-webmirror.desktop |
| 144 .fi |
| 145 .sp |
| 146 .PP |
| 147 To add a README file to the desktop as well, the following command can be used: |
| 148 .sp |
| 149 .nf |
| 150 xdg\-desktop\-icon install ./shinythings\-README |
| 151 .fi |
| 152 .sp |
| 153 .SH "AUTHOR" |
| 154 Kevin Krammer, Jeremy White. |
| 155 .br |
| 156 <kevin.krammer@gmx.at> |
| 157 .br |
| 158 <jwhite@codeweavers.com> |
| OLD | NEW |
|---|
Chromium Code Reviews
