diff options
Diffstat (limited to 'scripts')
34 files changed, 1751 insertions, 1807 deletions
diff --git a/scripts/README b/scripts/README index 8073b7a..f1d4d9e 100644 --- a/scripts/README +++ b/scripts/README @@ -1,21 +1,19 @@ - xdg-desktop-menu -- command line tool for (un)installing desktop menu - items +xdg-desktop-menu — command line tool for (un)installing desktop menu items - xdg-desktop-icon -- command line tool for (un)installing icons to the - desktop +xdg-desktop-icon — command line tool for (un)installing icons to the desktop - xdg-mime -- command line tool for querying information about file type - handling and adding descriptions for new file types +xdg-mime — command line tool for querying information about file type handling +and adding descriptions for new file types - xdg-icon-resource -- command line tool for (un)installing icon resources +xdg-icon-resource — command line tool for (un)installing icon resources - xdg-open -- opens a file or URL in the user's preferred application +xdg-open — opens a file or URL in the user's preferred application - xdg-email -- command line tool for sending mail using the user's preferred - e-mail composer +xdg-email — command line tool for sending mail using the user's preferred +e-mail composer xdg-su — run a GUI program as root after prompting for the root password - xdg-screensaver -- command line tool for controlling the screensaver +xdg-screensaver — command line tool for controlling the screensaver diff --git a/scripts/desc/xdg-desktop-icon.xml b/scripts/desc/xdg-desktop-icon.xml index 211c56e..63d9ef5 100644 --- a/scripts/desc/xdg-desktop-icon.xml +++ b/scripts/desc/xdg-desktop-icon.xml @@ -37,13 +37,12 @@ <cmdsynopsis> <command>xdg-desktop-icon</command> <arg choice="plain">install</arg> - <arg><option>--vendor <replaceable>vendor-id</replaceable></option></arg> + <arg><option>--novendor</option></arg> <arg choice="plain"><replaceable>FILE</replaceable></arg> </cmdsynopsis> <cmdsynopsis> <command>xdg-desktop-icon</command> <arg choice="plain">uninstall</arg> - <arg><option>--vendor <replaceable>vendor-id</replaceable></option></arg> <arg choice="plain"><replaceable>FILE</replaceable></arg> </cmdsynopsis> <cmdsynopsis> @@ -98,12 +97,21 @@ <title>Options</title> <variablelist> <varlistentry> - <term><option>--vendor</option> <replaceable>vendor-id</replaceable></term> + <term><option>--novendor</option></term> <listitem> <simpara> - Adds <replaceable>vendor-id</replaceable> as a prefix when installing desktop - files. + 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. </simpara> + <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. + </simpara> </listitem> </varlistentry> @@ -328,14 +336,14 @@ In order to add the application to the desktop there needs to be a .desktop file for the application: <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 @@ -344,7 +352,7 @@ webmirror.desktop: <para>Now the xdg-desktop-icon tool can be used to add the webmirror.desktop file to the desktop: <programlisting> -xdg-desktop-icon install --vendor shinythings ./webmirror.desktop +xdg-desktop-icon install ./shinythings-webmirror.desktop </programlisting> </para> <para>To add a README file to the desktop as well, the following command can be used: diff --git a/scripts/desc/xdg-desktop-menu.xml b/scripts/desc/xdg-desktop-menu.xml index 6f39a98..9168d75 100644 --- a/scripts/desc/xdg-desktop-menu.xml +++ b/scripts/desc/xdg-desktop-menu.xml @@ -38,7 +38,7 @@ <command>xdg-desktop-menu</command> <arg choice="plain">install</arg> <arg><option>--noupdate</option></arg> - <arg><option>--vendor <replaceable>vendor-id</replaceable></option></arg> + <arg><option>--novendor</option></arg> <arg><option>--mode <replaceable>mode</replaceable></option></arg> <group choice="req"> <arg choice="plain"><replaceable>desktop-file</replaceable></arg> @@ -50,7 +50,6 @@ <command>xdg-desktop-menu</command> <arg choice="plain">uninstall</arg> <arg><option>--noupdate</option></arg> - <arg><option>--vendor <replaceable>vendor-id</replaceable></option></arg> <arg><option>--mode <replaceable>mode</replaceable></option></arg> <group choice="req"> <arg choice="plain"><replaceable>desktop-file</replaceable></arg> @@ -150,12 +149,21 @@ </varlistentry> <varlistentry> - <term> <option>--vendor</option> <replaceable>vendor-id</replaceable></term> + <term><option>--novendor</option></term> <listitem> <simpara> - Adds <replaceable>vendor-id</replaceable> as a prefix when installing desktop - and directory files. + 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. </simpara> + <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. + </simpara> </listitem> </varlistentry> @@ -429,7 +437,7 @@ In order to add the application to the menu there needs to be a .desktop file with a suitable <emphasis>Categories</emphasis> entry: <programlisting> -webmirror.desktop: +shinythings-webmirror.desktop: [Desktop Entry] Encoding=UTF-8 @@ -444,10 +452,10 @@ webmirror.desktop: Categories=Network;WebDevelopment; </programlisting> </para> - <para>Now the xdg-desktop-menu tool can be used to add the webmirror.desktop file - to the desktop application menu: + <para>Now the xdg-desktop-menu tool can be used to add the + shinythings-webmirror.desktop file to the desktop application menu: <programlisting> -xdg-desktop-menu install --vendor shinythings ./webmirror.desktop +xdg-desktop-menu install ./shinythings-webmirror.desktop </programlisting> </para> <para> @@ -465,27 +473,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: <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 @@ -494,8 +502,8 @@ webmirror-admin.desktop: <para> The files can be installed with: <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 </programlisting> </para> <para> @@ -506,12 +514,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: <programlisting> -webmirror.directory: +shinythings-webmirror.directory: [Desktop Entry] Encoding=UTF-8 - Icon=webmirror-menu + Icon=shinythings-webmirror-menu Name=WebMirror Name[nl]=WebSpiegel @@ -520,7 +528,7 @@ webmirror.directory: <para> This webmirror.directory file can be installed with: <programlisting> -xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.directory +xdg-desktop-menu install --noupdate ./shinythings-webmirror.directory </programlisting> </para> <para> @@ -530,19 +538,19 @@ 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: <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 </programlisting> </para> <para> The last step is to provide a .menu file that links it all togther: <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"> @@ -560,9 +568,9 @@ webmirror.menu: </programlisting> </para> <para> - The webmirror.menu file can be installed with: + The shinythings-webmirror.menu file can be installed with: <programlisting> -xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.menu +xdg-desktop-menu install --noupdate ./shinythings-webmirror.menu </programlisting> </para> <para> diff --git a/scripts/desc/xdg-icon-resource.xml b/scripts/desc/xdg-icon-resource.xml index acb3649..04737b1 100644 --- a/scripts/desc/xdg-icon-resource.xml +++ b/scripts/desc/xdg-icon-resource.xml @@ -38,6 +38,7 @@ <command>xdg-icon-resource</command> <arg choice="plain">install</arg> <arg><option>--noupdate</option></arg> + <arg><option>--novendor</option></arg> <arg><option>--theme <replaceable>theme</replaceable></option></arg> <arg><option>--context <replaceable>context</replaceable></option></arg> <arg><option>--size <replaceable>size</replaceable></option></arg> @@ -147,6 +148,25 @@ </simpara> </listitem> </varlistentry> + <varlistentry> + <term><option>--novendor</option></term> + <listitem> + <simpara> + Normally, xdg-icon-resource checks to ensure that an icon file + to be installed in the <emphasis>apps</emphasis> context has + a proper vendor prefix. This option can be used to disable + that check. + </simpara> + <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. + </simpara> + </listitem> + </varlistentry> <varlistentry> <term><option>--theme</option> <replaceable>theme</replaceable></term> @@ -322,9 +342,10 @@ <refsect1 id="examples"> <title>Examples</title> <para> -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: <programlisting> -xdg-icon-resource install --size 64 myfoobar.png +xdg-icon-resource install --size 64 shinythings-myfoobar.png </programlisting> </para> <para> diff --git a/scripts/desc/xdg-mime.xml b/scripts/desc/xdg-mime.xml index 22978c8..603cf41 100644 --- a/scripts/desc/xdg-mime.xml +++ b/scripts/desc/xdg-mime.xml @@ -54,6 +54,7 @@ and adding descriptions for new file types</refpurpose> <command>xdg-mime</command> <arg choice="plain">install</arg> <arg><option>--mode <replaceable>mode</replaceable></option></arg> + <arg><option>--novendor</option></arg> <arg choice="plain"><replaceable>mimetypes-file</replaceable></arg> </cmdsynopsis> <cmdsynopsis> @@ -192,6 +193,25 @@ and adding descriptions for new file types</refpurpose> </simpara> </listitem> </varlistentry> + <varlistentry> + <term><option>--novendor</option></term> + <listitem> + <simpara> + Normally, xdg-mime checks to ensure that the + <replaceable>mimetypes-file</replaceable> to be installed + has a proper vendor prefix. This option can be + used to disable that check. + </simpara> + <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. + </simpara> + </listitem> + </varlistentry> <varlistentry> <term><option>--help</option></term> @@ -317,24 +337,25 @@ xdg-mime query default image/png </para> <para> <programlisting> -xdg-mime install diff.xml -</programlisting>Adds a file type description for "diff"-files. +xdg-mime install shinythings-shiny.xml +</programlisting>Adds a file type description for "shiny"-files. + "shinythings-" is used as the vendor prefix. The file type description could look as folows. <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> -</programlisting>An icon for this new file type must alsobe installed, for +</programlisting>An icon for this new file type must also be installed, for example with: <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 </programlisting> </para> </refsect1> 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. diff --git a/scripts/man/xdg-desktop-icon.1 b/scripts/man/xdg-desktop-icon.1 index 88d015b..dc9076f 100644 --- a/scripts/man/xdg-desktop-icon.1 +++ b/scripts/man/xdg-desktop-icon.1 @@ -1,203 +1,158 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-DESKTOP-ICON" 1 "" "" "xdg-desktop-icon Manual" -.SH NAME -xdg-desktop-icon \- command line tool for (un)installing icons to the desktop -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XDG\-DESKTOP\-ICON" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-desktop\-icon \- command line tool for (un)installing icons to the desktop +.SH "SYNOPSIS" .HP 17 -\fBxdg\-desktop\-icon\fR install [\fB\-\-vendor\ \fIvendor\-id\fR\fR] \fIFILE\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-desktop\-icon\fR install [\fB\-\-novendor\fR] \fIFILE\fR .HP 17 -\fBxdg\-desktop\-icon\fR uninstall [\fB\-\-vendor\ \fIvendor\-id\fR\fR] \fIFILE\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-desktop\-icon\fR uninstall \fIFILE\fR .HP 17 -\fBxdg\-desktop\-icon\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-desktop\-icon\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -The xdg\-desktop\-icon program can be used to install an application launcher or other file on the desktop of the current user\&. - +The xdg\-desktop\-icon program can be used to install an application launcher or other file on the desktop of the current user. .PP -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\&. - +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. .SH "COMMANDS" - .TP install -Installs \fIFILE\fR to the desktop of the current user\&. \fIFILE\fR can be a *\&.desktop file or any other type of file\&. - +Installs +\fIFILE\fR +to the desktop of the current user. +\fIFILE\fR +can be a *.desktop file or any other type of file. .TP uninstall -Removes \fIFILE\fR from the desktop of the current user\&. - +Removes +\fIFILE\fR +from the desktop of the current user. .SH "OPTIONS" - .TP -\fB\-\-vendor\fR \fIvendor\-id\fR -Adds \fIvendor\-id\fR as a prefix when installing desktop files\&. - +\fB\-\-novendor\fR +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. +.sp +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. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "DESKTOP FILES" - .PP -An application launcher can be added to the desktop by installing a *\&.desktop file\&. A *\&.desktop file consists of a \fI[Desktop Entry]\fR header followed by several \fIKey\fR=\fIValue\fR lines\&. - +An application launcher can be added to the desktop by installing a *.desktop file. A *.desktop file consists of a +\fI[Desktop Entry]\fR +header followed by several +\fIKey\fR=\fIValue\fR +lines. .PP -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 \fIKey\fR\&. This way one can specify different values for the same \fIKey\fR depending on the currently selected language\&. - +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 +\fIKey\fR. This way one can specify different values for the same +\fIKey\fR +depending on the currently selected language. .PP The following keys are often used: - .TP -Value=1\&.0 -This is a mandatory field to indicate that the *\&.desktop file follows the 1\&.0 version of the specification\&. - +Value=1.0 +This is a mandatory field to indicate that the *.desktop file follows the 1.0 version of the specification. .TP Type=Application -This is a mandatory field that indicates that the *\&.desktop file describes an application launcher\&. - +This is a mandatory field that indicates that the *.desktop file describes an application launcher. .TP Name=\fIApplication Name\fR -The name of the application\&. For example \fIMozilla\fR - +The name of the application. For example +\fIMozilla\fR .TP GenericName=\fIGeneric Name\fR -A generic description of the application\&. For example \fIWeb Browser\fR - +A generic description of the application. For example +\fIWeb Browser\fR .TP Comment=\fIComment\fR -Optional field to specify a tooltip for the application\&. For example \fIVisit websites on the Internet\fR - +Optional field to specify a tooltip for the application. For example +\fIVisit websites on the Internet\fR .TP Icon=\fIIcon File\fR -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 \fBxdg\-icon\-resource\fR 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\&. - +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 +\fBxdg\-icon\-resource\fR +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. .TP Exec=\fICommand Line\fR -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\&. - +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. .PP -For a complete oveview of the *\&.desktop file format please visit http://www\&.freedesktop\&.org/wiki/Standards/desktop\-entry\-spec - +For a complete oveview of the *.desktop file format please visit http://www.freedesktop.org/wiki/Standards/desktop\-entry\-spec .SH "ENVIRONMENT VARIABLES" - .PP xdg\-desktop\-icon honours the following environment variables: - .TP XDG_UTILS_DEBUG_LEVEL -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\&. - +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. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .TP \fB5\fR -No permission to read one of the files passed on the command line\&. - +No permission to read one of the files passed on the command line. .SH "SEE ALSO" - .PP -\fBxdg\-icon\-resource\fR(1) - +\fBxdg\-icon\-resource\fR(1) .SH "EXAMPLES" - .PP -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: - +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: +.sp .nf - -webmirror\&.desktop: +shinythings\-webmirror.desktop: [Desktop Entry] Encoding=UTF\-8 Type=Application Exec=webmirror - Icon=webmirror + Icon=shinythings\-webmirror Name=WebMirror Name[nl]=WebSpiegel - .fi - - +.sp .PP -Now the xdg\-desktop\-icon tool can be used to add the webmirror\&.desktop file to the desktop: - +Now the xdg\-desktop\-icon tool can be used to add the webmirror.desktop file to the desktop: +.sp .nf - -xdg\-desktop\-icon install \-\-vendor shinythings \&./webmirror\&.desktop - +xdg\-desktop\-icon install ./shinythings\-webmirror.desktop .fi - - +.sp .PP -To add a README file to the desktop as well, the following command can be used: - +To add a README file to the desktop as well, the following command can be used: +.sp .nf - -xdg\-desktop\-icon install \&./shinythings\-README - +xdg\-desktop\-icon install ./shinythings\-README .fi - - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-desktop-menu.1 b/scripts/man/xdg-desktop-menu.1 index fb113b0..be51180 100644 --- a/scripts/man/xdg-desktop-menu.1 +++ b/scripts/man/xdg-desktop-menu.1 @@ -1,204 +1,165 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-DESKTOP-MENU" 1 "" "" "xdg-desktop-menu Manual" -.SH NAME -xdg-desktop-menu \- command line tool for (un)installing desktop menu items -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XDG\-DESKTOP\-MENU" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-desktop\-menu \- command line tool for (un)installing desktop menu items +.SH "SYNOPSIS" .HP 17 -\fBxdg\-desktop\-menu\fR install [\fB\-\-noupdate\fR] [\fB\-\-vendor\ \fIvendor\-id\fR\fR] [\fB\-\-mode\ \fImode\fR\fR] {\fB\fIdesktop\-file\fR\fR | \fB\fImenu\-file\fR\fR | \fB\fIdirectory\-file\fR\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-desktop\-menu\fR install [\fB\-\-noupdate\fR] [\fB\-\-novendor\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] {\fIdesktop\-file\fR \fImenu\-file\fR \fIdirectory\-file\fR} .HP 17 -\fBxdg\-desktop\-menu\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-vendor\ \fIvendor\-id\fR\fR] [\fB\-\-mode\ \fImode\fR\fR] {\fB\fIdesktop\-file\fR\fR | \fB\fImenu\-file\fR\fR | \fB\fIdirectory\-file\fR\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-desktop\-menu\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] {\fIdesktop\-file\fR \fImenu\-file\fR \fIdirectory\-file\fR} .HP 17 -\fBxdg\-desktop\-menu\fR forceupdate [\fB\-\-mode\ \fImode\fR\fR] -.ad -.hy -.ad l -.hy 0 +\fBxdg\-desktop\-menu\fR forceupdate [\fB\-\-mode\ \fR\fB\fImode\fR\fR] .HP 17 -\fBxdg\-desktop\-menu\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-desktop\-menu\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -The xdg\-desktop\-menu program can be used to install new items to the desktop's application menu\&. - +The xdg\-desktop\-menu program can be used to install new items to the desktop's application menu. .PP -The application menu works according to the XDG Desktop Menu Specification at http://www\&.freedesktop\&.org/Standards/menu\-spec - +The application menu works according to the XDG Desktop Menu Specification at http://www.freedesktop.org/Standards/menu\-spec .SH "COMMANDS" - .TP install -Install applications or submenus into the desktop menu system\&. - -\fIdesktop\-file\fR: Installs the *\&.desktop file indicated by \fIdesktop\-file\fR to the menu system\&. A desktop file represents a single application in the menu\&. Desktop files are defined by the freedesktop\&.org Desktop Entry Specification\&. The most important aspects of *\&.desktop files are summarized below\&. - -\fImenu\-file\fR: Installs the *\&.menu file indicated by \fImenu\-file\fR to the menu system\&. A menu file describes the location and contents for one or more new submenus\&. Each submenu must reference a *\&.directory file\&. - -\fIdirectory\-file\fR: Installs the *\&.directory file indicated by \fIdirectory\-file\fR to the menu system\&. A directory file provides the name and icon for a submenu\&. - +Install applications or submenus into the desktop menu system. +.sp +\fIdesktop\-file\fR: Installs the *.desktop file indicated by +\fIdesktop\-file\fR +to the menu system. A desktop file represents a single application in the menu. Desktop files are defined by the freedesktop.org Desktop Entry Specification. The most important aspects of *.desktop files are summarized below. +.sp +\fImenu\-file\fR: Installs the *.menu file indicated by +\fImenu\-file\fR +to the menu system. A menu file describes the location and contents for one or more new submenus. Each submenu must reference a *.directory file. +.sp +\fIdirectory\-file\fR: Installs the *.directory file indicated by +\fIdirectory\-file\fR +to the menu system. A directory file provides the name and icon for a submenu. .TP uninstall -Remove applications or submenus from the desktop menu system previously installed with \fBxdg\-desktop\-menu install\fR\&. - +Remove applications or submenus from the desktop menu system previously installed with +\fBxdg\-desktop\-menu install\fR. .TP forceupdate -Force an update of the menu system\&. This is only useful if the last call to xdg\-desktop\-menu included the \fB\-\-noupdate\fR option\&. - +Force an update of the menu system. This is only useful if the last call to xdg\-desktop\-menu included the +\fB\-\-noupdate\fR +option. .SH "OPTIONS" - .TP \fB\-\-noupdate\fR -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\&. - +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. .TP -\fB\-\-vendor\fR \fIvendor\-id\fR -Adds \fIvendor\-id\fR as a prefix when installing desktop and directory files\&. - +\fB\-\-novendor\fR +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. +.sp +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. .TP \fB\-\-mode\fR \fImode\fR -\fImode\fR can be \fIuser\fR or \fIsystem\fR\&. 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\&. - -The default is to use system mode when called by root and to use user mode when called by a non\-root user\&. - +\fImode\fR +can be +\fIuser\fR +or +\fIsystem\fR. 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. +.sp +The default is to use system mode when called by root and to use user mode when called by a non\-root user. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "DESKTOP FILES" - .PP -An application item in the application menu is represented by a *\&.desktop file\&. A *\&.desktop file consists of a \fI[Desktop Entry]\fR header followed by several \fIKey\fR=\fIValue\fR lines\&. - +An application item in the application menu is represented by a *.desktop file. A *.desktop file consists of a +\fI[Desktop Entry]\fR +header followed by several +\fIKey\fR=\fIValue\fR +lines. .PP -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 \fIKey\fR\&. This way one can specify different values for the same \fIKey\fR depending on the currently selected language\&. - +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 +\fIKey\fR. This way one can specify different values for the same +\fIKey\fR +depending on the currently selected language. .PP The following keys are often used: - .TP -Value=1\&.0 -This is a mandatory field to indicate that the *\&.desktop file follows the 1\&.0 version of the specification\&. - +Value=1.0 +This is a mandatory field to indicate that the *.desktop file follows the 1.0 version of the specification. .TP Type=Application -This is a mandatory field that indicates that the *\&.desktop file describes an application launcher\&. - +This is a mandatory field that indicates that the *.desktop file describes an application launcher. .TP Name=\fIApplication Name\fR -The name of the application\&. For example \fIMozilla\fR - +The name of the application. For example +\fIMozilla\fR .TP GenericName=\fIGeneric Name\fR -A generic description of the application\&. For example \fIWeb Browser\fR - +A generic description of the application. For example +\fIWeb Browser\fR .TP Comment=\fIComment\fR -Optional field to specify a tooltip for the application\&. For example \fIVisit websites on the Internet\fR - +Optional field to specify a tooltip for the application. For example +\fIVisit websites on the Internet\fR .TP Icon=\fIIcon File\fR -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 \fBxdg\-icon\-resource\fR 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\&. - +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 +\fBxdg\-icon\-resource\fR +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. .TP Exec=\fICommand Line\fR -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\&. - +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. .TP Categories=\fICategories\fR -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\&. The XDG Desktop Menu Specification defines a large number of predefined categories\&. - +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. The XDG Desktop Menu Specification defines a large number of predefined categories. .TP MimeType=\fIMimetypes\fR -A list of mimetypes separated by semi\-colons\&. This field is used to indicate which file types the application is able to open\&. - +A list of mimetypes separated by semi\-colons. This field is used to indicate which file types the application is able to open. .PP -For a complete oveview of the *\&.desktop file format please visit http://www\&.freedesktop\&.org/wiki/Standards/desktop\-entry\-spec - +For a complete oveview of the *.desktop file format please visit http://www.freedesktop.org/wiki/Standards/desktop\-entry\-spec .SH "ENVIRONMENT VARIABLES" - .PP xdg\-desktop\-menu honours the following environment variables: - .TP XDG_UTILS_DEBUG_LEVEL -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\&. - +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. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .TP \fB5\fR -No permission to read one of the files passed on the command line\&. - +No permission to read one of the files passed on the command line. .SH "SEE ALSO" - .PP -\fBxdg\-desktop\-icon\fR(1), \fBxdg\-icon\-resource\fR(1), \fBxdg\-mime\fR(1) - +\fBxdg\-desktop\-icon\fR(1), +\fBxdg\-icon\-resource\fR(1), +\fBxdg\-mime\fR(1) .SH "EXAMPLES" - .PP -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 \fICategories\fR entry: - +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 +\fICategories\fR +entry: +.sp .nf - -webmirror\&.desktop: +shinythings\-webmirror.desktop: [Desktop Entry] Encoding=UTF\-8 @@ -211,159 +172,135 @@ webmirror\&.desktop: Name[nl]=WebSpiegel Categories=Network;WebDevelopment; - .fi - - +.sp .PP -Now the xdg\-desktop\-menu tool can be used to add the webmirror\&.desktop file to the desktop application menu: - +Now the xdg\-desktop\-menu tool can be used to add the shinythings\-webmirror.desktop file to the desktop application menu: +.sp .nf - -xdg\-desktop\-menu install \-\-vendor shinythings \&./webmirror\&.desktop - +xdg\-desktop\-menu install ./shinythings\-webmirror.desktop .fi - - +.sp .PP -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\&. - +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. .PP -In the next example the company ShinyThings Inc\&. wants to add its own submenu to the desktop application menu consisting of a "WebMirror" menu item and a "WebMirror Admin Tool" menu item\&. - +In the next example the company ShinyThings Inc. wants to add its own submenu to the desktop application menu consisting of a "WebMirror" menu item and a "WebMirror Admin Tool" menu item. .PP -First the company needs to create two \&.desktop files that describe the two menu items, this time no Categories item is needed: - +First the company needs to create two .desktop files that describe the two menu items, this time no Categories item is needed: +.sp .nf - -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 - .fi - - +.sp .PP -The files can be installed with: - +The files can be installed with: +.sp .nf - -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 .fi - - +.sp .PP -Because multiple items are added the \fB\-\-noupdate\fR option has been used\&. - +Because multiple items are added the +\fB\-\-noupdate\fR +option has been used. .PP -In addition a \&.directory file needs to be created to provide a title and icon for the sub\-menu itself: - +In addition a .directory file needs to be created to provide a title and icon for the sub\-menu itself: +.sp .nf - -webmirror\&.directory: +shinythings\-webmirror.directory: [Desktop Entry] Encoding=UTF\-8 - Icon=webmirror\-menu + Icon=shinythings\-webmirror\-menu Name=WebMirror Name[nl]=WebSpiegel - .fi - - +.sp .PP -This webmirror\&.directory file can be installed with: - +This webmirror.directory file can be installed with: +.sp .nf - -xdg\-desktop\-menu install \-\-noupdate \-\-vendor shinythings \&./webmirror\&.directory - +xdg\-desktop\-menu install \-\-noupdate ./shinythings\-webmirror.directory .fi - - +.sp .PP -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: - +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: +.sp .nf - -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 .fi - - +.sp .PP -The last step is to provide a \&.menu file that links it all togther: - +The last step is to provide a .menu file that links it all togther: +.sp .nf +shinythings\-webmirror.menu: -webmirror\&.menu: - - <!DOCTYPE Menu PUBLIC "\-//freedesktop//DTD Menu 1\&.0//EN" - "http://www\&.freedesktop\&.org/standards/menu\-spec/menu\-1\&.0\&.dtd"> + <!DOCTYPE Menu PUBLIC "\-//freedesktop//DTD Menu 1.0//EN" + "http://www.freedesktop.org/standards/menu\-spec/menu\-1.0.dtd"> <Menu> <Name>Applications</Name> <Menu> <Name>WebMirror</Name> - <Directory>shinythings\-webmirror\&.directory</Directory> + <Directory>shinythings\-webmirror.directory</Directory> <Include> - <Filename>shinythings\-webmirror\&.desktop</Filename> - <Filename>shinythings\-webmirror\-admin\&.desktop</Filename> + <Filename>shinythings\-webmirror.desktop</Filename> + <Filename>shinythings\-webmirror\-admin.desktop</Filename> </Include> </Menu> </Menu> - .fi - - +.sp .PP -The webmirror\&.menu file can be installed with: - +The shinythings\-webmirror.menu file can be installed with: +.sp .nf - -xdg\-desktop\-menu install \-\-noupdate \-\-vendor shinythings \&./webmirror\&.menu - +xdg\-desktop\-menu install \-\-noupdate ./shinythings\-webmirror.menu .fi - - +.sp .PP -After installing multiple files with \fB\-\-noupdate\fR make sure to force an update: - +After installing multiple files with +\fB\-\-noupdate\fR +make sure to force an update: +.sp .nf - xdg\-desktop\-menu forceupdate - .fi - - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-email.1 b/scripts/man/xdg-email.1 index 80fdfb9..f3b92f0 100644 --- a/scripts/man/xdg-email.1 +++ b/scripts/man/xdg-email.1 @@ -1,167 +1,118 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-EMAIL" 1 "" "" "xdg-email Manual" -.SH NAME -xdg-email \- command line tool for sending mail using the user's preferred e-mail composer -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XDG\-EMAIL" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-email \- command line tool for sending mail using the user's preferred e\-mail composer +.SH "SYNOPSIS" .HP 10 -\fBxdg\-email\fR [\fB\-\-utf8\fR] [\fB\-\-cc\fR\ \fIaddress\fR] [\fB\-\-bcc\fR\ \fIaddress\fR] [\fB\-\-subject\fR\ \fItext\fR] [\fB\-\-body\fR\ \fItext\fR] [\fB\-\-attach\fR\ \fIfile\fR] {\fB\fImailto\-uri\fR\fR | \fB\fIaddress(es)\fR\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-email\fR [\fB\-\-utf8\fR] [\fB\-\-cc\fR\ \fIaddress\fR] [\fB\-\-bcc\fR\ \fIaddress\fR] [\fB\-\-subject\fR\ \fItext\fR] [\fB\-\-body\fR\ \fItext\fR] [\fB\-\-attach\fR\ \fIfile\fR] {\fImailto\-uri\fR \fIaddress(es)\fR} .HP 10 -\fBxdg\-email\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-email\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -xdg\-email opens the user's preferred e\-mail composer in order to send a mail to \fIaddress(es)\fR or \fImailto\-uri\fR\&. RFC2368 defines mailto: URIs\&. xdg\-email limits support to, cc, subject and body fields in \fImailto\-uri\fR, all other fields are silently ignored\&. \fIaddress(es)\fR must follow the syntax of RFC822\&. Multiple addresses may be provided as separate arguments\&. - +xdg\-email opens the user's preferred e\-mail composer in order to send a mail to +\fIaddress(es)\fR +or +\fImailto\-uri\fR. RFC2368 defines mailto: URIs. xdg\-email limits support to, cc, subject and body fields in +\fImailto\-uri\fR, all other fields are silently ignored. +\fIaddress(es)\fR +must follow the syntax of RFC822. Multiple addresses may be provided as separate arguments. .PP -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\&. - +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. .PP -xdg\-email is for use inside a desktop session only\&. It is not recommended to use xdg\-email as root\&. - +xdg\-email is for use inside a desktop session only. It is not recommended to use xdg\-email as root. .PP -See http://portland\&.freedesktop\&.org/EmailConfig for information on how the user can change the e\-mail composer that is used\&. - +See http://portland.freedesktop.org/EmailConfig for information on how the user can change the e\-mail composer that is used. .SH "OPTIONS" - .TP \fB\-\-utf8\fR -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\&. - +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. .TP \fB\-\-cc\fR \fIaddress\fR -Specify a recipient to be copied on the e\-mail\&. - +Specify a recipient to be copied on the e\-mail. .TP \fB\-\-bcc\fR \fIaddress\fR -Specify a recipient to be blindly copied on the e\-mail\&. - +Specify a recipient to be blindly copied on the e\-mail. .TP \fB\-\-subject\fR \fItext\fR -Specify a subject for the e\-mail\&. - +Specify a subject for the e\-mail. .TP \fB\-\-body\fR \fItext\fR -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\&. \fItext\fR may contain linebreaks\&. - +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. +\fItext\fR +may contain linebreaks. .TP \fB\-\-attach\fR \fIfile\fR -Specify an attachment for the e\-mail\&. \fIfile\fR must point to an existing file\&. - -Some e\-mail applications require the file to remain present after xdg\-email returns\&. - +Specify an attachment for the e\-mail. +\fIfile\fR +must point to an existing file. +.sp +Some e\-mail applications require the file to remain present after xdg\-email returns. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "ENVIRONMENT VARIABLES" - .PP xdg\-email honours the following environment variables: - .TP XDG_UTILS_DEBUG_LEVEL -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\&. - +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. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .TP \fB5\fR -No permission to read one of the files passed on the command line\&. - +No permission to read one of the files passed on the command line. .SH "SEE ALSO" - .PP -http://portland\&.freedesktop\&.org/EmailConfig - +http://portland.freedesktop.org/EmailConfig .SH "EXAMPLES" - .PP - - .nf - -xdg\-email 'Jeremy White <jwhite@example\&.com>' - +xdg\-email 'Jeremy White <jwhite@example.com>' .fi - - +.sp .PP - - .nf - -xdg\-email \-\-attach /tmp/logo\&.png \\ +xdg\-email \-\-attach /tmp/logo.png \\ \-\-subject 'Logo contest' \\ - \-\-body 'Attached you find the logo for the contest\&.' \\ - 'jwhite@example\&.com' - + \-\-body 'Attached you find the logo for the contest.' \\ + 'jwhite@example.com' .fi - - +.sp .PP - - .nf - xdg\-email \-\-subject 'Your password is about to expire' \\ - 'jwhite@example\&.com' 'bastian@example\&.com' 'whipple@example\&.com' - + 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com' .fi - - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-icon-resource.1 b/scripts/man/xdg-icon-resource.1 index ce93b59..2e61256 100644 --- a/scripts/man/xdg-icon-resource.1 +++ b/scripts/man/xdg-icon-resource.1 @@ -1,173 +1,161 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-ICON-RESOURCE" 1 "" "" "xdg-icon-resource Manual" -.SH NAME -xdg-icon-resource \- command line tool for (un)installing icon resources -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XDG\-ICON\-RESOURCE" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-icon\-resource \- command line tool for (un)installing icon resources +.SH "SYNOPSIS" .HP 18 -\fBxdg\-icon\-resource\fR install [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fItheme\fR\fR] [\fB\-\-context\ \fIcontext\fR\fR] [\fB\-\-size\ \fIsize\fR\fR] [\fB\-\-mode\ \fImode\fR\fR] \fIicon\-file\fR [\fIicon\-name\fR] -.ad -.hy -.ad l -.hy 0 +\fBxdg\-icon\-resource\fR install [\fB\-\-noupdate\fR] [\fB\-\-novendor\fR] [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\-\-context\ \fR\fB\fIcontext\fR\fR] [\fB\-\-size\ \fR\fB\fIsize\fR\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] \fIicon\-file\fR [\fIicon\-name\fR] .HP 18 -\fBxdg\-icon\-resource\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fItheme\fR\fR] [\fB\-\-context\ \fIcontext\fR\fR] [\fB\-\-size\ \fIsize\fR\fR] [\fB\-\-mode\ \fImode\fR\fR] \fIicon\-name\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-icon\-resource\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\-\-context\ \fR\fB\fIcontext\fR\fR] [\fB\-\-size\ \fR\fB\fIsize\fR\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] \fIicon\-name\fR .HP 18 -\fBxdg\-icon\-resource\fR forceupdate [\fB\-\-theme\ \fItheme\fR\fR] [\fB\-\-mode\ \fImode\fR\fR] -.ad -.hy -.ad l -.hy 0 +\fBxdg\-icon\-resource\fR forceupdate [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] [\fB\-\-mode\ \fR\fB\fImode\fR\fR] .HP 18 -\fBxdg\-icon\-resource\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-icon\-resource\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -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\&. - +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. .PP -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, PNG files or SVG files\&. - +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, PNG files or SVG files. .PP -The desktop icon system works according to the XDG Icon Theme Specification at http://www\&.freedesktop\&.org/Standards/icon\-theme\-spec - +The desktop icon system works according to the XDG Icon Theme Specification at http://www.freedesktop.org/Standards/icon\-theme\-spec .SH "COMMANDS" - .TP install -Installs the icon file indicated by \fIicon\-file\fR to the desktop icon system under the name \fIicon\-name\fR\&. If \fIicon\-name\fR is not provided the name is derived from \fIicon\-file\fR\&. The icon file must have \fI\&.png\fR, \fI\&.xpm\fR or \fI\&.svg\fR as extension\&. If a corresponding \fI\&.icon\fR file exists in the same location as \fIicon\-file\fR it will be installed as well\&. - +Installs the icon file indicated by +\fIicon\-file\fR +to the desktop icon system under the name +\fIicon\-name\fR. If +\fIicon\-name\fR +is not provided the name is derived from +\fIicon\-file\fR. The icon file must have +\fI.png\fR, +\fI.xpm\fR +or +\fI.svg\fR +as extension. If a corresponding +\fI.icon\fR +file exists in the same location as +\fIicon\-file\fR +it will be installed as well. .TP uninstall -Removes the icon file indicated by \fIicon\-name\fR from the desktop icon system\&. - +Removes the icon file indicated by +\fIicon\-name\fR +from the desktop icon system. .TP forceupdate -Force an update of the desktop icon system\&. This is only useful if the last call to xdg\-icon\-resource included the \fB\-\-noupdate\fR option\&. - +Force an update of the desktop icon system. This is only useful if the last call to xdg\-icon\-resource included the +\fB\-\-noupdate\fR +option. .SH "OPTIONS" - .TP \fB\-\-noupdate\fR -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\&. - +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. +.TP +\fB\-\-novendor\fR +Normally, xdg\-icon\-resource checks to ensure that an icon file to be installed in the +\fIapps\fR +context has a proper vendor prefix. This option can be used to disable that check. +.sp +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. .TP \fB\-\-theme\fR \fItheme\fR -Installs or removes the icon file as part of \fItheme\fR\&. If no theme is specified the icons will be installed as part of the default \fIhicolor\fR theme\&. Applications may install icons under multiple themes but should at least install icons for the default \fIhicolor\fR theme\&. - +Installs or removes the icon file as part of +\fItheme\fR. If no theme is specified the icons will be installed as part of the default +\fIhicolor\fR +theme. Applications may install icons under multiple themes but should at least install icons for the default +\fIhicolor\fR +theme. .TP \fB\-\-context\fR \fIcontext\fR -Specifies the context for the icon\&. Icons to be used in the application menu and as desktop icon should use \fIapps\fR as context which is the default context\&. Icons to be used as file icons should use \fImimetypes\fR as context\&. Other common contexts are \fIactions\fR, \fIdevices\fR, \fIemblems\fR, \fIfilesystems\fR and \fIstock\fR\&. - +Specifies the context for the icon. Icons to be used in the application menu and as desktop icon should use +\fIapps\fR +as context which is the default context. Icons to be used as file icons should use +\fImimetypes\fR +as context. Other common contexts are +\fIactions\fR, +\fIdevices\fR, +\fIemblems\fR, +\fIfilesystems\fR +and +\fIstock\fR. .TP \fB\-\-size\fR \fIsize\fR -Specifies the size of the icon (required for png and xpm icons)\&. All icons must be square\&. Common sizes for icons in the apps context are: 16, 22, 32, 48, 64 and 128\&. Common sizes for icons in the mimetypes context are: 16, 22, 32, 48, 64 and 128 - +Specifies the size of the icon (required for png and xpm icons). All icons must be square. Common sizes for icons in the apps context are: 16, 22, 32, 48, 64 and 128. Common sizes for icons in the mimetypes context are: 16, 22, 32, 48, 64 and 128 .TP \fB\-\-mode\fR \fImode\fR -\fImode\fR can be \fIuser\fR or \fIsystem\fR\&. 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\&. - -The default is to use system mode when called by root and to use user mode when called by a non\-root user\&. - +\fImode\fR +can be +\fIuser\fR +or +\fIsystem\fR. 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. +.sp +The default is to use system mode when called by root and to use user mode when called by a non\-root user. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "ENVIRONMENT VARIABLES" - .PP xdg\-icon\-resource honours the following environment variables: - .TP XDG_UTILS_DEBUG_LEVEL -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\&. - +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. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .TP \fB5\fR -No permission to read one of the files passed on the command line\&. - +No permission to read one of the files passed on the command line. .SH "SEE ALSO" - .PP -\fBxdg\-desktop\-icon\fR(1), \fBxdg\-desktop\-menu\fR(1), \fBxdg\-mime\fR(1) - +\fBxdg\-desktop\-icon\fR(1), +\fBxdg\-desktop\-menu\fR(1), +\fBxdg\-mime\fR(1) .SH "EXAMPLES" - .PP -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: +.sp .nf - -xdg\-icon\-resource install \-\-size 64 myfoobar\&.png - +xdg\-icon\-resource install \-\-size 64 shinythings\-myfoobar.png .fi - - +.sp .PP -To install an icon for a new application/x\-foobar file type one can use: - +To install an icon for a new application/x\-foobar file type one can use: +.sp .nf - -xdg\-icon\-resource install \-\-context mimetypes \-\-size 48 \&./mime\-foobar\-48\&.png application\-x\-foobar\&.png -xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 \&./mime\-foobar\-64\&.png application\-x\-foobar\&.png - +xdg\-icon\-resource install \-\-context mimetypes \-\-size 48 ./mime\-foobar\-48.png application\-x\-foobar.png +xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 ./mime\-foobar\-64.png application\-x\-foobar.png .fi -This will install two icons with the name application\-x\-foobar\&.png but with different sizes\&. - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +This will install two icons with the name application\-x\-foobar.png but with different sizes. +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-mime.1 b/scripts/man/xdg-mime.1 index f8285a6..f9594ae 100644 --- a/scripts/man/xdg-mime.1 +++ b/scripts/man/xdg-mime.1 @@ -1,207 +1,182 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-MIME" 1 "" "" "xdg-mime Manual" -.SH NAME -xdg-mime \- command line tool for querying information about file type handling and adding descriptions for new file types -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XDG\-MIME" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-mime \- command line tool for querying information about file type handling and adding descriptions for new file types +.SH "SYNOPSIS" .HP 9 -\fBxdg\-mime\fR query {\fBfiletype\fR | \fBdefault\fR} \&.\&.\&. -.ad -.hy -.ad l -.hy 0 +\fBxdg\-mime\fR query {filetype default} ... .HP 9 \fBxdg\-mime\fR default \fIapplication\fR \fImimetype(s)\fR -.ad -.hy -.ad l -.hy 0 .HP 9 -\fBxdg\-mime\fR install [\fB\-\-mode\ \fImode\fR\fR] \fImimetypes\-file\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-mime\fR install [\fB\-\-mode\ \fR\fB\fImode\fR\fR] [\fB\-\-novendor\fR] \fImimetypes\-file\fR .HP 9 -\fBxdg\-mime\fR uninstall [\fB\-\-mode\ \fImode\fR\fR] \fImimetypes\-file\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-mime\fR uninstall [\fB\-\-mode\ \fR\fB\fImode\fR\fR] \fImimetypes\-file\fR .HP 9 -\fBxdg\-mime\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-mime\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -The xdg\-mime program can be used to query information about file types and to add descriptions for new file types\&. - +The xdg\-mime program can be used to query information about file types and to add descriptions for new file types. .SH "COMMANDS" - .TP query -Returns information related to file types\&. - -The \fIquery\fR option is for use inside a desktop session only\&. It is not recommended to use xdg\-mime query as root\&. - +Returns information related to file types. +.sp +The +\fIquery\fR +option is for use inside a desktop session only. It is not recommended to use xdg\-mime query as root. +.sp The following queries are supported: - -query filetype \fIFILE\fR: Returns the file type of \fIFILE\fR in the form of a MIME type\&. - -query default \fImimetype\fR: Returns the default application that the desktop environment uses for opening files of type \fImimetype\fR\&. The default application is identified by its *\&.desktop file\&. - +.sp +query filetype +\fIFILE\fR: Returns the file type of +\fIFILE\fR +in the form of a MIME type. +.sp +query default +\fImimetype\fR: Returns the default application that the desktop environment uses for opening files of type +\fImimetype\fR. The default application is identified by its *.desktop file. .TP default -Ask the desktop environment to make \fIapplication\fR the default application for opening files of type \fImimetype\fR\&. An application can be made the default for several file types by specifying multiple mimetypes\&. - - \fIapplication\fR is the desktop file id of the application and has the form vendor\-name\&.desktop \fIapplication\fR 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\&. - -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\&. - -The \fIdefault\fR option is for use inside a desktop session only\&. It is not recommended to use xdg\-mime default as root\&. - +Ask the desktop environment to make +\fIapplication\fR +the default application for opening files of type +\fImimetype\fR. An application can be made the default for several file types by specifying multiple mimetypes. +.sp +\fIapplication\fR +is the desktop file id of the application and has the form vendor\-name.desktop +\fIapplication\fR +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. +.sp +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. +.sp +The +\fIdefault\fR +option is for use inside a desktop session only. It is not recommended to use xdg\-mime default as root. .TP install -Adds the file type descriptions provided in \fImimetypes\-file\fR to the desktop environment\&. \fImimetypes\-file\fR 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 \fImajor\fR\-\fIminor\fR must be installed with the \fBxdg\-icon\-resource\fR command in the \fImimetypes\fR context\&. For example the application/vnd\&.oasis\&.opendocument\&.text filetype requires an icon by the name of application\-vnd\&.oasis\&.opendocument\&.text to be installed\&. - +Adds the file type descriptions provided in +\fImimetypes\-file\fR +to the desktop environment. +\fImimetypes\-file\fR +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 +\fImajor\fR\-\fIminor\fR +must be installed with the +\fBxdg\-icon\-resource\fR +command in the +\fImimetypes\fR +context. For example the application/vnd.oasis.opendocument.text filetype requires an icon by the name of application\-vnd.oasis.opendocument.text to be installed. .TP uninstall -Removes the file type descriptions provided in \fImimetypes\-file\fR and previously added with \fBxdg\-mime install\fR from the desktop environment\&. \fImimetypes\-file\fR 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\&. - +Removes the file type descriptions provided in +\fImimetypes\-file\fR +and previously added with +\fBxdg\-mime install\fR +from the desktop environment. +\fImimetypes\-file\fR +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. .SH "OPTIONS" - .TP \fB\-\-mode\fR \fImode\fR -\fImode\fR can be \fIuser\fR or \fIsystem\fR\&. 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\&. - -The default is to use system mode when called by root and to use user mode when called by a non\-root user\&. - +\fImode\fR +can be +\fIuser\fR +or +\fIsystem\fR. 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. +.sp +The default is to use system mode when called by root and to use user mode when called by a non\-root user. +.TP +\fB\-\-novendor\fR +Normally, xdg\-mime checks to ensure that the +\fImimetypes\-file\fR +to be installed has a proper vendor prefix. This option can be used to disable that check. +.sp +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. .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "ENVIRONMENT VARIABLES" - .PP xdg\-mime honours the following environment variables: - .TP XDG_UTILS_DEBUG_LEVEL -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\&. - +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. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .TP \fB5\fR -No permission to read one of the files passed on the command line\&. - +No permission to read one of the files passed on the command line. .SH "SEE ALSO" - .PP -\fBxdg\-icon\-resource\fR(1), \fBxdg\-desktop\-menu\fR(1) - +\fBxdg\-icon\-resource\fR(1), +\fBxdg\-desktop\-menu\fR(1) .SH "EXAMPLES" - .PP - - .nf - -xdg\-mime query filetype /tmp/foobar\&.png - +xdg\-mime query filetype /tmp/foobar.png .fi -Prints the MIME type of the file /tmp/foobar\&.png, in this case image/png - +.sp +Prints the MIME type of the file /tmp/foobar.png, in this case image/png .PP - - .nf - xdg\-mime query default image/png - .fi -Prints the \&.desktop filename of the application which is registered to open PNG files\&. - +.sp +Prints the .desktop filename of the application which is registered to open PNG files. .PP - - .nf - -xdg\-mime install diff\&.xml - +xdg\-mime install shinythings\-shiny.xml .fi -Adds a file type description for "diff"\-files\&. The file type description could look as folows\&. - +.sp +Adds a file type description for "shiny"\-files. "shinythings\-" is used as the vendor prefix. The file type description could look as folows. +.sp .nf - -diff\&.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"/> +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> - .fi -An icon for this new file type must alsobe installed, for example with: - +.sp +An icon for this new file type must also be installed, for example with: +.sp .nf - -xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 text\-x\-diff\&.png - +xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 text\-x\-shiny.png .fi - - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-open.1 b/scripts/man/xdg-open.1 index 68ed3d7..bc7f51b 100644 --- a/scripts/man/xdg-open.1 +++ b/scripts/man/xdg-open.1 @@ -1,103 +1,65 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-OPEN" 1 "" "" "xdg-open Manual" -.SH NAME -xdg-open \- opens a file or URL in the user's preferred application -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XDG\-OPEN" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-open \- opens a file or URL in the user's preferred application +.SH "SYNOPSIS" .HP 9 -\fBxdg\-open\fR {\fB\fB\fIfile\fR\fR\fR | \fB\fB\fIURL\fR\fR\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-open\fR {\fB\fIfile\fR\fR \fB\fIURL\fR\fR} .HP 9 -\fBxdg\-open\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-open\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -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\&. - +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. .PP -xdg\-open is for use inside a desktop session only\&. It is not recommended to use xdg\-open as root\&. - +xdg\-open is for use inside a desktop session only. It is not recommended to use xdg\-open as root. .SH "OPTIONS" - .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB2\fR -One of the files passed on the command line did not exist\&. - +One of the files passed on the command line did not exist. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .SH "EXAMPLES" - .PP - - .nf - -xdg\-open 'http://www\&.freedesktop\&.org/' - +xdg\-open 'http://www.freedesktop.org/' .fi - Opens the Freedesktop\&.org website in the user's default browser - +.sp +Opens the Freedesktop.org website in the user's default browser .PP - - .nf - -xdg\-open /tmp/foobar\&.png - +xdg\-open /tmp/foobar.png .fi - Opens the PNG image file /tmp/foobar\&.png in the user's default image viewing application\&. - -.SH AUTHORS -Kevin Krammer, Jeremy White. +.sp +Opens the PNG image file /tmp/foobar.png in the user's default image viewing application. +.SH "AUTHOR" +Kevin Krammer, Jeremy White. +.br +<kevin.krammer@gmx.at> +.br +<jwhite@codeweavers.com> diff --git a/scripts/man/xdg-screensaver.1 b/scripts/man/xdg-screensaver.1 index c0cf741..d4f35b9 100644 --- a/scripts/man/xdg-screensaver.1 +++ b/scripts/man/xdg-screensaver.1 @@ -1,127 +1,93 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XDG-SCREENSAVER" 1 "" "" "xdg-screensaver Manual" -.SH NAME -xdg-screensaver \- command line tool for controlling the screensaver -.SH "SYNOPSIS" +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XDG\-SCREENSAVER" "1" "07/31/2006" "xdg\-utils 1.0 beta2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 +.SH "NAME" +xdg\-screensaver \- command line tool for controlling the screensaver +.SH "SYNOPSIS" .HP 16 -\fBxdg\-screensaver\fR \fBsuspend\ \fIWindowID\fR\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-screensaver\fR \fBsuspend\ \fR\fB\fIWindowID\fR\fR .HP 16 -\fBxdg\-screensaver\fR \fBresume\ \fIWindowID\fR\fR -.ad -.hy -.ad l -.hy 0 +\fBxdg\-screensaver\fR \fBresume\ \fR\fB\fIWindowID\fR\fR .HP 16 -\fBxdg\-screensaver\fR {\fB\fBactivate\fR\fR | \fB\fBreset\fR\fR | \fB\fBstatus\fR\fR} -.ad -.hy -.ad l -.hy 0 +\fBxdg\-screensaver\fR {\fBactivate\fR \fBreset\fR \fBstatus\fR} .HP 16 -\fBxdg\-screensaver\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} -.ad -.hy - +\fBxdg\-screensaver\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} .SH "DESCRIPTION" - .PP -xdg\-screensaver provides commands to control the screensaver\&. - +xdg\-screensaver provides commands to control the screensaver. .PP -xdg\-screensaver is for use inside a desktop session only\&. It is not recommended to use xdg\-screensaver as root\&. - +xdg\-screensaver is for use inside a desktop session only. It is not recommended to use xdg\-screensaver as root. .SH "COMMANDS" - .TP -\fBsuspend \fIWindowID\fR\fR -Suspends the screensaver and monitor power management\&. \fIWindowID\fR 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\&. - -WindowID can be represented as either a decimal number or as a hexadecimal number consisting of the prefix \fI0x\fR followed by one or more hexadecimal digits\&. - -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 - +\fBsuspend \fR\fB\fIWindowID\fR\fR +Suspends the screensaver and monitor power management. +\fIWindowID\fR +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. +.sp +WindowID can be represented as either a decimal number or as a hexadecimal number consisting of the prefix +\fI0x\fR +followed by one or more hexadecimal digits. +.sp +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 .TP -\fBresume \fIWindowID\fR\fR -Resume the screensaver and monitor power management after being suspended\&. \fIWindowID\fR must be the same X Window ID that was passed to a previous call of \fBxdg\-screensaver suspend\fR - +\fBresume \fR\fB\fIWindowID\fR\fR +Resume the screensaver and monitor power management after being suspended. +\fIWindowID\fR +must be the same X Window ID that was passed to a previous call of +\fBxdg\-screensaver suspend\fR .TP \fBactivate\fR -Turns the screensaver on immediately\&. This may result in the screen getting locked, depending on existing system policies\&. - +Turns the screensaver on immediately. This may result in the screen getting locked, depending on existing system policies. .TP \fBreset\fR -Turns the screensaver off immediately\&. On some systems the user may be asked to authenticate first before the screen is unlocked\&. - +Turns the screensaver off immediately. On some systems the user may be asked to authenticate first before the screen is unlocked. .TP \fBstatus\fR -Prints \fIenabled\fR to stdout if the screensaver is enabled to turn on after a period of inactivity and prints \fIdisabled\fR if the screensaver is not enabled\&. - +Prints +\fIenabled\fR +to stdout if the screensaver is enabled to turn on after a period of inactivity and prints +\fIdisabled\fR +if the screensaver is not enabled. .SH "OPTIONS" - .TP \fB\-\-help\fR -Show command synopsis\&. - +Show command synopsis. .TP \fB\-\-manual\fR -Show this manualpage\&. - +Show this manualpage. .TP \fB\-\-version\fR -Show the xdg\-utils version information\&. - +Show the xdg\-utils version information. .SH "EXIT CODES" - .PP -An exit code of 0 indicates success while a non\-zero exit code indicates failure\&. The following failure codes can be returned: - +An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned: .TP \fB1\fR -Error in command line syntax\&. - +Error in command line syntax. .TP \fB3\fR -A required tool could not be found\&. - +A required tool could not be found. .TP \fB4\fR -The action failed\&. - +The action failed. .SH "EXAMPLES" - .PP - - .nf - xdg\-screensaver suspend 0x1c00007 - .fi -Causes the screensaver to be disabled till \fBxdg\-screensaver resume 0x1c00007\fR is called\&. \fI0x1c00007\fR must be the X Window ID of an existing window\&. - -.SH AUTHOR -Bryce Harrington. +.sp +Causes the screensaver to be disabled till +\fBxdg\-screensaver resume 0x1c00007\fR +is called. +\fI0x1c00007\fR +must be the X Window ID of an existing window. +.SH "AUTHOR" +Bryce Harrington. +.br +<bryce@osdl.org> diff --git a/scripts/man/xdg-su.1 b/scripts/man/xdg-su.1 index 11bf29c..6ed4b36 100644 --- a/scripts/man/xdg-su.1 +++ b/scripts/man/xdg-su.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "XDG\-SU" "1" "07/24/2006" "This is release 0.5 of the xdg\-su Manual" "" +.TH "XDG\-SU" "1" "07/31/2006" "This is release 0.5 of the xdg\-su Manual" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) diff --git a/scripts/xdg-desktop-icon b/scripts/xdg-desktop-icon index 2aae895..0277e83 100755 --- a/scripts/xdg-desktop-icon +++ b/scripts/xdg-desktop-icon @@ -34,16 +34,15 @@ usage() { cat << _USAGE - xdg-desktop-icon -- command line tool for (un)installing icons to the - desktop +xdg-desktop-icon — command line tool for (un)installing icons to the desktop Synopsis - xdg-desktop-icon install [--vendor vendor-id] FILE +xdg-desktop-icon install [--novendor] FILE - xdg-desktop-icon uninstall [--vendor vendor-id] FILE +xdg-desktop-icon uninstall FILE - xdg-desktop-icon { --help | --manual | --version } +xdg-desktop-icon { --help | --manual | --version } _USAGE } @@ -53,165 +52,157 @@ manualpage() cat << _MANUALPAGE Name - xdg-desktop-icon -- command line tool for (un)installing icons to the - desktop +xdg-desktop-icon — command line tool for (un)installing icons to the desktop Synopsis - xdg-desktop-icon install [--vendor vendor-id] FILE +xdg-desktop-icon install [--novendor] FILE - xdg-desktop-icon uninstall [--vendor vendor-id] FILE +xdg-desktop-icon uninstall FILE - xdg-desktop-icon { --help | --manual | --version } +xdg-desktop-icon { --help | --manual | --version } Description - The xdg-desktop-icon program can be used to install an application - launcher or other file on the desktop of the current user. +The xdg-desktop-icon program can be used to install an application launcher or +other file on the desktop of the current user. - 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. +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. Commands - install - Installs FILE to the desktop of the current user. FILE can be a - *.desktop file or any other type of file. - - uninstall - Removes FILE from the desktop of the current user. +install + Installs FILE to the desktop of the current user. FILE can be a *.desktop + file or any other type of file. +uninstall + Removes FILE from the desktop of the current user. Options - --vendor vendor-id - Adds vendor-id as a prefix when installing desktop files. +--novendor - --help - Show command synopsis. + 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. - --manual - Show this manualpage. + 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. - --version - Show the xdg-utils version information. +--help + Show command synopsis. +--manual + Show this manualpage. +--version + Show the xdg-utils version information. Desktop Files - An application launcher can be added to the desktop by installing a - *.desktop file. A *.desktop file consists of a [Desktop Entry] header - followed by several Key=Value lines. - - 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 Key. This way one can - specify different values for the same Key depending on the currently - selected language. - - The following keys are often used: - - Value=1.0 - This is a mandatory field to indicate that the *.desktop file - follows the 1.0 version of the specification. - - Type=Application - This is a mandatory field that indicates that the *.desktop file - describes an application launcher. - - Name=Application Name - The name of the application. For example Mozilla - - GenericName=Generic Name - A generic description of the application. For example Web Browser - - Comment=Comment - Optional field to specify a tooltip for the application. For - example Visit websites on the Internet - - Icon=Icon File - 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 xdg-icon-resource 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. - - Exec=Command Line - 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. - - For a complete oveview of the *.desktop file format please visit - http://www.freedesktop.org/wiki/Standards/desktop-entry-spec +An application launcher can be added to the desktop by installing a *.desktop +file. A *.desktop file consists of a [Desktop Entry] header followed by several +Key=Value lines. + +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 Key. This way one can specify +different values for the same Key depending on the currently selected language. + +The following keys are often used: + +Value=1.0 + This is a mandatory field to indicate that the *.desktop file follows the + 1.0 version of the specification. +Type=Application + This is a mandatory field that indicates that the *.desktop file describes + an application launcher. +Name=Application Name + The name of the application. For example Mozilla +GenericName=Generic Name + A generic description of the application. For example Web Browser +Comment=Comment + Optional field to specify a tooltip for the application. For example Visit + websites on the Internet +Icon=Icon File + 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 xdg-icon-resource + 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. +Exec=Command Line + 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. + +For a complete oveview of the *.desktop file format please visit http:// +www.freedesktop.org/wiki/Standards/desktop-entry-spec Environment Variables - xdg-desktop-icon honours the following environment variables: +xdg-desktop-icon honours the following environment variables: - XDG_UTILS_DEBUG_LEVEL - 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. +XDG_UTILS_DEBUG_LEVEL + 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. Exit Codes - An exit code of 0 indicates success while a non-zero exit code indicates - failure. The following failure codes can be returned: - - 1 - Error in command line syntax. - - 2 - One of the files passed on the command line did not exist. - - 3 - A required tool could not be found. +An exit code of 0 indicates success while a non-zero exit code indicates +failure. The following failure codes can be returned: - 4 - The action failed. - - 5 - No permission to read one of the files passed on the command line. +1 + Error in command line syntax. +2 + One of the files passed on the command line did not exist. +3 + A required tool could not be found. +4 + The action failed. +5 + No permission to read one of the files passed on the command line. See Also - xdg-icon-resource(1) +xdg-icon-resource(1) Examples - 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: +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: + +shinythings-webmirror.desktop: - webmirror.desktop: + [Desktop Entry] + Encoding=UTF-8 + Type=Application - [Desktop Entry] - Encoding=UTF-8 - Type=Application + Exec=webmirror + Icon=shinythings-webmirror - Exec=webmirror - Icon=webmirror + Name=WebMirror + Name[nl]=WebSpiegel - Name=WebMirror - Name[nl]=WebSpiegel +Now the xdg-desktop-icon tool can be used to add the webmirror.desktop file to +the desktop: - Now the xdg-desktop-icon tool can be used to add the webmirror.desktop - file to the desktop: +xdg-desktop-icon install ./shinythings-webmirror.desktop - xdg-desktop-icon install --vendor shinythings ./webmirror.desktop +To add a README file to the desktop as well, the following command can be used: - To add a README file to the desktop as well, the following command can be - used: +xdg-desktop-icon install ./shinythings-README - xdg-desktop-icon install ./shinythings-README _MANUALPAGE } @@ -330,6 +321,22 @@ check_input_file() fi } +check_vendor_prefix() +{ + file=`basename "$1"` + case "$file" in + [a-zA-Z]*-*) + return + ;; + esac + + echo "xdg-desktop-icon: filename '$file' does not have a proper vendor prefix" >&2 + echo 'A vendor prefix consists of alpha characters ([a-zA-Z]) and is terminated' >&2 + echo 'with a dash ("-"). An example filename is '"'example-$file'" >&2 + echo "Use --novendor to override or 'xdg-desktop-icon --manual' for additional info." >&2 + exit 1 +} + check_output_file() { # if the file exists, check if it is writeable @@ -368,7 +375,7 @@ check_common_commands() ;; --version) - echo "xdg-desktop-icon 1.0beta1" + echo "xdg-desktop-icon 1.0beta2" exit_success ;; esac @@ -421,17 +428,14 @@ esac shift +vendor=true while [ $# -gt 0 ] ; do parm=$1 shift case $parm in - --vendor) - if [ -z "$1" ] ; then - exit_failure_syntax "vendor-id argument missing for --vendor" - fi - vendor=$1 - shift + --novendor) + vendor=false ;; -*) @@ -463,6 +467,9 @@ filetype= case $desktop_file in *.desktop) filetype=desktop + if [ "$vendor" = "true" -a "$action" = "install" ] ; then + check_vendor_prefix "$desktop_file" + fi ;; *) filetype=other @@ -476,7 +483,6 @@ desktop_dir=$HOME/Desktop # echo "[using|$desktop_dir]" basefile=`basename $desktop_file` -[ -z $vendor ] || [ x"$filetype" != x"desktop" ] || basefile=$vendor-$basefile DEBUG 1 "$action $desktop_file in $desktop_dir" diff --git a/scripts/xdg-desktop-icon.in b/scripts/xdg-desktop-icon.in index 667d85d..47579b3 100644 --- a/scripts/xdg-desktop-icon.in +++ b/scripts/xdg-desktop-icon.in @@ -48,17 +48,14 @@ esac shift +vendor=true while [ $# -gt 0 ] ; do parm=$1 shift case $parm in - --vendor) - if [ -z "$1" ] ; then - exit_failure_syntax "vendor-id argument missing for --vendor" - fi - vendor=$1 - shift + --novendor) + vendor=false ;; -*) @@ -90,6 +87,9 @@ filetype= case $desktop_file in *.desktop) filetype=desktop + if [ "$vendor" = "true" -a "$action" = "install" ] ; then + check_vendor_prefix "$desktop_file" + fi ;; *) filetype=other @@ -103,7 +103,6 @@ desktop_dir=$HOME/Desktop # echo "[using|$desktop_dir]" basefile=`basename $desktop_file` -[ -z $vendor ] || [ x"$filetype" != x"desktop" ] || basefile=$vendor-$basefile DEBUG 1 "$action $desktop_file in $desktop_dir" diff --git a/scripts/xdg-desktop-menu b/scripts/xdg-desktop-menu index 3b76de9..9768a27 100755 --- a/scripts/xdg-desktop-menu +++ b/scripts/xdg-desktop-menu @@ -35,331 +35,315 @@ manualpage() cat << _MANUALPAGE Name - xdg-desktop-menu -- command line tool for (un)installing desktop menu - items +xdg-desktop-menu — command line tool for (un)installing desktop menu items Synopsis - xdg-desktop-menu install [--noupdate] [--vendor vendor-id] [--mode mode] { - desktop-file | menu-file | directory-file } +xdg-desktop-menu install [--noupdate] [--novendor] [--mode mode] { desktop-file +| menu-file | directory-file } - xdg-desktop-menu uninstall [--noupdate] [--vendor vendor-id] [--mode mode] - { desktop-file | menu-file | directory-file } +xdg-desktop-menu uninstall [--noupdate] [--mode mode] { desktop-file | +menu-file | directory-file } - xdg-desktop-menu forceupdate [--mode mode] +xdg-desktop-menu forceupdate [--mode mode] - xdg-desktop-menu { --help | --manual | --version } +xdg-desktop-menu { --help | --manual | --version } Description - The xdg-desktop-menu program can be used to install new items to the - desktop's application menu. +The xdg-desktop-menu program can be used to install new items to the desktop's +application menu. - The application menu works according to the XDG Desktop Menu Specification - at http://www.freedesktop.org/Standards/menu-spec +The application menu works according to the XDG Desktop Menu Specification at +http://www.freedesktop.org/Standards/menu-spec Commands - install +install - Install applications or submenus into the desktop menu system. + Install applications or submenus into the desktop menu system. - desktop-file: Installs the *.desktop file indicated by - desktop-file to the menu system. A desktop file represents a - single application in the menu. Desktop files are defined by the - freedesktop.org Desktop Entry Specification. The most important - aspects of *.desktop files are summarized below. + desktop-file: Installs the *.desktop file indicated by desktop-file to the + menu system. A desktop file represents a single application in the menu. + Desktop files are defined by the freedesktop.org Desktop Entry + Specification. The most important aspects of *.desktop files are summarized + below. - menu-file: Installs the *.menu file indicated by menu-file to the - menu system. A menu file describes the location and contents for - one or more new submenus. Each submenu must reference a - *.directory file. + menu-file: Installs the *.menu file indicated by menu-file to the menu + system. A menu file describes the location and contents for one or more new + submenus. Each submenu must reference a *.directory file. - directory-file: Installs the *.directory file indicated by - directory-file to the menu system. A directory file provides the - name and icon for a submenu. + directory-file: Installs the *.directory file indicated by directory-file + to the menu system. A directory file provides the name and icon for a + submenu. - uninstall - Remove applications or submenus from the desktop menu system - previously installed with xdg-desktop-menu install. - - forceupdate - Force an update of the menu system. This is only useful if the - last call to xdg-desktop-menu included the --noupdate option. +uninstall + Remove applications or submenus from the desktop menu system previously + installed with xdg-desktop-menu install. +forceupdate + Force an update of the menu system. This is only useful if the last call to + xdg-desktop-menu included the --noupdate option. Options - --noupdate - 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. - - --vendor vendor-id - Adds vendor-id as a prefix when installing desktop and directory - files. +--noupdate + 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. +--novendor - --mode mode + 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. - mode can be user or system. 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. + 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. - The default is to use system mode when called by root and to use - user mode when called by a non-root user. +--mode mode - --help - Show command synopsis. + mode can be user or system. 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. - --manual - Show this manualpage. + The default is to use system mode when called by root and to use user mode + when called by a non-root user. - --version - Show the xdg-utils version information. +--help + Show command synopsis. +--manual + Show this manualpage. +--version + Show the xdg-utils version information. Desktop Files - An application item in the application menu is represented by a *.desktop - file. A *.desktop file consists of a [Desktop Entry] header followed by - several Key=Value lines. - - 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 Key. This way one can - specify different values for the same Key depending on the currently - selected language. - - The following keys are often used: - - Value=1.0 - This is a mandatory field to indicate that the *.desktop file - follows the 1.0 version of the specification. - - Type=Application - This is a mandatory field that indicates that the *.desktop file - describes an application launcher. - - Name=Application Name - The name of the application. For example Mozilla - - GenericName=Generic Name - A generic description of the application. For example Web Browser - - Comment=Comment - Optional field to specify a tooltip for the application. For - example Visit websites on the Internet - - Icon=Icon File - 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 xdg-icon-resource 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. - - Exec=Command Line - 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. - - Categories=Categories - 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. The XDG Desktop Menu Specification defines a large - number of predefined categories. - - MimeType=Mimetypes - A list of mimetypes separated by semi-colons. This field is used - to indicate which file types the application is able to open. - - For a complete oveview of the *.desktop file format please visit - http://www.freedesktop.org/wiki/Standards/desktop-entry-spec +An application item in the application menu is represented by a *.desktop file. +A *.desktop file consists of a [Desktop Entry] header followed by several Key= +Value lines. + +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 Key. This way one can specify +different values for the same Key depending on the currently selected language. + +The following keys are often used: + +Value=1.0 + This is a mandatory field to indicate that the *.desktop file follows the + 1.0 version of the specification. +Type=Application + This is a mandatory field that indicates that the *.desktop file describes + an application launcher. +Name=Application Name + The name of the application. For example Mozilla +GenericName=Generic Name + A generic description of the application. For example Web Browser +Comment=Comment + Optional field to specify a tooltip for the application. For example Visit + websites on the Internet +Icon=Icon File + 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 xdg-icon-resource + 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. +Exec=Command Line + 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. +Categories=Categories + 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. The XDG Desktop Menu + Specification defines a large number of predefined categories. +MimeType=Mimetypes + A list of mimetypes separated by semi-colons. This field is used to + indicate which file types the application is able to open. + +For a complete oveview of the *.desktop file format please visit http:// +www.freedesktop.org/wiki/Standards/desktop-entry-spec Environment Variables - xdg-desktop-menu honours the following environment variables: +xdg-desktop-menu honours the following environment variables: - XDG_UTILS_DEBUG_LEVEL - 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. +XDG_UTILS_DEBUG_LEVEL + 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. Exit Codes - An exit code of 0 indicates success while a non-zero exit code indicates - failure. The following failure codes can be returned: - - 1 - Error in command line syntax. - - 2 - One of the files passed on the command line did not exist. - - 3 - A required tool could not be found. +An exit code of 0 indicates success while a non-zero exit code indicates +failure. The following failure codes can be returned: - 4 - The action failed. - - 5 - No permission to read one of the files passed on the command line. +1 + Error in command line syntax. +2 + One of the files passed on the command line did not exist. +3 + A required tool could not be found. +4 + The action failed. +5 + No permission to read one of the files passed on the command line. See Also - xdg-desktop-icon(1), xdg-icon-resource(1), xdg-mime(1) +xdg-desktop-icon(1), xdg-icon-resource(1), xdg-mime(1) Examples - 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 Categories - entry: +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 Categories entry: + +shinythings-webmirror.desktop: - webmirror.desktop: + [Desktop Entry] + Encoding=UTF-8 + Type=Application - [Desktop Entry] - Encoding=UTF-8 - Type=Application + Exec=webmirror + Icon=webmirror - Exec=webmirror - Icon=webmirror + Name=WebMirror + Name[nl]=WebSpiegel - Name=WebMirror - Name[nl]=WebSpiegel + Categories=Network;WebDevelopment; - Categories=Network;WebDevelopment; +Now the xdg-desktop-menu tool can be used to add the +shinythings-webmirror.desktop file to the desktop application menu: - Now the xdg-desktop-menu tool can be used to add the webmirror.desktop - file to the desktop application menu: +xdg-desktop-menu install ./shinythings-webmirror.desktop - xdg-desktop-menu install --vendor shinythings ./webmirror.desktop +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. - 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. +In the next example the company ShinyThings Inc. wants to add its own submenu +to the desktop application menu consisting of a "WebMirror" menu item and a +"WebMirror Admin Tool" menu item. - In the next example the company ShinyThings Inc. wants to add its own - submenu to the desktop application menu consisting of a "WebMirror" menu - item and a "WebMirror Admin Tool" menu item. +First the company needs to create two .desktop files that describe the two menu +items, this time no Categories item is needed: - First the company needs to create two .desktop files that describe the two - menu items, this time no Categories item is needed: +shinythings-webmirror.desktop: - webmirror.desktop: + [Desktop Entry] + Encoding=UTF-8 + Type=Application - [Desktop Entry] - Encoding=UTF-8 - Type=Application + Exec=webmirror + Icon=shinythings-webmirror - Exec=webmirror - Icon=webmirror + Name=WebMirror + Name[nl]=WebSpiegel - Name=WebMirror - Name[nl]=WebSpiegel +shinythings-webmirror-admin.desktop: - webmirror-admin.desktop: + [Desktop Entry] + Encoding=UTF-8 + Type=Application - [Desktop Entry] - Encoding=UTF-8 - Type=Application + Exec=webmirror-admintool + Icon=shinythings-webmirror-admintool - Exec=webmirror-admintool - Icon=webmirror-admintool + Name=WebMirror Admin Tool + Name[nl]=WebSpiegel Administratie Tool - Name=WebMirror Admin Tool - Name[nl]=WebSpiegel Administratie Tool +The files can be installed with: - The files can be installed with: +xdg-desktop-menu install --noupdate ./shinythings-webmirror.desktop +xdg-desktop-menu install --noupdate ./shinythings-webmirror-admin.desktop - xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.desktop - xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror-admin.desktop +Because multiple items are added the --noupdate option has been used. - Because multiple items are added the --noupdate option has been used. +In addition a .directory file needs to be created to provide a title and icon +for the sub-menu itself: - In addition a .directory file needs to be created to provide a title and - icon for the sub-menu itself: +shinythings-webmirror.directory: - webmirror.directory: + [Desktop Entry] + Encoding=UTF-8 - [Desktop Entry] - Encoding=UTF-8 + Icon=shinythings-webmirror-menu - Icon=webmirror-menu + Name=WebMirror + Name[nl]=WebSpiegel - Name=WebMirror - Name[nl]=WebSpiegel +This webmirror.directory file can be installed with: - This webmirror.directory file can be installed with: +xdg-desktop-menu install --noupdate ./shinythings-webmirror.directory - xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.directory +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: - 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: +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 - 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 +The last step is to provide a .menu file that links it all togther: - The last step is to provide a .menu file that links it all togther: +shinythings-webmirror.menu: - webmirror.menu: + <!DOCTYPE Menu PUBLIC "-//freedesktop//DTD Menu 1.0//EN" + "http://www.freedesktop.org/standards/menu-spec/menu-1.0.dtd"> + <Menu> + <Name>Applications</Name> + <Menu> + <Name>WebMirror</Name> + <Directory>shinythings-webmirror.directory</Directory> + <Include> + <Filename>shinythings-webmirror.desktop</Filename> + <Filename>shinythings-webmirror-admin.desktop</Filename> + </Include> + </Menu> + </Menu> - <!DOCTYPE Menu PUBLIC "-//freedesktop//DTD Menu 1.0//EN" - "http://www.freedesktop.org/standards/menu-spec/menu-1.0.dtd"> - <Menu> - <Name>Applications</Name> - <Menu> - <Name>WebMirror</Name> - <Directory>shinythings-webmirror.directory</Directory> - <Include> - <Filename>shinythings-webmirror.desktop</Filename> - <Filename>shinythings-webmirror-admin.desktop</Filename> - </Include> - </Menu> - </Menu> +The shinythings-webmirror.menu file can be installed with: - The webmirror.menu file can be installed with: +xdg-desktop-menu install --noupdate ./shinythings-webmirror.menu - xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.menu +After installing multiple files with --noupdate make sure to force an update: - After installing multiple files with --noupdate make sure to force an - update: +xdg-desktop-menu forceupdate - xdg-desktop-menu forceupdate _MANUALPAGE } usage() { cat << _USAGE - xdg-desktop-menu -- command line tool for (un)installing desktop menu - items +xdg-desktop-menu — command line tool for (un)installing desktop menu items Synopsis - xdg-desktop-menu install [--noupdate] [--vendor vendor-id] [--mode mode] { - desktop-file | menu-file | directory-file } +xdg-desktop-menu install [--noupdate] [--novendor] [--mode mode] { desktop-file +| menu-file | directory-file } - xdg-desktop-menu uninstall [--noupdate] [--vendor vendor-id] [--mode mode] - { desktop-file | menu-file | directory-file } +xdg-desktop-menu uninstall [--noupdate] [--mode mode] { desktop-file | +menu-file | directory-file } - xdg-desktop-menu forceupdate [--mode mode] +xdg-desktop-menu forceupdate [--mode mode] - xdg-desktop-menu { --help | --manual | --version } +xdg-desktop-menu { --help | --manual | --version } _USAGE } @@ -479,6 +463,22 @@ check_input_file() fi } +check_vendor_prefix() +{ + file=`basename "$1"` + case "$file" in + [a-zA-Z]*-*) + return + ;; + esac + + echo "xdg-desktop-menu: filename '$file' does not have a proper vendor prefix" >&2 + echo 'A vendor prefix consists of alpha characters ([a-zA-Z]) and is terminated' >&2 + echo 'with a dash ("-"). An example filename is '"'example-$file'" >&2 + echo "Use --novendor to override or 'xdg-desktop-menu --manual' for additional info." >&2 + exit 1 +} + check_output_file() { # if the file exists, check if it is writeable @@ -517,7 +517,7 @@ check_common_commands() ;; --version) - echo "xdg-desktop-menu 1.0beta1" + echo "xdg-desktop-menu 1.0beta2" exit_success ;; esac @@ -590,8 +590,7 @@ esac shift - - +vendor=true while [ $# -gt 0 ] ; do parm="$1" shift @@ -621,12 +620,8 @@ while [ $# -gt 0 ] ; do shift ;; - --vendor) - if [ -z "$1" ] ; then - exit_failure_syntax "vendor-id argument missing for --vendor" - fi - vendor="$1" - shift + --novendor) + vendor=false ;; -*) @@ -687,6 +682,10 @@ case $desktop_file in ;; esac +if [ "$vendor" = "true" -a "$action" = "install" ] ; then + check_vendor_prefix "$desktop_file" +fi + if [ x"$filetype" = x"menu" ] ; then xdg_user_dir="$XDG_CONFIG_HOME" [ -n "$xdg_user_dir" ] || xdg_user_dir="$HOME/.config" @@ -757,7 +756,6 @@ fi # echo "[using|$xdg_dir|$kde_dir|$gnome_dir]" basefile=`basename $desktop_file` -[ -z $vendor ] || basefile="$vendor-$basefile" DEBUG 1 "$action $desktop_file in $xdg_dir $kde_dir $gnome_dir" diff --git a/scripts/xdg-desktop-menu.in b/scripts/xdg-desktop-menu.in index 01ba59b..b251848 100644 --- a/scripts/xdg-desktop-menu.in +++ b/scripts/xdg-desktop-menu.in @@ -67,8 +67,7 @@ esac shift - - +vendor=true while [ $# -gt 0 ] ; do parm="$1" shift @@ -98,12 +97,8 @@ while [ $# -gt 0 ] ; do shift ;; - --vendor) - if [ -z "$1" ] ; then - exit_failure_syntax "vendor-id argument missing for --vendor" - fi - vendor="$1" - shift + --novendor) + vendor=false ;; -*) @@ -164,6 +159,10 @@ case $desktop_file in ;; esac +if [ "$vendor" = "true" -a "$action" = "install" ] ; then + check_vendor_prefix "$desktop_file" +fi + if [ x"$filetype" = x"menu" ] ; then xdg_user_dir="$XDG_CONFIG_HOME" [ -n "$xdg_user_dir" ] || xdg_user_dir="$HOME/.config" @@ -234,7 +233,6 @@ fi # echo "[using|$xdg_dir|$kde_dir|$gnome_dir]" basefile=`basename $desktop_file` -[ -z $vendor ] || basefile="$vendor-$basefile" DEBUG 1 "$action $desktop_file in $xdg_dir $kde_dir $gnome_dir" diff --git a/scripts/xdg-email b/scripts/xdg-email index b1f2f5e..96a8784 100755 --- a/scripts/xdg-email +++ b/scripts/xdg-email @@ -37,135 +37,122 @@ manualpage() cat << _MANUALPAGE Name - xdg-email -- command line tool for sending mail using the user's preferred - e-mail composer +xdg-email — command line tool for sending mail using the user's preferred +e-mail composer Synopsis - xdg-email [--utf8] [--cc address] [--bcc address] [--subject text] [--body - text] [--attach file] { mailto-uri | address(es) } +xdg-email [--utf8] [--cc address] [--bcc address] [--subject text] [--body text +] [--attach file] { mailto-uri | address(es) } - xdg-email { --help | --manual | --version } +xdg-email { --help | --manual | --version } Description - xdg-email opens the user's preferred e-mail composer in order to send a - mail to address(es) or mailto-uri. RFC2368 defines mailto: URIs. xdg-email - limits support to, cc, subject and body fields in mailto-uri, all other - fields are silently ignored. address(es) must follow the syntax of RFC822. - Multiple addresses may be provided as separate arguments. +xdg-email opens the user's preferred e-mail composer in order to send a mail to +address(es) or mailto-uri. RFC2368 defines mailto: URIs. xdg-email limits +support to, cc, subject and body fields in mailto-uri, all other fields are +silently ignored. address(es) must follow the syntax of RFC822. Multiple +addresses may be provided as separate arguments. - 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. +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. - xdg-email is for use inside a desktop session only. It is not recommended - to use xdg-email as root. +xdg-email is for use inside a desktop session only. It is not recommended to +use xdg-email as root. - See http://portland.freedesktop.org/EmailConfig for information on how the - user can change the e-mail composer that is used. +See http://portland.freedesktop.org/EmailConfig for information on how the user +can change the e-mail composer that is used. Options - --utf8 - 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. - - --cc address - Specify a recipient to be copied on the e-mail. - - --bcc address - Specify a recipient to be blindly copied on the e-mail. - - --subject text - Specify a subject for the e-mail. - - --body text - 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. text may contain - linebreaks. - - --attach file - - Specify an attachment for the e-mail. file must point to an - existing file. - - Some e-mail applications require the file to remain present after - xdg-email returns. - - --help - Show command synopsis. - - --manual - Show this manualpage. - - --version - Show the xdg-utils version information. +--utf8 + 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. +--cc address + Specify a recipient to be copied on the e-mail. +--bcc address + Specify a recipient to be blindly copied on the e-mail. +--subject text + Specify a subject for the e-mail. +--body text + 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. text may contain linebreaks. +--attach file + + Specify an attachment for the e-mail. file must point to an existing file. + + Some e-mail applications require the file to remain present after xdg-email + returns. + +--help + Show command synopsis. +--manual + Show this manualpage. +--version + Show the xdg-utils version information. Environment Variables - xdg-email honours the following environment variables: +xdg-email honours the following environment variables: - XDG_UTILS_DEBUG_LEVEL - 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. +XDG_UTILS_DEBUG_LEVEL + 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. Exit Codes - An exit code of 0 indicates success while a non-zero exit code indicates - failure. The following failure codes can be returned: - - 1 - Error in command line syntax. +An exit code of 0 indicates success while a non-zero exit code indicates +failure. The following failure codes can be returned: - 2 - One of the files passed on the command line did not exist. - - 3 - A required tool could not be found. - - 4 - The action failed. - - 5 - No permission to read one of the files passed on the command line. +1 + Error in command line syntax. +2 + One of the files passed on the command line did not exist. +3 + A required tool could not be found. +4 + The action failed. +5 + No permission to read one of the files passed on the command line. See Also - http://portland.freedesktop.org/EmailConfig +http://portland.freedesktop.org/EmailConfig Examples - xdg-email 'Jeremy White <jwhite@example.com>' +xdg-email 'Jeremy White <jwhite@example.com>' - xdg-email --attach /tmp/logo.png \ - --subject 'Logo contest' \ - --body 'Attached you find the logo for the contest.' \ - 'jwhite@example.com' +xdg-email --attach /tmp/logo.png \ + --subject 'Logo contest' \ + --body 'Attached you find the logo for the contest.' \ + 'jwhite@example.com' + +xdg-email --subject 'Your password is about to expire' \ + 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com' - xdg-email --subject 'Your password is about to expire' \ - 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com' _MANUALPAGE } usage() { cat << _USAGE - xdg-email -- command line tool for sending mail using the user's preferred - e-mail composer +xdg-email — command line tool for sending mail using the user's preferred +e-mail composer Synopsis - xdg-email [--utf8] [--cc address] [--bcc address] [--subject text] [--body - text] [--attach file] { mailto-uri | address(es) } +xdg-email [--utf8] [--cc address] [--bcc address] [--subject text] [--body text +] [--attach file] { mailto-uri | address(es) } - xdg-email { --help | --manual | --version } +xdg-email { --help | --manual | --version } _USAGE } @@ -285,6 +272,22 @@ check_input_file() fi } +check_vendor_prefix() +{ + file=`basename "$1"` + case "$file" in + [a-zA-Z]*-*) + return + ;; + esac + + echo "xdg-email: filename '$file' does not have a proper vendor prefix" >&2 + echo 'A vendor prefix consists of alpha characters ([a-zA-Z]) and is terminated' >&2 + echo 'with a dash ("-"). An example filename is '"'example-$file'" >&2 + echo "Use --novendor to override or 'xdg-email --manual' for additional info." >&2 + exit 1 +} + check_output_file() { # if the file exists, check if it is writeable @@ -323,7 +326,7 @@ check_common_commands() ;; --version) - echo "xdg-email 1.0beta1" + echo "xdg-email 1.0beta2" exit_success ;; esac diff --git a/scripts/xdg-icon-resource b/scripts/xdg-icon-resource index 25218cb..63c9a24 100755 --- a/scripts/xdg-icon-resource +++ b/scripts/xdg-icon-resource @@ -36,164 +36,161 @@ manualpage() cat << _MANUALPAGE Name - xdg-icon-resource -- command line tool for (un)installing icon resources +xdg-icon-resource — command line tool for (un)installing icon resources Synopsis - xdg-icon-resource install [--noupdate] [--theme theme] [--context context] - [--size size] [--mode mode] icon-file [icon-name] +xdg-icon-resource install [--noupdate] [--novendor] [--theme theme] [--context +context] [--size size] [--mode mode] icon-file [icon-name] - xdg-icon-resource uninstall [--noupdate] [--theme theme] [--context - context] [--size size] [--mode mode] icon-name +xdg-icon-resource uninstall [--noupdate] [--theme theme] [--context context] +[--size size] [--mode mode] icon-name - xdg-icon-resource forceupdate [--theme theme] [--mode mode] +xdg-icon-resource forceupdate [--theme theme] [--mode mode] - xdg-icon-resource { --help | --manual | --version } +xdg-icon-resource { --help | --manual | --version } Description - 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. +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. - 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, PNG files or SVG files. +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, PNG files or SVG files. - The desktop icon system works according to the XDG Icon Theme - Specification at http://www.freedesktop.org/Standards/icon-theme-spec +The desktop icon system works according to the XDG Icon Theme Specification at +http://www.freedesktop.org/Standards/icon-theme-spec Commands - install - Installs the icon file indicated by icon-file to the desktop icon - system under the name icon-name. If icon-name is not provided the - name is derived from icon-file. The icon file must have .png, .xpm - or .svg as extension. If a corresponding .icon file exists in the - same location as icon-file it will be installed as well. - - uninstall - Removes the icon file indicated by icon-name from the desktop icon - system. - - forceupdate - Force an update of the desktop icon system. This is only useful if - the last call to xdg-icon-resource included the --noupdate option. +install + Installs the icon file indicated by icon-file to the desktop icon system + under the name icon-name. If icon-name is not provided the name is derived + from icon-file. The icon file must have .png, .xpm or .svg as extension. If + a corresponding .icon file exists in the same location as icon-file it will + be installed as well. +uninstall + Removes the icon file indicated by icon-name from the desktop icon system. +forceupdate + Force an update of the desktop icon system. This is only useful if the last + call to xdg-icon-resource included the --noupdate option. Options - --noupdate - 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. - - --theme theme - Installs or removes the icon file as part of theme. If no theme is - specified the icons will be installed as part of the default - hicolor theme. Applications may install icons under multiple - themes but should at least install icons for the default hicolor - theme. - - --context context - Specifies the context for the icon. Icons to be used in the - application menu and as desktop icon should use apps as context - which is the default context. Icons to be used as file icons - should use mimetypes as context. Other common contexts are - actions, devices, emblems, filesystems and stock. - - --size size - Specifies the size of the icon (required for png and xpm icons). - All icons must be square. Common sizes for icons in the apps - context are: 16, 22, 32, 48, 64 and 128. Common sizes for icons in - the mimetypes context are: 16, 22, 32, 48, 64 and 128 - - --mode mode - - mode can be user or system. 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. - - The default is to use system mode when called by root and to use - user mode when called by a non-root user. - - --help - Show command synopsis. - - --manual - Show this manualpage. - - --version - Show the xdg-utils version information. +--noupdate + 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. +--novendor + + Normally, xdg-icon-resource checks to ensure that an icon file to be + installed in the apps context has a proper vendor prefix. This option can + be used to disable that check. + + 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. + +--theme theme + Installs or removes the icon file as part of theme. If no theme is + specified the icons will be installed as part of the default hicolor theme. + Applications may install icons under multiple themes but should at least + install icons for the default hicolor theme. +--context context + Specifies the context for the icon. Icons to be used in the application + menu and as desktop icon should use apps as context which is the default + context. Icons to be used as file icons should use mimetypes as context. + Other common contexts are actions, devices, emblems, filesystems and stock. +--size size + Specifies the size of the icon (required for png and xpm icons). All icons + must be square. Common sizes for icons in the apps context are: 16, 22, 32, + 48, 64 and 128. Common sizes for icons in the mimetypes context are: 16, + 22, 32, 48, 64 and 128 +--mode mode + + mode can be user or system. 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. + + The default is to use system mode when called by root and to use user mode + when called by a non-root user. + +--help + Show command synopsis. +--manual + Show this manualpage. +--version + Show the xdg-utils version information. Environment Variables - xdg-icon-resource honours the following environment variables: +xdg-icon-resource honours the following environment variables: - XDG_UTILS_DEBUG_LEVEL - 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. +XDG_UTILS_DEBUG_LEVEL + 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. Exit Codes - An exit code of 0 indicates success while a non-zero exit code indicates - failure. The following failure codes can be returned: - - 1 - Error in command line syntax. - - 2 - One of the files passed on the command line did not exist. - - 3 - A required tool could not be found. - - 4 - The action failed. +An exit code of 0 indicates success while a non-zero exit code indicates +failure. The following failure codes can be returned: - 5 - No permission to read one of the files passed on the command line. +1 + Error in command line syntax. +2 + One of the files passed on the command line did not exist. +3 + A required tool could not be found. +4 + The action failed. +5 + No permission to read one of the files passed on the command line. See Also - xdg-desktop-icon(1), xdg-desktop-menu(1), xdg-mime(1) +xdg-desktop-icon(1), xdg-desktop-menu(1), xdg-mime(1) Examples - 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: - xdg-icon-resource install --size 64 myfoobar.png +xdg-icon-resource install --size 64 shinythings-myfoobar.png - To install an icon for a new application/x-foobar file type one can use: +To install an icon for a new application/x-foobar file type one can use: - xdg-icon-resource install --context mimetypes --size 48 ./mime-foobar-48.png application-x-foobar.png - xdg-icon-resource install --context mimetypes --size 64 ./mime-foobar-64.png application-x-foobar.png +xdg-icon-resource install --context mimetypes --size 48 ./mime-foobar-48.png application-x-foobar.png +xdg-icon-resource install --context mimetypes --size 64 ./mime-foobar-64.png application-x-foobar.png + +This will install two icons with the name application-x-foobar.png but with +different sizes. - This will install two icons with the name application-x-foobar.png but - with different sizes. _MANUALPAGE } usage() { cat << _USAGE - xdg-icon-resource -- command line tool for (un)installing icon resources +xdg-icon-resource — command line tool for (un)installing icon resources Synopsis - xdg-icon-resource install [--noupdate] [--theme theme] [--context context] - [--size size] [--mode mode] icon-file [icon-name] +xdg-icon-resource install [--noupdate] [--novendor] [--theme theme] [--context +context] [--size size] [--mode mode] icon-file [icon-name] - xdg-icon-resource uninstall [--noupdate] [--theme theme] [--context - context] [--size size] [--mode mode] icon-name +xdg-icon-resource uninstall [--noupdate] [--theme theme] [--context context] +[--size size] [--mode mode] icon-name - xdg-icon-resource forceupdate [--theme theme] [--mode mode] +xdg-icon-resource forceupdate [--theme theme] [--mode mode] - xdg-icon-resource { --help | --manual | --version } +xdg-icon-resource { --help | --manual | --version } _USAGE } @@ -313,6 +310,22 @@ check_input_file() fi } +check_vendor_prefix() +{ + file=`basename "$1"` + case "$file" in + [a-zA-Z]*-*) + return + ;; + esac + + echo "xdg-icon-resource: filename '$file' does not have a proper vendor prefix" >&2 + echo 'A vendor prefix consists of alpha characters ([a-zA-Z]) and is terminated' >&2 + echo 'with a dash ("-"). An example filename is '"'example-$file'" >&2 + echo "Use --novendor to override or 'xdg-icon-resource --manual' for additional info." >&2 + exit 1 +} + check_output_file() { # if the file exists, check if it is writeable @@ -351,7 +364,7 @@ check_common_commands() ;; --version) - echo "xdg-icon-resource 1.0beta1" + echo "xdg-icon-resource 1.0beta2" exit_success ;; esac @@ -426,7 +439,7 @@ esac shift - +vendor=true while [ $# -gt 0 ] ; do parm="$1" shift @@ -480,6 +493,10 @@ while [ $# -gt 0 ] ; do shift ;; + --novendor) + vendor=false + ;; + -*) exit_failure_syntax "unexpected option '$parm'" ;; @@ -675,6 +692,10 @@ need_gnome_mime= [ -n "$icon_name" ] || icon_name=`basename $icon_file` +if [ "$vendor" = "true" -a "$action" = "install" -a "$context" = "apps" ] ; then + check_vendor_prefix "$icon_name" +fi + icon_icon_file=`echo "$icon_file" | sed 's/\.[^\.]*$/.icon/'` icon_icon_name=`echo "$icon_name" | sed 's/\.[^\.]*$/.icon/'` diff --git a/scripts/xdg-icon-resource.in b/scripts/xdg-icon-resource.in index 63f009d..54be49f 100644 --- a/scripts/xdg-icon-resource.in +++ b/scripts/xdg-icon-resource.in @@ -70,7 +70,7 @@ esac shift - +vendor=true while [ $# -gt 0 ] ; do parm="$1" shift @@ -124,6 +124,10 @@ while [ $# -gt 0 ] ; do shift ;; + --novendor) + vendor=false + ;; + -*) exit_failure_syntax "unexpected option '$parm'" ;; @@ -319,6 +323,10 @@ need_gnome_mime= [ -n "$icon_name" ] || icon_name=`basename $icon_file` +if [ "$vendor" = "true" -a "$action" = "install" -a "$context" = "apps" ] ; then + check_vendor_prefix "$icon_name" +fi + icon_icon_file=`echo "$icon_file" | sed 's/\.[^\.]*$/.icon/'` icon_icon_name=`echo "$icon_name" | sed 's/\.[^\.]*$/.icon/'` diff --git a/scripts/xdg-mime b/scripts/xdg-mime index 6021096..e332d39 100755 --- a/scripts/xdg-mime +++ b/scripts/xdg-mime @@ -37,188 +37,189 @@ manualpage() cat << _MANUALPAGE Name - xdg-mime -- command line tool for querying information about file type - handling and adding descriptions for new file types +xdg-mime — command line tool for querying information about file type handling +and adding descriptions for new file types Synopsis - xdg-mime query { filetype | default } ... +xdg-mime query { filetype | default } ... - xdg-mime default application mimetype(s) +xdg-mime default application mimetype(s) - xdg-mime install [--mode mode] mimetypes-file +xdg-mime install [--mode mode] [--novendor] mimetypes-file - xdg-mime uninstall [--mode mode] mimetypes-file +xdg-mime uninstall [--mode mode] mimetypes-file - xdg-mime { --help | --manual | --version } +xdg-mime { --help | --manual | --version } Description - The xdg-mime program can be used to query information about file types and - to add descriptions for new file types. +The xdg-mime program can be used to query information about file types and to +add descriptions for new file types. Commands - query +query - Returns information related to file types. + Returns information related to file types. - The query option is for use inside a desktop session only. It is - not recommended to use xdg-mime query as root. + The query option is for use inside a desktop session only. It is not + recommended to use xdg-mime query as root. - The following queries are supported: + The following queries are supported: - query filetype FILE: Returns the file type of FILE in the form of - a MIME type. + query filetype FILE: Returns the file type of FILE in the form of a MIME + type. - query default mimetype: Returns the default application that the - desktop environment uses for opening files of type mimetype. The - default application is identified by its *.desktop file. + query default mimetype: Returns the default application that the desktop + environment uses for opening files of type mimetype. The default + application is identified by its *.desktop file. - default +default - Ask the desktop environment to make application the default - application for opening files of type mimetype. An application can - be made the default for several file types by specifying multiple - mimetypes. + Ask the desktop environment to make application the default application for + opening files of type mimetype. An application can be made the default for + several file types by specifying multiple mimetypes. - application is the desktop file id of the application and has the - form vendor-name.desktop application 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. + application is the desktop file id of the application and has the form + vendor-name.desktop application 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. - 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. + 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. - The default option is for use inside a desktop session only. It is - not recommended to use xdg-mime default as root. + The default option is for use inside a desktop session only. It is not + recommended to use xdg-mime default as root. - install - Adds the file type descriptions provided in mimetypes-file to the - desktop environment. mimetypes-file 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 - major-minor must be installed with the xdg-icon-resource command - in the mimetypes context. For example the - application/vnd.oasis.opendocument.text filetype requires an icon - by the name of application-vnd.oasis.opendocument.text to be - installed. - - uninstall - Removes the file type descriptions provided in mimetypes-file and - previously added with xdg-mime install from the desktop - environment. mimetypes-file 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. +install + Adds the file type descriptions provided in mimetypes-file to the desktop + environment. mimetypes-file 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 major-minor must be installed with the xdg-icon-resource + command in the mimetypes context. For example the application/ + vnd.oasis.opendocument.text filetype requires an icon by the name of + application-vnd.oasis.opendocument.text to be installed. +uninstall + Removes the file type descriptions provided in mimetypes-file and + previously added with xdg-mime install from the desktop environment. + mimetypes-file 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. Options - --mode mode +--mode mode + + mode can be user or system. 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. - mode can be user or system. 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. + The default is to use system mode when called by root and to use user mode + when called by a non-root user. - The default is to use system mode when called by root and to use - user mode when called by a non-root user. +--novendor - --help - Show command synopsis. + Normally, xdg-mime checks to ensure that the mimetypes-file to be installed + has a proper vendor prefix. This option can be used to disable that check. - --manual - Show this manualpage. + 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. - --version - Show the xdg-utils version information. +--help + Show command synopsis. +--manual + Show this manualpage. +--version + Show the xdg-utils version information. Environment Variables - xdg-mime honours the following environment variables: +xdg-mime honours the following environment variables: - XDG_UTILS_DEBUG_LEVEL - 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. +XDG_UTILS_DEBUG_LEVEL + 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. Exit Codes - An exit code of 0 indicates success while a non-zero exit code indicates - failure. The following failure codes can be returned: - - 1 - Error in command line syntax. - - 2 - One of the files passed on the command line did not exist. - - 3 - A required tool could not be found. +An exit code of 0 indicates success while a non-zero exit code indicates +failure. The following failure codes can be returned: - 4 - The action failed. - - 5 - No permission to read one of the files passed on the command line. +1 + Error in command line syntax. +2 + One of the files passed on the command line did not exist. +3 + A required tool could not be found. +4 + The action failed. +5 + No permission to read one of the files passed on the command line. See Also - xdg-icon-resource(1), xdg-desktop-menu(1) +xdg-icon-resource(1), xdg-desktop-menu(1) Examples - xdg-mime query filetype /tmp/foobar.png +xdg-mime query filetype /tmp/foobar.png + +Prints the MIME type of the file /tmp/foobar.png, in this case image/png - Prints the MIME type of the file /tmp/foobar.png, in this case image/png +xdg-mime query default image/png - xdg-mime query default image/png +Prints the .desktop filename of the application which is registered to open PNG +files. - Prints the .desktop filename of the application which is registered to - open PNG files. +xdg-mime install shinythings-shiny.xml - xdg-mime install diff.xml +Adds a file type description for "shiny"-files. "shinythings-" is used as the +vendor prefix. The file type description could look as folows. - Adds a file type description for "diff"-files. The file type description - could look as folows. +shinythings-shiny.xml: - diff.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> - <?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> - </mime-info> +An icon for this new file type must also be installed, for example with: - An icon for this new file type must alsobe installed, for example with: +xdg-icon-resource install --context mimetypes --size 64 text-x-shiny.png - xdg-icon-resource install --context mimetypes --size 64 text-x-diff.png _MANUALPAGE } usage() { cat << _USAGE - xdg-mime -- command line tool for querying information about file type - handling and adding descriptions for new file types +xdg-mime — command line tool for querying information about file type handling +and adding descriptions for new file types Synopsis - xdg-mime query { filetype | default } ... +xdg-mime query { filetype | default } ... - xdg-mime default application mimetype(s) +xdg-mime default application mimetype(s) - xdg-mime install [--mode mode] mimetypes-file +xdg-mime install [--mode mode] [--novendor] mimetypes-file - xdg-mime uninstall [--mode mode] mimetypes-file +xdg-mime uninstall [--mode mode] mimetypes-file - xdg-mime { --help | --manual | --version } +xdg-mime { --help | --manual | --version } _USAGE } @@ -338,6 +339,22 @@ check_input_file() fi } +check_vendor_prefix() +{ + file=`basename "$1"` + case "$file" in + [a-zA-Z]*-*) + return + ;; + esac + + echo "xdg-mime: filename '$file' does not have a proper vendor prefix" >&2 + echo 'A vendor prefix consists of alpha characters ([a-zA-Z]) and is terminated' >&2 + echo 'with a dash ("-"). An example filename is '"'example-$file'" >&2 + echo "Use --novendor to override or 'xdg-mime --manual' for additional info." >&2 + exit 1 +} + check_output_file() { # if the file exists, check if it is writeable @@ -376,7 +393,7 @@ check_common_commands() ;; --version) - echo "xdg-mime 1.0beta1" + echo "xdg-mime 1.0beta2" exit_success ;; esac @@ -774,6 +791,7 @@ if [ "$action" = "defapp" ]; then exit_failure_operation_impossible "no method available for quering default application for '$mimetype'" fi +vendor=true while [ $# -gt 0 ] ; do parm="$1" shift @@ -799,6 +817,10 @@ while [ $# -gt 0 ] ; do shift ;; + --novendor) + vendor=false + ;; + -*) exit_failure_syntax "unexpected option '$parm'" ;; @@ -830,6 +852,10 @@ if [ -z "$filename" ] ; then exit_failure_syntax "mimetypes-file argument missing" fi +if [ "$vendor" = "true" -a "$action" = "install" ] ; then + check_vendor_prefix "$filename" +fi + xdg_base_dir= xdg_dir_name=mime/packages/ diff --git a/scripts/xdg-mime.in b/scripts/xdg-mime.in index 1cf0101..f313444 100755 --- a/scripts/xdg-mime.in +++ b/scripts/xdg-mime.in @@ -394,6 +394,7 @@ if [ "$action" = "defapp" ]; then exit_failure_operation_impossible "no method available for quering default application for '$mimetype'" fi +vendor=true while [ $# -gt 0 ] ; do parm="$1" shift @@ -419,6 +420,10 @@ while [ $# -gt 0 ] ; do shift ;; + --novendor) + vendor=false + ;; + -*) exit_failure_syntax "unexpected option '$parm'" ;; @@ -450,6 +455,10 @@ if [ -z "$filename" ] ; then exit_failure_syntax "mimetypes-file argument missing" fi +if [ "$vendor" = "true" -a "$action" = "install" ] ; then + check_vendor_prefix "$filename" +fi + xdg_base_dir= xdg_dir_name=mime/packages/ diff --git a/scripts/xdg-open b/scripts/xdg-open index 898ea77..490230f 100755 --- a/scripts/xdg-open +++ b/scripts/xdg-open @@ -36,75 +36,71 @@ manualpage() cat << _MANUALPAGE Name - xdg-open -- opens a file or URL in the user's preferred application +xdg-open — opens a file or URL in the user's preferred application Synopsis - xdg-open { file | URL } +xdg-open { file | URL } - xdg-open { --help | --manual | --version } +xdg-open { --help | --manual | --version } Description - 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. +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. - xdg-open is for use inside a desktop session only. It is not recommended - to use xdg-open as root. +xdg-open is for use inside a desktop session only. It is not recommended to use +xdg-open as root. Options - --help - Show command synopsis. - - --manual - Show this manualpage. - - --version - Show the xdg-utils version information. +--help + Show command synopsis. +--manual + Show this manualpage. +--version + Show the xdg-utils version information. Exit Codes - An exit code of 0 indicates success while a non-zero exit code indicates - failure. The following failure codes can be returned: - - 1 - Error in command line syntax. +An exit code of 0 indicates success while a non-zero exit code indicates +failure. The following failure codes can be returned: - 2 - One of the files passed on the command line did not exist. - - 3 - A required tool could not be found. - - 4 - The action failed. +1 + Error in command line syntax. +2 + One of the files passed on the command line did not exist. +3 + A required tool could not be found. +4 + The action failed. Examples - xdg-open 'http://www.freedesktop.org/' +xdg-open 'http://www.freedesktop.org/' + +Opens the Freedesktop.org website in the user's default browser - Opens the Freedesktop.org website in the user's default browser +xdg-open /tmp/foobar.png - xdg-open /tmp/foobar.png +Opens the PNG image file /tmp/foobar.png in the user's default image viewing +application. - Opens the PNG image file /tmp/foobar.png in the user's default image - viewing application. _MANUALPAGE } usage() { cat << _USAGE - xdg-open -- opens a file or URL in the user's preferred application +xdg-open — opens a file or URL in the user's preferred application Synopsis - xdg-open { file | URL } +xdg-open { file | URL } - xdg-open { --help | --manual | --version } +xdg-open { --help | --manual | --version } _USAGE } @@ -224,6 +220,22 @@ check_input_file() fi } +check_vendor_prefix() +{ + file=`basename "$1"` + case "$file" in + [a-zA-Z]*-*) + return + ;; + esac + + echo "xdg-open: filename '$file' does not have a proper vendor prefix" >&2 + echo 'A vendor prefix consists of alpha characters ([a-zA-Z]) and is terminated' >&2 + echo 'with a dash ("-"). An example filename is '"'example-$file'" >&2 + echo "Use --novendor to override or 'xdg-open --manual' for additional info." >&2 + exit 1 +} + check_output_file() { # if the file exists, check if it is writeable @@ -262,7 +274,7 @@ check_common_commands() ;; --version) - echo "xdg-open 1.0beta1" + echo "xdg-open 1.0beta2" exit_success ;; esac diff --git a/scripts/xdg-screensaver b/scripts/xdg-screensaver index 1bf0530..dc9c5db 100755 --- a/scripts/xdg-screensaver +++ b/scripts/xdg-screensaver @@ -35,113 +35,100 @@ manualpage() cat << _MANUALPAGE Name - xdg-screensaver -- command line tool for controlling the screensaver +xdg-screensaver — command line tool for controlling the screensaver Synopsis - xdg-screensaver suspend WindowID +xdg-screensaver suspend WindowID - xdg-screensaver resume WindowID +xdg-screensaver resume WindowID - xdg-screensaver { activate | reset | status } +xdg-screensaver { activate | reset | status } - xdg-screensaver { --help | --manual | --version } +xdg-screensaver { --help | --manual | --version } Description - xdg-screensaver provides commands to control the screensaver. +xdg-screensaver provides commands to control the screensaver. - xdg-screensaver is for use inside a desktop session only. It is not - recommended to use xdg-screensaver as root. +xdg-screensaver is for use inside a desktop session only. It is not recommended +to use xdg-screensaver as root. Commands - suspend WindowID - - Suspends the screensaver and monitor power management. WindowID - 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. - - WindowID can be represented as either a decimal number or as a - hexadecimal number consisting of the prefix 0x followed by one or - more hexadecimal digits. - - 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 - - resume WindowID - Resume the screensaver and monitor power management after being - suspended. WindowID must be the same X Window ID that was passed - to a previous call of xdg-screensaver suspend - - activate - Turns the screensaver on immediately. This may result in the - screen getting locked, depending on existing system policies. - - reset - Turns the screensaver off immediately. On some systems the user - may be asked to authenticate first before the screen is unlocked. - - status - Prints enabled to stdout if the screensaver is enabled to turn on - after a period of inactivity and prints disabled if the - screensaver is not enabled. +suspend WindowID + + Suspends the screensaver and monitor power management. WindowID 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. + + WindowID can be represented as either a decimal number or as a hexadecimal + number consisting of the prefix 0x followed by one or more hexadecimal + digits. + + 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 + +resume WindowID + Resume the screensaver and monitor power management after being suspended. + WindowID must be the same X Window ID that was passed to a previous call of + xdg-screensaver suspend +activate + Turns the screensaver on immediately. This may result in the screen getting + locked, depending on existing system policies. +reset + Turns the screensaver off immediately. On some systems the user may be + asked to authenticate first before the screen is unlocked. +status + Prints enabled to stdout if the screensaver is enabled to turn on after a + period of inactivity and prints disabled if the screensaver is not enabled. Options - --help - Show command synopsis. - - --manual - Show this manualpage. - - --version - Show the xdg-utils version information. +--help + Show command synopsis. +--manual + Show this manualpage. +--version + Show the xdg-utils version information. Exit Codes - An exit code of 0 indicates success while a non-zero exit code indicates - failure. The following failure codes can be returned: - - 1 - Error in command line syntax. +An exit code of 0 indicates success while a non-zero exit code indicates +failure. The following failure codes can be returned: - 2 - One of the files passed on the command line did not exist. - - 3 - A required tool could not be found. - - 4 - The action failed. +1 + Error in command line syntax. +3 + A required tool could not be found. +4 + The action failed. Examples - xdg-screensaver suspend 0x1c00007 +xdg-screensaver suspend 0x1c00007 + +Causes the screensaver to be disabled till xdg-screensaver resume 0x1c00007 is +called. 0x1c00007 must be the X Window ID of an existing window. - Causes the screensaver to be disabled till xdg-screensaver resume - 0x1c00007 is called. 0x1c00007 must be the X Window ID of an existing - window. _MANUALPAGE } usage() { cat << _USAGE - xdg-screensaver -- command line tool for controlling the screensaver +xdg-screensaver — command line tool for controlling the screensaver Synopsis - xdg-screensaver suspend WindowID +xdg-screensaver suspend WindowID - xdg-screensaver resume WindowID +xdg-screensaver resume WindowID - xdg-screensaver { activate | reset | status } +xdg-screensaver { activate | reset | status } - xdg-screensaver { --help | --manual | --version } +xdg-screensaver { --help | --manual | --version } _USAGE } @@ -261,6 +248,22 @@ check_input_file() fi } +check_vendor_prefix() +{ + file=`basename "$1"` + case "$file" in + [a-zA-Z]*-*) + return + ;; + esac + + echo "xdg-screensaver: filename '$file' does not have a proper vendor prefix" >&2 + echo 'A vendor prefix consists of alpha characters ([a-zA-Z]) and is terminated' >&2 + echo 'with a dash ("-"). An example filename is '"'example-$file'" >&2 + echo "Use --novendor to override or 'xdg-screensaver --manual' for additional info." >&2 + exit 1 +} + check_output_file() { # if the file exists, check if it is writeable @@ -299,7 +302,7 @@ check_common_commands() ;; --version) - echo "xdg-screensaver 1.0beta1" + echo "xdg-screensaver 1.0beta2" exit_success ;; esac diff --git a/scripts/xdg-su b/scripts/xdg-su index 0031383..fca779e 100755 --- a/scripts/xdg-su +++ b/scripts/xdg-su @@ -222,6 +222,22 @@ check_input_file() fi } +check_vendor_prefix() +{ + file=`basename "$1"` + case "$file" in + [a-zA-Z]*-*) + return + ;; + esac + + echo "xdg-su: filename '$file' does not have a proper vendor prefix" >&2 + echo 'A vendor prefix consists of alpha characters ([a-zA-Z]) and is terminated' >&2 + echo 'with a dash ("-"). An example filename is '"'example-$file'" >&2 + echo "Use --novendor to override or 'xdg-su --manual' for additional info." >&2 + exit 1 +} + check_output_file() { # if the file exists, check if it is writeable @@ -260,7 +276,7 @@ check_common_commands() ;; --version) - echo "xdg-su 1.0beta1" + echo "xdg-su 1.0beta2" exit_success ;; esac diff --git a/scripts/xdg-utils-common.in b/scripts/xdg-utils-common.in index 92776db..7fc2899 100644 --- a/scripts/xdg-utils-common.in +++ b/scripts/xdg-utils-common.in @@ -112,6 +112,22 @@ check_input_file() fi } +check_vendor_prefix() +{ + file=`basename "$1"` + case "$file" in + [a-zA-Z]*-*) + return + ;; + esac + + echo "@NAME@: filename '$file' does not have a proper vendor prefix" >&2 + echo 'A vendor prefix consists of alpha characters ([a-zA-Z]) and is terminated' >&2 + echo 'with a dash ("-"). An example filename is '"'example-$file'" >&2 + echo "Use --novendor to override or '@NAME@ --manual' for additional info." >&2 + exit 1 +} + check_output_file() { # if the file exists, check if it is writeable |