summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorTomas Bzatek <tbzatek@redhat.com>2012-07-16 17:29:01 +0200
committerMatthias Clasen <mclasen@redhat.com>2012-07-16 14:28:22 -0400
commitbdc6395d648708d4948dfb654af9947033c953ac (patch)
tree69927e98dc4aeec3cbc9abb74b5d74bb1f076f88 /docs/reference
parentad2dc27dd5f505a830c779fb051850fb5922a573 (diff)
downloadgtk+-bdc6395d648708d4948dfb654af9947033c953ac.tar.gz
New gtk-launch command
This program launches an application specified by its desktop name optinally taking list of URIs which are passed as arguments. Uses GdkAppLaunchContext to get proper startup notification and display handling for graphical apps. https://bugzilla.gnome.org/show_bug.cgi?id=679342
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/gtk/Makefile.am4
-rw-r--r--docs/reference/gtk/gtk-docs.sgml1
-rw-r--r--docs/reference/gtk/gtk-launch.xml72
3 files changed, 76 insertions, 1 deletions
diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am
index db1f0123a8..8ef4044bd4 100644
--- a/docs/reference/gtk/Makefile.am
+++ b/docs/reference/gtk/Makefile.am
@@ -141,6 +141,7 @@ content_files = \
x11.sgml \
gtk-query-immodules-3.0.xml \
gtk-update-icon-cache.xml \
+ gtk-launch.xml \
visual_index.xml \
getting_started.xml \
overview.xml
@@ -400,7 +401,8 @@ EXTRA_DIST += version.xml.in gtk3.types.in
man_MANS = \
gtk-query-immodules-3.0.1 \
- gtk-update-icon-cache.1
+ gtk-update-icon-cache.1 \
+ gtk-launch.1
if ENABLE_MAN
diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml
index 6eca4d0dce..098d5d73d6 100644
--- a/docs/reference/gtk/gtk-docs.sgml
+++ b/docs/reference/gtk/gtk-docs.sgml
@@ -377,6 +377,7 @@
<title>GTK+ Tools</title>
<xi:include href="gtk-query-immodules-3.0.xml" />
<xi:include href="gtk-update-icon-cache.xml" />
+ <xi:include href="gtk-launch.xml" />
</part>
<xi:include href="glossary.xml" />
diff --git a/docs/reference/gtk/gtk-launch.xml b/docs/reference/gtk/gtk-launch.xml
new file mode 100644
index 0000000000..17fc540cfd
--- /dev/null
+++ b/docs/reference/gtk/gtk-launch.xml
@@ -0,0 +1,72 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+]>
+<refentry id="gtk-launch">
+
+<refentryinfo>
+ <title>gtk-launch</title>
+ <productname>gtk+</productname>
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Tomáš</firstname>
+ <surname>Bžatek</surname>
+ <email>tbzatek@redhat.com</email>
+ </author>
+ </authorgroup>
+</refentryinfo>
+
+<refmeta>
+ <refentrytitle>gtk-launch</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="manual">User Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+ <refname>gtk-launch</refname>
+ <refpurpose>Launch an application</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>gtk-launch</command>
+<arg>APPLICATION</arg>
+<arg choice="opt" rep="repeat">URI</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+<para>
+<command>gtk-launch</command> launches an application using the given name.
+The application is started with proper startup notification on a default
+display, unless specified otherwise.
+</para>
+<para>
+<command>gtk-launch</command> takes at least one argument, the name of
+the application to launch. The name should match application desktop file name,
+as residing in /usr/share/application, with or without the '.desktop' suffix.
+</para>
+<para>
+If called with more than one argument, the rest of them besides the application name
+are considered URI locations and are passed as arguments to the launched application.
+</para>
+</refsect1>
+
+<refsect1><title>Options</title>
+ <para>The following options are understood:</para>
+ <variablelist>
+ <varlistentry>
+ <term><option>-?</option>, <option>--help</option></term>
+ <listitem><para>Prints a short help text and exits.</para></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect1>
+
+<refsect1><title>Bugs</title>
+<para>
+None known yet.
+</para>
+</refsect1>
+
+</refentry>