aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorBalint Reczey <balint@balintreczey.hu>2013-03-06 13:31:08 +0000
committerBalint Reczey <balint@balintreczey.hu>2013-03-06 13:31:08 +0000
commita8f543b56b86e1ac5246c70918dc7cb0f372ed77 (patch)
tree5aa30d8c53957d915c3ef987af3ee5bff4893adf /doc
parent974c0e18b9af3da1fdea4363f4abe37259238498 (diff)
Merge asn2deb and idl2deb from official Debian package
svn path=/trunk/; revision=48133
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am20
-rw-r--r--doc/Makefile.nmake30
-rw-r--r--doc/asn2deb.pod75
-rw-r--r--doc/idl2deb.pod74
4 files changed, 196 insertions, 3 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 741bb4437b..ce0000f01e 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -79,7 +79,7 @@ man_MANS =
# Build these in case a developer wants to read them and for the Debian
# development package.
# (The former arguably should be in noinst_MANS but it didn't work for me.)
-noinst_DATA = idl2wrs.1 idl2wrs.html
+noinst_DATA = asn2deb.1 asn2deb.html idl2deb.1 idl2deb.html idl2wrs.1 idl2wrs.html
pkgdata_DATA = AUTHORS-SHORT $(top_srcdir)/docbook/ws.css wireshark.html \
tshark.html wireshark-filter.html capinfos.html editcap.html \
@@ -117,6 +117,20 @@ AM_V_POD2HTML = $(am__v_POD2HTML_@AM_V@)
am__v_POD2HTML_ = $(am__v_POD2HTML_@AM_DEFAULT_V@)
am__v_POD2HTML_0 = @echo " POD2HTML" $@;
+%.1: %.pod ../config.h
+ $(AM_V_POD2MAN)$(POD2MAN) \
+ --center="The Wireshark Network Analyzer" \
+ --release=$(VERSION) \
+ $< > $@
+
+%.html: %.pod ../config.h
+ $(AM_V_POD2HTML)$(POD2HTML) \
+ --title="The Wireshark Network Analyzer $(VERSION)" \
+ --css=$(top_srcdir)/docbook/ws.css \
+ --noindex \
+ $< > $@
+
+
wireshark.1: wireshark.pod ../config.h
$(AM_V_POD2MAN)$(POD2MAN) \
--center="The Wireshark Network Analyzer" \
@@ -301,6 +315,10 @@ CLEANFILES = \
dumpcap.html \
editcap.1 \
editcap.html \
+ asn2deb.1 \
+ asn2deb.html \
+ idl2deb.1 \
+ idl2deb.html \
idl2wrs.1 \
idl2wrs.html \
mergecap.1 \
diff --git a/doc/Makefile.nmake b/doc/Makefile.nmake
index de3fb6a253..b8a9a15db1 100644
--- a/doc/Makefile.nmake
+++ b/doc/Makefile.nmake
@@ -28,10 +28,10 @@ include ../config.nmake
doc: wireshark.html tshark.html wireshark-filter.html capinfos.html \
editcap.html idl2wrs.html mergecap.html reordercap.html text2pcap.html dumpcap.html \
- rawshark.html
+ rawshark.html idl2deb.html asn2deb.html
man: wireshark.1 tshark.1 wireshark-filter.4 capinfos.1 editcap.1 \
- idl2wrs.1 mergecap.1 reordercap.1 text2pcap.1 dumpcap.1 rawshark.1
+ idl2wrs.1 mergecap.1 reordercap.1 text2pcap.1 dumpcap.1 rawshark.1 idl2deb.1 asn2deb.1
wireshark.pod: wireshark.pod.template AUTHORS-SHORT-FORMAT
copy /B wireshark.pod.template + AUTHORS-SHORT-FORMAT wireshark.pod
@@ -118,6 +118,32 @@ editcap.html: editcap.pod ../config.h ws.css
--noindex \
editcap.pod > editcap.html
+asn2deb.1: asn2deb.pod ../config.h
+ $(POD2MAN) \
+ --center="The Wireshark Network Analyzer" \
+ --release=$(VERSION) \
+ asn2deb.pod > asn2deb.1
+
+asn2deb.html: asn2deb.pod ../config.h ws.css
+ $(POD2HTML) \
+ --title="asn2deb - The Wireshark Network Analyzer $(VERSION)" \
+ --css=ws.css \
+ --noindex \
+ asn2deb.pod > asn2deb.html
+
+idl2deb.1: idl2deb.pod ../config.h
+ $(POD2MAN) \
+ --center="The Wireshark Network Analyzer" \
+ --release=$(VERSION) \
+ idl2deb.pod > idl2deb.1
+
+idl2deb.html: idl2deb.pod ../config.h ws.css
+ $(POD2HTML) \
+ --title="idl2deb - The Wireshark Network Analyzer $(VERSION)" \
+ --css=ws.css \
+ --noindex \
+ idl2deb.pod > idl2deb.html
+
idl2wrs.1: idl2wrs.pod ../config.h
$(POD2MAN) \
--center="The Wireshark Network Analyzer" \
diff --git a/doc/asn2deb.pod b/doc/asn2deb.pod
new file mode 100644
index 0000000000..716261e1f7
--- /dev/null
+++ b/doc/asn2deb.pod
@@ -0,0 +1,75 @@
+
+=head1 NAME
+
+asn2deb - create a Debian package for BER monitoring from ASN.1
+
+=head1 SYNOPSIS
+
+B<asn2deb> [-a I<ASN.1 file>] [--asn=I<ASN.1 file>] [B<-d >I<opts>] [B<--dbopts=>I<opts>] [B<-e >I<address>]
+[B<--email=>I<address>] [B<-h>] [B<--help>] [B<-n >I<name>] [B<--name=>I<name>] [B<-p>] [B<--preserve>] [B<-v>] [B<--version>]
+
+=head1 DESCRIPTION
+
+This manual page documents briefly the B<asn2deb> command. B<asn2deb>
+takes an ASN.1 file as input and creates a Debian package from it. The package
+contains a loadable type table file for the wireshark network analyser.
+The type table is generated by the ASN.1 compiler B<snacc>.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-a >I<ASN.1 file> B<--asn=>I<ASN.1 file>
+
+ASN.1 file to use (mandatory).
+
+=item B<-d >I<opts> B<--dbopts=>I<opts>
+
+options for dpkg-buildpackage.
+
+=item B<-e >I<address> B<--email=>I<address>
+
+use e-mail address.
+
+=item B<-h> B<--help>
+
+print help and exit.
+
+=item B<-n >I<name> B<--name=>I<name>
+
+use user name.
+
+=item B<-p> B<--preserve>
+
+do not overwrite files.
+
+=item B<-v> B<--version>
+
+print version and exit.
+
+=back
+
+=head1 EXAMPLES
+
+/usr/bin/asn2deb -e me@foo.net -a bar.asn1 \-n "My Name" -d "-rfakeroot -uc -us"-d "-rfakeroot -uc -us"
+
+=head1 SEE ALSO
+
+A lot of tools are used, which you have to B<apt-get install>: wireshark-dev, python, cdbs, autotools-dev, debhelper, dpkg-dev,
+snacc.
+
+=head1 COPYING
+
+This manual page was written by W. Borgert debacle@debian.org
+for Debian GNU/Linux (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.
+
+=head1 AUTHOR
+
+B<W. Borgert> Author.
+
+=head1 COPYRIGHT
+
+Copyright (C) 2003, 2005 W. Borger \ No newline at end of file
diff --git a/doc/idl2deb.pod b/doc/idl2deb.pod
new file mode 100644
index 0000000000..cd9dd1de52
--- /dev/null
+++ b/doc/idl2deb.pod
@@ -0,0 +1,74 @@
+
+=head1 NAME
+
+idl2deb - create a Debian package for CORBA monitoring from IDL
+
+=head1 SYNOPSIS
+
+B<idl2deb> [B<-d >I<opts>] [B<--dbopts=>I<opts>] [B<-e >I<address>] [B<--email=>I<address>] [-i I<idlfile>]
+[--idl=I<idlfile>] [B<-h>] [B<--help>] [B<-n >I<name>] [B<--name=>I<name>] [B<-p>] [B<--preserve>] [B<-v>] [B<--version>]
+
+
+=head1 DESCRIPTION
+
+This manual page documents briefly the B<idl2deb> command. B<idl2deb>
+takes an CORBA IDL file as input and creates a Debian package from it. The
+package contains a loadable module for the wireshark network analyser.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-d>I<opts> B<--dbopts=>I<opts>
+
+options for dpkg-buildpackage.
+
+=item B<-e >I<address> B<--email=>I<address>
+
+use e-mail address.
+
+=item B<-i >I<idlfile> B<--idl=>I<idlfile>
+
+IDL file to use (mandatory)
+
+=item B<-h> B<--help>
+
+print help and exit.
+
+=item B<-n >I<name> B<--name=>I<name>
+
+use user name.
+
+=item B<-p> B<--preserve>
+
+do not overwrite files.
+
+=item B<-v> B<--version>
+
+print version and exit.
+
+=back
+
+=head1 EXAMPLES
+
+/usr/bin/idl2deb -e me@foo.net -i bar.idl \-n "My Name" -d "-rfakeroot -uc -us"-d "-rfakeroot -uc -us"
+
+=head1 SEE ALSO
+
+A lot of tools are used, which you have to B<apt-get install>: wireshark-dev, python, cdbs, autotools-dev, debhelper, dpkg-dev.
+
+=head1 COPYING
+
+This manual page was written by W. Borgert debacle@debian.org
+for Debian GNU/Linux (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.
+
+=head1 AUTHOR
+
+B<W. Borgert> Author.
+
+=head1 COPYRIGHT
+
+Copyright (C) 2003, 2005 W. Borger