From 3af8eeca3be36c7dfb52a816f5e9cf57c3be1bd5 Mon Sep 17 00:00:00 2001
From: Rex Dieter <rdieter@math.unl.edu>
Date: Fri, 7 Feb 2014 12:23:34 -0600
Subject: [PATCH 04/22] remove generated html files
---
scripts/html/.gitignore | 9 +
scripts/html/index.html | 19 --
scripts/html/xdg-desktop-icon.html | 133 --------------
scripts/html/xdg-desktop-menu.html | 334 ------------------------------------
scripts/html/xdg-email.html | 89 ----------
scripts/html/xdg-icon-resource.html | 128 --------------
scripts/html/xdg-mime.html | 145 ----------------
scripts/html/xdg-open.html | 38 ----
scripts/html/xdg-screensaver.html | 63 -------
scripts/html/xdg-settings.html | 59 -------
10 files changed, 9 insertions(+), 1008 deletions(-)
delete mode 100644 scripts/html/index.html
delete mode 100644 scripts/html/xdg-desktop-icon.html
delete mode 100644 scripts/html/xdg-desktop-menu.html
delete mode 100644 scripts/html/xdg-email.html
delete mode 100644 scripts/html/xdg-icon-resource.html
delete mode 100644 scripts/html/xdg-mime.html
delete mode 100644 scripts/html/xdg-open.html
delete mode 100644 scripts/html/xdg-screensaver.html
delete mode 100644 scripts/html/xdg-settings.html
diff --git a/scripts/html/.gitignore b/scripts/html/.gitignore
index e69de29..0be5f9a 100644
--- a/scripts/html/.gitignore
+++ b/scripts/html/.gitignore
@@ -0,0 +1,9 @@
+index.html
+xdg-desktop-icon.html
+xdg-desktop-menu.html
+xdg-email.html
+xdg-icon-resource.html
+xdg-mime.html
+xdg-open.html
+xdg-screensaver.html
+xdg-settings.html
diff --git a/scripts/html/index.html b/scripts/html/index.html
deleted file mode 100644
index 64b0c53..0000000
--- a/scripts/html/index.html
+++ /dev/null
@@ -1,19 +0,0 @@
-<html>
-<body>
-<h1>xdg-utils</h1>
-<p>
-This version of xdg-utils contains the following commands:
-</p>
-<table>
-<tr><td><a href="xdg-desktop-menu.html">xdg-desktop-menu</a>:</td><td>command line tool for (un)installing desktop menu items</td></tr>
-<tr><td><a href="xdg-desktop-icon.html">xdg-desktop-icon</a>:</td><td>command line tool for (un)installing icons to the desktop</td></tr>
-<tr><td><a href="xdg-mime.html">xdg-mime</a>:</td><td>command line tool for querying information about file type handling
-and adding descriptions for new file types</td></tr>
-<tr><td><a href="xdg-icon-resource.html">xdg-icon-resource</a>:</td><td>command line tool for (un)installing icon resources</td></tr>
-<tr><td><a href="xdg-open.html">xdg-open</a>:</td><td>opens a file or URL in the user's preferred application</td></tr>
-<tr><td><a href="xdg-email.html">xdg-email</a>:</td><td>command line tool for sending mail using the user's preferred e-mail composer</td></tr>
-<tr><td><a href="xdg-screensaver.html">xdg-screensaver</a>:</td><td>command line tool for controlling the screensaver</td></tr>
-<tr><td><a href="xdg-settings.html">xdg-settings</a>:</td><td>get various settings from the desktop environment</td></tr>
-</table>
-</body>
-</html>
\ No newline at end of file
diff --git a/scripts/html/xdg-desktop-icon.html b/scripts/html/xdg-desktop-icon.html
deleted file mode 100644
index f9683ba..0000000
--- a/scripts/html/xdg-desktop-icon.html
+++ /dev/null
@@ -1,133 +0,0 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-desktop-icon</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-icon"><a name="xdg-desktop-icon"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-desktop-icon — command line tool for (un)installing icons to the desktop</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-desktop-icon</code> install [<code class="option">--novendor</code>] <em class="replaceable"><code>FILE</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-desktop-icon</code> uninstall <em class="replaceable"><code>FILE</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-desktop-icon</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-icon program can be used to install an application launcher
- or other file on the desktop of the current user.
- </p><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.
- </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>
- Installs <em class="replaceable"><code>FILE</code></em> to the desktop of the current user.
- <em class="replaceable"><code>FILE</code></em> can be a *.desktop file or any
- other type of file.
- </dd><dt><span class="term">uninstall</span></dt><dd>
- Removes <em class="replaceable"><code>FILE</code></em> from the desktop
- of the current user.
- </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">--novendor</code></span></dt><dd><p class="simpara">
- 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><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">--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" title="Desktop Files"><a name="desktopfiles"></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
- <span class="emphasis"><em>[Desktop Entry]</em></span> header followed by several
- <em class="replaceable"><code>Key</code></em>=<em class="replaceable"><code>Value</code></em> lines.
- </p><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
- <em class="replaceable"><code>Key</code></em>. This way one can specify different
- values for the same <em class="replaceable"><code>Key</code></em> depending on the
- currently selected language.
- </p><p>
- The following keys are often used:
- </p><div class="variablelist"><dl><dt><span class="term">Value=1.0</span></dt><dd>
- This is a mandatory field to indicate that the *.desktop file
- follows the 1.0 version of the specification.
- </dd><dt><span class="term">Type=Application</span></dt><dd>
- This is a mandatory field that indicates that the *.desktop file
- describes an application launcher.
- </dd><dt><span class="term">Name=<em class="replaceable"><code>Application Name</code></em></span></dt><dd>
- The name of the application.
- For example <span class="emphasis"><em>Mozilla</em></span>
- </dd><dt><span class="term">GenericName=<em class="replaceable"><code>Generic Name</code></em></span></dt><dd>
- A generic description of the application.
- For example <span class="emphasis"><em>Web Browser</em></span>
- </dd><dt><span class="term">Comment=<em class="replaceable"><code>Comment</code></em></span></dt><dd>
- Optional field to specify a tooltip for the application.
- For example <span class="emphasis"><em>Visit websites on the Internet</em></span>
- </dd><dt><span class="term">Icon=<em class="replaceable"><code>Icon File</code></em></span></dt><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 <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
- provided in several different sizes as well as in several
- differently themed styles.
- </dd><dt><span class="term">Exec=<em class="replaceable"><code>Command Line</code></em></span></dt><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.
- </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" title="Environment Variables"><a name="env_vars"></a><h2>Environment Variables</h2><p>
- xdg-desktop-icon 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-desktop-icon do more verbose reporting on stderr.
- Setting a higher value increases the verbosity.
- </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>
- 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" title="See Also"><a name="seealso"></a><h2>See Also</h2><p><span class="citerefentry"><span class="refentrytitle">xdg-icon-resource</span>(1)</span>
- </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 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><pre class="programlisting">
-shinythings-webmirror.desktop:
-
- [Desktop Entry]
- Encoding=UTF-8
- Type=Application
-
- Exec=webmirror
- Icon=shinythings-webmirror
-
- Name=WebMirror
- Name[nl]=WebSpiegel
-</pre><p>
- </p><p>Now the xdg-desktop-icon tool can be used to add the webmirror.desktop file
- to the desktop:
-</p><pre class="programlisting">
-xdg-desktop-icon install ./shinythings-webmirror.desktop
-</pre><p>
- </p><p>To add a README file to the desktop as well, the following command can be used:
-</p><pre class="programlisting">
-xdg-desktop-icon install ./shinythings-README
-</pre><p>
- </p></div></div></body></html>
diff --git a/scripts/html/xdg-desktop-menu.html b/scripts/html/xdg-desktop-menu.html
deleted file mode 100644
index 71b7e04..0000000
--- a/scripts/html/xdg-desktop-menu.html
+++ /dev/null
@@ -1,334 +0,0 @@
-<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" 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 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 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 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 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 class="command"><strong>xdg-desktop-menu</strong></span> the entries will be
- installed in addition to any already existing entries.
- </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 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 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 class="simpara">
- Remove applications or submenus from the desktop menu system
- 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 class="simpara">
- Force an update of the menu system.
- </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" 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 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 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 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 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>
- 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" 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
- <em class="replaceable"><code>Key</code></em>=<em class="replaceable"><code>Value</code></em> lines.
- </p><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
- <em class="replaceable"><code>Key</code></em>. This way one can specify different
- values for the same <em class="replaceable"><code>Key</code></em> depending on the
- currently selected language.
- </p><p>
- The following keys are often used:
- </p><div class="variablelist"><dl><dt><span class="term">Value=1.0</span></dt><dd>
- This is a mandatory field to indicate that the *.desktop file
- follows the 1.0 version of the specification.
- </dd><dt><span class="term">Type=Application</span></dt><dd>
- This is a mandatory field that indicates that the *.desktop file
- describes an application launcher.
- </dd><dt><span class="term">Name=<em class="replaceable"><code>Application Name</code></em></span></dt><dd>
- The name of the application.
- For example <span class="emphasis"><em>Mozilla</em></span>
- </dd><dt><span class="term">GenericName=<em class="replaceable"><code>Generic Name</code></em></span></dt><dd>
- A generic description of the application.
- For example <span class="emphasis"><em>Web Browser</em></span>
- </dd><dt><span class="term">Comment=<em class="replaceable"><code>Comment</code></em></span></dt><dd>
- Optional field to specify a tooltip for the application.
- For example <span class="emphasis"><em>Visit websites on the Internet</em></span>
- </dd><dt><span class="term">Icon=<em class="replaceable"><code>Icon File</code></em></span></dt><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 <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
- provided in several different sizes as well as in several
- differently themed styles.
- </dd><dt><span class="term">Exec=<em class="replaceable"><code>Command Line</code></em></span></dt><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.
- </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 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 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
- </p></dd><dt><span class="term">MimeType=<em class="replaceable"><code>Mimetypes</code></em></span></dt><dd>
- A list of mimetypes separated by semi-colons. This field is
- used to indicate which file types the application is able to
- open.
- </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" 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
- <span class="emphasis"><em>[Desktop Entry]</em></span> header followed by several
- <em class="replaceable"><code>Key</code></em>=<em class="replaceable"><code>Value</code></em> lines.
- </p><p>
- A *.directory file can provide a title (name) for the submenu
- in several different languages. This is done by adding a language
- code as used by LC_MESSAGES in square brackets behind the
- <em class="replaceable"><code>Key</code></em>. This way one can specify different
- values for the same <em class="replaceable"><code>Key</code></em> depending on the
- currently selected language.
- </p><p>
- The following keys are relevqnt for submenus:
- </p><div class="variablelist"><dl><dt><span class="term">Value=1.0</span></dt><dd>
- This is a mandatory field to indicate that the *.directory file
- follows the 1.0 version of the Desktop Entry specification.
- </dd><dt><span class="term">Type=Directory</span></dt><dd>
- This is a mandatory field that indicates that the *.directory file
- describes a submenu.
- </dd><dt><span class="term">Name=<em class="replaceable"><code>Menu Name</code></em></span></dt><dd>
- The title of submenu.
- For example <span class="emphasis"><em>Mozilla</em></span>
- </dd><dt><span class="term">Comment=<em class="replaceable"><code>Comment</code></em></span></dt><dd>
- Optional field to specify a tooltip for the submenu.
- </dd><dt><span class="term">Icon=<em class="replaceable"><code>Icon File</code></em></span></dt><dd>
- The icon to use for the submenu. 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 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" 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
- makes xdg-desktop-menu 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" 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>
- 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" 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>,
- <span class="citerefentry"><span class="refentrytitle">xdg-mime</span>(1)</span>
- </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.
- In order to add the application to the menu there needs to be a
- .desktop file with a suitable <span class="emphasis"><em>Categories</em></span> entry:
-</p><pre class="programlisting">
-shinythings-webmirror.desktop:
-
- [Desktop Entry]
- Encoding=UTF-8
- Type=Application
-
- Exec=webmirror
- Icon=webmirror
-
- Name=WebMirror
- Name[nl]=WebSpiegel
-
- Categories=Network;WebDevelopment;
-</pre><p>
- </p><p>Now the xdg-desktop-menu tool can be used to add the
- shinythings-webmirror.desktop file to the desktop application menu:
-</p><pre class="programlisting">
-xdg-desktop-menu install ./shinythings-webmirror.desktop
-</pre><p>
- </p><p>
- Note that for the purpose of this example the menu items are available
- in two languages, English and Dutch.
- The language code for Dutch is nl.
- </p><p>
- In the next example the company ShinyThings Inc. will add its own
- submenu to the desktop application menu consisting of a
- "WebMirror" menu item and a "WebMirror Admin Tool" menu item.
- </p><p>
- First the company needs to create two .desktop files that describe
- the two menu items. Since the items are to be added to a new submenu
- it is not necassery to include a Categories= line:
-</p><pre class="programlisting">
-shinythings-webmirror.desktop:
-
- [Desktop Entry]
- Encoding=UTF-8
- Type=Application
-
- Exec=webmirror
- Icon=shinythings-webmirror
-
- Name=WebMirror
- Name[nl]=WebSpiegel
-
-
-shinythings-webmirror-admin.desktop:
-
- [Desktop Entry]
- Encoding=UTF-8
- Type=Application
-
- Exec=webmirror-admintool
- Icon=shinythings-webmirror-admintool
-
- Name=WebMirror Admin Tool
- Name[nl]=WebSpiegel Administratie Tool
-</pre><p>
- </p><p>
- In addition a .directory file needs to be created to provide a title and icon
- for the sub-menu itself:
-</p><pre class="programlisting">
-shinythings-webmirror.directory:
-
- [Desktop Entry]
- Encoding=UTF-8
-
- Icon=shinythings-webmirror-menu
-
- Name=WebMirror
- Name[nl]=WebSpiegel
-</pre><p>
- </p><p>
- These file can now be installed with:
-</p><pre class="programlisting">
-xdg-desktop-menu install ./shinythings-webmirror.directory \
- ./shinythings-webmirror.desktop ./shinythings-webmirror-admin.desktop
-</pre><p>
- </p><p>
- The menu entries could also be installed one by one:
-</p><pre class="programlisting">
-xdg-desktop-menu install --noupdate ./shinythings-webmirror.directory \
- ./shinythings-webmirror.desktop
-xdg-desktop-menu install --noupdate ./shinythings-webmirror.directory \
- ./shinythings-webmirror-admin.desktop
-xdg-desktop-menu forceupdate
-</pre><p>
- </p><p>
- Although the result is the same it is slightly more efficient to
- install all files at the same time.
- </p><p>
- The *.desktop and *.directory files reference icons with the names
- webmirror, webmirror-admin and webmirror-menu which should also be
- installed. In this example the icons are installed in two different
- sizes, once with a size of 22x22 pixels and once with a size
- of 64x64 pixels:
-</p><pre class="programlisting">
-xdg-icon-resource install --size 22 ./wmicon-22.png shinythings-webmirror
-xdg-icon-resource install --size 22 ./wmicon-menu-22.png shinythings-webmirror-menu
-xdg-icon-resource install --size 22 ./wmicon-admin-22.png shinythings-webmirror-admin
-xdg-icon-resource install --size 64 ./wmicon-64.png shinythings-webmirror
-xdg-icon-resource install --size 64 ./wmicon-menu-64.png shinythings-webmirror-menu
-xdg-icon-resource install --size 64 ./wmicon-admin-64.png shinythings-webmirror-admin
-</pre><p>
- </p></div></div></body></html>
diff --git a/scripts/html/xdg-email.html b/scripts/html/xdg-email.html
deleted file mode 100644
index a3854af..0000000
--- a/scripts/html/xdg-email.html
+++ /dev/null
@@ -1,89 +0,0 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-email</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-email"><a name="xdg-email"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-email — command line tool for sending mail using the user's preferred e-mail composer</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-email</code> [<code class="option">--utf8</code>] [<code class="option">--cc</code> <em class="replaceable"><code>address</code></em>] [<code class="option">--bcc</code> <em class="replaceable"><code>address</code></em>] [<code class="option">--subject</code> <em class="replaceable"><code>text</code></em>] [<code class="option">--body</code> <em class="replaceable"><code>text</code></em>] [<code class="option">--attach</code> <em class="replaceable"><code>file</code></em>] [ <em class="replaceable"><code>mailto-uri</code></em> | <em class="replaceable"><code>address(es)</code></em> ]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-email</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>
- xdg-email opens the user's preferred e-mail composer in order to send
- a mail to <em class="replaceable"><code>address(es)</code></em> or
- <em class="replaceable"><code>mailto-uri</code></em>. RFC2368 defines mailto:
- URIs. xdg-email limits support to, cc, subject and body fields in
- <em class="replaceable"><code>mailto-uri</code></em>, all other fields are silently
- ignored. <em class="replaceable"><code>address(es)</code></em> must follow the
- syntax of RFC822. Multiple addresses may be provided as
- separate arguments.
- </p><p>
- All information provided on the command line is used to
- prefill corresponding fields in the user's e-mail composer. The user
- will have the opportunity to change any of this information before
- actually sending the e-mail.
- </p><p>
- xdg-email is for use inside a desktop session only.
- It is not recommended to use xdg-email as root.
- </p><p>
- See http://portland.freedesktop.org/EmailConfig for information on
- how the user can change the e-mail composer that is used.
- </p></div><div class="refsect1" title="Options"><a name="options"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--utf8</code></span></dt><dd>
- Indicates that all command line options that follow are in utf8.
- Without this option, command line options are expected to be
- encoded according to locale.
- If the locale already specifies utf8 this option has no effect.
- This option does not affect mailto URIs that are passed on the
- command line.
- </dd><dt><span class="term"><code class="option">--cc</code> <em class="replaceable"><code>address</code></em></span></dt><dd>
- Specify a recipient to be copied on the e-mail.
- </dd><dt><span class="term"><code class="option">--bcc</code> <em class="replaceable"><code>address</code></em></span></dt><dd>
- Specify a recipient to be blindly copied on the e-mail.
- </dd><dt><span class="term"><code class="option">--subject</code> <em class="replaceable"><code>text</code></em></span></dt><dd>
- Specify a subject for the e-mail.
- </dd><dt><span class="term"><code class="option">--body</code> <em class="replaceable"><code>text</code></em></span></dt><dd>
- Specify a body for the e-mail. Since the user will be able to
- make changes before actually sending the e-mail, this can be
- used to provide the user with a template for the e-mail.
- <em class="replaceable"><code>text</code></em> may contain linebreaks.
- </dd><dt><span class="term"><code class="option">--attach</code> <em class="replaceable"><code>file</code></em></span></dt><dd><p class="simpara">
- Specify an attachment for the e-mail. <em class="replaceable"><code>file</code></em>
- must point to an existing file.
- </p><p class="simpara">
- Some e-mail applications require the file to remain present
- after xdg-email returns.
- </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" title="Environment Variables"><a name="env_vars"></a><h2>Environment Variables</h2><p>
- xdg-email 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-email do more verbose reporting on stderr.
- Setting a higher value increases the verbosity.
- </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>
- 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" title="Configuration"><a name="configuration"></a><h2>Configuration</h2><p>Visit http://portland.freedesktop.org/EmailConfig for information
- how to configure xdg-email to use the email client of your choice.
- </p></div><div class="refsect1" title="Examples"><a name="examples"></a><h2>Examples</h2><p>
-</p><pre class="programlisting">
-xdg-email 'Jeremy White <jwhite@example.com>'
-</pre><p>
- </p><p>
-</p><pre class="programlisting">
-xdg-email --attach /tmp/logo.png \
- --subject 'Logo contest' \
- --body 'Attached you find the logo for the contest.' \
- 'jwhite@example.com'
-</pre><p>
- </p><p>
-</p><pre class="programlisting">
-xdg-email --subject 'Your password is about to expire' \
- 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com'
-</pre><p>
- </p></div></div></body></html>
diff --git a/scripts/html/xdg-icon-resource.html b/scripts/html/xdg-icon-resource.html
deleted file mode 100644
index a734033..0000000
--- a/scripts/html/xdg-icon-resource.html
+++ /dev/null
@@ -1,128 +0,0 @@
-<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.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="xdg-icon-resource"><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" title="Synopsis"><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" title="Description"><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" title="Commands"><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" 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 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 class="simpara">
- 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 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">--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 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 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>
- 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" title="Environment Variables"><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" 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>
- 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" 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-desktop-menu</span>(1)</span>,
- <span class="citerefentry"><span class="refentrytitle">xdg-mime</span>(1)</span>
- </p></div><div class="refsect1" title="Examples"><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>
diff --git a/scripts/html/xdg-mime.html b/scripts/html/xdg-mime.html
deleted file mode 100644
index 53bb99c..0000000
--- a/scripts/html/xdg-mime.html
+++ /dev/null
@@ -1,145 +0,0 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-mime</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-mime"><a name="xdg-mime"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-mime — command line tool for querying information about file type handling
-and adding descriptions for new file types</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-mime</code> query { filetype | default } ... </p></div><div class="cmdsynopsis"><p><code class="command">xdg-mime</code> default <em class="replaceable"><code>application</code></em> <em class="replaceable"><code>mimetype(s)</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-mime</code> install [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>] [<code class="option">--novendor</code>] <em class="replaceable"><code>mimetypes-file</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-mime</code> uninstall [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>] <em class="replaceable"><code>mimetypes-file</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-mime</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-mime program can be used to query information about file types
- and to add descriptions for new file types.
- </p></div><div class="refsect1" title="Commands"><a name="commands"></a><h2>Commands</h2><div class="variablelist"><dl><dt><span class="term">query</span></dt><dd><p class="simpara">
- Returns information related to file types.
- </p><p class="simpara">
- The <span class="emphasis"><em>query</em></span> option is for use inside a desktop session only.
- It is not recommended to use xdg-mime query as root.
- </p><p class="simpara">
- The following queries are supported:
- </p><p class="simpara">query filetype <em class="replaceable"><code>FILE</code></em>:
- Returns the file type of <em class="replaceable"><code>FILE</code></em> in the form of a MIME type.
- </p><p class="simpara">query default <em class="replaceable"><code>mimetype</code></em>:
- Returns the default application that the desktop environment uses for opening
- files of type <em class="replaceable"><code>mimetype</code></em>. The default application is
- identified by its *.desktop file.
- </p></dd><dt><span class="term">default</span></dt><dd><p class="simpara">
- Ask the desktop environment to make <em class="replaceable"><code>application</code></em>
- the default application for opening
- files of type <em class="replaceable"><code>mimetype</code></em>. An
- application can be made the default for several file types by
- specifying multiple mimetypes.
- </p><p class="simpara">
- <em class="replaceable"><code>application</code></em> is the desktop file
- id of the application and has the form vendor-name.desktop
- <em class="replaceable"><code>application</code></em> must already be installed
- in the desktop menu before it can be made the default handler.
- The aplication's desktop file must list support for all the
- MIME types that it wishes to be the default handler for.
- </p><p class="simpara">
- Requests to make an application a default handler may be
- subject to system policy or approval by the end-user. xdg-mime
- query can be used to verify whether an application is the
- actual default handler for a specific file type.
- </p><p class="simpara">
- The <span class="emphasis"><em>default</em></span> option is for use inside a desktop session only.
- It is not recommended to use xdg-mime default as root.
- </p></dd><dt><span class="term">install</span></dt><dd>
- Adds the file type descriptions provided in <em class="replaceable"><code>mimetypes-file</code></em>
- to the desktop environment. <em class="replaceable"><code>mimetypes-file</code></em>
- must be a XML file that follows the freedesktop.org
- Shared MIME-info Database specification
- and that has a mime-info element as its document root. For
- each new file type one or more icons with name
- <em class="replaceable"><code>type</code></em>-<em class="replaceable"><code>subtype</code></em>
- must be installed with the <span class="command"><strong>xdg-icon-resource</strong></span>
- command in the <span class="emphasis"><em>mimetypes</em></span> context. For example the
- filetype application/vnd.oasis.opendocument.text requires an
- icon named application-vnd.oasis.opendocument.text
- to be installed (unless the file type recommends another icon name).
- </dd><dt><span class="term">uninstall</span></dt><dd>
- Removes the file type descriptions provided in <em class="replaceable"><code>mimetypes-file</code></em>
- and previously added with <span class="command"><strong>xdg-mime install</strong></span> from the
- desktop environment. <em class="replaceable"><code>mimetypes-file</code></em>
- must be a XML file that follows the freedesktop.org
- Shared MIME-info Database specification
- and that has a mime-info element as its document root.
- </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">--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 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">--novendor</code></span></dt><dd><p class="simpara">
- Normally, xdg-mime checks to ensure that the
- <em class="replaceable"><code>mimetypes-file</code></em> to be installed
- has a proper vendor prefix. This option can be
- used to disable that check.
- </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">--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" title="Environment Variables"><a name="env_vars"></a><h2>Environment Variables</h2><p>
- xdg-mime 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-mime 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" 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>
- 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" title="See Also"><a name="seealso"></a><h2>See Also</h2><p><span class="citerefentry"><span class="refentrytitle">xdg-icon-resource</span>(1)</span>,
- <span class="citerefentry"><span class="refentrytitle">xdg-desktop-menu</span>(1)</span>
- </p></div><div class="refsect1" title="Examples"><a name="examples"></a><h2>Examples</h2><p>
-</p><pre class="programlisting">
-xdg-mime query filetype /tmp/foobar.png
-</pre><p>Prints the MIME type of the file /tmp/foobar.png, in this
-case image/png
- </p><p>
-</p><pre class="programlisting">
-xdg-mime query default image/png
-</pre><p>Prints the .desktop filename of the application which is
- registered to open PNG files.
- </p><p>
-</p><pre class="programlisting">
-xdg-mime install shinythings-shiny.xml
-</pre><p>Adds a file type description for "shiny"-files.
- "shinythings-" is used as the vendor prefix.
- The file type description could look as folows.
-</p><pre class="programlisting">
-shinythings-shiny.xml:
-
-<?xml version="1.0"?>
-<mime-info xmlns='http://www.freedesktop.org/standards/shared-mime-info'>
- <mime-type type="text/x-shiny">
- <comment>Shiny new file type</comment>
- <glob pattern="*.shiny"/>
- <glob pattern="*.shi"/>
- </mime-type>
-</mime-info>
-</pre><p>An icon for this new file type must also be installed, for
-example with:
-</p><pre class="programlisting">
-xdg-icon-resource install --context mimetypes --size 64 shiny-file-icon.png text-x-shiny
-</pre><p>
- </p></div></div></body></html>
diff --git a/scripts/html/xdg-open.html b/scripts/html/xdg-open.html
deleted file mode 100644
index 2433500..0000000
--- a/scripts/html/xdg-open.html
+++ /dev/null
@@ -1,38 +0,0 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-open</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-open"><a name="xdg-open"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-open — opens a file or URL in the user's preferred application</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-open</code> { <code class="option"><em class="replaceable"><code>file</code></em></code> | <code class="option"><em class="replaceable"><code>URL</code></em></code> }</p></div><div class="cmdsynopsis"><p><code class="command">xdg-open</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>
- xdg-open opens a file or URL in the user's preferred application.
- If a URL is provided the URL will be opened in the user's preferred
- web browser. If a file is provided the file will be opened in the
- preferred application for files of that type. xdg-open supports
- file, ftp, http and https URLs.
- </p><p>
- xdg-open is for use inside a desktop session only.
- It is not recommended to use xdg-open as root.
- </p></div><div class="refsect1" title="Options"><a name="options"></a><h2>Options</h2><div class="variablelist"><dl><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" 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>
- 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></dl></div></div><div class="refsect1" title="Examples"><a name="examples"></a><h2>Examples</h2><p>
-</p><pre class="programlisting">
-xdg-open 'http://www.freedesktop.org/'
-</pre><p>
- Opens the Freedesktop.org website in the user's default browser
- </p><p>
-</p><pre class="programlisting">
-xdg-open /tmp/foobar.png
-</pre><p>
- Opens the PNG image file /tmp/foobar.png in the user's default image
- viewing application.
- </p></div></div></body></html>
diff --git a/scripts/html/xdg-screensaver.html b/scripts/html/xdg-screensaver.html
deleted file mode 100644
index 219f48c..0000000
--- a/scripts/html/xdg-screensaver.html
+++ /dev/null
@@ -1,63 +0,0 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-screensaver</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-screensaver"><a name="xdg-screensaver"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-screensaver — command line tool for controlling the screensaver</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-screensaver</code> <code class="option">suspend <em class="replaceable"><code>WindowID</code></em></code> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-screensaver</code> <code class="option">resume <em class="replaceable"><code>WindowID</code></em></code> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-screensaver</code> { <code class="option">activate</code> | <code class="option">lock</code> | <code class="option">reset</code> | <code class="option">status</code> }</p></div><div class="cmdsynopsis"><p><code class="command">xdg-screensaver</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>
- xdg-screensaver provides commands to control the screensaver.
- </p><p>
- xdg-screensaver is for use inside a desktop session only.
- It is not recommended to use xdg-screensaver as root.
- </p></div><div class="refsect1" title="Commands"><a name="commands"></a><h2>Commands</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">suspend <em class="replaceable"><code>WindowID</code></em></code></span></dt><dd><p class="simpara">
- Suspends the screensaver and monitor power management.
- <em class="replaceable"><code>WindowID</code></em> must be the X Window ID
- of an existing window of the calling application. The window
- must remain in existance for the duration of the suspension.
- </p><p class="simpara">
- WindowID can be represented as either a decimal number
- or as a hexadecimal number consisting of the prefix
- <span class="emphasis"><em>0x</em></span> followed by one or more hexadecimal
- digits.
- </p><p class="simpara">
- The screensaver can be suspended in relation to multiple
- windows at the same time. In that case screensaver
- operation is only restored once the screensaver has been
- resumed in relation to each of the windows
- </p></dd><dt><span class="term"><code class="option">resume <em class="replaceable"><code>WindowID</code></em></code></span></dt><dd>
- Resume the screensaver and monitor power management after being
- suspended.
- <em class="replaceable"><code>WindowID</code></em>
- must be the same X Window ID that was passed to a previous call
- of <span class="command"><strong>xdg-screensaver suspend</strong></span>
- </dd><dt><span class="term"><code class="option">activate</code></span></dt><dd>
- Turns the screensaver on immediately. This may result in the
- screen getting locked, depending on existing system policies.
- </dd><dt><span class="term"><code class="option">lock</code></span></dt><dd>
- Lock the screen immediately.
- </dd><dt><span class="term"><code class="option">reset</code></span></dt><dd>
- Turns the screensaver off immediately. If the screen was locked
- the user may be asked to authenticate first.
- </dd><dt><span class="term"><code class="option">status</code></span></dt><dd>
- Prints <span class="emphasis"><em>enabled</em></span> to stdout if the
- screensaver is enabled to turn on after a period of
- inactivity and prints
- <span class="emphasis"><em>disabled</em></span> if the screensaver is
- not enabled.
- </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">--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" 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>
- Error in command line syntax.
- </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></dl></div></div><div class="refsect1" title="Examples"><a name="examples"></a><h2>Examples</h2><p>
-</p><pre class="programlisting">
-xdg-screensaver suspend 0x1c00007
-</pre><p>Causes the screensaver to be disabled till
- <span class="command"><strong>xdg-screensaver resume 0x1c00007</strong></span> is called.
- <span class="emphasis"><em>0x1c00007</em></span> must be the X Window ID of an
- existing window.
- </p></div></div></body></html>
diff --git a/scripts/html/xdg-settings.html b/scripts/html/xdg-settings.html
deleted file mode 100644
index 380ad2a..0000000
--- a/scripts/html/xdg-settings.html
+++ /dev/null
@@ -1,59 +0,0 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-settings</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-settings"><a name="xdg-settings"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-settings — get various settings from the desktop environment</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-settings</code> { <code class="option"><em class="replaceable"><code>get</code></em></code> | <code class="option"><em class="replaceable"><code>check</code></em></code> | <code class="option"><em class="replaceable"><code>set</code></em></code> } {<code class="option">property</code>} [<code class="option">subproperty</code>] [<code class="option">value</code>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-settings</code> { <code class="option">--help</code> | <code class="option">--list</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>
- xdg-settings gets various settings from the desktop environment.
- For instance, desktop environments often provide proxy configuration
- and default web browser settings. Using xdg-settings these parameters
- can be extracted for use by applications that do not use the desktop
- environment's libraries (which would use the settings natively).
- </p><p>
- xdg-settings is for use inside a desktop session only.
- It is not recommended to use xdg-settings as root.
- </p></div><div class="refsect1" title="Options"><a name="options"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--help</code></span></dt><dd>
- Show command synopsis.
- </dd><dt><span class="term"><code class="option">--list</code></span></dt><dd>
- List all properties xdg-settings knows about.
- </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" title="Properties"><a name="properties"></a><h2>Properties</h2><p>
- When using xdg-settings to get, check or set a destkop setting, properties
- and possibly sub-properties are used to specify the setting to be changed.
- </p><p>
- Some properties (such as default-web-browser) fully describe the setting
- to be changed. Other properties (such as default-url-scheme-handler) require
- more information (in this case the actual scheme to set the default handler
- for) which must be provided in a sub-property.
- </p></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>
- 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></dl></div></div><div class="refsect1" title="Examples"><a name="examples"></a><h2>Examples</h2><p>
- Get the desktop file name of the current default web browser
- </p><pre class="programlisting">
- xdg-settings get default-web-browser
- </pre><p>
- </p><p>
- Check whether the default web browser is firefox.desktop, which can be
- false even if "get default-web-browser" says that is the current value
- (if only some of the underlying settings actually reflect that value)
- </p><pre class="programlisting">
- xdg-settings check default-web-browser firefox.desktop
- </pre><p>
- </p><p>
- Set the default web browser to google-chrome.desktop
- </p><pre class="programlisting">
- xdg-settings set default-web-browser google-chrome.desktop
- </pre><p>
- </p><p>
- Set the default mailto URL scheme handler to be evolution.desktop
- </p><pre class="programlisting">
- xdg-settings set default-url-scheme-handler mailto evolution.desktop
- </pre><p>
- </p></div></div></body></html>
--
2.1.0