summaryrefslogtreecommitdiffstats
path: root/ubuntu/lucid_automake/kdelibs/debian/man/dcop-kde3.sgml
blob: 0c80c88a1580d5dd08f4ec90c8010f2ed9cbdc11 (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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<!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>Chris</firstname>">
  <!ENTITY dhsurname   "<surname>Cheney</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>October 13, 2004</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>ccheney@debian.org</email>">
  <!ENTITY dhusername  "Chris Cheney">
  <!ENTITY dhucpackage "<refentrytitle>DCOP</refentrytitle>">
  <!ENTITY dhpackage   "dcop">

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

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

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

    <refpurpose>Console DCOP client</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option><replaceable>options</replaceable></option></arg>
      <arg><option><replaceable>application <optional><replaceable>function <optional><replaceable>arg1</replaceable></optional> <optional><replaceable>arg2</replaceable></optional> ... </replaceable></optional> </replaceable></option></arg>

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

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>

    <para><command>&dhpackage;</command> is a console DCOP (Desktop Communications Protocol) client.</para>

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

    <para>This program follows the usual GNU command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.</para>

    <variablelist>
      <varlistentry>
        <term><option>--all-sessions</option>
        </term>
        <listitem>
          <para>Send to all sessions found. Only works with the --user and --all-users options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--all-users</option>
        </term>
        <listitem>
          <para>Send the same DCOP call to all users with a running DCOP server. Only failed calls to existing DCOP servers will generate an error message. If no DCOP server is available at all, no error will be generated.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--help</option>
        </term>
        <listitem>
          <para>Show help about options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--list-sessions</option>
        </term>
        <listitem>
          <para>List all active KDE session for a user or all users.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--pipe</option>
        </term>
        <listitem>
          <para>Call DCOP for each line read from stdin.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--session <replaceable>session</replaceable></option>
        </term>
        <listitem>
          <para>Send to the given KDE session. This option can only be used in combination with the --user option.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--user <replaceable>user</replaceable></option>
        </term>
        <listitem>
          <para>Connect to the given user's DCOP server. This option will ignore the values of the environment vars $DCOPSERVER and $ICEAUTHORITY, even if they are set. If the user has more than one open session, you must also use one of the --list-sessions, --session or --all-sessions command-line options.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>EXAMPLES</title>
    
    <para><example>
      <title>Return number of the current desktop, e.g. 2</title>
        <blockquote><literallayout>
dcop kwin KWinInterface currentDesktop
        </literallayout></blockquote>
    </example></para>

    <para><example>
      <title>Jump to the next dektop</title>
        <blockquote><literallayout>
dcop kwin KWinInterface nextDesktop
        </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>kdcop</application>(1), <application>dcopserver</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:
-->