diff options
author | Waldo Bastian <waldo.bastian@intel.com> | 2006-08-01 00:19:12 +0000 |
---|---|---|
committer | Waldo Bastian <waldo.bastian@intel.com> | 2006-08-01 00:19:12 +0000 |
commit | bd75e5b3d539846fcfbed02a0e07dfda43340ea6 (patch) | |
tree | 0eb461f0adcaf0abb06b272e6d01cc2fb22c19f8 /scripts/html | |
parent | c5958cf86b5d795ac9cec7672be00d181ff65345 (diff) |
Replace --vendor with an implicit check for a vendor prefix and --novendor
to override.
Diffstat (limited to 'scripts/html')
-rw-r--r-- | scripts/html/xdg-desktop-icon.html | 24 | ||||
-rw-r--r-- | scripts/html/xdg-desktop-menu.html | 62 | ||||
-rw-r--r-- | scripts/html/xdg-email.html | 2 | ||||
-rw-r--r-- | scripts/html/xdg-icon-resource.html | 21 | ||||
-rw-r--r-- | scripts/html/xdg-mime.html | 37 | ||||
-rw-r--r-- | scripts/html/xdg-open.html | 2 | ||||
-rw-r--r-- | scripts/html/xdg-screensaver.html | 7 | ||||
-rw-r--r-- | scripts/html/xdg-su.html | 2 |
8 files changed, 98 insertions, 59 deletions
diff --git a/scripts/html/xdg-desktop-icon.html b/scripts/html/xdg-desktop-icon.html index be8d0fc..e3b55b9 100644 --- a/scripts/html/xdg-desktop-icon.html +++ b/scripts/html/xdg-desktop-icon.html @@ -1,4 +1,4 @@ -<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.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><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"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-desktop-icon</code> install [<code class="option">--vendor <em class="replaceable"><code>vendor-id</code></em></code>] <em class="replaceable"><code>FILE</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-desktop-icon</code> uninstall [<code class="option">--vendor <em class="replaceable"><code>vendor-id</code></em></code>] <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" 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-icon</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-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"><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" lang="en"><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> @@ -13,10 +13,18 @@ </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" lang="en"><a name="options"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--vendor</code> <em class="replaceable"><code>vendor-id</code></em></span></dt><dd> - Adds <em class="replaceable"><code>vendor-id</code></em> as a prefix when installing desktop - files. - </dd><dt><span class="term"><code class="option">--help</code></span></dt><dd> + </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">--novendor</code></span></dt><dd><p> + 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> + 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. @@ -101,14 +109,14 @@ In order to add the application to the desktop there needs to be a .desktop file for the application: </p><pre class="programlisting"> -webmirror.desktop: +shinythings-webmirror.desktop: [Desktop Entry] Encoding=UTF-8 Type=Application Exec=webmirror - Icon=webmirror + Icon=shinythings-webmirror Name=WebMirror Name[nl]=WebSpiegel @@ -116,7 +124,7 @@ webmirror.desktop: </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 --vendor shinythings ./webmirror.desktop +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"> diff --git a/scripts/html/xdg-desktop-menu.html b/scripts/html/xdg-desktop-menu.html index b289902..9d5b9c4 100644 --- a/scripts/html/xdg-desktop-menu.html +++ b/scripts/html/xdg-desktop-menu.html @@ -1,4 +1,4 @@ -<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.68.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">--vendor <em class="replaceable"><code>vendor-id</code></em></code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>] { <em class="replaceable"><code>desktop-file</code></em> | <em class="replaceable"><code>menu-file</code></em> | <em class="replaceable"><code>directory-file</code></em> }</p></div><div class="cmdsynopsis"><p><code class="command">xdg-desktop-menu</code> uninstall [<code class="option">--noupdate</code>] [<code class="option">--vendor <em class="replaceable"><code>vendor-id</code></em></code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>] { <em class="replaceable"><code>desktop-file</code></em> | <em class="replaceable"><code>menu-file</code></em> | <em class="replaceable"><code>directory-file</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.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>desktop-file</code></em> | <em class="replaceable"><code>menu-file</code></em> | <em class="replaceable"><code>directory-file</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>desktop-file</code></em> | <em class="replaceable"><code>menu-file</code></em> | <em class="replaceable"><code>directory-file</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> The xdg-desktop-menu program can be used to install new items to the desktop's application menu. </p><p> @@ -31,10 +31,18 @@ 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">--vendor</code> <em class="replaceable"><code>vendor-id</code></em></span></dt><dd> - Adds <em class="replaceable"><code>vendor-id</code></em> as a prefix when installing desktop - and directory files. - </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 + </dd><dt><span class="term"><code class="option">--novendor</code></span></dt><dd><p> + Normally, xdg-desktop-menu checks to ensure that any *.desktop, + *.directory and *.menu files to be installed has + a vendor prefix. This option can be used to disable that check. + </p><p> + A vendor prefix consists of alpha characters ([a-zA-Z]) and is + terminated with a dash ("-"). + Companies and organizations are encouraged to use a word + or phrase, preferably the organizations name, for which they hold + a trademark as their vendor prefix. + The purpose of the vendor prefix is to prevent name conflicts. + </p></dd><dt><span class="term"><code class="option">--mode</code> <em class="replaceable"><code>mode</code></em></span></dt><dd><p><em class="replaceable"><code>mode</code></em> can be <span class="emphasis"><em>user</em></span> or <span class="emphasis"><em>system</em></span>. In user mode the file is (un)installed for the current user only. In system mode the file is (un)installed for all users @@ -140,7 +148,7 @@ 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"> -webmirror.desktop: +shinythings-webmirror.desktop: [Desktop Entry] Encoding=UTF-8 @@ -154,10 +162,10 @@ webmirror.desktop: Categories=Network;WebDevelopment; </pre><p> - </p><p>Now the xdg-desktop-menu tool can be used to add the webmirror.desktop file - to the desktop application menu: + </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 --vendor shinythings ./webmirror.desktop +xdg-desktop-menu install ./shinythings-webmirror.desktop </pre><p> </p><p> Note that for the purpose of this example the menu items are available @@ -172,27 +180,27 @@ xdg-desktop-menu install --vendor shinythings ./webmirror.desktop First the company needs to create two .desktop files that describe the two menu items, this time no Categories item is needed: </p><pre class="programlisting"> -webmirror.desktop: +shinythings-webmirror.desktop: [Desktop Entry] Encoding=UTF-8 Type=Application Exec=webmirror - Icon=webmirror + Icon=shinythings-webmirror Name=WebMirror Name[nl]=WebSpiegel -webmirror-admin.desktop: +shinythings-webmirror-admin.desktop: [Desktop Entry] Encoding=UTF-8 Type=Application Exec=webmirror-admintool - Icon=webmirror-admintool + Icon=shinythings-webmirror-admintool Name=WebMirror Admin Tool Name[nl]=WebSpiegel Administratie Tool @@ -200,8 +208,8 @@ webmirror-admin.desktop: </p><p> The files can be installed with: </p><pre class="programlisting"> -xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.desktop -xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror-admin.desktop +xdg-desktop-menu install --noupdate ./shinythings-webmirror.desktop +xdg-desktop-menu install --noupdate ./shinythings-webmirror-admin.desktop </pre><p> </p><p> Because multiple items are added the <code class="option">--noupdate</code> @@ -210,12 +218,12 @@ xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror-admin.deskt In addition a .directory file needs to be created to provide a title and icon for the sub-menu itself: </p><pre class="programlisting"> -webmirror.directory: +shinythings-webmirror.directory: [Desktop Entry] Encoding=UTF-8 - Icon=webmirror-menu + Icon=shinythings-webmirror-menu Name=WebMirror Name[nl]=WebSpiegel @@ -223,7 +231,7 @@ webmirror.directory: </p><p> This webmirror.directory file can be installed with: </p><pre class="programlisting"> -xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.directory +xdg-desktop-menu install --noupdate ./shinythings-webmirror.directory </pre><p> </p><p> The *.desktop and *.directory files reference icons with the names @@ -232,18 +240,18 @@ xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.directory 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 webmirror.png -xdg-icon-resource install --size 22 ./wmicon-menu-22.png webmirror-menu.png -xdg-icon-resource install --size 22 ./wmicon-admin-22.png webmirror-admin.png -xdg-icon-resource install --size 64 ./wmicon-64.png webmirror.png -xdg-icon-resource install --size 64 ./wmicon-menu-64.png webmirror-menu.png -xdg-icon-resource install --size 64 ./wmicon-admin-64.png webmirror-admin.png +xdg-icon-resource install --size 22 ./wmicon-22.png shinythings-webmirror.png +xdg-icon-resource install --size 22 ./wmicon-menu-22.png shinythings-webmirror-menu.png +xdg-icon-resource install --size 22 ./wmicon-admin-22.png shinythings-webmirror-admin.png +xdg-icon-resource install --size 64 ./wmicon-64.png shinythings-webmirror.png +xdg-icon-resource install --size 64 ./wmicon-menu-64.png shinythings-webmirror-menu.png +xdg-icon-resource install --size 64 ./wmicon-admin-64.png shinythings-webmirror-admin.png </pre><p> </p><p> The last step is to provide a .menu file that links it all togther: </p><pre class="programlisting"> -webmirror.menu: +shinythings-webmirror.menu: <!DOCTYPE Menu PUBLIC "-//freedesktop//DTD Menu 1.0//EN" "http://www.freedesktop.org/standards/menu-spec/menu-1.0.dtd"> @@ -260,9 +268,9 @@ webmirror.menu: </Menu> </pre><p> </p><p> - The webmirror.menu file can be installed with: + The shinythings-webmirror.menu file can be installed with: </p><pre class="programlisting"> -xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.menu +xdg-desktop-menu install --noupdate ./shinythings-webmirror.menu </pre><p> </p><p> After installing multiple files with <code class="option">--noupdate</code> make sure diff --git a/scripts/html/xdg-email.html b/scripts/html/xdg-email.html index d8e343b..ed80892 100644 --- a/scripts/html/xdg-email.html +++ b/scripts/html/xdg-email.html @@ -1,4 +1,4 @@ -<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.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><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"><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" 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-email</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-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"><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" lang="en"><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: diff --git a/scripts/html/xdg-icon-resource.html b/scripts/html/xdg-icon-resource.html index a866f76..0bbd1f5 100644 --- a/scripts/html/xdg-icon-resource.html +++ b/scripts/html/xdg-icon-resource.html @@ -1,4 +1,4 @@ -<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.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="xdg-icon-resource"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-icon-resource — command line tool for (un)installing icon resources</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-icon-resource</code> install [<code class="option">--noupdate</code>] [<code class="option">--theme <em class="replaceable"><code>theme</code></em></code>] [<code class="option">--context <em class="replaceable"><code>context</code></em></code>] [<code class="option">--size <em class="replaceable"><code>size</code></em></code>] [<code class="option">--mode <em class="replaceable"><code>mode</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">--size <em class="replaceable"><code>size</code></em></code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>] <em class="replaceable"><code>icon-name</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-icon-resource</code> forceupdate [<code class="option">--theme <em class="replaceable"><code>theme</code></em></code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-icon-resource</code> { <code class="option">--help</code> | <code class="option">--manual</code> | <code class="option">--version</code> }</p></div></div><div class="refsect1" lang="en"><a name="description"></a><h2>Description</h2><p> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-icon-resource</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="xdg-icon-resource"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-icon-resource — command line tool for (un)installing icon resources</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-icon-resource</code> install [<code class="option">--noupdate</code>] [<code class="option">--novendor</code>] [<code class="option">--theme <em class="replaceable"><code>theme</code></em></code>] [<code class="option">--context <em class="replaceable"><code>context</code></em></code>] [<code class="option">--size <em class="replaceable"><code>size</code></em></code>] [<code class="option">--mode <em class="replaceable"><code>mode</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">--size <em class="replaceable"><code>size</code></em></code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>] <em class="replaceable"><code>icon-name</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-icon-resource</code> forceupdate [<code class="option">--theme <em class="replaceable"><code>theme</code></em></code>] [<code class="option">--mode <em class="replaceable"><code>mode</code></em></code>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-icon-resource</code> { <code class="option">--help</code> | <code class="option">--manual</code> | <code class="option">--version</code> }</p></div></div><div class="refsect1" lang="en"><a name="description"></a><h2>Description</h2><p> The xdg-icon-resource program can be used to install icon resources into the desktop icon system in order to illustrate menu entries, to depict desktop icons or to graphically represent file types. @@ -34,7 +34,19 @@ added in sequence this flag can be used to indicate that additional changes will follow and that it is not necassery to update the desktop icon system right away. - </dd><dt><span class="term"><code class="option">--theme</code> <em class="replaceable"><code>theme</code></em></span></dt><dd> + </dd><dt><span class="term"><code class="option">--novendor</code></span></dt><dd><p> + Normally, xdg-icon-resource checks to ensure that an icon file + to be installed in the <span class="emphasis"><em>apps</em></span> context has + a proper vendor prefix. This option can be used to disable + that check. + </p><p> + A vendor prefix consists of alpha characters ([a-zA-Z]) and is + terminated with a dash ("-"). + Companies and organizations are encouraged to use a word + or phrase, preferably the organizations name, for which they hold + a trademark as their vendor prefix. + The purpose of the vendor prefix is to prevent name conflicts. + </p></dd><dt><span class="term"><code class="option">--theme</code> <em class="replaceable"><code>theme</code></em></span></dt><dd> Installs or removes the icon file as part of <em class="replaceable"><code>theme</code></em>. If no theme is specified the icons will be installed as part of the default <span class="emphasis"><em>hicolor</em></span> theme. @@ -95,9 +107,10 @@ <span class="citerefentry"><span class="refentrytitle">xdg-desktop-menu</span>(1)</span>, <span class="citerefentry"><span class="refentrytitle">xdg-mime</span>(1)</span> </p></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Examples</h2><p> -To install an icon resource to depict a launcher for the application myfoobar one can use: +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 myfoobar.png +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: diff --git a/scripts/html/xdg-mime.html b/scripts/html/xdg-mime.html index cd5f0e9..cd99a47 100644 --- a/scripts/html/xdg-mime.html +++ b/scripts/html/xdg-mime.html @@ -1,5 +1,5 @@ -<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.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><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"><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>] <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" 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-mime</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-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"><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" lang="en"><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" lang="en"><a name="commands"></a><h2>Commands</h2><div class="variablelist"><dl><dt><span class="term">query</span></dt><dd><p> @@ -65,7 +65,19 @@ and adding descriptions for new file types</p></div><div class="refsynopsisdiv"> </p><p> The default is to use system mode when called by root and to use user mode when called by a non-root user. - </p></dd><dt><span class="term"><code class="option">--help</code></span></dt><dd> + </p></dd><dt><span class="term"><code class="option">--novendor</code></span></dt><dd><p> + 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> + 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. @@ -105,23 +117,24 @@ xdg-mime query default image/png registered to open PNG files. </p><p> </p><pre class="programlisting"> -xdg-mime install diff.xml -</pre><p>Adds a file type description for "diff"-files. +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"> -diff.xml: +shinythings-shiny.xml: <?xml version="1.0"?> <mime-info xmlns='http://www.freedesktop.org/standards/shared-mime-info'> - <mime-type type="text/x-diff"> - <comment>Differences between files</comment> - <glob pattern="*.diff"/> - <glob pattern="*.patch"/> + <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 alsobe installed, for +</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 text-x-diff.png +xdg-icon-resource install --context mimetypes --size 64 text-x-shiny.png </pre><p> </p></div></div></body></html> diff --git a/scripts/html/xdg-open.html b/scripts/html/xdg-open.html index bbe3874..8c19e90 100644 --- a/scripts/html/xdg-open.html +++ b/scripts/html/xdg-open.html @@ -1,4 +1,4 @@ -<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.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><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"><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" 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-open</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-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"><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" lang="en"><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 diff --git a/scripts/html/xdg-screensaver.html b/scripts/html/xdg-screensaver.html index 1476780..e6fe4ee 100644 --- a/scripts/html/xdg-screensaver.html +++ b/scripts/html/xdg-screensaver.html @@ -1,4 +1,4 @@ -<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.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><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"><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">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" 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-screensaver</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-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"><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">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" lang="en"><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. @@ -48,8 +48,6 @@ 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> @@ -57,8 +55,7 @@ </dd></dl></div></div><div class="refsect1" lang="en"><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 +</pre><p>Causes the screensaver to be disabled till <span><strong class="command">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. diff --git a/scripts/html/xdg-su.html b/scripts/html/xdg-su.html index 8055384..7b8b9be 100644 --- a/scripts/html/xdg-su.html +++ b/scripts/html/xdg-su.html @@ -1,4 +1,4 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-su</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="xdg-su"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-su — run a GUI program as root after prompting for the root password</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-su</code> [<code class="option">-u <em class="replaceable"><code>user</code></em></code>] <code class="option">-c <em class="replaceable"><code>command</code></em></code> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-su</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-su</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-su"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-su — run a GUI program as root after prompting for the root password</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-su</code> [<code class="option">-u <em class="replaceable"><code>user</code></em></code>] <code class="option">-c <em class="replaceable"><code>command</code></em></code> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-su</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> xdg-su provides a graphical dialog that prompts the user for a password to run <em class="replaceable"><code>command</code></em> as <em class="replaceable"><code>user</code></em> or as root if no user was specified. |