summaryrefslogtreecommitdiff
path: root/scripts/html/xdg-icon.html
blob: aae6643cfad859e058c10170d5e0514f26c67546 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-icon</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="xdg-icon"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-icon &#8212; command line tool for (un)installing icons</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-icon</code>   <code class="option">--install</code>  [<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">--size <em class="replaceable"><code>size</code></em></code>] { <code class="option">--user</code>  |   <code class="option">--system</code> }  <em class="replaceable"><code>icon-file</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-icon</code>   <code class="option">--uninstall</code>  [<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">--size <em class="replaceable"><code>size</code></em></code>] { <code class="option">--user</code>  |   <code class="option">--system</code> }  <em class="replaceable"><code>icon-file</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-icon</code>   <code class="option">--forceupdate</code>  [<code class="option">--theme <em class="replaceable"><code>theme</code></em></code>] { --user  |   --system }</p></div><div class="cmdsynopsis"><p><code class="command">xdg-icon</code>  { <code class="option">--help</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 program can be used to install icons into the desktop
      icon system for use in menu entries, as desktop icons or as file icon.
    </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="options"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--install</code></span></dt><dd>
	    Installs the icon file indicated by <em class="replaceable"><code>icon-file</code></em>
            to the desktop icon system. The icon file must have
            <span class="emphasis"><em>.png</em></span>, <span class="emphasis"><em>.xpm</em></span> or
            <span class="emphasis"><em>.svg</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"><code class="option">--uninstall</code></span></dt><dd>
	    Removes the icon file indicated by <em class="replaceable"><code>icon-file</code></em>
            from the desktop icon system.
	  </dd><dt><span class="term"><code class="option">--forceupdate</code></span></dt><dd>
	    Force an update of the desktop icon system. This is only useful if
	    the last call to xdg-icon included the <code class="option">--noupdate</code> option.
	  </dd><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">--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 (required for png and xpm icons).
	    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">--user</code></span></dt><dd>
	    Installs or uninstalls the icon for the current user only.
	  </dd><dt><span class="term"><code class="option">--system</code></span></dt><dd>
	    Installs or uninstalls the icon for all users on the system.
            Usually only root is allowed to do this.
	  </dd><dt><span class="term"><code class="option">--help</code></span></dt><dd>
	    Show this help.
	  </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="examples"></a><h2>Examples</h2><p>
      TBD
    </p></div></div></body></html>