tde-packaging/ubuntu/maverick/tdelibs/debian/man/dcopstart-trinity.sgml

<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Johannes</firstname>">
  <!ENTITY dhsurname   "<surname>Ranke</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>March 25, 2006</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>jranke@uni-bremen.de</email>">
  <!ENTITY dhusername  "Johannes Ranke">
  <!ENTITY dhucpackage "<refentrytitle>DCOPSTART</refentrytitle>">
  <!ENTITY dhpackage   "dcopstart">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2006</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>Start a TDE service and return its DCOP reference</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg choice='req'><replaceable>service</replaceable></arg>
      <arg><replaceable>...</replaceable></arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para><command>&dhpackage;</command> starts a TDE service (i.e. an application
	that is registered in the TDE system of .desktop files) and returns its
	reference for later use in shell scripts. If the service is not scriptable
	via DCOP, dcopstart returns nothing, but starts the service.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>--help</option>
        </term>
        <listitem>
          <para>Show usage information.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>EXAMPLES</title>
    
    <para><example>
      <title>Get the DCOP reference for a newly started konqueror instance</title>
        <blockquote><literallayout>
KONQ_ID=$(dcopstart konqueror http://www.trinitydesktop.org)
        </literallayout></blockquote>
    </example></para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &lt;&dhemail;&gt; for 
	  the &debian; system (but may be used by others).  Permission is granted
	  to copy, distribute and/or modify this document under the terms of the
	  &gnu; General Public License, Version 2 or any later version published by
	  the Free Software Foundation.</para>

	<para>On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.</para>

  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
      <para><application>dcop</application>(1), <application>dcopfind</application>(1)</para>
  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->