File: CreateInterface.sgml

package info (click to toggle)
dbus-java 2.8-9
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,336 kB
  • sloc: java: 11,718; makefile: 289; sh: 35
file content (182 lines) | stat: -rw-r--r-- 5,624 bytes parent folder | download | duplicates (5)
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
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [

<!-- 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>Matthew</firstname>">
  <!ENTITY dhsurname   "<surname>Johnson</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>January  10, 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>&lt;debian@matthew.ath.cx&gt;</email>">
  <!ENTITY dhusername  "Matthew Johnson">
  <!ENTITY dhucpackage "<refentrytitle>DBUS-JAVA</refentrytitle>">
  <!ENTITY dhpackage   "CreateInterface">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</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>Create a Java Interface definition from DBus
    introspection data.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
         <arg><option><replaceable>introspection.xml</replaceable></option></arg>
         <arg><option><replaceable>busname</replaceable> <replaceable>objectname</replaceable></option></arg>
         <arg><option>-y </option></arg>
         <arg><option>--system </option></arg>
         <arg><option>-s </option></arg>
         <arg><option>--session </option></arg>
         <arg><option>-f </option></arg>
         <arg><option>--create-files </option></arg>
         <arg><option>-h </option></arg>
         <arg><option>--help</option></arg>

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

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

    <para><command>&dhpackage;</command> takes DBus introspection data, 
       either as an XML file or by calling the Introspect() method on the Bus,
       and converts it into a Java interface file. This is either written
       to the standard output or to the correct file structure for the
       Java packages.
    </para>


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

    <para>These programs follow 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>-s</option>
          <option>--session</option>
        </term>
        <listitem>
          <para>Use the Session Bus to query introspection data 
          (This is the Default)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-y</option>
          <option>--system</option>
        </term>
        <listitem>
          <para>Use the System Bus to query introspection data 
          (Default is Session)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-f</option>
          <option>--create-files</option>
        </term>
        <listitem>
          <para>Writes introspection data into files rather than to stdout.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--no-ignore-builtin</option>
        </term>
        <listitem>
          <para>Do not ignore builtin (org.freedesktop.DBus)
          interfaces while parsing introspection data</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option>
          <option>--help</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail;. Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; Lesser General Public License, Version 2 as
      published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU Lesser General Public
	  License can be found in /usr/share/common-licenses/LGPL-2.
	</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:
-->