summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWaldo Bastian <waldo.bastian@intel.com>2006-06-19 01:41:13 +0000
committerWaldo Bastian <waldo.bastian@intel.com>2006-06-19 01:41:13 +0000
commit8a03104916e59619abdd0fd6e6fac8d987a7809a (patch)
tree0580b172e3bc98c2fefb02e75a77babc5a9cd681
parent2ebc21f203f95260cedde04463f99dd4537852ae (diff)
Add example
-rw-r--r--scripts/desc/xdg-desktop-icon.xml32
-rw-r--r--scripts/html/xdg-desktop-icon.html30
-rw-r--r--scripts/man/xdg-desktop-icon.141
3 files changed, 99 insertions, 4 deletions
diff --git a/scripts/desc/xdg-desktop-icon.xml b/scripts/desc/xdg-desktop-icon.xml
index daf72df..f6c7120 100644
--- a/scripts/desc/xdg-desktop-icon.xml
+++ b/scripts/desc/xdg-desktop-icon.xml
@@ -77,6 +77,8 @@
<listitem>
<simpara>
Installs <replaceable>FILE</replaceable> to the desktop of the current user.
+ <replaceable>FILE</replaceable> can be a *.desktop file or any
+ other type of file.
</simpara>
</listitem>
</varlistentry>
@@ -293,7 +295,35 @@
<refsect1 id="examples">
<title>Examples</title>
<para>
- TBD
+ The company ShinyThings Inc. has developed an application named
+ "WebMirror" and would like to add a launcher for for on the desktop.
+ The company will use "shinythings" as its vendor id.
+ In order to add the application to the desktop there needs to be a
+ .desktop file for the application:
+<programlisting>
+webmirror.desktop:
+
+ [Desktop Entry]
+ Encoding=UTF-8
+ Type=Application
+
+ Exec=webmirror
+ Icon=webmirror
+
+ Name=WebMirror
+ Name[nl]=WebSpiegel
+</programlisting>
+ </para>
+ <para>Now the xdg-desktop-icon tool can be used to add the webmirror.desktop file
+ to the desktop:
+<programlisting>
+xdg-desktop-icon install --vendor shinythings ./webmirror.desktop
+</programlisting>
+ </para>
+ <para>To add a README file to the desktop as well, the following command can be used:
+<programlisting>
+xdg-desktop-icon install ./shinythings-README
+</programlisting>
</para>
</refsect1>
</refentry>
diff --git a/scripts/html/xdg-desktop-icon.html b/scripts/html/xdg-desktop-icon.html
index 67d4668..bcbbfa6 100644
--- a/scripts/html/xdg-desktop-icon.html
+++ b/scripts/html/xdg-desktop-icon.html
@@ -8,6 +8,8 @@
are summarized below.
</p></div><div class="refsect1" lang="en"><a name="commands"></a><h2>Commands</h2><div class="variablelist"><dl><dt><span class="term">install</span></dt><dd>
Installs <em class="replaceable"><code>FILE</code></em> to the desktop of the current user.
+ <em class="replaceable"><code>FILE</code></em> can be a *.desktop file or any
+ other type of file.
</dd><dt><span class="term">uninstall</span></dt><dd>
Removes <em class="replaceable"><code>FILE</code></em> from the desktop
of the current user.
@@ -84,5 +86,31 @@
The action failed.
</dd></dl></div></div><div class="refsect1" lang="en"><a name="seealso"></a><h2>See Also</h2><p><span class="citerefentry"><span class="refentrytitle">xdg-icon-resource</span>(1)</span>
</p></div><div class="refsect1" lang="en"><a name="examples"></a><h2>Examples</h2><p>
- TBD
+ The company ShinyThings Inc. has developed an application named
+ "WebMirror" and would like to add a launcher for for on the desktop.
+ The company will use "shinythings" as its vendor id.
+ In order to add the application to the desktop there needs to be a
+ .desktop file for the application:
+</p><pre class="programlisting">
+webmirror.desktop:
+
+ [Desktop Entry]
+ Encoding=UTF-8
+ Type=Application
+
+ Exec=webmirror
+ Icon=webmirror
+
+ Name=WebMirror
+ Name[nl]=WebSpiegel
+</pre><p>
+ </p><p>Now the xdg-desktop-icon tool can be used to add the webmirror.desktop file
+ to the desktop:
+</p><pre class="programlisting">
+xdg-desktop-icon install --vendor shinythings ./webmirror.desktop
+</pre><p>
+ </p><p>To add a README file to the desktop as well, the following command can be used:
+</p><pre class="programlisting">
+xdg-desktop-icon install ./shinythings-README
+</pre><p>
</p></div></div></body></html>
diff --git a/scripts/man/xdg-desktop-icon.1 b/scripts/man/xdg-desktop-icon.1
index e5c51f3..0f915f9 100644
--- a/scripts/man/xdg-desktop-icon.1
+++ b/scripts/man/xdg-desktop-icon.1
@@ -52,7 +52,7 @@ An application launcher is represented by a *\&.desktop file\&. Desktop files ar
.TP
install
-Installs \fIFILE\fR to the desktop of the current user\&.
+Installs \fIFILE\fR to the desktop of the current user\&. \fIFILE\fR can be a *\&.desktop file or any other type of file\&.
.TP
uninstall
@@ -147,7 +147,44 @@ The action failed\&.
.SH "EXAMPLES"
.PP
-TBD
+The company ShinyThings Inc\&. has developed an application named "WebMirror" and would like to add a launcher for for on the desktop\&. The company will use "shinythings" as its vendor id\&. In order to add the application to the desktop there needs to be a \&.desktop file for the application:
+
+.nf
+
+webmirror\&.desktop:
+
+ [Desktop Entry]
+ Encoding=UTF\-8
+ Type=Application
+
+ Exec=webmirror
+ Icon=webmirror
+
+ Name=WebMirror
+ Name[nl]=WebSpiegel
+
+.fi
+
+
+.PP
+Now the xdg\-desktop\-icon tool can be used to add the webmirror\&.desktop file to the desktop:
+
+.nf
+
+xdg\-desktop\-icon install \-\-vendor shinythings \&./webmirror\&.desktop
+
+.fi
+
+
+.PP
+To add a README file to the desktop as well, the following command can be used:
+
+.nf
+
+xdg\-desktop\-icon install \&./shinythings\-README
+
+.fi
+
.SH AUTHORS
Kevin Krammer, Jeremy White.