diff options
Diffstat (limited to 'portland/xdg-utils')
33 files changed, 1829 insertions, 1379 deletions
diff --git a/portland/xdg-utils/scripts/README b/portland/xdg-utils/scripts/README index f1d4d9e..8073b7a 100644 --- a/portland/xdg-utils/scripts/README +++ b/portland/xdg-utils/scripts/README @@ -1,19 +1,21 @@ -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/portland/xdg-utils/scripts/desc/xdg-desktop-icon.xml b/portland/xdg-utils/scripts/desc/xdg-desktop-icon.xml index 0786d9e..211c56e 100644 --- a/portland/xdg-utils/scripts/desc/xdg-desktop-icon.xml +++ b/portland/xdg-utils/scripts/desc/xdg-desktop-icon.xml @@ -20,7 +20,7 @@ <surname>White</surname> </author> <address><email>jwhite@codeweavers.com</email></address> - <releaseinfo>This is release 0.5 of the xdg-desktop-icon Manual.</releaseinfo> + <releaseinfo>xdg-utils 1.0 beta2</releaseinfo> </refentryinfo> <refmeta> diff --git a/portland/xdg-utils/scripts/desc/xdg-desktop-menu.xml b/portland/xdg-utils/scripts/desc/xdg-desktop-menu.xml index 70dadac..6f39a98 100644 --- a/portland/xdg-utils/scripts/desc/xdg-desktop-menu.xml +++ b/portland/xdg-utils/scripts/desc/xdg-desktop-menu.xml @@ -20,7 +20,7 @@ <surname>White</surname> </author> <address><email>jwhite@codeweavers.com</email></address> - <releaseinfo>This is release 0.5 of the xdg-desktop-menu Manual.</releaseinfo> + <releaseinfo>xdg-utils 1.0 beta2</releaseinfo> </refentryinfo> <refmeta> @@ -39,10 +39,7 @@ <arg choice="plain">install</arg> <arg><option>--noupdate</option></arg> <arg><option>--vendor <replaceable>vendor-id</replaceable></option></arg> - <group choice="req"> - <arg choice="plain"><option>--user</option></arg> - <arg choice="plain"><option>--system</option></arg> - </group> + <arg><option>--mode <replaceable>mode</replaceable></option></arg> <group choice="req"> <arg choice="plain"><replaceable>desktop-file</replaceable></arg> <arg choice="plain"><replaceable>menu-file</replaceable></arg> @@ -54,10 +51,7 @@ <arg choice="plain">uninstall</arg> <arg><option>--noupdate</option></arg> <arg><option>--vendor <replaceable>vendor-id</replaceable></option></arg> - <group choice="req"> - <arg choice="plain"><option>--user</option></arg> - <arg choice="plain"><option>--system</option></arg> - </group> + <arg><option>--mode <replaceable>mode</replaceable></option></arg> <group choice="req"> <arg choice="plain"><replaceable>desktop-file</replaceable></arg> <arg choice="plain"><replaceable>menu-file</replaceable></arg> @@ -67,10 +61,7 @@ <cmdsynopsis> <command>xdg-desktop-menu</command> <arg choice="plain">forceupdate</arg> - <group choice="req"> - <arg choice="plain"><option>--user</option></arg> - <arg choice="plain"><option>--system</option></arg> - </group> + <arg><option>--mode <replaceable>mode</replaceable></option></arg> </cmdsynopsis> <cmdsynopsis> <command>xdg-desktop-menu</command> @@ -169,20 +160,18 @@ </varlistentry> <varlistentry> - <term><option>--user</option></term> + <term><option>--mode</option> <replaceable>mode</replaceable></term> <listitem> - <simpara> - Installs or uninstalls the file for the current user only. + <simpara><replaceable>mode</replaceable> can be + <emphasis>user</emphasis> or <emphasis>system</emphasis>. + 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. </simpara> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>--system</option></term> - <listitem> <simpara> - Installs or uninstalls the file for all users on the system. - Usually only root is allowed to do this. + The default is to use system mode when called by root + and to use user mode when called by a non-root user. </simpara> </listitem> </varlistentry> @@ -458,7 +447,7 @@ webmirror.desktop: <para>Now the xdg-desktop-menu tool can be used to add the webmirror.desktop file to the desktop application menu: <programlisting> -xdg-desktop-menu install --system --vendor shinythings ./webmirror.desktop +xdg-desktop-menu install --vendor shinythings ./webmirror.desktop </programlisting> </para> <para> @@ -505,8 +494,8 @@ webmirror-admin.desktop: <para> The files can be installed with: <programlisting> -xdg-desktop-menu install --system --noupdate --vendor shinythings ./webmirror.desktop -xdg-desktop-menu install --system --noupdate --vendor shinythings ./webmirror-admin.desktop +xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.desktop +xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror-admin.desktop </programlisting> </para> <para> @@ -531,7 +520,7 @@ webmirror.directory: <para> This webmirror.directory file can be installed with: <programlisting> -xdg-desktop-menu install --system --noupdate --vendor shinythings ./webmirror.directory +xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.directory </programlisting> </para> <para> @@ -541,12 +530,12 @@ xdg-desktop-menu install --system --noupdate --vendor shinythings ./webmirror.di sizes, once with a size of 22x22 pixels and once with a size of 64x64 pixels: <programlisting> -xdg-icon-resource install --system --size 22 ./wmicon-22.png webmirror.png -xdg-icon-resource install --system --size 22 ./wmicon-menu-22.png webmirror-menu.png -xdg-icon-resource install --system --size 22 ./wmicon-admin-22.png webmirror-admin.png -xdg-icon-resource install --system --size 64 ./wmicon-64.png webmirror.png -xdg-icon-resource install --system --size 64 ./wmicon-menu-64.png webmirror-menu.png -xdg-icon-resource install --system --size 64 ./wmicon-admin-64.png 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 </programlisting> </para> <para> @@ -573,14 +562,14 @@ webmirror.menu: <para> The webmirror.menu file can be installed with: <programlisting> -xdg-desktop-menu install --system --noupdate --vendor shinythings ./webmirror.menu +xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.menu </programlisting> </para> <para> After installing multiple files with <option>--noupdate</option> make sure to force an update: <programlisting> -xdg-desktop-menu forceupdate --system +xdg-desktop-menu forceupdate </programlisting> </para> </refsect1> diff --git a/portland/xdg-utils/scripts/desc/xdg-email.xml b/portland/xdg-utils/scripts/desc/xdg-email.xml index 295f07c..4cf03fa 100755 --- a/portland/xdg-utils/scripts/desc/xdg-email.xml +++ b/portland/xdg-utils/scripts/desc/xdg-email.xml @@ -20,7 +20,7 @@ <surname>White</surname> </author> <address><email>jwhite@codeweavers.com</email></address> - <releaseinfo>This is release 0.5 of the xdg-email Manual.</releaseinfo> + <releaseinfo>xdg-utils 1.0 beta2</releaseinfo> </refentryinfo> <refmeta> diff --git a/portland/xdg-utils/scripts/desc/xdg-icon-resource.xml b/portland/xdg-utils/scripts/desc/xdg-icon-resource.xml index 08a2f00..acb3649 100644 --- a/portland/xdg-utils/scripts/desc/xdg-icon-resource.xml +++ b/portland/xdg-utils/scripts/desc/xdg-icon-resource.xml @@ -20,7 +20,7 @@ <surname>White</surname> </author> <address><email>jwhite@codeweavers.com</email></address> - <releaseinfo>This is release 0.5 of the xdg-icon-resource Manual.</releaseinfo> + <releaseinfo>xdg-utils 1.0 beta2</releaseinfo> </refentryinfo> <refmeta> @@ -41,10 +41,7 @@ <arg><option>--theme <replaceable>theme</replaceable></option></arg> <arg><option>--context <replaceable>context</replaceable></option></arg> <arg><option>--size <replaceable>size</replaceable></option></arg> - <group choice="req"> - <arg choice="plain"><option>--user</option></arg> - <arg choice="plain"><option>--system</option></arg> - </group> + <arg><option>--mode <replaceable>mode</replaceable></option></arg> <arg choice="plain"><replaceable>icon-file</replaceable></arg> <arg><replaceable>icon-name</replaceable></arg> </cmdsynopsis> @@ -55,20 +52,14 @@ <arg><option>--theme <replaceable>theme</replaceable></option></arg> <arg><option>--context <replaceable>context</replaceable></option></arg> <arg><option>--size <replaceable>size</replaceable></option></arg> - <group choice="req"> - <arg choice="plain"><option>--user</option></arg> - <arg choice="plain"><option>--system</option></arg> - </group> + <arg><option>--mode <replaceable>mode</replaceable></option></arg> <arg choice="plain"><replaceable>icon-name</replaceable></arg> </cmdsynopsis> <cmdsynopsis> <command>xdg-icon-resource</command> <arg choice="plain">forceupdate</arg> <arg><option>--theme <replaceable>theme</replaceable></option></arg> - <group choice="req"> - <arg choice="plain">--user</arg> - <arg choice="plain">--system</arg> - </group> + <arg><option>--mode <replaceable>mode</replaceable></option></arg> </cmdsynopsis> <cmdsynopsis> <command>xdg-icon-resource</command> @@ -201,20 +192,18 @@ </varlistentry> <varlistentry> - <term><option>--user</option></term> + <term><option>--mode</option> <replaceable>mode</replaceable></term> <listitem> - <simpara> - Installs or uninstalls the icon for the current user only. + <simpara><replaceable>mode</replaceable> can be + <emphasis>user</emphasis> or <emphasis>system</emphasis>. + 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. </simpara> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>--system</option></term> - <listitem> <simpara> - Installs or uninstalls the icon for all users on the system. - Usually only root is allowed to do this. + The default is to use system mode when called by root + and to use user mode when called by a non-root user. </simpara> </listitem> </varlistentry> @@ -335,16 +324,16 @@ <para> To install an icon resource to depict a launcher for the application myfoobar one can use: <programlisting> -xdg-icon-resource install --system --size 64 myfoobar.png +xdg-icon-resource install --size 64 myfoobar.png </programlisting> </para> <para> To install an icon for a new application/x-foobar file type one can use: <programlisting> -xdg-icon-resource install --system --context mimetypes --size 48 ./mime-foobar-48.png application-x-foobar.png -xdg-icon-resource install --system --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 </programlisting>This will install two icons with the name application-x-foobar.png -but with different sizes. The icons will be installed for use by all users. +but with different sizes. </para> </refsect1> </refentry> diff --git a/portland/xdg-utils/scripts/desc/xdg-mime.xml b/portland/xdg-utils/scripts/desc/xdg-mime.xml index 5de877d..22978c8 100644 --- a/portland/xdg-utils/scripts/desc/xdg-mime.xml +++ b/portland/xdg-utils/scripts/desc/xdg-mime.xml @@ -20,7 +20,7 @@ <surname>White</surname> </author> <address><email>jwhite@codeweavers.com</email></address> - <releaseinfo>This is release 0.5 of the xdg-mime Manual.</releaseinfo> + <releaseinfo>xdg-utils 1.0 beta2</releaseinfo> </refentryinfo> <refmeta> @@ -53,19 +53,13 @@ and adding descriptions for new file types</refpurpose> <cmdsynopsis> <command>xdg-mime</command> <arg choice="plain">install</arg> - <group choice="req"> - <arg choice="plain"><option>--user</option></arg> - <arg choice="plain"><option>--system</option></arg> - </group> + <arg><option>--mode <replaceable>mode</replaceable></option></arg> <arg choice="plain"><replaceable>mimetypes-file</replaceable></arg> </cmdsynopsis> <cmdsynopsis> <command>xdg-mime</command> <arg choice="plain">uninstall</arg> - <group choice="req"> - <arg choice="plain"><option>--user</option></arg> - <arg choice="plain"><option>--system</option></arg> - </group> + <arg><option>--mode <replaceable>mode</replaceable></option></arg> <arg choice="plain"><replaceable>mimetypes-file</replaceable></arg> </cmdsynopsis> <cmdsynopsis> @@ -183,20 +177,18 @@ and adding descriptions for new file types</refpurpose> <title>Options</title> <variablelist> <varlistentry> - <term><option>--user</option></term> + <term><option>--mode</option> <replaceable>mode</replaceable></term> <listitem> - <simpara> - Adds or removes file type descriptions for the current user only. + <simpara><replaceable>mode</replaceable> can be + <emphasis>user</emphasis> or <emphasis>system</emphasis>. + 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. </simpara> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>--system</option></term> - <listitem> <simpara> - Adds or removes file type descriptions for all users on the system. - Usually only root is allowed to do this. + The default is to use system mode when called by root + and to use user mode when called by a non-root user. </simpara> </listitem> </varlistentry> @@ -325,9 +317,9 @@ xdg-mime query default image/png </para> <para> <programlisting> -xdg-mime install --system diff.xml -</programlisting>Adds a file type description for "diff"-files for all users on the - system. The file type description could look as folows. +xdg-mime install diff.xml +</programlisting>Adds a file type description for "diff"-files. + The file type description could look as folows. <programlisting> diff.xml: @@ -342,7 +334,7 @@ diff.xml: </programlisting>An icon for this new file type must alsobe installed, for example with: <programlisting> -xdg-icon-resource install --system --context mimetypes --size 64 text-x-diff.png +xdg-icon-resource install --context mimetypes --size 64 text-x-diff.png </programlisting> </para> </refsect1> diff --git a/portland/xdg-utils/scripts/desc/xdg-open.xml b/portland/xdg-utils/scripts/desc/xdg-open.xml index acd5b1a..a7e6358 100755 --- a/portland/xdg-utils/scripts/desc/xdg-open.xml +++ b/portland/xdg-utils/scripts/desc/xdg-open.xml @@ -20,7 +20,7 @@ <surname>White</surname> </author> <address><email>jwhite@codeweavers.com</email></address> - <releaseinfo>This is release 0.5 of the xdg-open Manual.</releaseinfo> + <releaseinfo>xdg-utils 1.0 beta2</releaseinfo> </refentryinfo> <refmeta> diff --git a/portland/xdg-utils/scripts/desc/xdg-screensaver.xml b/portland/xdg-utils/scripts/desc/xdg-screensaver.xml index 0af004e..a6dcbca 100755 --- a/portland/xdg-utils/scripts/desc/xdg-screensaver.xml +++ b/portland/xdg-utils/scripts/desc/xdg-screensaver.xml @@ -15,7 +15,7 @@ <surname>Harrington</surname> </author> <address><email>bryce@osdl.org</email></address> - <releaseinfo>This is release 0.1 of the xdg-screensaver Manual.</releaseinfo> + <releaseinfo>xdg-utils 1.0 beta2</releaseinfo> </refentryinfo> <refmeta> @@ -187,14 +187,6 @@ </listitem> </varlistentry> <varlistentry> - <term><option>2</option></term> - <listitem> - <simpara> - One of the files passed on the command line did not exist. - </simpara> - </listitem> - </varlistentry> - <varlistentry> <term><option>3</option></term> <listitem> <simpara> @@ -217,8 +209,7 @@ <para> <programlisting> xdg-screensaver suspend 0x1c00007 -</programlisting> - Causes the screensaver to be disabled till +</programlisting>Causes the screensaver to be disabled till <command>xdg-screensaver resume 0x1c00007</command> is called. <emphasis>0x1c00007</emphasis> must be the X Window ID of an existing window. diff --git a/portland/xdg-utils/scripts/html/xdg-desktop-icon.html b/portland/xdg-utils/scripts/html/xdg-desktop-icon.html index 49af403..be8d0fc 100644 --- a/portland/xdg-utils/scripts/html/xdg-desktop-icon.html +++ b/portland/xdg-utils/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.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">--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.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> 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> diff --git a/portland/xdg-utils/scripts/html/xdg-desktop-menu.html b/portland/xdg-utils/scripts/html/xdg-desktop-menu.html index 63d282f..b289902 100644 --- a/portland/xdg-utils/scripts/html/xdg-desktop-menu.html +++ b/portland/xdg-utils/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.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">--vendor <em class="replaceable"><code>vendor-id</code></em></code>] { <code class="option">--user</code> | <code class="option">--system</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">--user</code> | <code class="option">--system</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">--user</code> | <code class="option">--system</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.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> The xdg-desktop-menu program can be used to install new items to the desktop's application menu. </p><p> @@ -34,12 +34,16 @@ </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">--user</code></span></dt><dd> - Installs or uninstalls the file for the current user only. - </dd><dt><span class="term"><code class="option">--system</code></span></dt><dd> - Installs or uninstalls the file for all users on the system. - Usually only root is allowed to do this. - </dd><dt><span class="term"><code class="option">--help</code></span></dt><dd> + </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 + on the system. Usually only root is allowed to install in + system mode. + </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> Show command synopsis. </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> Show this manualpage. @@ -153,7 +157,7 @@ webmirror.desktop: </p><p>Now the xdg-desktop-menu tool can be used to add the webmirror.desktop file to the desktop application menu: </p><pre class="programlisting"> -xdg-desktop-menu install --system --vendor shinythings ./webmirror.desktop +xdg-desktop-menu install --vendor shinythings ./webmirror.desktop </pre><p> </p><p> Note that for the purpose of this example the menu items are available @@ -196,8 +200,8 @@ webmirror-admin.desktop: </p><p> The files can be installed with: </p><pre class="programlisting"> -xdg-desktop-menu install --system --noupdate --vendor shinythings ./webmirror.desktop -xdg-desktop-menu install --system --noupdate --vendor shinythings ./webmirror-admin.desktop +xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.desktop +xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror-admin.desktop </pre><p> </p><p> Because multiple items are added the <code class="option">--noupdate</code> @@ -219,7 +223,7 @@ webmirror.directory: </p><p> This webmirror.directory file can be installed with: </p><pre class="programlisting"> -xdg-desktop-menu install --system --noupdate --vendor shinythings ./webmirror.directory +xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.directory </pre><p> </p><p> The *.desktop and *.directory files reference icons with the names @@ -228,12 +232,12 @@ xdg-desktop-menu install --system --noupdate --vendor shinythings ./webmirror.di sizes, once with a size of 22x22 pixels and once with a size of 64x64 pixels: </p><pre class="programlisting"> -xdg-icon-resource install --system --size 22 ./wmicon-22.png webmirror.png -xdg-icon-resource install --system --size 22 ./wmicon-menu-22.png webmirror-menu.png -xdg-icon-resource install --system --size 22 ./wmicon-admin-22.png webmirror-admin.png -xdg-icon-resource install --system --size 64 ./wmicon-64.png webmirror.png -xdg-icon-resource install --system --size 64 ./wmicon-menu-64.png webmirror-menu.png -xdg-icon-resource install --system --size 64 ./wmicon-admin-64.png 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 </pre><p> </p><p> The last step is to provide a .menu file that links it all @@ -258,12 +262,12 @@ webmirror.menu: </p><p> The webmirror.menu file can be installed with: </p><pre class="programlisting"> -xdg-desktop-menu install --system --noupdate --vendor shinythings ./webmirror.menu +xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.menu </pre><p> </p><p> After installing multiple files with <code class="option">--noupdate</code> make sure to force an update: </p><pre class="programlisting"> -xdg-desktop-menu forceupdate --system +xdg-desktop-menu forceupdate </pre><p> </p></div></div></body></html> diff --git a/portland/xdg-utils/scripts/html/xdg-email.html b/portland/xdg-utils/scripts/html/xdg-email.html index ed80892..d8e343b 100644 --- a/portland/xdg-utils/scripts/html/xdg-email.html +++ b/portland/xdg-utils/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.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> +<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> 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/portland/xdg-utils/scripts/html/xdg-icon-resource.html b/portland/xdg-utils/scripts/html/xdg-icon-resource.html index a1da0e4..a866f76 100644 --- a/portland/xdg-utils/scripts/html/xdg-icon-resource.html +++ b/portland/xdg-utils/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.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">--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">--user</code> | <code class="option">--system</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">--user</code> | <code class="option">--system</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>] { --user | --system }</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.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> 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. @@ -56,12 +56,16 @@ 16, 22, 32, 48, 64 and 128. Common sizes for icons in the mimetypes context are: 16, 22, 32, 48, 64 and 128 - </dd><dt><span class="term"><code class="option">--user</code></span></dt><dd> - Installs or uninstalls the icon for the current user only. - </dd><dt><span class="term"><code class="option">--system</code></span></dt><dd> - Installs or uninstalls the icon for all users on the system. - Usually only root is allowed to do this. - </dd><dt><span class="term"><code class="option">--help</code></span></dt><dd> + </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 + on the system. Usually only root is allowed to install in + system mode. + </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> Show command synopsis. </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> Show this manualpage. @@ -93,13 +97,13 @@ </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: </p><pre class="programlisting"> -xdg-icon-resource install --system --size 64 myfoobar.png +xdg-icon-resource install --size 64 myfoobar.png </pre><p> </p><p> To install an icon for a new application/x-foobar file type one can use: </p><pre class="programlisting"> -xdg-icon-resource install --system --context mimetypes --size 48 ./mime-foobar-48.png application-x-foobar.png -xdg-icon-resource install --system --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 </pre><p>This will install two icons with the name application-x-foobar.png -but with different sizes. The icons will be installed for use by all users. +but with different sizes. </p></div></div></body></html> diff --git a/portland/xdg-utils/scripts/html/xdg-mime.html b/portland/xdg-utils/scripts/html/xdg-mime.html index e3637f6..cd5f0e9 100644 --- a/portland/xdg-utils/scripts/html/xdg-mime.html +++ b/portland/xdg-utils/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.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">--user</code> | <code class="option">--system</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">--user</code> | <code class="option">--system</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.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> 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> @@ -56,12 +56,16 @@ and adding descriptions for new file types</p></div><div class="refsynopsisdiv"> must be a XML file that follows the freedesktop.org Shared MIME-info Database specification and that has a mime-info element as its document root. - </dd></dl></div></div><div class="refsect1" lang="en"><a name="options"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--user</code></span></dt><dd> - Adds or removes file type descriptions for the current user only. - </dd><dt><span class="term"><code class="option">--system</code></span></dt><dd> - Adds or removes file type descriptions for all users on the system. - Usually only root is allowed to do this. - </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">--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 + on the system. Usually only root is allowed to install in + system mode. + </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> Show command synopsis. </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> Show this manualpage. @@ -101,9 +105,9 @@ xdg-mime query default image/png registered to open PNG files. </p><p> </p><pre class="programlisting"> -xdg-mime install --system diff.xml -</pre><p>Adds a file type description for "diff"-files for all users on the - system. The file type description could look as folows. +xdg-mime install diff.xml +</pre><p>Adds a file type description for "diff"-files. + The file type description could look as folows. </p><pre class="programlisting"> diff.xml: @@ -118,6 +122,6 @@ diff.xml: </pre><p>An icon for this new file type must alsobe installed, for example with: </p><pre class="programlisting"> -xdg-icon-resource install --system --context mimetypes --size 64 text-x-diff.png +xdg-icon-resource install --context mimetypes --size 64 text-x-diff.png </pre><p> </p></div></div></body></html> diff --git a/portland/xdg-utils/scripts/html/xdg-open.html b/portland/xdg-utils/scripts/html/xdg-open.html index 8c19e90..bbe3874 100644 --- a/portland/xdg-utils/scripts/html/xdg-open.html +++ b/portland/xdg-utils/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.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> +<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> 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/portland/xdg-utils/scripts/html/xdg-screensaver.html b/portland/xdg-utils/scripts/html/xdg-screensaver.html index b5398e4..1476780 100644 --- a/portland/xdg-utils/scripts/html/xdg-screensaver.html +++ b/portland/xdg-utils/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.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> +<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> xdg-screensaver provides commands to control the screensaver. </p><p> xdg-screensaver is for use inside a desktop session only. diff --git a/portland/xdg-utils/scripts/html/xdg-su.html b/portland/xdg-utils/scripts/html/xdg-su.html index 7b8b9be..8055384 100644 --- a/portland/xdg-utils/scripts/html/xdg-su.html +++ b/portland/xdg-utils/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.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> +<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> 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/portland/xdg-utils/scripts/man/xdg-desktop-icon.1 b/portland/xdg-utils/scripts/man/xdg-desktop-icon.1 index e2ad44d..88d015b 100644 --- a/portland/xdg-utils/scripts/man/xdg-desktop-icon.1 +++ b/portland/xdg-utils/scripts/man/xdg-desktop-icon.1 @@ -1,129 +1,170 @@ -.\" ** 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" "This is release 0.5 of the xdg\-desktop\-i" "" -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.SH "NAME" -xdg\-desktop\-icon \- command line tool for (un)installing icons to the desktop +.\"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" +.ad l +.hy 0 .HP 17 -\fBxdg\-desktop\-icon\fR install [\fB\-\-vendor\ \fR\fB\fIvendor\-id\fR\fR] \fIFILE\fR +\fBxdg\-desktop\-icon\fR install [\fB\-\-vendor\ \fIvendor\-id\fR\fR] \fIFILE\fR +.ad +.hy +.ad l +.hy 0 .HP 17 -\fBxdg\-desktop\-icon\fR uninstall [\fB\-\-vendor\ \fR\fB\fIvendor\-id\fR\fR] \fIFILE\fR +\fBxdg\-desktop\-icon\fR uninstall [\fB\-\-vendor\ \fIvendor\-id\fR\fR] \fIFILE\fR +.ad +.hy +.ad l +.hy 0 .HP 17 -\fBxdg\-desktop\-icon\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +\fBxdg\-desktop\-icon\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} +.ad +.hy + .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. +Adds \fIvendor\-id\fR as a prefix when installing desktop files\&. + .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: -.sp +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: + .nf -webmirror.desktop: + +webmirror\&.desktop: [Desktop Entry] Encoding=UTF\-8 @@ -134,25 +175,29 @@ webmirror.desktop: 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: -.sp +Now the xdg\-desktop\-icon tool can be used to add the webmirror\&.desktop file to the desktop: + .nf -xdg\-desktop\-icon install \-\-vendor shinythings ./webmirror.desktop + +xdg\-desktop\-icon install \-\-vendor shinythings \&./webmirror\&.desktop + .fi -.sp + + .PP -To add a README file to the desktop as well, the following command can be used: -.sp +To add a README file to the desktop as well, the following command can be used: + .nf -xdg\-desktop\-icon install ./shinythings\-README + +xdg\-desktop\-icon install \&./shinythings\-README + .fi -.sp -.SH "AUTHOR" -Kevin Krammer, Jeremy White. -.br -<kevin.krammer@gmx.at> -.br -<jwhite@codeweavers.com> + + +.SH AUTHORS +Kevin Krammer, Jeremy White. diff --git a/portland/xdg-utils/scripts/man/xdg-desktop-menu.1 b/portland/xdg-utils/scripts/man/xdg-desktop-menu.1 index 8bbaf5b..fb113b0 100644 --- a/portland/xdg-utils/scripts/man/xdg-desktop-menu.1 +++ b/portland/xdg-utils/scripts/man/xdg-desktop-menu.1 @@ -1,162 +1,204 @@ -.\" ** 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" "This is release 0.5 of the xdg\-desktop\-m" "" -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.SH "NAME" -xdg\-desktop\-menu \- command line tool for (un)installing desktop menu items +.\"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" +.ad l +.hy 0 .HP 17 -\fBxdg\-desktop\-menu\fR install [\fB\-\-noupdate\fR] [\fB\-\-vendor\ \fR\fB\fIvendor\-id\fR\fR] {\fB\-\-user\fR \fB\-\-system\fR} {\fIdesktop\-file\fR \fImenu\-file\fR \fIdirectory\-file\fR} +\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 .HP 17 -\fBxdg\-desktop\-menu\fR uninstall [\fB\-\-noupdate\fR] [\fB\-\-vendor\ \fR\fB\fIvendor\-id\fR\fR] {\fB\-\-user\fR \fB\-\-system\fR} {\fIdesktop\-file\fR \fImenu\-file\fR \fIdirectory\-file\fR} +\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 .HP 17 -\fBxdg\-desktop\-menu\fR forceupdate {\fB\-\-user\fR \fB\-\-system\fR} +\fBxdg\-desktop\-menu\fR forceupdate [\fB\-\-mode\ \fImode\fR\fR] +.ad +.hy +.ad l +.hy 0 .HP 17 -\fBxdg\-desktop\-menu\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +\fBxdg\-desktop\-menu\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} +.ad +.hy + .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. -.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. +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\&. + .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. -.TP -\fB\-\-user\fR -Installs or uninstalls the file for the current user only. +Adds \fIvendor\-id\fR as a prefix when installing desktop and directory files\&. + .TP -\fB\-\-system\fR -Installs or uninstalls the file for all users on the system. Usually only root is allowed to do this. +\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\&. + .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: -.sp +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: + .nf -webmirror.desktop: + +webmirror\&.desktop: [Desktop Entry] Encoding=UTF\-8 @@ -169,24 +211,32 @@ 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: -.sp +Now the xdg\-desktop\-menu tool can be used to add the webmirror\&.desktop file to the desktop application menu: + .nf -xdg\-desktop\-menu install \-\-system \-\-vendor shinythings ./webmirror.desktop + +xdg\-desktop\-menu install \-\-vendor 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: -.sp +First the company needs to create two \&.desktop files that describe the two menu items, this time no Categories item is needed: + .nf -webmirror.desktop: + +webmirror\&.desktop: [Desktop Entry] Encoding=UTF\-8 @@ -199,7 +249,7 @@ webmirror.desktop: Name[nl]=WebSpiegel -webmirror\-admin.desktop: +webmirror\-admin\&.desktop: [Desktop Entry] Encoding=UTF\-8 @@ -210,25 +260,30 @@ webmirror\-admin.desktop: Name=WebMirror Admin Tool Name[nl]=WebSpiegel Administratie Tool + .fi -.sp + + .PP -The files can be installed with: -.sp +The files can be installed with: + .nf -xdg\-desktop\-menu install \-\-system \-\-noupdate \-\-vendor shinythings ./webmirror.desktop -xdg\-desktop\-menu install \-\-system \-\-noupdate \-\-vendor shinythings ./webmirror\-admin.desktop + +xdg\-desktop\-menu install \-\-noupdate \-\-vendor shinythings \&./webmirror\&.desktop +xdg\-desktop\-menu install \-\-noupdate \-\-vendor 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: -.sp +In addition a \&.directory file needs to be created to provide a title and icon for the sub\-menu itself: + .nf -webmirror.directory: + +webmirror\&.directory: [Desktop Entry] Encoding=UTF\-8 @@ -237,67 +292,78 @@ webmirror.directory: Name=WebMirror Name[nl]=WebSpiegel + .fi -.sp + + .PP -This webmirror.directory file can be installed with: -.sp +This webmirror\&.directory file can be installed with: + .nf -xdg\-desktop\-menu install \-\-system \-\-noupdate \-\-vendor shinythings ./webmirror.directory + +xdg\-desktop\-menu install \-\-noupdate \-\-vendor 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: -.sp +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: + .nf -xdg\-icon\-resource install \-\-system \-\-size 22 ./wmicon\-22.png webmirror.png -xdg\-icon\-resource install \-\-system \-\-size 22 ./wmicon\-menu\-22.png webmirror\-menu.png -xdg\-icon\-resource install \-\-system \-\-size 22 ./wmicon\-admin\-22.png webmirror\-admin.png -xdg\-icon\-resource install \-\-system \-\-size 64 ./wmicon\-64.png webmirror.png -xdg\-icon\-resource install \-\-system \-\-size 64 ./wmicon\-menu\-64.png webmirror\-menu.png -xdg\-icon\-resource install \-\-system \-\-size 64 ./wmicon\-admin\-64.png 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 + .fi -.sp + + .PP -The last step is to provide a .menu file that links it all togther: -.sp +The last step is to provide a \&.menu file that links it all togther: + .nf -webmirror.menu: - <!DOCTYPE Menu PUBLIC "\-//freedesktop//DTD Menu 1.0//EN" - "http://www.freedesktop.org/standards/menu\-spec/menu\-1.0.dtd"> +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> + <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: -.sp +The webmirror\&.menu file can be installed with: + .nf -xdg\-desktop\-menu install \-\-system \-\-noupdate \-\-vendor shinythings ./webmirror.menu + +xdg\-desktop\-menu install \-\-noupdate \-\-vendor shinythings \&./webmirror\&.menu + .fi -.sp + + .PP -After installing multiple files with -\fB\-\-noupdate\fR -make sure to force an update: -.sp +After installing multiple files with \fB\-\-noupdate\fR make sure to force an update: + .nf -xdg\-desktop\-menu forceupdate \-\-system + +xdg\-desktop\-menu forceupdate + .fi -.sp -.SH "AUTHOR" -Kevin Krammer, Jeremy White. -.br -<kevin.krammer@gmx.at> -.br -<jwhite@codeweavers.com> + + +.SH AUTHORS +Kevin Krammer, Jeremy White. diff --git a/portland/xdg-utils/scripts/man/xdg-email.1 b/portland/xdg-utils/scripts/man/xdg-email.1 index 9edcdb0..80fdfb9 100644 --- a/portland/xdg-utils/scripts/man/xdg-email.1 +++ b/portland/xdg-utils/scripts/man/xdg-email.1 @@ -1,118 +1,167 @@ -.\" ** 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" "This is release 0.5 of the xdg\-email Man" "" -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.SH "NAME" -xdg\-email \- command line tool for sending mail using the user's preferred e\-mail composer +.\"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" +.ad l +.hy 0 .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] {\fImailto\-uri\fR \fIaddress(es)\fR} +\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 .HP 10 -\fBxdg\-email\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +\fBxdg\-email\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} +.ad +.hy + .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. -.sp -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\&. + +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 -.sp -.SH "AUTHOR" -Kevin Krammer, Jeremy White. -.br -<kevin.krammer@gmx.at> -.br -<jwhite@codeweavers.com> + + +.SH AUTHORS +Kevin Krammer, Jeremy White. diff --git a/portland/xdg-utils/scripts/man/xdg-icon-resource.1 b/portland/xdg-utils/scripts/man/xdg-icon-resource.1 index a528160..ce93b59 100644 --- a/portland/xdg-utils/scripts/man/xdg-icon-resource.1 +++ b/portland/xdg-utils/scripts/man/xdg-icon-resource.1 @@ -1,151 +1,173 @@ -.\" ** 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" "This is release 0.5 of the xdg\-icon\-reso" "" -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.SH "NAME" -xdg\-icon\-resource \- command line tool for (un)installing icon resources +.\"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" +.ad l +.hy 0 .HP 18 -\fBxdg\-icon\-resource\fR install [\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\-\-user\fR \fB\-\-system\fR} \fIicon\-file\fR [\fIicon\-name\fR] +\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 .HP 18 -\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\-\-user\fR \fB\-\-system\fR} \fIicon\-name\fR +\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 .HP 18 -\fBxdg\-icon\-resource\fR forceupdate [\fB\-\-theme\ \fR\fB\fItheme\fR\fR] {\-\-user \-\-system} +\fBxdg\-icon\-resource\fR forceupdate [\fB\-\-theme\ \fItheme\fR\fR] [\fB\-\-mode\ \fImode\fR\fR] +.ad +.hy +.ad l +.hy 0 .HP 18 -\fBxdg\-icon\-resource\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +\fBxdg\-icon\-resource\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} +.ad +.hy + .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\-\-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\-\-user\fR -Installs or uninstalls the icon for the current user only. -.TP -\fB\-\-system\fR -Installs or uninstalls the icon for all users on the system. Usually only root is allowed to do this. +\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\&. + .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: -.sp +To install an icon resource to depict a launcher for the application myfoobar one can use: + .nf -xdg\-icon\-resource install \-\-system \-\-size 64 myfoobar.png + +xdg\-icon\-resource install \-\-size 64 myfoobar\&.png + .fi -.sp + + .PP -To install an icon for a new application/x\-foobar file type one can use: -.sp +To install an icon for a new application/x\-foobar file type one can use: + .nf -xdg\-icon\-resource install \-\-system \-\-context mimetypes \-\-size 48 ./mime\-foobar\-48.png application\-x\-foobar.png -xdg\-icon\-resource install \-\-system \-\-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 -.sp -This will install two icons with the name application\-x\-foobar.png but with different sizes. The icons will be installed for use by all users. -.SH "AUTHOR" -Kevin Krammer, Jeremy White. -.br -<kevin.krammer@gmx.at> -.br -<jwhite@codeweavers.com> +This will install two icons with the name application\-x\-foobar\&.png but with different sizes\&. + +.SH AUTHORS +Kevin Krammer, Jeremy White. diff --git a/portland/xdg-utils/scripts/man/xdg-mime.1 b/portland/xdg-utils/scripts/man/xdg-mime.1 index 99451c4..f8285a6 100644 --- a/portland/xdg-utils/scripts/man/xdg-mime.1 +++ b/portland/xdg-utils/scripts/man/xdg-mime.1 @@ -1,172 +1,207 @@ -.\" ** 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" "This is release 0.5 of the xdg\-mime Manu" "" -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.SH "NAME" -xdg\-mime \- command line tool for querying information about file type handling and adding descriptions for new file types +.\"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" +.ad l +.hy 0 .HP 9 -\fBxdg\-mime\fR query {filetype default} ... +\fBxdg\-mime\fR query {\fBfiletype\fR | \fBdefault\fR} \&.\&.\&. +.ad +.hy +.ad l +.hy 0 .HP 9 \fBxdg\-mime\fR default \fIapplication\fR \fImimetype(s)\fR +.ad +.hy +.ad l +.hy 0 .HP 9 -\fBxdg\-mime\fR install {\fB\-\-user\fR \fB\-\-system\fR} \fImimetypes\-file\fR +\fBxdg\-mime\fR install [\fB\-\-mode\ \fImode\fR\fR] \fImimetypes\-file\fR +.ad +.hy +.ad l +.hy 0 .HP 9 -\fBxdg\-mime\fR uninstall {\fB\-\-user\fR \fB\-\-system\fR} \fImimetypes\-file\fR +\fBxdg\-mime\fR uninstall [\fB\-\-mode\ \fImode\fR\fR] \fImimetypes\-file\fR +.ad +.hy +.ad l +.hy 0 .HP 9 -\fBxdg\-mime\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +\fBxdg\-mime\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} +.ad +.hy + .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. -.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 +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\&. + The following queries are supported: -.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. + +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\&. + .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. -.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. +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\&. + .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\-\-user\fR -Adds or removes file type descriptions for the current user only. -.TP -\fB\-\-system\fR -Adds or removes file type descriptions for all users on the system. Usually only root is allowed to do this. +\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\&. + .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 -.sp -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 + .PP + + .nf + xdg\-mime query default image/png + .fi -.sp -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\&. + .PP + + .nf -xdg\-mime install \-\-system diff.xml + +xdg\-mime install diff\&.xml + .fi -.sp -Adds a file type description for "diff"\-files for all users on the system. The file type description could look as folows. -.sp +Adds a file type description for "diff"\-files\&. The file type description could look as folows\&. + .nf -diff.xml: -<?xml version="1.0"?> -<mime\-info xmlns='http://www.freedesktop.org/standards/shared\-mime\-info'> +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"/> + <glob pattern="*\&.diff"/> + <glob pattern="*\&.patch"/> </mime\-type> </mime\-info> + .fi -.sp -An icon for this new file type must alsobe installed, for example with: -.sp +An icon for this new file type must alsobe installed, for example with: + .nf -xdg\-icon\-resource install \-\-system \-\-context mimetypes \-\-size 64 text\-x\-diff.png + +xdg\-icon\-resource install \-\-context mimetypes \-\-size 64 text\-x\-diff\&.png + .fi -.sp -.SH "AUTHOR" -Kevin Krammer, Jeremy White. -.br -<kevin.krammer@gmx.at> -.br -<jwhite@codeweavers.com> + + +.SH AUTHORS +Kevin Krammer, Jeremy White. diff --git a/portland/xdg-utils/scripts/man/xdg-open.1 b/portland/xdg-utils/scripts/man/xdg-open.1 index a271018..68ed3d7 100644 --- a/portland/xdg-utils/scripts/man/xdg-open.1 +++ b/portland/xdg-utils/scripts/man/xdg-open.1 @@ -1,65 +1,103 @@ -.\" ** 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/17/2006" "This is release 0.5 of the xdg\-open Manu" "" -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.SH "NAME" -xdg\-open \- opens a file or URL in the user's preferred application +.\"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" +.ad l +.hy 0 .HP 9 -\fBxdg\-open\fR {\fB\fIfile\fR\fR \fB\fIURL\fR\fR} +\fBxdg\-open\fR {\fB\fB\fIfile\fR\fR\fR | \fB\fB\fIURL\fR\fR\fR} +.ad +.hy +.ad l +.hy 0 .HP 9 -\fBxdg\-open\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +\fBxdg\-open\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} +.ad +.hy + .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 -.sp -Opens the Freedesktop.org website in the user's default browser + Opens the Freedesktop\&.org website in the user's default browser + .PP + + .nf -xdg\-open /tmp/foobar.png + +xdg\-open /tmp/foobar\&.png + .fi -.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> + Opens the PNG image file /tmp/foobar\&.png in the user's default image viewing application\&. + +.SH AUTHORS +Kevin Krammer, Jeremy White. diff --git a/portland/xdg-utils/scripts/man/xdg-screensaver.1 b/portland/xdg-utils/scripts/man/xdg-screensaver.1 index 7ddce67..c0cf741 100644 --- a/portland/xdg-utils/scripts/man/xdg-screensaver.1 +++ b/portland/xdg-utils/scripts/man/xdg-screensaver.1 @@ -1,96 +1,127 @@ -.\" ** 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/28/2006" "This is release 0.1 of the xdg\-screensav" "" -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.SH "NAME" -xdg\-screensaver \- command line tool for controlling the screensaver +.\"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" +.ad l +.hy 0 .HP 16 -\fBxdg\-screensaver\fR \fBsuspend\ \fR\fB\fIWindowID\fR\fR +\fBxdg\-screensaver\fR \fBsuspend\ \fIWindowID\fR\fR +.ad +.hy +.ad l +.hy 0 .HP 16 -\fBxdg\-screensaver\fR \fBresume\ \fR\fB\fIWindowID\fR\fR +\fBxdg\-screensaver\fR \fBresume\ \fIWindowID\fR\fR +.ad +.hy +.ad l +.hy 0 .HP 16 -\fBxdg\-screensaver\fR {\fBactivate\fR \fBreset\fR \fBstatus\fR} +\fBxdg\-screensaver\fR {\fB\fBactivate\fR\fR | \fB\fBreset\fR\fR | \fB\fBstatus\fR\fR} +.ad +.hy +.ad l +.hy 0 .HP 16 -\fBxdg\-screensaver\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR} +\fBxdg\-screensaver\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} +.ad +.hy + .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 \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 +\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 + .TP -\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 +\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 + .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. -.TP -\fB2\fR -One of the files passed on the command line did not exist. +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 -.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> +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. diff --git a/portland/xdg-utils/scripts/xdg-desktop-icon b/portland/xdg-utils/scripts/xdg-desktop-icon index 303e771..2aae895 100755 --- a/portland/xdg-utils/scripts/xdg-desktop-icon +++ b/portland/xdg-utils/scripts/xdg-desktop-icon @@ -34,15 +34,16 @@ 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 [--vendor vendor-id] FILE -xdg-desktop-icon uninstall [--vendor vendor-id] FILE + xdg-desktop-icon uninstall [--vendor vendor-id] FILE -xdg-desktop-icon { --help | --manual | --version } + xdg-desktop-icon { --help | --manual | --version } _USAGE } @@ -52,147 +53,165 @@ 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 [--vendor vendor-id] FILE -xdg-desktop-icon uninstall [--vendor vendor-id] FILE + xdg-desktop-icon uninstall [--vendor vendor-id] 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. ---help - Show command synopsis. ---manual - Show this manualpage. ---version - Show the xdg-utils version information. + --vendor vendor-id + Adds vendor-id as a prefix when installing desktop files. + + --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: + 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. -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. + 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: - -webmirror.desktop: + 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: - [Desktop Entry] - Encoding=UTF-8 - Type=Application + webmirror.desktop: - Exec=webmirror - Icon=webmirror + [Desktop Entry] + Encoding=UTF-8 + Type=Application - Name=WebMirror - Name[nl]=WebSpiegel + Exec=webmirror + Icon=webmirror -Now the xdg-desktop-icon tool can be used to add the webmirror.desktop file to -the desktop: + Name=WebMirror + Name[nl]=WebSpiegel -xdg-desktop-icon install --vendor shinythings ./webmirror.desktop + Now the xdg-desktop-icon tool can be used to add the webmirror.desktop + file to the desktop: -To add a README file to the desktop as well, the following command can be used: + xdg-desktop-icon install --vendor shinythings ./webmirror.desktop -xdg-desktop-icon install ./shinythings-README + To add a README file to the desktop as well, the following command can be + used: + xdg-desktop-icon install ./shinythings-README _MANUALPAGE } diff --git a/portland/xdg-utils/scripts/xdg-desktop-menu b/portland/xdg-utils/scripts/xdg-desktop-menu index f7d7eb2..3b76de9 100755 --- a/portland/xdg-utils/scripts/xdg-desktop-menu +++ b/portland/xdg-utils/scripts/xdg-desktop-menu @@ -35,301 +35,331 @@ 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] { --user | --system -} { desktop-file | menu-file | directory-file } + xdg-desktop-menu install [--noupdate] [--vendor vendor-id] [--mode mode] { + desktop-file | menu-file | directory-file } -xdg-desktop-menu uninstall [--noupdate] [--vendor vendor-id] { --user | ---system } { 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 forceupdate { --user | --system } + 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. ---user - Installs or uninstalls the file for the current user only. ---system - Installs or uninstalls the file for all users on the system. Usually only - root is allowed to do this. ---help - Show command synopsis. ---manual - Show this manualpage. ---version - Show the xdg-utils version information. + --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. + + --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. 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: + 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. -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. + 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: -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 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 --system --vendor 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: -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 -webmirror-admin.desktop: + webmirror-admin.desktop: - [Desktop Entry] - Encoding=UTF-8 - Type=Application + [Desktop Entry] + Encoding=UTF-8 + Type=Application - Exec=webmirror-admintool - Icon=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 --system --noupdate --vendor shinythings ./webmirror.desktop -xdg-desktop-menu install --system --noupdate --vendor 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: -webmirror.directory: + webmirror.directory: - [Desktop Entry] - Encoding=UTF-8 + [Desktop Entry] + Encoding=UTF-8 - Icon=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 --system --noupdate --vendor 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 --system --size 22 ./wmicon-22.png webmirror.png -xdg-icon-resource install --system --size 22 ./wmicon-menu-22.png webmirror-menu.png -xdg-icon-resource install --system --size 22 ./wmicon-admin-22.png webmirror-admin.png -xdg-icon-resource install --system --size 64 ./wmicon-64.png webmirror.png -xdg-icon-resource install --system --size 64 ./wmicon-menu-64.png webmirror-menu.png -xdg-icon-resource install --system --size 64 ./wmicon-admin-64.png 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: -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 webmirror.menu file can be installed with: + The webmirror.menu file can be installed with: -xdg-desktop-menu install --system --noupdate --vendor shinythings ./webmirror.menu + xdg-desktop-menu install --noupdate --vendor shinythings ./webmirror.menu -After installing multiple files with --noupdate make sure to force an update: - -xdg-desktop-menu forceupdate --system + After installing multiple files with --noupdate make sure to force an + update: + 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] { --user | --system -} { desktop-file | menu-file | directory-file } + xdg-desktop-menu install [--noupdate] [--vendor vendor-id] [--mode mode] { + desktop-file | menu-file | directory-file } -xdg-desktop-menu uninstall [--noupdate] [--vendor vendor-id] { --user | ---system } { 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 forceupdate { --user | --system } + xdg-desktop-menu forceupdate [--mode mode] -xdg-desktop-menu { --help | --manual | --version } + xdg-desktop-menu { --help | --manual | --version } _USAGE } @@ -571,12 +601,24 @@ while [ $# -gt 0 ] ; do update=no ;; - --user) - mode=user - ;; + --mode) + if [ -z "$1" ] ; then + exit_failure_syntax "mode argument missing for --mode" + fi + case "$1" in + user) + mode=user + ;; - --system) - mode=system + system) + mode=system + ;; + + *) + exit_failure_syntax "unknown mode '$1'" + ;; + esac + shift ;; --vendor) @@ -609,7 +651,11 @@ if [ -z "$action" ] ; then fi if [ -z "$mode" ] ; then - exit_failure_syntax "expected --user or --system option" + if [ `whoami` = "root" ] ; then + mode=system + else + mode=user + fi fi if [ x"$action" = x"forceupdate" ] ; then @@ -699,8 +745,7 @@ else gnome_dir="$gnome_global_dir" my_umask=022 if [ -z "${xdg_dir}${kde_dir}${gnome_dir}" ] ; then - [ `whoami` = "root" ] || rootmsg="Try as root or use --user." - exit_failure_operation_impossible "No writable system menu directory found. $rootmsg" + exit_failure_operation_impossible "No writable system menu directory found." fi fi diff --git a/portland/xdg-utils/scripts/xdg-desktop-menu.in b/portland/xdg-utils/scripts/xdg-desktop-menu.in index e22b854..01ba59b 100644 --- a/portland/xdg-utils/scripts/xdg-desktop-menu.in +++ b/portland/xdg-utils/scripts/xdg-desktop-menu.in @@ -78,12 +78,24 @@ while [ $# -gt 0 ] ; do update=no ;; - --user) - mode=user - ;; - - --system) - mode=system + --mode) + if [ -z "$1" ] ; then + exit_failure_syntax "mode argument missing for --mode" + fi + case "$1" in + user) + mode=user + ;; + + system) + mode=system + ;; + + *) + exit_failure_syntax "unknown mode '$1'" + ;; + esac + shift ;; --vendor) @@ -116,7 +128,11 @@ if [ -z "$action" ] ; then fi if [ -z "$mode" ] ; then - exit_failure_syntax "expected --user or --system option" + if [ `whoami` = "root" ] ; then + mode=system + else + mode=user + fi fi if [ x"$action" = x"forceupdate" ] ; then @@ -206,8 +222,7 @@ else gnome_dir="$gnome_global_dir" my_umask=022 if [ -z "${xdg_dir}${kde_dir}${gnome_dir}" ] ; then - [ `whoami` = "root" ] || rootmsg="Try as root or use --user." - exit_failure_operation_impossible "No writable system menu directory found. $rootmsg" + exit_failure_operation_impossible "No writable system menu directory found." fi fi diff --git a/portland/xdg-utils/scripts/xdg-email b/portland/xdg-utils/scripts/xdg-email index 2f15971..b1f2f5e 100755 --- a/portland/xdg-utils/scripts/xdg-email +++ b/portland/xdg-utils/scripts/xdg-email @@ -37,122 +37,135 @@ 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: + 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. -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. + 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 --attach /tmp/logo.png \ - --subject 'Logo contest' \ - --body 'Attached you find the logo for the contest.' \ - 'jwhite@example.com' + xdg-email 'Jeremy White <jwhite@example.com>' -xdg-email --subject 'Your password is about to expire' \ - 'jwhite@example.com' 'bastian@example.com' 'whipple@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' _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 } diff --git a/portland/xdg-utils/scripts/xdg-icon-resource b/portland/xdg-utils/scripts/xdg-icon-resource index 49b1cb1..25218cb 100755 --- a/portland/xdg-utils/scripts/xdg-icon-resource +++ b/portland/xdg-utils/scripts/xdg-icon-resource @@ -36,145 +36,164 @@ 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] { --user | --system } icon-file [icon-name] + xdg-icon-resource install [--noupdate] [--theme theme] [--context context] + [--size size] [--mode mode] icon-file [icon-name] -xdg-icon-resource uninstall [--noupdate] [--theme theme] [--context context] -[--size size] { --user | --system } icon-name + xdg-icon-resource uninstall [--noupdate] [--theme theme] [--context + context] [--size size] [--mode mode] icon-name -xdg-icon-resource forceupdate [--theme theme] { --user | --system } + 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 ---user - Installs or uninstalls the icon for the current user only. ---system - Installs or uninstalls the icon for all users on the system. Usually only - root is allowed to do this. ---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. + + --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: + 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. -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. + 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 one can use: -xdg-icon-resource install --system --size 64 myfoobar.png + xdg-icon-resource install --size 64 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 --system --context mimetypes --size 48 ./mime-foobar-48.png application-x-foobar.png -xdg-icon-resource install --system --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. The icons will be installed for use by all users. + 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. _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] { --user | --system } icon-file [icon-name] + xdg-icon-resource install [--noupdate] [--theme theme] [--context context] + [--size size] [--mode mode] icon-file [icon-name] -xdg-icon-resource uninstall [--noupdate] [--theme theme] [--context context] -[--size size] { --user | --system } icon-name + xdg-icon-resource uninstall [--noupdate] [--theme theme] [--context + context] [--size size] [--mode mode] icon-name -xdg-icon-resource forceupdate [--theme theme] { --user | --system } + xdg-icon-resource forceupdate [--theme theme] [--mode mode] -xdg-icon-resource { --help | --manual | --version } + xdg-icon-resource { --help | --manual | --version } _USAGE } @@ -417,12 +436,24 @@ while [ $# -gt 0 ] ; do update=no ;; - --user) - mode=user - ;; + --mode) + if [ -z "$1" ] ; then + exit_failure_syntax "mode argument missing for --mode" + fi + case "$1" in + user) + mode=user + ;; - --system) - mode=system + system) + mode=system + ;; + + *) + exit_failure_syntax "unknown mode '$1'" + ;; + esac + shift ;; --theme) @@ -479,7 +510,11 @@ if [ -z "$context" ] ; then fi if [ -z "$mode" ] ; then - exit_failure_syntax "expected --user or --system option" + if [ `whoami` = "root" ] ; then + mode=system + else + mode=user + fi fi xdg_dir_name="icons/$theme" @@ -507,8 +542,7 @@ if [ x"$mode" = x"user" ] ; then else xdg_base_dir="$xdg_global_dir" if [ -z "$xdg_base_dir" ] ; then - [ `whoami` = "root" ] || rootmsg="Try as root or use --user." - exit_failure_operation_impossible "No writable system icon directory found. $rootmsg" + exit_failure_operation_impossible "No writable system icon directory found." fi fi diff --git a/portland/xdg-utils/scripts/xdg-icon-resource.in b/portland/xdg-utils/scripts/xdg-icon-resource.in index 6ba0e83..63f009d 100644 --- a/portland/xdg-utils/scripts/xdg-icon-resource.in +++ b/portland/xdg-utils/scripts/xdg-icon-resource.in @@ -80,12 +80,24 @@ while [ $# -gt 0 ] ; do update=no ;; - --user) - mode=user - ;; - - --system) - mode=system + --mode) + if [ -z "$1" ] ; then + exit_failure_syntax "mode argument missing for --mode" + fi + case "$1" in + user) + mode=user + ;; + + system) + mode=system + ;; + + *) + exit_failure_syntax "unknown mode '$1'" + ;; + esac + shift ;; --theme) @@ -142,7 +154,11 @@ if [ -z "$context" ] ; then fi if [ -z "$mode" ] ; then - exit_failure_syntax "expected --user or --system option" + if [ `whoami` = "root" ] ; then + mode=system + else + mode=user + fi fi xdg_dir_name="icons/$theme" @@ -170,8 +186,7 @@ if [ x"$mode" = x"user" ] ; then else xdg_base_dir="$xdg_global_dir" if [ -z "$xdg_base_dir" ] ; then - [ `whoami` = "root" ] || rootmsg="Try as root or use --user." - exit_failure_operation_impossible "No writable system icon directory found. $rootmsg" + exit_failure_operation_impossible "No writable system icon directory found." fi fi diff --git a/portland/xdg-utils/scripts/xdg-mime b/portland/xdg-utils/scripts/xdg-mime index ae9e1ce..6021096 100755 --- a/portland/xdg-utils/scripts/xdg-mime +++ b/portland/xdg-utils/scripts/xdg-mime @@ -46,9 +46,9 @@ Synopsis xdg-mime default application mimetype(s) - xdg-mime install { --user | --system } mimetypes-file + xdg-mime install [--mode mode] mimetypes-file - xdg-mime uninstall { --user | --system } mimetypes-file + xdg-mime uninstall [--mode mode] mimetypes-file xdg-mime { --help | --manual | --version } @@ -117,12 +117,15 @@ Commands Options - --user - Adds or removes file type descriptions for the current user only. + --mode mode - --system - Adds or removes file type descriptions for all users on the - system. Usually only root is allowed to do this. + 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. @@ -177,10 +180,10 @@ Examples Prints the .desktop filename of the application which is registered to open PNG files. - xdg-mime install --system diff.xml + xdg-mime install diff.xml - Adds a file type description for "diff"-files for all users on the system. - The file type description could look as folows. + Adds a file type description for "diff"-files. The file type description + could look as folows. diff.xml: @@ -195,7 +198,7 @@ Examples An icon for this new file type must alsobe installed, for example with: - xdg-icon-resource install --system --context mimetypes --size 64 text-x-diff.png + xdg-icon-resource install --context mimetypes --size 64 text-x-diff.png _MANUALPAGE } @@ -211,9 +214,9 @@ Synopsis xdg-mime default application mimetype(s) - xdg-mime install { --user | --system } mimetypes-file + xdg-mime install [--mode mode] mimetypes-file - xdg-mime uninstall { --user | --system } mimetypes-file + xdg-mime uninstall [--mode mode] mimetypes-file xdg-mime { --help | --manual | --version } @@ -776,12 +779,24 @@ while [ $# -gt 0 ] ; do shift case $parm in - --user) - mode=user - ;; + --mode) + if [ -z "$1" ] ; then + exit_failure_syntax "mode argument missing for --mode" + fi + case "$1" in + user) + mode=user + ;; - --system) - mode=system + system) + mode=system + ;; + + *) + exit_failure_syntax "unknown mode '$1'" + ;; + esac + shift ;; -*) @@ -803,10 +818,14 @@ if [ -z "$action" ] ; then exit_failure_syntax "command argument missing" fi - if [ -z "$mode" ] ; then - exit_failure_syntax "expected --user or --system option" + if [ `whoami` = "root" ] ; then + mode=system + else + mode=user + fi fi + if [ -z "$filename" ] ; then exit_failure_syntax "mimetypes-file argument missing" fi @@ -868,8 +887,7 @@ else gnome_dir="$gnome_global_dir" my_umask=022 if [ -z "${xdg_dir}${kde_dir}${gnome_dir}" ] ; then - [ `whoami` = "root" ] || rootmsg="Try as root or use --user." - exit_failure_operation_impossible "No writable system mimetype directory found. $rootmsg" + exit_failure_operation_impossible "No writable system mimetype directory found." fi fi diff --git a/portland/xdg-utils/scripts/xdg-mime.in b/portland/xdg-utils/scripts/xdg-mime.in index 105baf5..1cf0101 100755 --- a/portland/xdg-utils/scripts/xdg-mime.in +++ b/portland/xdg-utils/scripts/xdg-mime.in @@ -399,12 +399,24 @@ while [ $# -gt 0 ] ; do shift case $parm in - --user) - mode=user - ;; + --mode) + if [ -z "$1" ] ; then + exit_failure_syntax "mode argument missing for --mode" + fi + case "$1" in + user) + mode=user + ;; - --system) - mode=system + system) + mode=system + ;; + + *) + exit_failure_syntax "unknown mode '$1'" + ;; + esac + shift ;; -*) @@ -426,10 +438,14 @@ if [ -z "$action" ] ; then exit_failure_syntax "command argument missing" fi - if [ -z "$mode" ] ; then - exit_failure_syntax "expected --user or --system option" + if [ `whoami` = "root" ] ; then + mode=system + else + mode=user + fi fi + if [ -z "$filename" ] ; then exit_failure_syntax "mimetypes-file argument missing" fi @@ -491,8 +507,7 @@ else gnome_dir="$gnome_global_dir" my_umask=022 if [ -z "${xdg_dir}${kde_dir}${gnome_dir}" ] ; then - [ `whoami` = "root" ] || rootmsg="Try as root or use --user." - exit_failure_operation_impossible "No writable system mimetype directory found. $rootmsg" + exit_failure_operation_impossible "No writable system mimetype directory found." fi fi diff --git a/portland/xdg-utils/scripts/xdg-open b/portland/xdg-utils/scripts/xdg-open index 3ff63e5..898ea77 100755 --- a/portland/xdg-utils/scripts/xdg-open +++ b/portland/xdg-utils/scripts/xdg-open @@ -36,71 +36,75 @@ 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: + 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. + 1 + Error in command line syntax. -Examples + 2 + One of the files passed on the command line did not exist. -xdg-open 'http://www.freedesktop.org/' + 3 + A required tool could not be found. + + 4 + The action failed. + +Examples -Opens the Freedesktop.org website in the user's default browser + xdg-open 'http://www.freedesktop.org/' -xdg-open /tmp/foobar.png + Opens the Freedesktop.org website in the user's default browser -Opens the PNG image file /tmp/foobar.png in the user's default image viewing -application. + xdg-open /tmp/foobar.png + 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 } diff --git a/portland/xdg-utils/scripts/xdg-screensaver b/portland/xdg-utils/scripts/xdg-screensaver index f1374eb..1bf0530 100755 --- a/portland/xdg-utils/scripts/xdg-screensaver +++ b/portland/xdg-utils/scripts/xdg-screensaver @@ -35,102 +35,113 @@ 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: + 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. + 1 + Error in command line syntax. -Examples + 2 + One of the files passed on the command line did not exist. -xdg-screensaver suspend 0x1c00007 + 3 + A required tool could not be found. + + 4 + The action failed. + +Examples -Causes the screensaver to be disabled till xdg-screensaver resume 0x1c00007 is -called. 0x1c00007 must be the X Window ID of an existing window. + 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. _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 } |