forked from osmocom/wireshark
Clean up some documentation a bit, removing non-ASCII characters, formatting like other pages, alphabetizing options, describing options under their own headingadding missing newline at end of file, fixing typos and some minor rewording.
svn path=/trunk/; revision=49424
This commit is contained in:
Chris Maynard
parent
ab10fed503
commit
17bbb2dbe9
|
|
@ -5,8 +5,21 @@ 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>]
|
||||
B<asn2deb>
|
||||
S<[ B<-a> E<lt>ASN.1 fileE<gt> ]>
|
||||
S<[ B<--asn>=E<lt>ASN.1 fileE<gt> ]>
|
||||
S<[ B<-d> E<lt>optsE<gt> ]>
|
||||
S<[ B<--dbopts>=E<lt>optsE<gt> ]>
|
||||
S<[ B<-e> E<lt>addressE<gt> ]>
|
||||
S<[ B<--email>=E<lt>addressE<gt> ]>
|
||||
S<[ B<-h> ]>
|
||||
S<[ B<--help> ]>
|
||||
S<[ B<-n> E<lt>nameE<gt> ]>
|
||||
S<[ B<--name>=E<lt>nameE<gt> ]>
|
||||
S<[ B<-p> ]>
|
||||
S<[ B<--preserve> ]>
|
||||
S< [B<-v> ]>
|
||||
S<[ B<--version> ]>
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
|
|
@ -19,31 +32,31 @@ The type table is generated by the ASN.1 compiler B<snacc>.
|
|||
|
||||
=over 4
|
||||
|
||||
=item B<-a >I<ASN.1 file> B<--asn=>I<ASN.1 file>
|
||||
=item -a E<lt>ASN.1 fileE<gt> --asn=E<lt>ASN.1 fileE<gt>
|
||||
|
||||
ASN.1 file to use (mandatory).
|
||||
|
||||
=item B<-d >I<opts> B<--dbopts=>I<opts>
|
||||
=item -d E<lt>optsE<gt> --dbopts=E<lt>optsE<gt>
|
||||
|
||||
options for dpkg-buildpackage.
|
||||
|
||||
=item B<-e >I<address> B<--email=>I<address>
|
||||
=item -e E<lt>addressE<gt> --email=E<lt>addressE<gt>
|
||||
|
||||
use e-mail address.
|
||||
|
||||
=item B<-h> B<--help>
|
||||
=item -h --help
|
||||
|
||||
print help and exit.
|
||||
|
||||
=item B<-n >I<name> B<--name=>I<name>
|
||||
=item -n E<lt>nameE<gt> --name=E<lt>nameE<gt>
|
||||
|
||||
use user name.
|
||||
|
||||
=item B<-p> B<--preserve>
|
||||
=item -p --preserve
|
||||
|
||||
do not overwrite files.
|
||||
|
||||
=item B<-v> B<--version>
|
||||
=item -v --version
|
||||
|
||||
print version and exit.
|
||||
|
||||
|
|
@ -68,8 +81,8 @@ the Free Software Foundation.
|
|||
|
||||
=head1 AUTHOR
|
||||
|
||||
B<W. Borgert> Author.
|
||||
B<W. Borgert> Author.
|
||||
|
||||
=head1 COPYRIGHT
|
||||
|
||||
Copyright (C) 2003, 2005 W. Borger
|
||||
Copyright (C) 2003, 2005 W. Borger
|
||||
|
|
|
|||
|
|
@ -5,9 +5,21 @@ 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>]
|
||||
|
||||
B<idl2deb>
|
||||
S< [ B<-d> E<lt>optsE<gt> ]>
|
||||
S< [ B<--dbopts>=E<lt>optsE<gt> ]>
|
||||
S< [ B<-e> E<lt>addressE<gt> ]>
|
||||
S< [ B<--email>=E<lt>addressE<gt> ]>
|
||||
S< [ B<-h> ]>
|
||||
S< [ B<--help> ]>
|
||||
S< [ B<-i> E<lt>idlfileE<gt> ]>
|
||||
S< [ B<--idl>=E<lt>idlfileE<gt> ]>
|
||||
S< [ B<-n> E<lt>nameE<gt> ]>
|
||||
S< [ B<--name>=E<lt>nameE<gt> ]>
|
||||
S< [ B<-p> ]>
|
||||
S< [ B<--preserve> ]>
|
||||
S< [ B<-v> ]>
|
||||
S< [ B<--version> ]>
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
|
|
@ -19,31 +31,31 @@ package contains a loadable module for the wireshark network analyser.
|
|||
|
||||
=over 4
|
||||
|
||||
=item B<-d>I<opts> B<--dbopts=>I<opts>
|
||||
=item -d E<lt>optsE<gt> --dbopts=E<lt>optsE<gt>
|
||||
|
||||
options for dpkg-buildpackage.
|
||||
|
||||
=item B<-e >I<address> B<--email=>I<address>
|
||||
=item -e E<lt>addressE<gt> --email=E<lt>addressE<gt>
|
||||
|
||||
use e-mail address.
|
||||
|
||||
=item B<-i >I<idlfile> B<--idl=>I<idlfile>
|
||||
|
||||
IDL file to use (mandatory)
|
||||
|
||||
=item B<-h> B<--help>
|
||||
=item -h --help
|
||||
|
||||
print help and exit.
|
||||
|
||||
=item B<-n >I<name> B<--name=>I<name>
|
||||
=item -i E<lt>idlfileE<gt> --idl=E<lt>idlfileE<gt>
|
||||
|
||||
IDL file to use (mandatory)
|
||||
|
||||
=item -n E<lt>nameE<gt> --name=E<lt>nameE<gt>
|
||||
|
||||
use user name.
|
||||
|
||||
=item B<-p> B<--preserve>
|
||||
=item -p --preserve
|
||||
|
||||
do not overwrite files.
|
||||
|
||||
=item B<-v> B<--version>
|
||||
=item -v --version
|
||||
|
||||
print version and exit.
|
||||
|
||||
|
|
@ -67,7 +79,7 @@ the Free Software Foundation.
|
|||
|
||||
=head1 AUTHOR
|
||||
|
||||
B<W. Borgert> Author.
|
||||
B<W. Borgert> Author.
|
||||
|
||||
=head1 COPYRIGHT
|
||||
|
||||
|
|
|
|||
|
|
@ -5,11 +5,11 @@ idl2wrs - CORBA IDL to Wireshark Plugin Generator
|
|||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
B<idl2wrs> filename
|
||||
B<idl2wrs> E<lt>filenameE<gt>
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
B<idl2wrs> is a program that takes a user specified B<CORBA IDL>
|
||||
B<idl2wrs> is a program that takes a user specified B<CORBA IDL>
|
||||
file and generates B<"C"> source code for a B<Wireshark> "plugin".
|
||||
|
||||
This resulting file can be compiled as a B<Wireshark> plugin, and
|
||||
|
|
@ -23,7 +23,7 @@ These programs are:
|
|||
|
||||
B<wireshark_be.py> - Contains the main IDL Visitor Class
|
||||
|
||||
B<wireshark_gen.py> - Contains the Source Code Generator Class
|
||||
B<wireshark_gen.py> - Contains the Source Code Generator Class
|
||||
|
||||
=back
|
||||
|
||||
|
|
@ -39,7 +39,7 @@ method unless you have some namespace collisions.
|
|||
|
||||
Currently there are no options. B<idl2wrs> can be invoked as follows.
|
||||
|
||||
1. To write the C code to stdout.
|
||||
1. To write the C code to stdout.
|
||||
|
||||
idl2wrs <your_file.idl>
|
||||
|
||||
|
|
@ -63,10 +63,10 @@ The B<-p> option passed to omniidl (inside B<idl2wrs>) indicates where
|
|||
B<wireshark_be.py> and B<wireshark_gen.py> will be searched. This may
|
||||
need tweaking if you place these files somewhere else.
|
||||
|
||||
If it complains about being unable to find some modules (eg tempfile.py),
|
||||
If it complains about being unable to find some modules (eg tempfile.py),
|
||||
you may want to check if PYTHONPATH is set correctly.
|
||||
|
||||
eg: PYTHONPATH=/usr/lib/python1.5/
|
||||
eg: PYTHONPATH=/usr/lib/python1.5/
|
||||
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
|
@ -76,8 +76,8 @@ wireshark(1), tshark(1)
|
|||
|
||||
=head1 NOTES
|
||||
|
||||
B<idl2wrs> (including B<wireshark_be.py> and B<wireshark_gen.py>) are part of
|
||||
the B<Wireshark> distribution. The latest version of B<Wireshark> can
|
||||
B<idl2wrs> (including B<wireshark_be.py> and B<wireshark_gen.py>) are part of
|
||||
the B<Wireshark> distribution. The latest version of B<Wireshark> can
|
||||
be found at L<http://www.wireshark.org>.
|
||||
|
||||
B<idl2wrs> uses B<omniidl>, an IDL parser, and can be found at
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ reordercap - Reorder input file by timestamp into output file
|
|||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
B<reorder>
|
||||
B<reordercap>
|
||||
S<[ B<-n> ]>
|
||||
E<lt>I<infile>E<gt> E<lt>I<outfile>E<gt>
|
||||
|
||||
|
|
@ -19,20 +19,26 @@ This functionality may be useful when capture files have been created by
|
|||
combining frames from more than one well-synchronised source, but the
|
||||
frames have not been combined in strict time order.
|
||||
|
||||
When the B<-n> option is used, B<Reordercap> will, if it finds that the input file
|
||||
is already in order, not write out the output file.
|
||||
|
||||
B<Reordercap> writes the output capture file in the same format as the input
|
||||
capture file.
|
||||
|
||||
B<Reordercap> is able to detect, read and write the same capture files that
|
||||
are supported by B<Wireshark>.
|
||||
The input file doesn't need a specific filename extension; the file
|
||||
format and an optional gzip compression will be automatically detected.
|
||||
format and an optional gzip compression will be detected automatically.
|
||||
Near the beginning of the DESCRIPTION section of wireshark(1) or
|
||||
L<http://www.wireshark.org/docs/man-pages/wireshark.html>
|
||||
is a detailed description of the way B<Wireshark> handles this, which is
|
||||
the same way B<Reordercap> handles this.
|
||||
the same way B<reordercap> handles this.
|
||||
|
||||
=head1 OPTIONS
|
||||
|
||||
=over 4
|
||||
|
||||
=item -n
|
||||
|
||||
When the B<-n> option is used, B<reordercap> will not write out the output
|
||||
file if it finds that the input file is already in order.
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
|
|
@ -44,8 +50,8 @@ text2pcap(1), pcap-filter(7) or tcpdump(8) if it doesn't exist.
|
|||
B<Reordercap> is part of the B<Wireshark> distribution. The latest version
|
||||
of B<Wireshark> can be found at L<http://www.wireshark.org>.
|
||||
|
||||
It may make sense to move this functionality into B<Editcap>, or perhaps
|
||||
B<Mergecap>, in which case B<reordercap> could be retired.
|
||||
It may make sense to move this functionality into B<editcap>, or perhaps
|
||||
B<mergecap>, in which case B<reordercap> could be retired.
|
||||
|
||||
HTML versions of the Wireshark project man pages are available at:
|
||||
L<http://www.wireshark.org/docs/man-pages>.
|
||||
|
|
|
|||
Loading…
Reference in New Issue