doc: add README.extcap
[metze/wireshark/wip.git] / doc / idl2deb.pod
1
2 =head1 NAME
3
4 idl2deb - Create a Debian package for CORBA monitoring from IDL
5
6 =head1 SYNOPSIS
7
8 B<idl2deb>
9 S< [ B<-d> E<lt>optsE<gt> ]>
10 S< [ B<--dbopts>=E<lt>optsE<gt> ]>
11 S< [ B<-e> E<lt>addressE<gt> ]>
12 S< [ B<--email>=E<lt>addressE<gt> ]>
13 S< [ B<-h> ]>
14 S< [ B<--help> ]>
15 S< [ B<-i> E<lt>idlfileE<gt> ]>
16 S< [ B<--idl>=E<lt>idlfileE<gt> ]>
17 S< [ B<-n> E<lt>nameE<gt> ]>
18 S< [ B<--name>=E<lt>nameE<gt> ]>
19 S< [ B<-p> ]>
20 S< [ B<--preserve> ]>
21 S< [ B<-v> ]>
22 S< [ B<--version> ]>
23
24 =head1 DESCRIPTION
25
26 This manual page documents briefly the B<idl2deb> command. B<idl2deb>
27 takes an CORBA IDL file as input and creates a Debian package from it. The
28 package contains a loadable module for the wireshark network analyser.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item -d E<lt>optsE<gt> --dbopts=E<lt>optsE<gt>
35
36 options for dpkg-buildpackage.
37
38 =item -e E<lt>addressE<gt> --email=E<lt>addressE<gt>
39
40 use e-mail address.
41
42 =item -h --help
43
44 print help and exit.
45
46 =item -i E<lt>idlfileE<gt> --idl=E<lt>idlfileE<gt>
47
48 IDL file to use (mandatory)
49
50 =item -n E<lt>nameE<gt> --name=E<lt>nameE<gt>
51
52 use user name.
53
54 =item -p --preserve
55
56 do not overwrite files.
57
58 =item -v --version
59
60 print version and exit.
61
62 =back
63
64 =head1 EXAMPLES
65
66 /usr/bin/idl2deb -e me@foo.net -i bar.idl \-n "My Name" -d "-rfakeroot -uc -us"-d "-rfakeroot -uc -us"
67
68 =head1 SEE ALSO
69
70 A lot of tools are used, which you have to B<apt-get install>: wireshark-dev, python, cdbs, autotools-dev, debhelper, dpkg-dev.
71
72 =head1 COPYING
73
74 This manual page was written by W. Borgert debacle@debian.org
75 for Debian GNU/Linux (but may be used by others). Permission is granted
76 to copy, distribute and/or modify this document under the terms of the
77 GNU General Public License, Version 2 or any later version published by
78 the Free Software Foundation.
79
80 =head1 AUTHOR
81
82 B<W. Borgert> Author.
83
84 =head1 COPYRIGHT
85
86 Copyright (C) 2003, 2005 W. Borger