summaryrefslogtreecommitdiffstats
path: root/ubuntu/maverick_automake/kdelibs/debian/man/dcopfind-kde3.sgml
blob: 5aeb03ce0592e8c7cdf94632da203636504c9da0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<!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>DCOPFIND</refentrytitle>">
  <!ENTITY dhpackage   "dcopfind">

  <!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>Find the DCOP reference of a KDE service</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option>-a</option></arg>
      <arg><option>-l</option></arg>
      <arg choice='req'><replaceable>service</replaceable></arg>
	  <arg><replaceable>object</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

	<para><command>&dhpackage;</command> returns a reference to the first
	instance of the KDE service specified by
	<replaceable>service</replaceable>. See also dcopstart, which starts a
	service/application and immediately returns its reference.
	</para>

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

    <variablelist>
      <varlistentry>
        <term><option>-a</option>
        </term>
        <listitem>
		  <para>Print the application id. Without this argument, the
		  application id will be returned in the form
		  DCOPRef(application id,object id).
		  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-l</option>
        </term>
        <listitem>
          <para>If the object is not found, run dcopstart and try again.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help</option>
        </term>
        <listitem>
          <para>Show usage information.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>EXAMPLES</title>
    
    <para><example>
      <title>Return reference to a Kate instance</title>
        <blockquote><literallayout>
KATE=`dcopfind -a 'kate-*'`
        </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>dcopstart</application>(1), <application>dcop</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:
-->