diff options
author | Waldo Bastian <waldo.bastian@intel.com> | 2006-06-06 06:01:36 +0000 |
---|---|---|
committer | Waldo Bastian <waldo.bastian@intel.com> | 2006-06-06 06:01:36 +0000 |
commit | 5d22f403287f5278036d0c9eaaab3394eb4b7e01 (patch) | |
tree | 20919e74cbbcd021ef89a8ace8fd996f4635fbf4 /scripts/html | |
parent | 9c0bbb5303bf8e85feaae4b0a26492b035e02aa3 (diff) |
* Improve presentation of options according to the form
xdg-command --action [--options xxx] --options yyy FILE
* Describe actions first, options later and --help and --version last
Diffstat (limited to 'scripts/html')
-rw-r--r-- | scripts/html/xdg-copy.html | 2 | ||||
-rw-r--r-- | scripts/html/xdg-desktop.html | 22 | ||||
-rw-r--r-- | scripts/html/xdg-email.html | 2 | ||||
-rw-r--r-- | scripts/html/xdg-file-dialog.html | 42 | ||||
-rw-r--r-- | scripts/html/xdg-icon.html | 58 | ||||
-rw-r--r-- | scripts/html/xdg-menu.html | 69 | ||||
-rw-r--r-- | scripts/html/xdg-mime.html | 39 | ||||
-rw-r--r-- | scripts/html/xdg-open.html | 2 | ||||
-rw-r--r-- | scripts/html/xdg-screensaver.html | 6 | ||||
-rw-r--r-- | scripts/html/xdg-su.html | 12 |
10 files changed, 133 insertions, 121 deletions
diff --git a/scripts/html/xdg-copy.html b/scripts/html/xdg-copy.html index ecaa204..400ed3d 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">--help</code>] [<code class="option">--version</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><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">--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> diff --git a/scripts/html/xdg-desktop.html b/scripts/html/xdg-desktop.html index 820ae9b..ceac5c2 100644 --- a/scripts/html/xdg-desktop.html +++ b/scripts/html/xdg-desktop.html @@ -1,16 +1,16 @@ -<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> [<code class="option">--help</code>] [<code class="option">--version</code>] [<code class="option">--vendor <em class="replaceable"><code>vendor-id</code></em></code>] { --install <em class="replaceable"><code>file</code></em> | --uninstall <em class="replaceable"><code>file</code></em> }</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> <code class="option">--install</code> [<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">--uninstall</code> [<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> The xdg-desktop program can be used to install an icon on the desktop of the current user. - </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> + </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">--install</code></span></dt><dd> + Installs <em class="replaceable"><code>FILE</code></em> to the desktop of the current user. + </dd><dt><span class="term"> <code class="option">--uninstall</code></span></dt><dd> + Removes <em class="replaceable"><code>FILE</code></em> from the desktop + of the current user. + </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 + files. + </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 the xdg-utils version information. - </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 - files. - </dd><dt><span class="term"> <code class="option">--install</code> <em class="replaceable"><code>file</code></em></span></dt><dd> - Installs <em class="replaceable"><code>file</code></em> to the desktop of the current user. - </dd><dt><span class="term"> <code class="option">--uninstall</code> <em class="replaceable"><code>file</code></em></span></dt><dd> - Removes <em class="replaceable"><code>file</code></em> from the desktop - of the current user. - </dd></dl></div></div></div></body></html> + </dd></dl></div></div></div></body></html> diff --git a/scripts/html/xdg-email.html b/scripts/html/xdg-email.html index ce248a7..6e08fd9 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">--help</code>] [<code class="option">--version</code>] <code class="option"><em class="replaceable"><code>mailto-uri</code></em></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> <em class="replaceable"><code>mailto-uri</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> xdg-email opens the user's preferred e-mail composer in order to send a mail to <em class="replaceable"><code>mailto-uri</code></em>. RFC2368 defines mailto: URIs. <em class="replaceable"><code>mailto-uri</code></em> may contain fields for to, cc, diff --git a/scripts/html/xdg-file-dialog.html b/scripts/html/xdg-file-dialog.html index 72daa6e..2ade58e 100644 --- a/scripts/html/xdg-file-dialog.html +++ b/scripts/html/xdg-file-dialog.html @@ -1,28 +1,36 @@ -<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> [<code class="option">--help</code>] [<code class="option">--version</code>] [<code class="option">--title <em class="replaceable"><code>TITLE</code></em></code>] { <code class="option">--openfilename <em class="replaceable"><code>FILENAME</code></em></code> | <code class="option">--openfilenamelist <em class="replaceable"><code>FILENAME</code></em></code> | <code class="option">--savefilename <em class="replaceable"><code>FILENAME</code></em></code> | <code class="option">--directory <em class="replaceable"><code>DIRNAME</code></em></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> <code class="option">--openfilename</code> [<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> <code class="option">--openfilenamelist</code> [<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> <code class="option">--savefilename</code> [<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> <code class="option">--directory</code> [<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> The xdg-file-dialog program can be used to let the native file selection dialog handle file and directory input. - </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> + </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">--openfilename</code></span></dt><dd> + Returns the filename with path for a file to read from. + <em class="replaceable"><code>FILENAME</code></em> can optionally be used to + specify path and filename of a preselection. + </dd><dt><span class="term"><code class="option">--openfilenamelist</code></span></dt><dd> + Returns one or more filenames with path for files to read from, + each on a new line. <em class="replaceable"><code>FILENAME</code></em> can optionally + be used to specify path and filename of a preselection. + </dd><dt><span class="term"><code class="option">--savefilename</code></span></dt><dd> + Returns the filename with path for file to write to. + <em class="replaceable"><code>FILENAME</code></em> can optionally be used to + specify path and filename of a preselection. + </dd><dt><span class="term"><code class="option">--directory</code></span></dt><dd> + Returns the path for an exsiting directory. + <em class="replaceable"><code>DIRNAME</code></em> can optionally be used to + specify a path of a preselection. + </dd><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 the xdg-utils version information. - </dd><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">--openfilename</code> <em class="replaceable"><code>FILENAME</code></em></span></dt><dd> - Returns the filename with path for a file to read from. <em class="replaceable"><code>FILENAME</code></em> can optionally be used to specify path and filename of a preselection - </dd><dt><span class="term"> <code class="option">--openfilenamelist</code> <em class="replaceable"><code>FILENAME</code></em></span></dt><dd> - Returns one or more filenames with path for files to read from, each on a new line. <em class="replaceable"><code>FILENAME</code></em> can optionally be used to specify path and filename of a preselection - </dd><dt><span class="term"> <code class="option">--savefilename</code> <em class="replaceable"><code>FILENAME</code></em></span></dt><dd> - Returns the filename with path for file to write to. <em class="replaceable"><code>FILENAME</code></em> can optionally be used to specify path and filename of a preselection - </dd><dt><span class="term"> <code class="option">--directory</code> <em class="replaceable"><code>DIRNAME</code></em></span></dt><dd> - Returns the path for an exsiting directory. <em class="replaceable"><code>DIRNAME</code></em> can optionally be used to specify a path of a preselection - </dd></dl></div></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Examples</h2><p> + </dd></dl></div></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Examples</h2><p> </p><pre class="programlisting"> xdg-file-dialog --savefilename /tmp/foobar.png </pre><p> Asks for a save file name starting in directory /tmp and suggesting foobar.png as the filename </p><p> - </p><pre class="programlisting"> - xdg-file-dialog --title "Select a target folder" --directory /tmp - </pre><p> - Asks for a directory name starting in directory /tmp using the text "Select a target folder" as the dialog's title/caption. +</p><pre class="programlisting"> +xdg-file-dialog --directory --title "Select a target folder" /tmp +</pre><p> + Asks for a directory name starting in directory /tmp using the text "Select a target folder" as the dialog's title/caption. </p></div></div></body></html> diff --git a/scripts/html/xdg-icon.html b/scripts/html/xdg-icon.html index 3fe1288..aae6643 100644 --- a/scripts/html/xdg-icon.html +++ b/scripts/html/xdg-icon.html @@ -1,26 +1,35 @@ -<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> [<code class="option">--help</code>] [<code class="option">--version</code>] [<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>] { --user | --system } <code class="option">--context <em class="replaceable"><code>context</code></em></code> <code class="option">--size <em class="replaceable"><code>size</code></em></code> { --install <em class="replaceable"><code>icon-file</code></em> | --uninstall <em class="replaceable"><code>icon-file</code></em> | --forceupdate }</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> <code class="option">--install</code> [<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> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-icon</code> <code class="option">--uninstall</code> [<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> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-icon</code> <code class="option">--forceupdate</code> [<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> 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> The desktop icon system works according to the XDG Icon Theme Specification at http://www.freedesktop.org/Standards/icon-theme--spec - </p></div><div class="refsect1" 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. - </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> - Show the xdg-utils version information. - </dd><dt><span class="term"><code class="option">--noupdate</code></span></dt><dd> + </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">--install</code></span></dt><dd> + Installs the icon file indicated by <em class="replaceable"><code>icon-file</code></em> + to the desktop icon system. The icon file must have + <span class="emphasis"><em>.png</em></span>, <span class="emphasis"><em>.xpm</em></span> or + <span class="emphasis"><em>.svg</em></span> as extension. If a corresponding + <span class="emphasis"><em>.icon</em></span> file exists in the same location as <em class="replaceable"><code>icon-file</code></em> + it will be installed as well. + </dd><dt><span class="term"><code class="option">--uninstall</code></span></dt><dd> + Removes the icon file indicated by <em class="replaceable"><code>icon-file</code></em> + from the desktop icon system. + </dd><dt><span class="term"><code class="option">--forceupdate</code></span></dt><dd> + Force an update of the desktop icon system. This is only useful if + the last call to xdg-icon included the <code class="option">--noupdate</code> option. + </dd><dt><span class="term"><code class="option">--noupdate</code></span></dt><dd> Postpone updating the desktop icon system. If multiple icons are added in sequence this flag can be used to indicate that additional changes will follow and that it is not necassery to update the desktop icon system right away. - </dd><dt><span class="term"> <code class="option">--theme</code> <em class="replaceable"><code>theme</code></em></span></dt><dd> + </dd><dt><span class="term"><code class="option">--theme</code> <em class="replaceable"><code>theme</code></em></span></dt><dd> Installs or removes the icon file as part of <em class="replaceable"><code>theme</code></em>. If no theme is specified the icons will be installed as part of the default <span class="emphasis"><em>hicolor</em></span> theme. Applications may install icons under multiple themes but should at least install icons for the default <span class="emphasis"><em>hicolor</em></span> theme. - </dd><dt><span class="term"> <code class="option">--context</code> <em class="replaceable"><code>context</code></em></span></dt><dd> + </dd><dt><span class="term"><code class="option">--context</code> <em class="replaceable"><code>context</code></em></span></dt><dd> Specifies the context for the icon. Icons to be used in the application menu and as desktop icon should use <span class="emphasis"><em>apps</em></span> as context which is the default @@ -29,31 +38,22 @@ Other common contexts are <span class="emphasis"><em>actions</em></span>, <span class="emphasis"><em>devices</em></span>, <span class="emphasis"><em>emblems</em></span>, <span class="emphasis"><em>filesystems</em></span> and <span class="emphasis"><em>stock</em></span>. - </dd><dt><span class="term"><code class="option">--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">--size</code> <em class="replaceable"><code>size</code></em></span></dt><dd> - Specifies the size of the icon (for png and xpm icons only). + </dd><dt><span class="term"><code class="option">--size</code> <em class="replaceable"><code>size</code></em></span></dt><dd> + Specifies the size of the icon (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 - </dd><dt><span class="term"> <code class="option">--install</code> <em class="replaceable"><code>icon-file</code></em></span></dt><dd> - Installs the icon file indicated by <em class="replaceable"><code>icon-file</code></em> - to the desktop icon system. The icon file must have the - <span class="emphasis"><em>.png</em></span>, <span class="emphasis"><em>.xpm</em></span> or - <span class="emphasis"><em>.svg</em></span> as extension. If a corresponding - <span class="emphasis"><em>.icon</em></span> file exists in the same location as <em class="replaceable"><code>icon-file</code></em> - it will be installed as well. - </dd><dt><span class="term"> <code class="option">--uninstall</code> <em class="replaceable"><code>icon-file</code></em></span></dt><dd> - Removes the icon file indicated by <em class="replaceable"><code>icon-file</code></em> - from the desktop icon system. - </dd><dt><span class="term"><code class="option">--forceupdate</code></span></dt><dd> - Force an update of the desktop icon system. This is only useful if - the last call to xdg-icon included the <code class="option">--noupdate</code> option. - </dd></dl></div></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Examples</h2><p> + </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> + Show this help. + </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="examples"></a><h2>Examples</h2><p> TBD </p></div></div></body></html> diff --git a/scripts/html/xdg-menu.html b/scripts/html/xdg-menu.html index c935348..c12a52f 100644 --- a/scripts/html/xdg-menu.html +++ b/scripts/html/xdg-menu.html @@ -1,49 +1,46 @@ -<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> [<code class="option">--help</code>] [<code class="option">--version</code>] [<code class="option">--vendor <em class="replaceable"><code>vendor-id</code></em></code>] [<code class="option">--noupdate</code>] { --user | --system } { --install <em class="replaceable"><code>desktop-file</code></em> | --install <em class="replaceable"><code>directory-file</code></em> | --install <em class="replaceable"><code>menu-file</code></em> | --uninstall <em class="replaceable"><code>desktop-file</code></em> | --uninstall <em class="replaceable"><code>directory-file</code></em> | --uninstall <em class="replaceable"><code>menu-file</code></em> | --forceupdate }</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> { --help | --version }</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> The application menu works according to the XDG Desktop Menu Specification at http://www.freedesktop.org/Standards/menu-spec - </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. - </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> - Show the xdg-utils version information. - </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. + </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">--install</code></span></dt><dd><p> + Install applications or submenus into the desktop menu system. + </p><p><em class="replaceable"><code>desktop-file</code></em>: + Installs the *.desktop file indicated by <em class="replaceable"><code>desktop-file</code></em> + to the menu system. A desktop file represents a single application in the menu. + </p><p><em class="replaceable"><code>menu-file</code></em>: + Installs the *.menu file indicated by <em class="replaceable"><code>menu-file</code></em> + 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. + </p><p><em class="replaceable"><code>directory-file</code></em>: + Installs the *.directory file indicated by <em class="replaceable"><code>directory-file</code></em> + to the menu system. A directory file provides the name and icon for a submenu. + </p></dd><dt><span class="term"><code class="option">--uninstall</code></span></dt><dd> + Remove applications or submenus from the desktop menu system + previously installed with <span><strong class="command">xdg-menu --install</strong></span>. + </dd><dt><span class="term"><code class="option">--forceupdate</code></span></dt><dd> + Force an update of the menu system. This is only useful if + the last call to xdg-menu included the <code class="option">--noupdate</code> option. </dd><dt><span class="term"><code class="option">--noupdate</code></span></dt><dd> Postpone updating the menu system. If multiple updates to the menu system are made in sequence this flag can be used to indicate that additional changes will follow and that it is not necassery to update the menu system right away. + </dd><dt><span class="term"> <code class="option">--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">--install</code> <em class="replaceable"><code>desktop-file</code></em></span></dt><dd> - Installs the *.desktop file indicated by <em class="replaceable"><code>desktop-file</code></em> - to the menu system. A desktop file represents a single menu item. - </dd><dt><span class="term"> <code class="option">--install</code> <em class="replaceable"><code>directory-file</code></em></span></dt><dd> - Installs the *.directory file indicated by <em class="replaceable"><code>directory-file</code></em> - to the menu system. A directory file provides the name and icon for a submenu. - </dd><dt><span class="term"> <code class="option">--install</code> <em class="replaceable"><code>menu-file</code></em></span></dt><dd> - Installs the *.menu file indicated by <em class="replaceable"><code>menu-file</code></em> - to the menu system. A menu file describes a submenu. - </dd><dt><span class="term"> <code class="option">--uninstall</code> <em class="replaceable"><code>desktop-file</code></em></span></dt><dd> - Removes the *.desktop file indicated by <em class="replaceable"><code>desktop-file</code></em> - from the menu system. - </dd><dt><span class="term"> <code class="option">--uninstall</code> <em class="replaceable"><code>directory-file</code></em></span></dt><dd> - Removes the *.directory file indicated by <em class="replaceable"><code>directory-file</code></em> - from the menu system. - </dd><dt><span class="term"> <code class="option">--uninstall</code> <em class="replaceable"><code>menu-file</code></em></span></dt><dd> - Removes the *.menu file indicated by <em class="replaceable"><code>menu-file</code></em> - from the menu system. - </dd><dt><span class="term"><code class="option">--forceupdate</code></span></dt><dd> - Force an update of the menu system. This is only useful if - the last call to xdg-menu included the <code class="option">--noupdate</code> option. - </dd></dl></div></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Examples</h2><p> + </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 the xdg-utils version information. + </dd></dl></div></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Examples</h2><p> The company ShinyThings Inc. has developed an application named "WebMirror" and would like to add it to the application menu. The company will use "shinythings" as its vendor id. @@ -67,7 +64,7 @@ webmirror.desktop: </p><p>Now the xdg-menu tool can be used to add the webmirror.desktop file to the desktop application menu: </p><pre class="programlisting"> -xdg-menu --system --vendor shinythings --install ./webmirror.desktop +xdg-menu --install --system --vendor shinythings ./webmirror.desktop </pre><p> </p><p> Note that for the purpose of this example the menu items are available @@ -110,8 +107,8 @@ webmirror-admin.desktop: </p><p> The files can be installed with: </p><pre class="programlisting"> -xdg-menu --system --noupdate --vendor shinythings --install ./webmirror.desktop -xdg-menu --system --noupdate --vendor shinythings --install ./webmirror-admin.desktop +xdg-menu --install --system --noupdate --vendor shinythings ./webmirror.desktop +xdg-menu --install --system --noupdate --vendor shinythings ./webmirror-admin.desktop </pre><p> </p><p> Because multiple items are added the <code class="option">--noupdate</code> @@ -133,7 +130,7 @@ webmirror.directory: </p><p> This webmirror.directorty file can be installed with: </p><pre class="programlisting"> -xdg-menu --system --noupdate --vendor shinythings --install ./webmirror.directory +xdg-menu --install --system --noupdate --vendor shinythings ./webmirror.directory </pre><p> </p><p> The last step is to provide a .menu file that links it all @@ -157,12 +154,12 @@ webmirror.menu: </p><p> The webmirror.menu file can be installed with: </p><pre class="programlisting"> -xdg-menu --system --noupdate --vendor shinythings --install ./webmirror.menu +xdg-menu --install --system --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-menu --system --forceupdate +xdg-menu --forceupdate --system </pre><p> </p></div></div></body></html> diff --git a/scripts/html/xdg-mime.html b/scripts/html/xdg-mime.html index 94ad91a..f995304 100644 --- a/scripts/html/xdg-mime.html +++ b/scripts/html/xdg-mime.html @@ -1,49 +1,52 @@ <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> [<code class="option">--help</code>] [<code class="option">--version</code>] [ <code class="option">--info <em class="replaceable"><code>FILE</code></em></code> | <code class="option">--defapp <em class="replaceable"><code>FILE</code></em></code> ] { --user | --system } { --install <em class="replaceable"><code>mimetypes-file</code></em> | --uninstall <em class="replaceable"><code>mimeypes-file</code></em> }</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> <code class="option">--query <em class="replaceable"><code>what</code></em></code> <em class="replaceable"><code>FILE</code></em> </p></div><div class="cmdsynopsis"><p><code class="command">xdg-mime</code> <code class="option">--install</code> { <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">--uninstall</code> { <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> 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="options"></a><h2>Options</h2><div class="variablelist"><dl><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 the xdg-utils version information. - </dd><dt><span class="term"> <code class="option">--info</code> <em class="replaceable"><code>FILE</code></em></span></dt><dd> + </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">--query</code> <em class="replaceable"><code>what</code></em></span></dt><dd><p> + Returns information related to the file type of <em class="replaceable"><code>FILE</code></em> + as specified by <em class="replaceable"><code>what</code></em>: + </p><p><span class="emphasis"><em>type</em></span>: Returns the file type of <em class="replaceable"><code>FILE</code></em> in the form of a MIME type. - </dd><dt><span class="term"> <code class="option">--defapp</code> <em class="replaceable"><code>FILE</code></em></span></dt><dd> + </p><p><span class="emphasis"><em>default</em></span>: Returns the default application that the desktop environment uses for opening <em class="replaceable"><code>FILE</code></em>. The default applications is identified by its *.desktop file. - </dd><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">--install</code> <em class="replaceable"><code>mimetypes-file</code></em></span></dt><dd> + </p></dd><dt><span class="term"><code class="option">--install</code></span></dt><dd> Adds the file type descriptions provided in <em class="replaceable"><code>mimetypes-file</code></em> to the desktop environment. <em class="replaceable"><code>mimetypes-file</code></em> must be a XML file that follows the freedesktop.org Shared MIME-info Database specification and that has a mime-info element as its document root. - </dd><dt><span class="term"> <code class="option">--uninstall</code> <em class="replaceable"><code>mimetypes-file</code></em></span></dt><dd> + </dd><dt><span class="term"><code class="option">--uninstall</code></span></dt><dd> Removes the file type descriptions provided in <em class="replaceable"><code>mimetypes-file</code></em> and previously added with <span><strong class="command">xdg-mime --install</strong></span> from the desktop environment. <em class="replaceable"><code>mimetypes-file</code></em> must be a XML file that follows the freedesktop.org Shared MIME-info Database specification and that has a mime-info element as its document root. - </dd></dl></div></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Examples</h2><p> + </dd><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> + Show this help. + </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="examples"></a><h2>Examples</h2><p> </p><pre class="programlisting"> -xdg-mime --info /tmp/foobar.png +xdg-mime --query type /tmp/foobar.png </pre><p> Prints the MIME type of the file /tmp/foobar.png </p><p> </p><pre class="programlisting"> -xdg-mime --defapp /tmp/foobar.png +xdg-mime --query default /tmp/foobar.png </pre><p> Prints the name of the .desktop file of the application which is registered to open files of the MIME type the file /tmp/foobar.png has </p><p> </p><pre class="programlisting"> -xdg-mime --system --install diff.xml +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. diff --git a/scripts/html/xdg-open.html b/scripts/html/xdg-open.html index 0d12273..078893a 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">--help</code>] [<code class="option">--version</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><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">--version</code> }</p></div></div><div class="refsect1" lang="en"><a name="description"></a><h2>Description</h2><p> xdg-open opens a file or URL in the user's preferred application. If a URL is provided the URL will be opened in the user's preferred web browser. If a file is provided the file will be opened in the diff --git a/scripts/html/xdg-screensaver.html b/scripts/html/xdg-screensaver.html index a477f54..38fd8b9 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 — Enable, disable, and suspend 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">enable</code> | <code class="option">disable</code> | <code class="option">activate</code> | <code class="option">reset</code> | <code class="option">status</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 — Enable, disable, and suspend 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">enable</code> | <code class="option">disable</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> xdg-screensaver provides commands </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">suspend <em class="replaceable"><code>delay</code></em></code></span></dt><dd> Suspends the screensaver and monitor power management for @@ -27,6 +27,10 @@ </dd><dt><span class="term"><code class="option">status</code></span></dt><dd> 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. + </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="examples"></a><h2>Examples</h2><p> </p><pre class="programlisting"> xdg-screensaver suspend 3h diff --git a/scripts/html/xdg-su.html b/scripts/html/xdg-su.html index f6ddfac..a90d41f 100644 --- a/scripts/html/xdg-su.html +++ b/scripts/html/xdg-su.html @@ -1,15 +1,15 @@ -<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">--help</code>] [<code class="option">--version</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><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">--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. - </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> + </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">-u <em class="replaceable"><code>user</code></em></code></span></dt><dd> + 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. </dd><dt><span class="term"><code class="option">--version</code></span></dt><dd> Show the xdg-utils version information. - </dd><dt><span class="term"><code class="option">-u <em class="replaceable"><code>user</code></em></code></span></dt><dd> - run <em class="replaceable"><code>command</code></em> as - <em class="replaceable"><code>user</code></em>. The default is to run as root. - </dd></dl></div></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Examples</h2><p> + </dd></dl></div></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Examples</h2><p> </p><pre class="programlisting"> xdg-su -u root -c "/opt/shinythings/bin/install-GUI --install fast" </pre><p> |