354 lines
7.8 KiB
HTML
354 lines
7.8 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of XDG-DESKTOP-ICON</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>XDG-DESKTOP-ICON</H1>
|
|
Section: xdg-desktop-icon Manual (1)<BR>Updated: 01/11/2021<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
xdg-desktop-icon - command line tool for (un)installing icons to the desktop
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1">
|
|
<B>xdg-desktop-icon</B> install [<B>--novendor</B>] <I>FILE</I>
|
|
<DT id="2">
|
|
<B>xdg-desktop-icon</B> uninstall <I>FILE</I>
|
|
<DT id="3">
|
|
<B>xdg-desktop-icon</B> {<B>--help</B> | <B>--manual</B> | <B>--version</B>}
|
|
</DL>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
|
|
<DD>The xdg-desktop-icon program can be used to install an application launcher or other file on the desktop of the current user.
|
|
<P>
|
|
|
|
An application launcher is represented by a *.desktop file. Desktop files are defined by the freedesktop.org Desktop Entry Specification. The most important aspects of *.desktop files are summarized below.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>COMMANDS</H2>
|
|
|
|
<P>
|
|
|
|
install
|
|
<DL COMPACT><DT id="4"><DD>
|
|
Installs
|
|
<I>FILE</I>
|
|
to the desktop of the current user.
|
|
<I>FILE</I>
|
|
can be a *.desktop file or any other type of file.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
uninstall
|
|
<DL COMPACT><DT id="5"><DD>
|
|
Removes
|
|
<I>FILE</I>
|
|
from the desktop of the current user.
|
|
</DL>
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<P>
|
|
|
|
<B>--novendor</B>
|
|
<DL COMPACT><DT id="6"><DD>
|
|
Normally, xdg-desktop-icon checks to ensure that a *.desktop file to be installed has a vendor prefix. This option can be used to disable that check.
|
|
<P>
|
|
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 phrase, 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.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>--help</B>
|
|
<DL COMPACT><DT id="7"><DD>
|
|
Show command synopsis.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>--manual</B>
|
|
<DL COMPACT><DT id="8"><DD>
|
|
Show this manual page.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>--version</B>
|
|
<DL COMPACT><DT id="9"><DD>
|
|
Show the xdg-utils version information.
|
|
</DL>
|
|
|
|
<A NAME="lbAG"> </A>
|
|
<H2>DESKTOP FILES</H2>
|
|
|
|
<P>
|
|
|
|
An application launcher can be added to the desktop by installing a *.desktop file. A *.desktop file consists of a
|
|
<I>[Desktop Entry]</I>
|
|
header followed by several
|
|
<I>Key</I>=<I>Value</I>
|
|
lines.
|
|
<P>
|
|
|
|
A *.desktop file can provide a name and description for an application in several different languages. This is done by adding a language code as used by LC_MESSAGES in square brackets behind the
|
|
<I>Key</I>. This way one can specify different values for the same
|
|
<I>Key</I>
|
|
depending on the currently selected language.
|
|
<P>
|
|
|
|
The following keys are often used:
|
|
<P>
|
|
|
|
Type=Application
|
|
<DL COMPACT><DT id="10"><DD>
|
|
This is a mandatory field that indicates that the *.desktop file describes an application launcher.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
Name=<I>Application Name</I>
|
|
<DL COMPACT><DT id="11"><DD>
|
|
The name of the application. For example
|
|
<I>Mozilla</I>
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
GenericName=<I>Generic Name</I>
|
|
<DL COMPACT><DT id="12"><DD>
|
|
A generic description of the application. For example
|
|
<I>Web Browser</I>
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
Comment=<I>Comment</I>
|
|
<DL COMPACT><DT id="13"><DD>
|
|
Optional field to specify a tooltip for the application. For example
|
|
<I>Visit websites on the Internet</I>
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
Icon=<I>Icon File</I>
|
|
<DL COMPACT><DT id="14"><DD>
|
|
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's current icon theme. The
|
|
<B>xdg-icon-resource</B>
|
|
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 application icon can be provided in several different sizes as well as in several differently themed styles.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
Exec=<I>Command Line</I>
|
|
<DL COMPACT><DT id="15"><DD>
|
|
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 launcher the %f is replaced with the file path of the dropped file. If multiple files can be specified on the command line the %F placeholder should be used 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.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
For a complete overview of the *.desktop file format please visit
|
|
m[blue]<B><A HREF="http://www.freedesktop.org/wiki/Specifications/desktop-entry-spec">http://www.freedesktop.org/wiki/Specifications/desktop-entry-spec</A></B>m[]
|
|
<A NAME="lbAH"> </A>
|
|
<H2>ENVIRONMENT VARIABLES</H2>
|
|
|
|
<P>
|
|
|
|
xdg-desktop-icon honours the following environment variables:
|
|
<P>
|
|
|
|
XDG_UTILS_DEBUG_LEVEL
|
|
<DL COMPACT><DT id="16"><DD>
|
|
Setting this environment variable to a non-zero numerical value makes xdg-desktop-icon do more verbose reporting on stderr. Setting a higher value increases the verbosity.
|
|
</DL>
|
|
|
|
<A NAME="lbAI"> </A>
|
|
<H2>EXIT CODES</H2>
|
|
|
|
<P>
|
|
|
|
An exit code of 0 indicates success while a non-zero exit code indicates failure. The following failure codes can be returned:
|
|
<P>
|
|
|
|
<B>1</B>
|
|
<DL COMPACT><DT id="17"><DD>
|
|
Error in command line syntax.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>2</B>
|
|
<DL COMPACT><DT id="18"><DD>
|
|
One of the files passed on the command line did not exist.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>3</B>
|
|
<DL COMPACT><DT id="19"><DD>
|
|
A required tool could not be found.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>4</B>
|
|
<DL COMPACT><DT id="20"><DD>
|
|
The action failed.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>5</B>
|
|
<DL COMPACT><DT id="21"><DD>
|
|
No permission to read one of the files passed on the command line.
|
|
</DL>
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<P>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+xdg-icon-resource">xdg-icon-resource</A></B>(1)
|
|
<A NAME="lbAK"> </A>
|
|
<H2>EXAMPLES</H2>
|
|
|
|
<P>
|
|
|
|
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 "shinythings" as its vendor id. In order to add the application to the desktop there needs to be a .desktop file for the application:
|
|
<P>
|
|
<DL COMPACT><DT id="22"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
shinythings-webmirror.desktop:
|
|
|
|
[Desktop Entry]
|
|
Encoding=UTF-8
|
|
Type=Application
|
|
|
|
Exec=webmirror
|
|
Icon=shinythings-webmirror
|
|
|
|
Name=WebMirror
|
|
Name[nl]=WebSpiegel
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
Now the xdg-desktop-icon tool can be used to add the webmirror.desktop file to the desktop:
|
|
<P>
|
|
<DL COMPACT><DT id="23"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
xdg-desktop-icon install ./shinythings-webmirror.desktop
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
To add a README file to the desktop as well, the following command can be used:
|
|
<P>
|
|
<DL COMPACT><DT id="24"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
xdg-desktop-icon install ./shinythings-README
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<A NAME="lbAL"> </A>
|
|
<H2>AUTHORS</H2>
|
|
|
|
<P>
|
|
|
|
<B>Kevin Krammer</B>
|
|
<DL COMPACT><DT id="25"><DD>
|
|
Author.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>Jeremy White</B>
|
|
<DL COMPACT><DT id="26"><DD>
|
|
Author.
|
|
</DL>
|
|
|
|
<A NAME="lbAM"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
<BR>
|
|
|
|
Copyright © 2006
|
|
<BR>
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="27"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="28"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="29"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="30"><A HREF="#lbAE">COMMANDS</A><DD>
|
|
<DT id="31"><A HREF="#lbAF">OPTIONS</A><DD>
|
|
<DT id="32"><A HREF="#lbAG">DESKTOP FILES</A><DD>
|
|
<DT id="33"><A HREF="#lbAH">ENVIRONMENT VARIABLES</A><DD>
|
|
<DT id="34"><A HREF="#lbAI">EXIT CODES</A><DD>
|
|
<DT id="35"><A HREF="#lbAJ">SEE ALSO</A><DD>
|
|
<DT id="36"><A HREF="#lbAK">EXAMPLES</A><DD>
|
|
<DT id="37"><A HREF="#lbAL">AUTHORS</A><DD>
|
|
<DT id="38"><A HREF="#lbAM">COPYRIGHT</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:30 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|