| Index: third_party/xdg-utils/scripts/html/xdg-icon-resource.html
|
| ===================================================================
|
| --- third_party/xdg-utils/scripts/html/xdg-icon-resource.html (revision 0)
|
| +++ third_party/xdg-utils/scripts/html/xdg-icon-resource.html (revision 0)
|
| @@ -0,0 +1,128 @@
|
| +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-icon-resource</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="xdg-icon-resource"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-icon-resource — command line tool for (un)installing icon resources</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-icon-resource</code> install [<code class="option">--noupdate</code>] [<code class="option">--novendor</code>] [<code class="option">--theme <em class="replaceable"><code>theme</code></em></code>] [<code class="option">--context <em class="replaceable"><code>context</code></em></code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>] <code class="option">--size <em class="replaceable"><code>size</code></em></code> <em class="replaceable"><code>icon-file</code></em> [<em class="replaceable"><code>icon-name</code></em>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-icon-resource</code> uninstall [<code class="option">--noupdate</code>] [<code class="option">--theme <em class="replaceable"><code>theme</code></em></code>] [<code class="option">--context <em class="replaceable"><code>context</code></em></code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>] <code class="option">--size <em class="replaceable"><code>size</code></em></code> <em class="replaceable"><code>icon-name</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-icon-resource</code> forceupdate [<code class="option">--theme <em class="replaceable"><code>theme</code></em></code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-icon-resource</code> { <code class="option">--help</code> | <code class="option">--manual</code> | <code class="option">--version</code> }</p></div></div><div class="refsect1" lang="en"><a name="description"></a><h2>Description</h2><p>
|
| + The xdg-icon-resource program can be used to install icon resources
|
| + into the desktop icon system in order to illustrate menu entries,
|
| + to depict desktop icons or to graphically represent file types.
|
| + </p><p>
|
| + 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 desktop icon system locates an appropriate
|
| + icon resource to depict an icon. Icon resources can be XPM files or
|
| + PNG files.
|
| + </p><p>
|
| + The desktop icon system works according to the
|
| + XDG Icon Theme Specification at
|
| + http://www.freedesktop.org/Standards/icon-theme-spec
|
| + </p></div><div class="refsect1" lang="en"><a name="commands"></a><h2>Commands</h2><div class="variablelist"><dl><dt><span class="term">install</span></dt><dd>
|
| + Installs the icon file indicated by <em class="replaceable"><code>icon-file</code></em>
|
| + to the desktop icon system under the name
|
| + <em class="replaceable"><code>icon-name</code></em>.
|
| + Icon names do not have an extension.
|
| + If <em class="replaceable"><code>icon-name</code></em> is not provided the name is
|
| + derived from <em class="replaceable"><code>icon-file</code></em>.
|
| + The icon file must have
|
| + <span class="emphasis"><em>.png</em></span> or <span class="emphasis"><em>.xpm</em></span>
|
| + as extension. If a corresponding <span class="emphasis"><em>.icon</em></span>
|
| + file exists in the same location as <em class="replaceable"><code>icon-file</code></em>
|
| + it will be installed as well.
|
| + </dd><dt><span class="term">uninstall</span></dt><dd>
|
| + Removes the icon indicated by <em class="replaceable"><code>icon-name</code></em>
|
| + from the desktop icon system. Note that icon names do not have
|
| + an extension.
|
| + </dd><dt><span class="term">forceupdate</span></dt><dd>
|
| + Force an update of the desktop icon system. This is only useful if
|
| + the last call to xdg-icon-resource included the <code class="option">--noupdate</code> option.
|
| + </dd></dl></div></div><div class="refsect1" lang="en"><a name="options"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--noupdate</code></span></dt><dd>
|
| + Postpone updating the desktop icon system. If multiple icons are
|
| + added in sequence this flag can be used to indicate that
|
| + additional changes will follow and that it is not
|
| + necassery to update the desktop icon system right away.
|
| + </dd><dt><span class="term"><code class="option">--novendor</code></span></dt><dd><p>
|
| + Normally, xdg-icon-resource checks to ensure that an icon file
|
| + to be installed in the <span class="emphasis"><em>apps</em></span> context has
|
| + a proper vendor prefix. This option can be used to disable
|
| + that check.
|
| + </p><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.
|
| + </p></dd><dt><span class="term"><code class="option">--theme</code> <em class="replaceable"><code>theme</code></em></span></dt><dd>
|
| + Installs or removes the icon file as part of
|
| + <em class="replaceable"><code>theme</code></em>. If no theme is specified the
|
| + icons will be installed as part of the default <span class="emphasis"><em>hicolor</em></span> theme.
|
| + Applications may install icons under multiple themes but should
|
| + at least install icons for the default <span class="emphasis"><em>hicolor</em></span> theme.
|
| + </dd><dt><span class="term"><code class="option">--context</code> <em class="replaceable"><code>context</code></em></span></dt><dd>
|
| + Specifies the context for the icon. Icons to be used in the
|
| + application menu and as desktop icon should use
|
| + <span class="emphasis"><em>apps</em></span> as context which is the default
|
| + context. Icons to be used as file icons should use
|
| + <span class="emphasis"><em>mimetypes</em></span> as context.
|
| + Other common contexts are <span class="emphasis"><em>actions</em></span>,
|
| + <span class="emphasis"><em>devices</em></span>, <span class="emphasis"><em>emblems</em></span>,
|
| + <span class="emphasis"><em>filesystems</em></span> and <span class="emphasis"><em>stock</em></span>.
|
| + </dd><dt><span class="term"><code class="option">--size</code> <em class="replaceable"><code>size</code></em></span></dt><dd>
|
| + 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
|
| + </dd><dt><span class="term"><code class="option">--mode</code> <em class="replaceable"><code>mode</code></em></span></dt><dd><p><em class="replaceable"><code>mode</code></em> can be
|
| + <span class="emphasis"><em>user</em></span> or <span class="emphasis"><em>system</em></span>.
|
| + 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 only root is allowed to install in
|
| + system mode.
|
| + </p><p>
|
| + The default is to use system mode when called by root
|
| + and to use user mode when called by a non-root user.
|
| + </p></dd><dt><span class="term"><code class="option">--help</code></span></dt><dd>
|
| + Show command synopsis.
|
| + </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd>
|
| + Show this manualpage.
|
| + </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd>
|
| + Show the xdg-utils version information.
|
| + </dd></dl></div></div><div class="refsect1" lang="en"><a name="env_vars"></a><h2>Environment Variables</h2><p>
|
| + xdg-icon-resource honours the following environment variables:
|
| + </p><div class="variablelist"><dl><dt><span class="term">XDG_UTILS_DEBUG_LEVEL</span></dt><dd>
|
| + 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.
|
| + </dd><dt><span class="term">XDG_UTILS_INSTALL_MODE</span></dt><dd>
|
| + This environment variable can be used by the user or
|
| + administrator to override the installation mode.
|
| + Valid values are <span class="emphasis"><em>user</em></span> and
|
| + <span class="emphasis"><em>system</em></span>.
|
| + </dd></dl></div></div><div class="refsect1" lang="en"><a name="exitcodes"></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><div class="variablelist"><dl><dt><span class="term"><code class="option">1</code></span></dt><dd>
|
| + Error in command line syntax.
|
| + </dd><dt><span class="term"><code class="option">2</code></span></dt><dd>
|
| + One of the files passed on the command line did not exist.
|
| + </dd><dt><span class="term"><code class="option">3</code></span></dt><dd>
|
| + A required tool could not be found.
|
| + </dd><dt><span class="term"><code class="option">4</code></span></dt><dd>
|
| + The action failed.
|
| + </dd><dt><span class="term"><code class="option">5</code></span></dt><dd>
|
| + No permission to read one of the files passed on the command
|
| + line.
|
| + </dd></dl></div></div><div class="refsect1" lang="en"><a name="seealso"></a><h2>See Also</h2><p><span class="citerefentry"><span class="refentrytitle">xdg-desktop-icon</span>(1)</span>,
|
| + <span class="citerefentry"><span class="refentrytitle">xdg-desktop-menu</span>(1)</span>,
|
| + <span class="citerefentry"><span class="refentrytitle">xdg-mime</span>(1)</span>
|
| + </p></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Examples</h2><p>
|
| +To install an icon resource to depict a launcher for the application
|
| +myfoobar, the company ShinyThings Inc. can use:
|
| +</p><pre class="programlisting">
|
| +xdg-icon-resource install --size 64 shinythings-myfoobar.png
|
| +</pre><p>
|
| + </p><p>
|
| +To install an icon for a new application/x-foobar file type one can use:
|
| +</p><pre class="programlisting">
|
| +xdg-icon-resource install --context mimetypes --size 48 ./mime-foobar-48.png application-x-foobar
|
| +xdg-icon-resource install --context mimetypes --size 64 ./mime-foobar-64.png application-x-foobar
|
| +</pre><p>This will install two icons with the name application-x-foobar
|
| +but with different sizes.
|
| + </p></div></div></body></html>
|
|
|
Chromium Code Reviews
