summaryrefslogtreecommitdiff
path: root/scripts/desc/xdg-menu.xml
blob: 79555f544cb2d4e0849911f8aa2393e3664e1934 (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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl"
   href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<refentry id="xdg-menu">
  <refentryinfo>
    <title>xdg-menu Manual</title>
    <copyright>
      <year>2006</year>
    </copyright>
    <author>
      <firstname>Kevin</firstname>
      <surname>Krammer</surname>
    </author>
    <address><email>kevin.krammer@gmx.at</email></address>
    <author>
      <firstname>Jeremy</firstname>
      <surname>White</surname>
    </author>
    <address><email>jwhite@codeweavers.com</email></address>
    <releaseinfo>This is release 0.5 of the xdg-menu Manual.</releaseinfo>
  </refentryinfo>

  <refmeta>
    <refentrytitle>xdg-menu</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>xdg-menu</refname>
    <refpurpose>command line tool for (un)installing desktop menu items</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>xdg-menu</command>
      <arg><option>--help</option></arg>
      <arg><option>--vendor <replaceable>vendor-id</replaceable></option></arg>
      <arg><option>--noupdate</option></arg>
      <group>
	<arg>--user</arg>
	<arg>--system</arg>
      </group>
      <group>
	<arg>--install <replaceable>desktop-file</replaceable></arg>
	<arg>--install <replaceable>directory-file</replaceable></arg>
	<arg>--install <replaceable>menu-file</replaceable></arg>
	<arg>--uninstall <replaceable>desktop-file</replaceable></arg>
	<arg>--uninstall <replaceable>directory-file</replaceable></arg>
	<arg>--uninstall <replaceable>menu-file</replaceable></arg>
	<arg>--forceupdate</arg>
      </group>
  </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="description">
    <title>Description</title>
    <para>
      The xdg-menu program can be used to install new items to the
      desktop's application menu.
    </para>
    <para>
      The application menu works according to the 
      XDG Desktop Menu Specification at
      http://www.freedesktop.org/Standards/menu-spec 
    </para>
  </refsect1>
  <refsect1 id="options">
    <title>Options</title>
    <variablelist>
      <varlistentry>
	<term><option>--help</option></term>
	<listitem>
	  <simpara>
	    Show this help.
	  </simpara>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term> <option>--vendor</option> <replaceable>vendor-id</replaceable></term>
	<listitem>
	  <simpara>
	    Adds <replaceable>vendor-id</replaceable> as a prefix when installing desktop
            and directory files.
	  </simpara>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--noupdate</option></term>
	<listitem>
	  <simpara>
	    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.
	  </simpara>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--user</option></term>
	<listitem>
	  <simpara>
	    Installs or uninstalls the file for the current user only.
	  </simpara>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--system</option></term>
	<listitem>
	  <simpara>
	    Installs or uninstalls the file for all users on the system.
            Usually only root is allowed to do this.
	  </simpara>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term> <option>--install</option> <replaceable>desktop-file</replaceable></term>
	<listitem>
	  <simpara>
	    Installs the *.desktop file indicated by <replaceable>desktop-file</replaceable>
            to the menu system. A desktop file represents a single menu item.
	  </simpara>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term> <option>--install</option> <replaceable>directory-file</replaceable></term>
	<listitem>
	  <simpara>
	    Installs the *.directory file indicated by <replaceable>directory-file</replaceable>
            to the menu system. A directory file provides the name and icon for a submenu.
	  </simpara>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term> <option>--install</option> <replaceable>menu-file</replaceable></term>
	<listitem>
	  <simpara>
	    Installs the *.menu file indicated by <replaceable>menu-file</replaceable>
            to the menu system. A menu file describes a submenu.
	  </simpara>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term> <option>--uninstall</option> <replaceable>desktop-file</replaceable></term>
	<listitem>
	  <simpara>
	    Removes the *.desktop file indicated by <replaceable>desktop-file</replaceable>
            from the menu system. 
	  </simpara>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term> <option>--uninstall</option> <replaceable>directory-file</replaceable></term>
	<listitem>
	  <simpara>
	    Removes the *.directory file indicated by <replaceable>directory-file</replaceable>
            from the menu system. 
	  </simpara>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term> <option>--uninstall</option> <replaceable>menu-file</replaceable></term>
	<listitem>
	  <simpara>
	    Removes the *.menu file indicated by <replaceable>menu-file</replaceable>
            from the menu system.
	  </simpara>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><option>--forceupdate</option></term>
	<listitem>
	  <simpara>
	    Force an update of the menu system. This is only useful if
	    the last call to xdg-menu included the <option>--noupdate</option> option.
	  </simpara>
	</listitem>
      </varlistentry>

    </variablelist>
  </refsect1>
</refentry>