diff options
| author | Waldo Bastian <waldo.bastian@intel.com> | 2006-06-15 00:44:19 +0000 |
|---|---|---|
| committer | Waldo Bastian <waldo.bastian@intel.com> | 2006-06-15 00:44:19 +0000 |
| commit | 8cbf5169ec50e15872aeb73006689bdd5afe7007 (patch) | |
| tree | ea873509516b42d4b6bb4f0a3d1b03485f9bf742 /scripts | |
| parent | 1a7591e6f1f0097ab54dc42894f12c2132264c2d (diff) | |
* --help: Don't show examples, refer to --manual for additional info
* Added --manual: Show entire manual page
Diffstat (limited to 'scripts')
52 files changed, 1237 insertions, 148 deletions
diff --git a/scripts/desc/xdg-copy.xml b/scripts/desc/xdg-copy.xml index 50e6f3d..72cc540 100644 --- a/scripts/desc/xdg-copy.xml +++ b/scripts/desc/xdg-copy.xml @@ -43,6 +43,7 @@ <command>xdg-copy</command> <group choice="req"> <arg choice="plain"><option>--help</option></arg> + <arg choice="plain"><option>--manual</option></arg> <arg choice="plain"><option>--version</option></arg> </group> </cmdsynopsis> @@ -70,7 +71,16 @@ <term><option>--help</option></term> <listitem> <simpara> - Show this help. + Show command synopsis. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--manual</option></term> + <listitem> + <simpara> + Show this manualpage. </simpara> </listitem> </varlistentry> diff --git a/scripts/desc/xdg-desktop.xml b/scripts/desc/xdg-desktop.xml index 64a520d..2c3bd37 100755 --- a/scripts/desc/xdg-desktop.xml +++ b/scripts/desc/xdg-desktop.xml @@ -50,6 +50,7 @@ <command>xdg-desktop</command> <group choice="req"> <arg choice="plain"><option>--help</option></arg> + <arg choice="plain"><option>--manual</option></arg> <arg choice="plain"><option>--version</option></arg> </group> </cmdsynopsis> @@ -108,7 +109,16 @@ <term><option>--help</option></term> <listitem> <simpara> - Show this help. + Show command synopsis. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--manual</option></term> + <listitem> + <simpara> + Show this manualpage. </simpara> </listitem> </varlistentry> diff --git a/scripts/desc/xdg-email.xml b/scripts/desc/xdg-email.xml index b5bd636..c57a227 100755 --- a/scripts/desc/xdg-email.xml +++ b/scripts/desc/xdg-email.xml @@ -51,6 +51,7 @@ <command>xdg-email</command> <group choice="req"> <arg choice="plain"><option>--help</option></arg> + <arg choice="plain"><option>--manual</option></arg> <arg choice="plain"><option>--version</option></arg> </group> </cmdsynopsis> @@ -149,7 +150,16 @@ <term><option>--help</option></term> <listitem> <simpara> - Show this help. + Show command synopsis. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--manual</option></term> + <listitem> + <simpara> + Show this manualpage. </simpara> </listitem> </varlistentry> diff --git a/scripts/desc/xdg-file-dialog.xml b/scripts/desc/xdg-file-dialog.xml index 0fdac2d..11c2542 100644 --- a/scripts/desc/xdg-file-dialog.xml +++ b/scripts/desc/xdg-file-dialog.xml @@ -57,6 +57,7 @@ <command>xdg-file-dialog</command> <group choice="req"> <arg choice="plain"><option>--help</option></arg> + <arg choice="plain"><option>--manual</option></arg> <arg choice="plain"><option>--version</option></arg> </group> </cmdsynopsis> @@ -134,12 +135,21 @@ </varlistentry> <varlistentry> - <term><option>--help</option></term> - <listitem> - <simpara> - Show this help. - </simpara> - </listitem> + <term><option>--help</option></term> + <listitem> + <simpara> + Show command synopsis. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--manual</option></term> + <listitem> + <simpara> + Show this manualpage. + </simpara> + </listitem> </varlistentry> <varlistentry> diff --git a/scripts/desc/xdg-icon.xml b/scripts/desc/xdg-icon.xml index 50b954b..f7187dd 100755 --- a/scripts/desc/xdg-icon.xml +++ b/scripts/desc/xdg-icon.xml @@ -74,6 +74,7 @@ <command>xdg-icon</command> <group choice="req"> <arg choice="plain"><option>--help</option></arg> + <arg choice="plain"><option>--manual</option></arg> <arg choice="plain"><option>--version</option></arg> </group> </cmdsynopsis> @@ -214,7 +215,16 @@ <term><option>--help</option></term> <listitem> <simpara> - Show this help. + Show command synopsis. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--manual</option></term> + <listitem> + <simpara> + Show this manualpage. </simpara> </listitem> </varlistentry> diff --git a/scripts/desc/xdg-menu.xml b/scripts/desc/xdg-menu.xml index f799aa8..7ff35bf 100755 --- a/scripts/desc/xdg-menu.xml +++ b/scripts/desc/xdg-menu.xml @@ -75,8 +75,9 @@ <cmdsynopsis> <command>xdg-menu</command> <group choice="req"> - <arg choice="plain">--help</arg> - <arg choice="plain">--version</arg> + <arg choice="plain"><option>--help</option></arg> + <arg choice="plain"><option>--manual</option></arg> + <arg choice="plain"><option>--version</option></arg> </group> </cmdsynopsis> </refsynopsisdiv> @@ -190,7 +191,16 @@ <term><option>--help</option></term> <listitem> <simpara> - Show this help. + Show command synopsis. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--manual</option></term> + <listitem> + <simpara> + Show this manualpage. </simpara> </listitem> </varlistentry> diff --git a/scripts/desc/xdg-mime.xml b/scripts/desc/xdg-mime.xml index f145f0d..40dcd96 100644 --- a/scripts/desc/xdg-mime.xml +++ b/scripts/desc/xdg-mime.xml @@ -66,6 +66,7 @@ and adding descriptions for new file types</refpurpose> <command>xdg-mime</command> <group choice="req"> <arg choice="plain"><option>--help</option></arg> + <arg choice="plain"><option>--manual</option></arg> <arg choice="plain"><option>--version</option></arg> </group> </cmdsynopsis> @@ -168,7 +169,16 @@ and adding descriptions for new file types</refpurpose> <term><option>--help</option></term> <listitem> <simpara> - Show this help. + Show command synopsis. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--manual</option></term> + <listitem> + <simpara> + Show this manualpage. </simpara> </listitem> </varlistentry> diff --git a/scripts/desc/xdg-open.xml b/scripts/desc/xdg-open.xml index 498390e..acd5b1a 100755 --- a/scripts/desc/xdg-open.xml +++ b/scripts/desc/xdg-open.xml @@ -45,6 +45,7 @@ <command>xdg-open</command> <group choice="req"> <arg choice="plain"><option>--help</option></arg> + <arg choice="plain"><option>--manual</option></arg> <arg choice="plain"><option>--version</option></arg> </group> </cmdsynopsis> @@ -71,7 +72,16 @@ <term><option>--help</option></term> <listitem> <simpara> - Show this help. + Show command synopsis. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--manual</option></term> + <listitem> + <simpara> + Show this manualpage. </simpara> </listitem> </varlistentry> diff --git a/scripts/desc/xdg-screensaver.xml b/scripts/desc/xdg-screensaver.xml index 2a4c338..5ad281a 100755 --- a/scripts/desc/xdg-screensaver.xml +++ b/scripts/desc/xdg-screensaver.xml @@ -43,6 +43,7 @@ <command>xdg-screensaver</command> <group choice="req"> <arg choice="plain"><option>--help</option></arg> + <arg choice="plain"><option>--manual</option></arg> <arg choice="plain"><option>--version</option></arg> </group> </cmdsynopsis> @@ -120,7 +121,16 @@ <term><option>--help</option></term> <listitem> <simpara> - Show this help. + Show command synopsis. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--manual</option></term> + <listitem> + <simpara> + Show this manualpage. </simpara> </listitem> </varlistentry> diff --git a/scripts/desc/xdg-su.xml b/scripts/desc/xdg-su.xml index 9518315..0e900b5 100755 --- a/scripts/desc/xdg-su.xml +++ b/scripts/desc/xdg-su.xml @@ -43,6 +43,7 @@ <command>xdg-su</command> <group choice="req"> <arg choice="plain"><option>--help</option></arg> + <arg choice="plain"><option>--manual</option></arg> <arg choice="plain"><option>--version</option></arg> </group> </cmdsynopsis> @@ -76,7 +77,16 @@ <term><option>--help</option></term> <listitem> <simpara> - Show this help. + Show command synopsis. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--manual</option></term> + <listitem> + <simpara> + Show this manualpage. </simpara> </listitem> </varlistentry> diff --git a/scripts/generate-help-script.awk b/scripts/generate-help-script.awk index b59dfd6..5677c8e 100644 --- a/scripts/generate-help-script.awk +++ b/scripts/generate-help-script.awk @@ -47,21 +47,23 @@ # Insert the examples text from the .txt file -# after the "cat << _EXAMPLES" line -/^cat << _EXAMPLES/ { +# after the "cat << _MANUALPAGE" line +/^cat << _MANUALPAGE/ { # determine the name of the .txt file txtfile = FILENAME sub(/\.in$/, ".txt", txtfile) # read the .txt file content for (txtfile_print = 0; getline < txtfile; ) { - if (match ($0, /^Examples/) != 0) { - # print everything starting at the "Examples" line - txtfile_print = 1 - } - if (txtfile_print != 0) { - print $0 - } +# if (match ($0, /^Examples/) != 0) { +# # print everything starting at the "Examples" line +# txtfile_print = 1 +# } +# if (txtfile_print != 0) { +# print $0 +# } + gsub("`","'") + print $0 } close (txtfile) } diff --git a/scripts/html/xdg-copy.html b/scripts/html/xdg-copy.html index ca0873d..2a8efbf 100644 --- a/scripts/html/xdg-copy.html +++ b/scripts/html/xdg-copy.html @@ -1,4 +1,4 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-copy</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-copy"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-copy — command line tool for copying files between desktop URIs</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-copy</code> <code class="option"><em class="replaceable"><code>source</code></em></code> <code class="option"><em class="replaceable"><code>destination</code></em></code> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-copy</code> { <code class="option">--help</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-copy</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-copy"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-copy — command line tool for copying files between desktop URIs</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-copy</code> <code class="option"><em class="replaceable"><code>source</code></em></code> <code class="option"><em class="replaceable"><code>destination</code></em></code> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-copy</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-copy copies <em class="replaceable"><code>source</code></em> to <em class="replaceable"><code>destination</code></em> and provides visual feedback to the user during the operation. Both <em class="replaceable"><code>source</code></em> @@ -9,7 +9,9 @@ xdg-copy is for use inside a desktop session only. It is not recommended to use xdg-copy as root. </p></div><div class="refsect1" lang="en"><a name="options"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--help</code></span></dt><dd> - Show this help. + Show command synopsis. + </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> + Show this manualpage. </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> Show the xdg-utils version information. </dd></dl></div></div><div class="refsect1" lang="en"><a name="exitcodes"></a><h2>Exit Codes</h2><p> diff --git a/scripts/html/xdg-desktop.html b/scripts/html/xdg-desktop.html index 6ba8e51..3e96d88 100644 --- a/scripts/html/xdg-desktop.html +++ b/scripts/html/xdg-desktop.html @@ -1,4 +1,4 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-desktop</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"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-desktop — 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</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</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</code> { <code class="option">--help</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</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"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-desktop — 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</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</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</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 program can be used to install an application launcher or other file on the desktop of the current user. </p><p> @@ -15,7 +15,9 @@ Adds <em class="replaceable"><code>vendor-id</code></em> as a prefix when installing desktop files. </dd><dt><span class="term"><code class="option">--help</code></span></dt><dd> - Show this help. + Show command synopsis. + </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> + Show this manualpage. </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> Show the xdg-utils version information. </dd></dl></div></div><div class="refsect1" lang="en"><a name="desktopfiles"></a><h2>Desktop Files</h2><p> diff --git a/scripts/html/xdg-email.html b/scripts/html/xdg-email.html index 1b7157b..74f3d4a 100644 --- a/scripts/html/xdg-email.html +++ b/scripts/html/xdg-email.html @@ -1,4 +1,4 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-email</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="xdg-email"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-email — command line tool for sending mail using the user's preferred e-mail composer</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-email</code> [<code class="option">--utf8</code>] [<code class="option">--cc</code> <em class="replaceable"><code>address</code></em>] [<code class="option">--bcc</code> <em class="replaceable"><code>address</code></em>] [<code class="option">--subject</code> <em class="replaceable"><code>text</code></em>] [<code class="option">--body</code> <em class="replaceable"><code>text</code></em>] [<code class="option">--attach</code> <em class="replaceable"><code>file</code></em>] { <em class="replaceable"><code>mailto-uri</code></em> | <em class="replaceable"><code>address(es)</code></em> }</p></div><div class="cmdsynopsis"><p><code class="command">xdg-email</code> { <code class="option">--help</code> | <code class="option">--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: @@ -37,7 +37,9 @@ Specify an attachment for the e-mail. <em class="replaceable"><code>file</code></em> must point to an existing file. </dd><dt><span class="term"><code class="option">--help</code></span></dt><dd> - Show this help. + Show command synopsis. + </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> + Show this manualpage. </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> Show the xdg-utils version information. </dd></dl></div></div><div class="refsect1" lang="en"><a name="exitcodes"></a><h2>Exit Codes</h2><p> diff --git a/scripts/html/xdg-file-dialog.html b/scripts/html/xdg-file-dialog.html index 5ff7aca..81b3531 100644 --- a/scripts/html/xdg-file-dialog.html +++ b/scripts/html/xdg-file-dialog.html @@ -1,4 +1,4 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-file-dialog</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-file-dialog"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-file-dialog — command line tool for providing file and directory selection dialogs</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-file-dialog</code> openfilename [<code class="option">--title <em class="replaceable"><code>TITLE</code></em></code>] [<em class="replaceable"><code>FILENAME</code></em>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-file-dialog</code> openfilenamelist [<code class="option">--title <em class="replaceable"><code>TITLE</code></em></code>] [<em class="replaceable"><code>FILENAME</code></em>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-file-dialog</code> savefilename [<code class="option">--title <em class="replaceable"><code>TITLE</code></em></code>] [<em class="replaceable"><code>FILENAME</code></em>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-file-dialog</code> directory [<code class="option">--title <em class="replaceable"><code>TITLE</code></em></code>] [<em class="replaceable"><code>DIRNAME</code></em>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-file-dialog</code> { <code class="option">--help</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-file-dialog</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-file-dialog"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-file-dialog — command line tool for providing file and directory selection dialogs</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-file-dialog</code> openfilename [<code class="option">--title <em class="replaceable"><code>TITLE</code></em></code>] [<em class="replaceable"><code>FILENAME</code></em>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-file-dialog</code> openfilenamelist [<code class="option">--title <em class="replaceable"><code>TITLE</code></em></code>] [<em class="replaceable"><code>FILENAME</code></em>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-file-dialog</code> savefilename [<code class="option">--title <em class="replaceable"><code>TITLE</code></em></code>] [<em class="replaceable"><code>FILENAME</code></em>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-file-dialog</code> directory [<code class="option">--title <em class="replaceable"><code>TITLE</code></em></code>] [<em class="replaceable"><code>DIRNAME</code></em>]</p></div><div class="cmdsynopsis"><p><code class="command">xdg-file-dialog</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-file-dialog program can be used to let the native file selection dialog handle file and directory input. </p><p> @@ -23,8 +23,10 @@ </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">--title</code> <em class="replaceable"><code>TITLE</code></em></span></dt><dd> Sets the dialog's title (caption) to the specified text. </dd><dt><span class="term"><code class="option">--help</code></span></dt><dd> - Show this help. - </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> + Show command synopsis. + </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> + Show this manualpage. + </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> Show the xdg-utils version information. </dd></dl></div></div><div class="refsect1" lang="en"><a name="exitcodes"></a><h2>Exit Codes</h2><p> An exit code of 0 indicates success while a non-zero exit code diff --git a/scripts/html/xdg-icon.html b/scripts/html/xdg-icon.html index de3465d..fa7dbae 100644 --- a/scripts/html/xdg-icon.html +++ b/scripts/html/xdg-icon.html @@ -1,4 +1,4 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-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-icon"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-icon — command line tool for (un)installing icons</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-icon</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</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</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</code> { <code class="option">--help</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</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"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-icon — command line tool for (un)installing icons</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-icon</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</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</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</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 program can be used to install icons into the desktop icon system for use in menu entries, as desktop icons or as file icon. </p><p> @@ -55,7 +55,9 @@ 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> - Show this help. + Show command synopsis. + </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> + Show this manualpage. </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> Show the xdg-utils version information. </dd></dl></div></div><div class="refsect1" lang="en"><a name="exitcodes"></a><h2>Exit Codes</h2><p> diff --git a/scripts/html/xdg-menu.html b/scripts/html/xdg-menu.html index 2235a44..a7e0772 100644 --- a/scripts/html/xdg-menu.html +++ b/scripts/html/xdg-menu.html @@ -1,4 +1,4 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-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-menu"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-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-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-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-menu</code> forceupdate { <code class="option">--user</code> | <code class="option">--system</code> }</p></div><div class="cmdsynopsis"><p><code class="command">xdg-menu</code> { --help | --version }</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-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-menu"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-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-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-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-menu</code> forceupdate { <code class="option">--user</code> | <code class="option">--system</code> }</p></div><div class="cmdsynopsis"><p><code class="command">xdg-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-menu program can be used to install new items to the desktop's application menu. </p><p> @@ -40,7 +40,9 @@ 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> - Show this help. + Show command synopsis. + </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> + Show this manualpage. </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> Show the xdg-utils version information. </dd></dl></div></div><div class="refsect1" lang="en"><a name="desktopfiles"></a><h2>Desktop Files</h2><p> diff --git a/scripts/html/xdg-mime.html b/scripts/html/xdg-mime.html index 73338cb..2e908f3 100644 --- a/scripts/html/xdg-mime.html +++ b/scripts/html/xdg-mime.html @@ -1,5 +1,5 @@ <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-mime</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="xdg-mime"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-mime — command line tool for querying information about file type handling -and adding descriptions for new file types</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-mime</code> query { filetype | default } <em class="replaceable"><code>FILE</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">--version</code> }</p></div></div><div class="refsect1" lang="en"><a name="description"></a><h2>Description</h2><p> +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 } <em class="replaceable"><code>FILE</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> 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> @@ -42,7 +42,9 @@ and adding descriptions for new file types</p></div><div class="refsynopsisdiv"> 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> - Show this help. + Show command synopsis. + </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> + Show this manualpage. </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> Show the xdg-utils version information. </dd></dl></div></div><div class="refsect1" lang="en"><a name="exitcodes"></a><h2>Exit Codes</h2><p> diff --git a/scripts/html/xdg-open.html b/scripts/html/xdg-open.html index 613431c..bbe3874 100644 --- a/scripts/html/xdg-open.html +++ b/scripts/html/xdg-open.html @@ -1,4 +1,4 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-open</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="xdg-open"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-open — opens a file or URL in the user's preferred application</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xdg-open</code> { <code class="option"><em class="replaceable"><code>file</code></em></code> | <code class="option"><em class="replaceable"><code>URL</code></em></code> }</p></div><div class="cmdsynopsis"><p><code class="command">xdg-open</code> { <code class="option">--help</code> | <code class="option">--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 @@ -8,7 +8,9 @@ xdg-open is for use inside a desktop session only. It is not recommended to use xdg-open as root. </p></div><div class="refsect1" lang="en"><a name="options"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"><code class="option">--help</code></span></dt><dd> - Show this help. + Show command synopsis. + </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> + Show this manualpage. </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> Show the xdg-utils version information. </dd></dl></div></div><div class="refsect1" lang="en"><a name="exitcodes"></a><h2>Exit Codes</h2><p> diff --git a/scripts/html/xdg-screensaver.html b/scripts/html/xdg-screensaver.html index 41feb86..67bf611 100644 --- a/scripts/html/xdg-screensaver.html +++ b/scripts/html/xdg-screensaver.html @@ -1,4 +1,4 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-screensaver</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="xdg-screensaver"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-screensaver — Control 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>delay</code></em></code> | <code class="option">restore</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">--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 — Control 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>delay</code></em></code> | <code class="option">restore</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. @@ -24,7 +24,9 @@ Returns true if the screensaver is enabled to turn on after a period of inactivty, or false otherwise. </dd><dt><span class="term"><code class="option">--help</code></span></dt><dd> - Show this help. + Show command synopsis. + </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> + Show this manualpage. </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> Show the xdg-utils version information. </dd></dl></div></div><div class="refsect1" lang="en"><a name="exitcodes"></a><h2>Exit Codes</h2><p> diff --git a/scripts/html/xdg-su.html b/scripts/html/xdg-su.html index 6156618..ae9f16a 100644 --- a/scripts/html/xdg-su.html +++ b/scripts/html/xdg-su.html @@ -1,4 +1,4 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xdg-su</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="xdg-su"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xdg-su — run a 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">--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 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. @@ -8,7 +8,9 @@ run <em class="replaceable"><code>command</code></em> as <em class="replaceable"><code>user</code></em>. The default is to run as root. </dd><dt><span class="term"><code class="option">--help</code></span></dt><dd> - Show this help. + Show command synopsis. + </dd><dt><span class="term"><code class="option">--manual</code></span></dt><dd> + Show this manualpage. </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> Show the xdg-utils version information. </dd></dl></div></div><div class="refsect1" lang="en"><a name="exitcodes"></a><h2>Exit Codes</h2><p> diff --git a/scripts/man/xdg-copy.1 b/scripts/man/xdg-copy.1 index 3579af3..a0ea24f 100644 --- a/scripts/man/xdg-copy.1 +++ b/scripts/man/xdg-copy.1 @@ -30,7 +30,7 @@ xdg-copy \- command line tool for copying files between desktop URIs .ad l .hy 0 .HP 9 -\fBxdg\-copy\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-version\fR\fR} +\fBxdg\-copy\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} .ad .hy @@ -46,7 +46,11 @@ xdg\-copy is for use inside a desktop session only\&. It is not recommended to u .TP \fB\-\-help\fR -Show this help\&. +Show command synopsis\&. + +.TP +\fB\-\-manual\fR +Show this manualpage\&. .TP \fB\-\-version\fR diff --git a/scripts/man/xdg-desktop.1 b/scripts/man/xdg-desktop.1 index 11f8534..e434b7f 100644 --- a/scripts/man/xdg-desktop.1 +++ b/scripts/man/xdg-desktop.1 @@ -36,7 +36,7 @@ xdg-desktop \- command line tool for (un)installing icons to the desktop .ad l .hy 0 .HP 12 -\fBxdg\-desktop\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-version\fR\fR} +\fBxdg\-desktop\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} .ad .hy @@ -66,7 +66,11 @@ Adds \fIvendor\-id\fR as a prefix when installing desktop files\&. .TP \fB\-\-help\fR -Show this help\&. +Show command synopsis\&. + +.TP +\fB\-\-manual\fR +Show this manualpage\&. .TP \fB\-\-version\fR diff --git a/scripts/man/xdg-email.1 b/scripts/man/xdg-email.1 index c00aa12..87372f9 100644 --- a/scripts/man/xdg-email.1 +++ b/scripts/man/xdg-email.1 @@ -30,7 +30,7 @@ xdg-email \- command line tool for sending mail using the user's preferred e-mai .ad l .hy 0 .HP 10 -\fBxdg\-email\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-version\fR\fR} +\fBxdg\-email\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} .ad .hy @@ -73,7 +73,11 @@ Specify an attachment for the e\-mail\&. \fIfile\fR must point to an existing fi .TP \fB\-\-help\fR -Show this help\&. +Show command synopsis\&. + +.TP +\fB\-\-manual\fR +Show this manualpage\&. .TP \fB\-\-version\fR diff --git a/scripts/man/xdg-file-dialog.1 b/scripts/man/xdg-file-dialog.1 index 6febfaf..50d759b 100644 --- a/scripts/man/xdg-file-dialog.1 +++ b/scripts/man/xdg-file-dialog.1 @@ -48,7 +48,7 @@ xdg-file-dialog \- command line tool for providing file and directory selection .ad l .hy 0 .HP 16 -\fBxdg\-file\-dialog\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-version\fR\fR} +\fBxdg\-file\-dialog\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} .ad .hy @@ -86,7 +86,11 @@ Sets the dialog's title (caption) to the specified text\&. .TP \fB\-\-help\fR -Show this help\&. +Show command synopsis\&. + +.TP +\fB\-\-manual\fR +Show this manualpage\&. .TP \fB\-\-version\fR diff --git a/scripts/man/xdg-icon.1 b/scripts/man/xdg-icon.1 index 13bda42..518481b 100644 --- a/scripts/man/xdg-icon.1 +++ b/scripts/man/xdg-icon.1 @@ -42,7 +42,7 @@ xdg-icon \- command line tool for (un)installing icons .ad l .hy 0 .HP 9 -\fBxdg\-icon\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-version\fR\fR} +\fBxdg\-icon\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} .ad .hy @@ -96,7 +96,11 @@ Installs or uninstalls the icon for all users on the system\&. Usually only root .TP \fB\-\-help\fR -Show this help\&. +Show command synopsis\&. + +.TP +\fB\-\-manual\fR +Show this manualpage\&. .TP \fB\-\-version\fR diff --git a/scripts/man/xdg-menu.1 b/scripts/man/xdg-menu.1 index 0e146ae..fe8b86c 100644 --- a/scripts/man/xdg-menu.1 +++ b/scripts/man/xdg-menu.1 @@ -42,7 +42,7 @@ xdg-menu \- command line tool for (un)installing desktop menu items .ad l .hy 0 .HP 9 -\fBxdg\-menu\fR {\fB\-\-help\fR | \fB\-\-version\fR} +\fBxdg\-menu\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} .ad .hy @@ -94,7 +94,11 @@ Installs or uninstalls the file for all users on the system\&. Usually only root .TP \fB\-\-help\fR -Show this help\&. +Show command synopsis\&. + +.TP +\fB\-\-manual\fR +Show this manualpage\&. .TP \fB\-\-version\fR diff --git a/scripts/man/xdg-mime.1 b/scripts/man/xdg-mime.1 index a80c9a4..0e03045 100644 --- a/scripts/man/xdg-mime.1 +++ b/scripts/man/xdg-mime.1 @@ -42,7 +42,7 @@ xdg-mime \- command line tool for querying information about file type handling .ad l .hy 0 .HP 9 -\fBxdg\-mime\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-version\fR\fR} +\fBxdg\-mime\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} .ad .hy @@ -85,7 +85,11 @@ Adds or removes file type descriptions for all users on the system\&. Usually on .TP \fB\-\-help\fR -Show this help\&. +Show command synopsis\&. + +.TP +\fB\-\-manual\fR +Show this manualpage\&. .TP \fB\-\-version\fR diff --git a/scripts/man/xdg-open.1 b/scripts/man/xdg-open.1 index 694a539..68ed3d7 100644 --- a/scripts/man/xdg-open.1 +++ b/scripts/man/xdg-open.1 @@ -30,7 +30,7 @@ xdg-open \- opens a file or URL in the user's preferred application .ad l .hy 0 .HP 9 -\fBxdg\-open\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-version\fR\fR} +\fBxdg\-open\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} .ad .hy @@ -46,7 +46,11 @@ xdg\-open is for use inside a desktop session only\&. It is not recommended to u .TP \fB\-\-help\fR -Show this help\&. +Show command synopsis\&. + +.TP +\fB\-\-manual\fR +Show this manualpage\&. .TP \fB\-\-version\fR diff --git a/scripts/man/xdg-screensaver.1 b/scripts/man/xdg-screensaver.1 index 5dd5f3e..e3fc0e7 100644 --- a/scripts/man/xdg-screensaver.1 +++ b/scripts/man/xdg-screensaver.1 @@ -30,7 +30,7 @@ xdg-screensaver \- Control the screensaver .ad l .hy 0 .HP 16 -\fBxdg\-screensaver\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-version\fR\fR} +\fBxdg\-screensaver\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} .ad .hy @@ -66,7 +66,11 @@ Returns true if the screensaver is enabled to turn on after a period of inactivt .TP \fB\-\-help\fR -Show this help\&. +Show command synopsis\&. + +.TP +\fB\-\-manual\fR +Show this manualpage\&. .TP \fB\-\-version\fR diff --git a/scripts/man/xdg-su.1 b/scripts/man/xdg-su.1 index fc40de9..f50c8a3 100644 --- a/scripts/man/xdg-su.1 +++ b/scripts/man/xdg-su.1 @@ -30,7 +30,7 @@ xdg-su \- run a program as root after prompting for the root password .ad l .hy 0 .HP 7 -\fBxdg\-su\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-version\fR\fR} +\fBxdg\-su\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR} .ad .hy @@ -50,7 +50,11 @@ run \fIcommand\fR as \fIuser\fR\&. The default is to run as root\&. .TP \fB\-\-help\fR -Show this help\&. +Show command synopsis\&. + +.TP +\fB\-\-manual\fR +Show this manualpage\&. .TP \fB\-\-version\fR diff --git a/scripts/xdg-copy b/scripts/xdg-copy index cd881e3..8b17b64 100755 --- a/scripts/xdg-copy +++ b/scripts/xdg-copy @@ -32,15 +32,63 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES +cat << _MANUALPAGE +Name + + xdg-copy -- command line tool for copying files between desktop URIs + +Synopsis + + xdg-copy source destination + + xdg-copy { --help | --manual | --version } + +Description + + xdg-copy copies source to destination and provides visual feedback to the + user during the operation. Both source and destination can either be a + file or URL. Supported URL types are file, ftp, http and https. Additional + URL types may be supported depending on the desktop environment. + + xdg-copy is for use inside a desktop session only. It is not recommended + to use xdg-copy as root. + +Options + + --help + Show command synopsis. + + --manual + Show this manualpage. + + --version + Show the xdg-utils version information. + +Exit Codes + + An exit code of 0 indicates success while a non-zero exit code indicates + failure. The following failure codes can be returned: + + 1 + Error in command line syntax. + + 2 + One of the files passed on the command line did not exist. + + 3 + A required tool could not be found. + + 4 + The action failed. + Examples xdg-copy "http://portland.freedesktop.org/png/freedesktop-logo.png" . xdg-copy "/tmp/foobar.png" "/home/user/foobar-copy.png" -_EXAMPLES +_MANUALPAGE } usage() @@ -52,7 +100,7 @@ Synopsis xdg-copy source destination - xdg-copy { --help | --version } + xdg-copy { --help | --manual | --version } _USAGE } @@ -89,6 +137,7 @@ exit_failure_syntax() echo "Try 'xdg-copy --help' for more information." >&2 else usage + echo "Use 'man xdg-copy' or 'xdg-copy --manual' for additional info." fi exit 1 @@ -143,7 +192,12 @@ check_common_commands() case $parm in --help) usage - examples + echo "Use 'man xdg-copy' or 'xdg-copy --manual' for additional info." + exit_success + ;; + + --manual) + manualpage exit_success ;; diff --git a/scripts/xdg-copy.in b/scripts/xdg-copy.in index 9cad64e..1cfe8e7 100755 --- a/scripts/xdg-copy.in +++ b/scripts/xdg-copy.in @@ -14,10 +14,10 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES -_EXAMPLES +cat << _MANUALPAGE +_MANUALPAGE } usage() diff --git a/scripts/xdg-desktop b/scripts/xdg-desktop index b6a7123..01b1c0c 100755 --- a/scripts/xdg-desktop +++ b/scripts/xdg-desktop @@ -42,18 +42,136 @@ Synopsis xdg-desktop uninstall [--vendor vendor-id] FILE - xdg-desktop { --help | --version } + xdg-desktop { --help | --manual | --version } _USAGE } -examples() +manualpage() { -cat << _EXAMPLES +cat << _MANUALPAGE +Name + + xdg-desktop -- command line tool for (un)installing icons to the desktop + +Synopsis + + xdg-desktop install [--vendor vendor-id] FILE + + xdg-desktop uninstall [--vendor vendor-id] FILE + + xdg-desktop { --help | --manual | --version } + +Description + + The xdg-desktop 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. + +Commands + + install + Installs FILE to the desktop of the current user. + + 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. + +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 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 + +Exit Codes + + An exit code of 0 indicates success while a non-zero exit code indicates + failure. The following failure codes can be returned: + + 1 + Error in command line syntax. + + 2 + One of the files passed on the command line did not exist. + + 3 + A required tool could not be found. + + 4 + The action failed. + +See Also + + xdg-icon(1) + Examples TBD -_EXAMPLES +_MANUALPAGE } #@xdg-utils-common@ @@ -88,6 +206,7 @@ exit_failure_syntax() echo "Try 'xdg-desktop --help' for more information." >&2 else usage + echo "Use 'man xdg-desktop' or 'xdg-desktop --manual' for additional info." fi exit 1 @@ -142,7 +261,12 @@ check_common_commands() case $parm in --help) usage - examples + echo "Use 'man xdg-desktop' or 'xdg-desktop --manual' for additional info." + exit_success + ;; + + --manual) + manualpage exit_success ;; diff --git a/scripts/xdg-desktop.in b/scripts/xdg-desktop.in index 09aded6..fccf36b 100755 --- a/scripts/xdg-desktop.in +++ b/scripts/xdg-desktop.in @@ -19,10 +19,10 @@ cat << _USAGE _USAGE } -examples() +manualpage() { -cat << _EXAMPLES -_EXAMPLES +cat << _MANUALPAGE +_MANUALPAGE } #@xdg-utils-common@ diff --git a/scripts/xdg-email b/scripts/xdg-email index 73e69ea..fca2a8d 100755 --- a/scripts/xdg-email +++ b/scripts/xdg-email @@ -32,9 +32,91 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES +cat << _MANUALPAGE +Name + + 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 { --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. + + 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. + +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. + + --help + Show command synopsis. + + --manual + Show this manualpage. + + --version + Show the xdg-utils version information. + +Exit Codes + + An exit code of 0 indicates success while a non-zero exit code indicates + failure. The following failure codes can be returned: + + 1 + Error in command line syntax. + + 2 + One of the files passed on the command line did not exist. + + 3 + A required tool could not be found. + + 4 + The action failed. + Examples xdg-email 'Jeremy White <jwhite@example.com>' @@ -46,7 +128,7 @@ Examples xdg-email --subject 'Your password is about to expire' \ 'jwhite@example.com' 'bastian@example.com' 'whipple@example.com' -_EXAMPLES +_MANUALPAGE } usage() @@ -60,7 +142,7 @@ Synopsis xdg-email [--utf8] [--cc address] [--bcc address] [--subject text] [--body text] [--attach file] { mailto-uri | address(es) } - xdg-email { --help | --version } + xdg-email { --help | --manual | --version } _USAGE } @@ -97,6 +179,7 @@ exit_failure_syntax() echo "Try 'xdg-email --help' for more information." >&2 else usage + echo "Use 'man xdg-email' or 'xdg-email --manual' for additional info." fi exit 1 @@ -151,7 +234,12 @@ check_common_commands() case $parm in --help) usage - examples + echo "Use 'man xdg-email' or 'xdg-email --manual' for additional info." + exit_success + ;; + + --manual) + manualpage exit_success ;; diff --git a/scripts/xdg-email.in b/scripts/xdg-email.in index afdecf4..9ce815b 100755 --- a/scripts/xdg-email.in +++ b/scripts/xdg-email.in @@ -14,10 +14,10 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES -_EXAMPLES +cat << _MANUALPAGE +_MANUALPAGE } usage() diff --git a/scripts/xdg-file-dialog b/scripts/xdg-file-dialog index a29debd..3f6fae7 100755 --- a/scripts/xdg-file-dialog +++ b/scripts/xdg-file-dialog @@ -31,9 +31,85 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES +cat << _MANUALPAGE +Name + + xdg-file-dialog -- command line tool for providing file and directory + selection dialogs + +Synopsis + + xdg-file-dialog openfilename [--title TITLE] [FILENAME] + + xdg-file-dialog openfilenamelist [--title TITLE] [FILENAME] + + xdg-file-dialog savefilename [--title TITLE] [FILENAME] + + xdg-file-dialog directory [--title TITLE] [DIRNAME] + + xdg-file-dialog { --help | --manual | --version } + +Description + + The xdg-file-dialog program can be used to let the native file selection + dialog handle file and directory input. + + xdg-file-dialog is for use inside a desktop session only. It is not + recommended to use xdg-file-dialog as root. + +Commands + + openfilename + Returns the filename with path for a file to read from. FILENAME + can optionally be used to specify path and filename of a + preselection. + + openfilenamelist + Returns one or more filenames with path for files to read from, + each on a new line. FILENAME can optionally be used to specify + path and filename of a preselection. + + savefilename + Returns the filename with path for file to write to. FILENAME can + optionally be used to specify path and filename of a preselection. + + directory + Returns the path for an exsiting directory. DIRNAME can optionally + be used to specify a path of a preselection. + +Options + + --title TITLE + Sets the dialog's title (caption) to the specified text. + + --help + Show command synopsis. + + --manual + Show this manualpage. + + --version + Show the xdg-utils version information. + +Exit Codes + + An exit code of 0 indicates success while a non-zero exit code indicates + failure. The following failure codes can be returned: + + 1 + Error in command line syntax. + + 2 + One of the files passed on the command line did not exist. + + 3 + A required tool could not be found. + + 4 + The action failed. + Examples xdg-file-dialog savefilename /tmp/foobar.png @@ -45,7 +121,7 @@ Examples Asks for a directory name starting in directory /tmp using the text "Select a target folder" as the dialog's title/caption. -_EXAMPLES +_MANUALPAGE } usage() @@ -64,7 +140,7 @@ Synopsis xdg-file-dialog directory [--title TITLE] [DIRNAME] - xdg-file-dialog { --help | --version } + xdg-file-dialog { --help | --manual | --version } _USAGE } @@ -101,6 +177,7 @@ exit_failure_syntax() echo "Try 'xdg-file-dialog --help' for more information." >&2 else usage + echo "Use 'man xdg-file-dialog' or 'xdg-file-dialog --manual' for additional info." fi exit 1 @@ -155,7 +232,12 @@ check_common_commands() case $parm in --help) usage - examples + echo "Use 'man xdg-file-dialog' or 'xdg-file-dialog --manual' for additional info." + exit_success + ;; + + --manual) + manualpage exit_success ;; diff --git a/scripts/xdg-file-dialog.in b/scripts/xdg-file-dialog.in index ca7d4fb..82e4a23 100755 --- a/scripts/xdg-file-dialog.in +++ b/scripts/xdg-file-dialog.in @@ -13,10 +13,10 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES -_EXAMPLES +cat << _MANUALPAGE +_MANUALPAGE } usage() diff --git a/scripts/xdg-icon b/scripts/xdg-icon index 0f8a56b..656db56 100755 --- a/scripts/xdg-icon +++ b/scripts/xdg-icon @@ -33,13 +33,119 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES +cat << _MANUALPAGE +Name + + xdg-icon -- command line tool for (un)installing icons + +Synopsis + + xdg-icon install [--noupdate] [--theme theme] [--context context] [--size + size] { --user | --system } icon-file [icon-name] + + xdg-icon uninstall [--noupdate] [--theme theme] [--context context] + [--size size] { --user | --system } icon-name + + xdg-icon forceupdate [--theme theme] { --user | --system } + + xdg-icon { --help | --manual | --version } + +Description + + The xdg-icon program can be used to install icons into the desktop icon + system for use in menu entries, as desktop icons or as file icon. + + 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 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. + +Exit Codes + + An exit code of 0 indicates success while a non-zero exit code indicates + failure. The following failure codes can be returned: + + 1 + Error in command line syntax. + + 2 + One of the files passed on the command line did not exist. + + 3 + A required tool could not be found. + + 4 + The action failed. + +See Also + + xdg-desktop(1), xdg-menu(1), xdg-mime(1) + Examples TBD -_EXAMPLES +_MANUALPAGE } usage() @@ -57,7 +163,7 @@ Synopsis xdg-icon forceupdate [--theme theme] { --user | --system } - xdg-icon { --help | --version } + xdg-icon { --help | --manual | --version } _USAGE } @@ -94,6 +200,7 @@ exit_failure_syntax() echo "Try 'xdg-icon --help' for more information." >&2 else usage + echo "Use 'man xdg-icon' or 'xdg-icon --manual' for additional info." fi exit 1 @@ -148,7 +255,12 @@ check_common_commands() case $parm in --help) usage - examples + echo "Use 'man xdg-icon' or 'xdg-icon --manual' for additional info." + exit_success + ;; + + --manual) + manualpage exit_success ;; diff --git a/scripts/xdg-icon.in b/scripts/xdg-icon.in index f3afa7c..014a46a 100755 --- a/scripts/xdg-icon.in +++ b/scripts/xdg-icon.in @@ -15,10 +15,10 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES -_EXAMPLES +cat << _MANUALPAGE +_MANUALPAGE } usage() diff --git a/scripts/xdg-menu b/scripts/xdg-menu index adc9d26..8145521 100755 --- a/scripts/xdg-menu +++ b/scripts/xdg-menu @@ -33,9 +33,176 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES +cat << _MANUALPAGE +Name + + xdg-menu -- command line tool for (un)installing desktop menu items + +Synopsis + + xdg-menu install [--noupdate] [--vendor vendor-id] { --user | --system } { + desktop-file | menu-file | directory-file } + + xdg-menu uninstall [--noupdate] [--vendor vendor-id] { --user | --system } + { desktop-file | menu-file | directory-file } + + xdg-menu forceupdate { --user | --system } + + xdg-menu { --help | --manual | --version } + +Description + + The xdg-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 + +Commands + + install + + 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. + + 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. + + uninstall + Remove applications or submenus from the desktop menu system + previously installed with xdg-menu install. + + forceupdate + Force an update of the menu system. This is only useful if the + last call to xdg-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. + +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 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 + +Exit Codes + + An exit code of 0 indicates success while a non-zero exit code indicates + failure. The following failure codes can be returned: + + 1 + Error in command line syntax. + + 2 + One of the files passed on the command line did not exist. + + 3 + A required tool could not be found. + + 4 + The action failed. + +See Also + + xdg-desktop(1), xdg-icon(1), xdg-mime(1) + Examples The company ShinyThings Inc. has developed an application named @@ -159,7 +326,7 @@ Examples update: xdg-menu forceupdate --system -_EXAMPLES +_MANUALPAGE } usage() @@ -177,7 +344,7 @@ Synopsis xdg-menu forceupdate { --user | --system } - xdg-menu { --help | --version } + xdg-menu { --help | --manual | --version } _USAGE } @@ -214,6 +381,7 @@ exit_failure_syntax() echo "Try 'xdg-menu --help' for more information." >&2 else usage + echo "Use 'man xdg-menu' or 'xdg-menu --manual' for additional info." fi exit 1 @@ -268,7 +436,12 @@ check_common_commands() case $parm in --help) usage - examples + echo "Use 'man xdg-menu' or 'xdg-menu --manual' for additional info." + exit_success + ;; + + --manual) + manualpage exit_success ;; diff --git a/scripts/xdg-menu.in b/scripts/xdg-menu.in index 20b95a8..7e53409 100755 --- a/scripts/xdg-menu.in +++ b/scripts/xdg-menu.in @@ -15,10 +15,10 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES -_EXAMPLES +cat << _MANUALPAGE +_MANUALPAGE } usage() diff --git a/scripts/xdg-mime b/scripts/xdg-mime index faaf58a..65776a1 100755 --- a/scripts/xdg-mime +++ b/scripts/xdg-mime @@ -32,9 +32,105 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES +cat << _MANUALPAGE +Name + + xdg-mime -- command line tool for querying information about file type + handling and adding descriptions for new file types + +Synopsis + + xdg-mime query { filetype | default } FILE + + xdg-mime install { --user | --system } mimetypes-file + + xdg-mime uninstall { --user | --system } mimetypes-file + + xdg-mime { --help | --manual | --version } + +Description + + The xdg-mime program can be used to query information about file types and + to add descriptions for new file types. + +Commands + + query + + Returns information related to the file type of FILE. + + The query option is for use inside a desktop session only. It is + not recommended to use xdg-mime query as root. + + The following queries are supported: + + filetype: Returns the file type of FILE in the form of a MIME + type. + + default: Returns the default application that the desktop + environment uses for opening FILE. The default applications is + identified by its *.desktop file. + + install + Adds the file type descriptions provided in mimetypes-file to the + desktop environment. mimetypes-file must be a XML file that + follows the freedesktop.org Shared MIME-info Database + specification and that has a mime-info element as its document + root. For each new file type one or more icons with name + major-minor must be installed with the xdg-icon command in the + mimetypes context. For example the + application/vnd.oasis.opendocument.text filetype requires an icon + by the name of application-vnd.oasis.opendocument.text to be + installed. + + uninstall + Removes the file type descriptions provided in mimetypes-file and + previously added with xdg-mime install from the desktop + environment. mimetypes-file must be a XML file that follows the + freedesktop.org Shared MIME-info Database specification and that + has a mime-info element as its document root. + +Options + + --user + Adds or removes file type descriptions for the current user only. + + --system + Adds or removes file type descriptions 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. + +Exit Codes + + An exit code of 0 indicates success while a non-zero exit code indicates + failure. The following failure codes can be returned: + + 1 + Error in command line syntax. + + 2 + One of the files passed on the command line did not exist. + + 3 + A required tool could not be found. + + 4 + The action failed. + +See Also + + xdg-icon(1), xdg-menu(1) + Examples xdg-mime query filetype /tmp/foobar.png @@ -65,7 +161,7 @@ Examples An icon for this new file type must alsobe installed, for example with: xdg-icon install --system --context mimetypes --size 64 text-x-diff.png -_EXAMPLES +_MANUALPAGE } usage() @@ -82,7 +178,7 @@ Synopsis xdg-mime uninstall { --user | --system } mimetypes-file - xdg-mime { --help | --version } + xdg-mime { --help | --manual | --version } _USAGE } @@ -119,6 +215,7 @@ exit_failure_syntax() echo "Try 'xdg-mime --help' for more information." >&2 else usage + echo "Use 'man xdg-mime' or 'xdg-mime --manual' for additional info." fi exit 1 @@ -173,7 +270,12 @@ check_common_commands() case $parm in --help) usage - examples + echo "Use 'man xdg-mime' or 'xdg-mime --manual' for additional info." + exit_success + ;; + + --manual) + manualpage exit_success ;; diff --git a/scripts/xdg-mime.in b/scripts/xdg-mime.in index bf98942..f130153 100755 --- a/scripts/xdg-mime.in +++ b/scripts/xdg-mime.in @@ -14,10 +14,10 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES -_EXAMPLES +cat << _MANUALPAGE +_MANUALPAGE } usage() diff --git a/scripts/xdg-open b/scripts/xdg-open index c0df84d..56ffe98 100755 --- a/scripts/xdg-open +++ b/scripts/xdg-open @@ -31,9 +31,57 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES +cat << _MANUALPAGE +Name + + xdg-open -- opens a file or URL in the user's preferred application + +Synopsis + + xdg-open { file | URL } + + 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 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. + +Exit Codes + + An exit code of 0 indicates success while a non-zero exit code indicates + failure. The following failure codes can be returned: + + 1 + Error in command line syntax. + + 2 + One of the files passed on the command line did not exist. + + 3 + A required tool could not be found. + + 4 + The action failed. + Examples xdg-open 'http://www.freedesktop.org/' @@ -44,7 +92,7 @@ Examples Opens the PNG image file /tmp/foobar.png in the user's default image viewing application. -_EXAMPLES +_MANUALPAGE } usage() @@ -56,7 +104,7 @@ Synopsis xdg-open { file | URL } - xdg-open { --help | --version } + xdg-open { --help | --manual | --version } _USAGE } @@ -93,6 +141,7 @@ exit_failure_syntax() echo "Try 'xdg-open --help' for more information." >&2 else usage + echo "Use 'man xdg-open' or 'xdg-open --manual' for additional info." fi exit 1 @@ -147,7 +196,12 @@ check_common_commands() case $parm in --help) usage - examples + echo "Use 'man xdg-open' or 'xdg-open --manual' for additional info." + exit_success + ;; + + --manual) + manualpage exit_success ;; diff --git a/scripts/xdg-open.in b/scripts/xdg-open.in index 2ae06fa..3cece3c 100755 --- a/scripts/xdg-open.in +++ b/scripts/xdg-open.in @@ -13,10 +13,10 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES -_EXAMPLES +cat << _MANUALPAGE +_MANUALPAGE } usage() diff --git a/scripts/xdg-screensaver b/scripts/xdg-screensaver index ab84825..8c4ff5b 100755 --- a/scripts/xdg-screensaver +++ b/scripts/xdg-screensaver @@ -33,9 +33,77 @@ # Default value for delay when suspending screensaver DELAY=60m -examples() +manualpage() { -cat << _EXAMPLES +cat << _MANUALPAGE +Name + + xdg-screensaver -- Control the screensaver + +Synopsis + + xdg-screensaver { suspend delay | restore | activate | reset | status } + + xdg-screensaver { --help | --manual | --version } + +Description + + 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. + +Options + + suspend delay + Suspends the screensaver and monitor power management for the + amount of time given by delay, or 60 minutes if unspecified. This + is of the form NUMBERSUFFIX, such as 45m, 4h, or 30s. SUFFIX may + be 's' for seconds (the default), 'm' for minutes, 'h' for hours + or 'd' for days This is intended to allow preventing the + screensaver coming on during a presentation, and return it to + normal behavior after the specified delay. + + restore + Restores the screensaver state, timeout, etc. to the user's + standard settings. + + activate + Turns the screensaver on immediately. + + reset + Turns the screensaver off immediately. + + status + Returns true if the screensaver is enabled to turn on after a + period of inactivty, or false otherwise. + + --help + Show command synopsis. + + --manual + Show this manualpage. + + --version + Show the xdg-utils version information. + +Exit Codes + + An exit code of 0 indicates success while a non-zero exit code indicates + failure. The following failure codes can be returned: + + 1 + Error in command line syntax. + + 2 + One of the files passed on the command line did not exist. + + 3 + A required tool could not be found. + + 4 + The action failed. + Examples xdg-screensaver suspend 3h @@ -59,7 +127,7 @@ Bugss disable the screensaver while it is connected, which will re-enable the screensaver. xdg-screensaver should be updated to take advantage of this functionality when it is available. -_EXAMPLES +_MANUALPAGE } usage() @@ -71,7 +139,7 @@ Synopsis xdg-screensaver { suspend delay | restore | activate | reset | status } - xdg-screensaver { --help | --version } + xdg-screensaver { --help | --manual | --version } _USAGE } @@ -108,6 +176,7 @@ exit_failure_syntax() echo "Try 'xdg-screensaver --help' for more information." >&2 else usage + echo "Use 'man xdg-screensaver' or 'xdg-screensaver --manual' for additional info." fi exit 1 @@ -162,7 +231,12 @@ check_common_commands() case $parm in --help) usage - examples + echo "Use 'man xdg-screensaver' or 'xdg-screensaver --manual' for additional info." + exit_success + ;; + + --manual) + manualpage exit_success ;; diff --git a/scripts/xdg-screensaver.in b/scripts/xdg-screensaver.in index 2675161..bc4d743 100755 --- a/scripts/xdg-screensaver.in +++ b/scripts/xdg-screensaver.in @@ -15,10 +15,10 @@ # Default value for delay when suspending screensaver DELAY=60m -examples() +manualpage() { -cat << _EXAMPLES -_EXAMPLES +cat << _MANUALPAGE +_MANUALPAGE } usage() diff --git a/scripts/xdg-su b/scripts/xdg-su index ccbf4ac..6894d07 100755 --- a/scripts/xdg-su +++ b/scripts/xdg-su @@ -33,15 +33,67 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES +cat << _MANUALPAGE +Name + + xdg-su -- run a program as root after prompting for the root password + +Synopsis + + xdg-su [-u user] -c command + + xdg-su { --help | --manual | --version } + +Description + + xdg-su provides a graphical dialog that prompts the user for a password to + run command as user or as root if no user was specified. + + xdg-su is for use inside a desktop session only. + +Options + + -u user + run command as user. The default is to run as root. + + --help + Show command synopsis. + + --manual + Show this manualpage. + + --version + Show the xdg-utils version information. + +Exit Codes + + An exit code of 0 indicates success while a non-zero exit code indicates + failure. The following failure codes can be returned: + + 1 + Error in command line syntax. + + 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. + +See Also + + su(1) + Examples xdg-su -u root -c "/opt/shinythings/bin/install-GUI --install fast" Runs the /opt/shinythings/bin/install-GUI command with root permissions. -_EXAMPLES +_MANUALPAGE } usage() @@ -53,7 +105,7 @@ Synopsis xdg-su [-u user] -c command - xdg-su { --help | --version } + xdg-su { --help | --manual | --version } _USAGE } @@ -90,6 +142,7 @@ exit_failure_syntax() echo "Try 'xdg-su --help' for more information." >&2 else usage + echo "Use 'man xdg-su' or 'xdg-su --manual' for additional info." fi exit 1 @@ -144,7 +197,12 @@ check_common_commands() case $parm in --help) usage - examples + echo "Use 'man xdg-su' or 'xdg-su --manual' for additional info." + exit_success + ;; + + --manual) + manualpage exit_success ;; diff --git a/scripts/xdg-su.in b/scripts/xdg-su.in index 0b1cde1..89fc6c3 100755 --- a/scripts/xdg-su.in +++ b/scripts/xdg-su.in @@ -15,10 +15,10 @@ # #--------------------------------------------- -examples() +manualpage() { -cat << _EXAMPLES -_EXAMPLES +cat << _MANUALPAGE +_MANUALPAGE } usage() diff --git a/scripts/xdg-utils-common.in b/scripts/xdg-utils-common.in index 88d2cfc..25acc81 100644 --- a/scripts/xdg-utils-common.in +++ b/scripts/xdg-utils-common.in @@ -29,6 +29,7 @@ exit_failure_syntax() echo "Try '@NAME@ --help' for more information." >&2 else usage + echo "Use 'man @NAME@' or '@NAME@ --manual' for additional info." fi exit 1 @@ -83,7 +84,12 @@ check_common_commands() case $parm in --help) usage - examples + echo "Use 'man @NAME@' or '@NAME@ --manual' for additional info." + exit_success + ;; + + --manual) + manualpage exit_success ;; |