third_party/xdg-utils/scripts/html/xdg-desktop-menu.html - Issue 6737007: Update xdg-utils to the latest version available in git.

Unified Diff: third_party/xdg-utils/scripts/html/xdg-desktop-menu.html

Issue 6737007: Update xdg-utils to the latest version available in git. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/deps/

Patch Set: Created 9 years, 9 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: third_party/xdg-utils/scripts/html/xdg-desktop-menu.html

===================================================================

--- third_party/xdg-utils/scripts/html/xdg-desktop-menu.html (revision 79890)

+++ third_party/xdg-utils/scripts/html/xdg-desktop-menu.html (working copy)

@@ -1,83 +1,83 @@

-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-desktop-menu</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-desktop-menu"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-desktop-menu — command line tool for (un)installing desktop menu items</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-desktop-menu</code> install [<code class="option">--noupdate</code>] [<code class="option">--novendor</code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>] <em class="replaceable"><code>directory-file(s)</code></em> <em class="replaceable"><code>desktop-file(s)</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-desktop-menu</code> uninstall [<code class="option">--noupdate</code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>] <em class="replaceable"><code>directory-file(s)</code></em> <em class="replaceable"><code>desktop-file(s)</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-desktop-menu</code> forceupdate [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-desktop-menu</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>

+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-desktop-menu</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="xdg-desktop-menu"><a name="xdg-desktop-menu"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-desktop-menu — command line tool for (un)installing desktop menu items</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-desktop-menu</code> install [<code class="option">--noupdate</code>] [<code class="option">--novendor</code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>] <em class="replaceable"><code>directory-file(s)</code></em> <em class="replaceable"><code>desktop-file(s)</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-desktop-menu</code> uninstall [<code class="option">--noupdate</code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>] <em class="replaceable"><code>directory-file(s)</code></em> <em class="replaceable"><code>desktop-file(s)</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-desktop-menu</code> forceupdate [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-desktop-menu</code> { <code class="option">--help</code> | <code class="option">--manual</code> | <code class="option">--version</code> }</p></div></div><div class="refsect1" title="Description"><a name="description"></a><h2>Description</h2><p>

The xdg-desktop-menu program can be used to install new menu entries

to the desktop's application menu.

</p><p>

The application menu works according to the

XDG Desktop Menu Specification at

http://www.freedesktop.org/Standards/menu-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><p>

+ </p></div><div class="refsect1" title="Commands"><a name="commands"></a><h2>Commands</h2><div class="variablelist"><dl><dt><span class="term">install</span></dt><dd><p class="simpara">

Install one or more applications in a submenu of

the desktop menu system.

- </p><p><em class="replaceable"><code>desktop-file</code></em>:

+ </p><p class="simpara"><em class="replaceable"><code>desktop-file</code></em>:

A desktop file represents a single menu entry in the menu.

Desktop files are defined by the freedesktop.org Desktop Entry

Specification. The most important aspects of *.desktop

files are summarized below.

- </p><p>

+ </p><p class="simpara">

Menu entries can be added to the menu system in two different

ways. They can either be added to a predefined submenu in the

menu system based on one or more category keywords, or they can

be added to a new submenu.

- </p><p>

+ </p><p class="simpara">

To add a menu entry to a predefined submenu the desktop file

that represents the menu entry must have a Categories= entry

that lists one or more keywords. The menu item will be included

in an appropriate submenu based on the included keywords.

- </p><p>

+ </p><p class="simpara">

To add menu items to a new submenu the desktop-files must be

preceded by a directory-file that describes the submenu.

If multiple desktop-files are specified, all entries will

be added to the same menu. If entries are installed to a menu

that has been created with a previous call to

- <span><strong class="command">xdg-desktop-menu</strong></span> the entries will be

+ <span class="command"><strong>xdg-desktop-menu</strong></span> the entries will be

installed in addition to any already existing entries.

- </p><p><em class="replaceable"><code>directory-file</code></em>:

+ </p><p class="simpara"><em class="replaceable"><code>directory-file</code></em>:

The *.directory file indicated by

<em class="replaceable"><code>directory-file</code></em> represents a submenu.

The directory file provides the name and icon for a submenu. The

name of the directory file is used to identify the submenu.

- </p><p>

+ </p><p class="simpara">

If multiple directory files are provided each file will

represent a submenu within the menu that preceeds it, creating

a nested menu hierarchy (sub-sub-menus).

The menu entries themselves will be added to the last submenu.

- </p><p>

+ </p><p class="simpara">

Directory files follow the syntax defined by the freedesktop.org

Desktop Entry Specification.

- </p></dd><dt><span class="term">uninstall</span></dt><dd><p>

+ </p></dd><dt><span class="term">uninstall</span></dt><dd><p class="simpara">

Remove applications or submenus from the desktop menu system

- previously installed with <span><strong class="command">xdg-desktop-menu install</strong></span>.

- </p><p>

+ previously installed with <span class="command"><strong>xdg-desktop-menu install</strong></span>.

+ </p><p class="simpara">

A submenu and the associated directory file is only removed

when the submenu no longer contains any menu entries.

- </p></dd><dt><span class="term">forceupdate</span></dt><dd><p>

+ </p></dd><dt><span class="term">forceupdate</span></dt><dd><p class="simpara">

Force an update of the menu system.

- </p><p>

+ </p><p class="simpara">

This command is only useful if the last call to

xdg-desktop-menu included the <code class="option">--noupdate</code> option.

- </p></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>

+ </p></dd></dl></div></div><div class="refsect1" title="Options"><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 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.

- </dd><dt><span class="term"><code class="option">--novendor</code></span></dt><dd><p>

+ </dd><dt><span class="term"><code class="option">--novendor</code></span></dt><dd><p class="simpara">

Normally, xdg-desktop-menu checks to ensure that any *.directory

and *.desktop files to be installed has a vendor prefix.

This option can be used to disable that check.

- </p><p>

+ </p><p class="simpara">

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">--mode</code> <em class="replaceable"><code>mode</code></em></span></dt><dd><p><em class="replaceable"><code>mode</code></em> can be

+ </p></dd><dt><span class="term"><code class="option">--mode</code> <em class="replaceable"><code>mode</code></em></span></dt><dd><p class="simpara"><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>

+ </p><p class="simpara">

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>

@@ -86,7 +86,7 @@

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="desktopfiles"></a><h2>Desktop Files</h2><p>

+ </dd></dl></div></div><div class="refsect1" title="Desktop Files"><a name="desktopfiles"></a><h2>Desktop Files</h2><p>

An application item in the application menu is represented by a

*.desktop file. A *.desktop file consists of a

<span class="emphasis"><em>[Desktop Entry]</em></span> header followed by several

@@ -119,7 +119,7 @@

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 <span><strong class="command">xdg-icon-resource</strong></span>

+ in the user's current icon theme. The <span class="command"><strong>xdg-icon-resource</strong></span>

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

@@ -134,18 +134,18 @@

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.

- </dd><dt><span class="term">Categories=<em class="replaceable"><code>Categories</code></em></span></dt><dd><p>

+ </dd><dt><span class="term">Categories=<em class="replaceable"><code>Categories</code></em></span></dt><dd><p class="simpara">

A list of categories separated by semi-colons. A category is

a keyword that describes and classifies the application.

By default applications are organized in the application menu

based on category. When menu entries are explicitly assigned

to a new submenu it is not necassery to list any categories.

- </p><p>

+ </p><p class="simpara">

When using categories it is recommended to include

one of the following categories:

AudioVideo, Development, Education, Game, Graphics, Network,

Office, Settings, System, Utility.

- </p><p>

+ </p><p class="simpara">

See Appendix A of the XDG Desktop Menu Specification

for information about additional categories.

http://standards.freedesktop.org/menu-spec/menu-spec-1.0.html

@@ -156,7 +156,7 @@

</dd></dl></div><p>

For a complete oveview of the *.desktop file format please

visit http://www.freedesktop.org/wiki/Standards/desktop-entry-spec

- </p></div><div class="refsect1" lang="en"><a name="directoryfiles"></a><h2>Directory Files</h2><p>

+ </p></div><div class="refsect1" title="Directory Files"><a name="directoryfiles"></a><h2>Directory Files</h2><p>

The appearance of submenu in the application menu is

provided by a *.directory file. In particular it provides the title

of the submenu and a possible icon. A *.directory file consists of a

@@ -187,13 +187,13 @@

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 <span><strong class="command">xdg-icon-resource</strong></span>

+ The <span class="command"><strong>xdg-icon-resource</strong></span>

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 submenu icon can be

provided in several different sizes as well as in several

differently themed styles.

- </dd></dl></div></div><div class="refsect1" lang="en"><a name="env_vars"></a><h2>Environment Variables</h2><p>

+ </dd></dl></div></div><div class="refsect1" title="Environment Variables"><a name="env_vars"></a><h2>Environment Variables</h2><p>

xdg-desktop-menu 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

@@ -204,7 +204,7 @@

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>

+ </dd></dl></div></div><div class="refsect1" title="Exit Codes"><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>

@@ -218,10 +218,10 @@

</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>,

+ </dd></dl></div></div><div class="refsect1" title="See Also"><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-icon-resource</span>(1)</span>,

- </p></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Examples</h2><p>

+ </p></div><div class="refsect1" title="Examples"><a name="examples"></a><h2>Examples</h2><p>

The company ShinyThings Inc. has developed an application named

"WebMirror" and would like to add it to the application menu.

The company will use "shinythings" as its vendor id.

« no previous file with comments | « third_party/xdg-utils/scripts/html/xdg-desktop-icon.html ('k') | third_party/xdg-utils/scripts/html/xdg-email.html » ('j') | no next file with comments »