osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

SPDX: Convert doc and docbook. 

Replace the GPLv2+ blurbs in the doc and docbook directories with SPDX
headers as appropriate. This includes example code such as
packet-PROTOABBREV.c.

Remove dfilter2pod.pl and dfilter2xml.pl. We haven't used them since
2010.

Change-Id: I4adec02a9a4bc3e71e32bdf89f2754edaf696938
Reviewed-on: https://code.wireshark.org/review/24343
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
This commit is contained in:
Gerald Combs 2017-11-11 12:14:09 +00:00 committed by Anders Broman
parent 92be91f57a
commit 4ec8ebcebb
15 changed files with 12 additions and 475 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/CMakeLists.txt
View File

@ -4,19 +4,7 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
# SPDX-License-Identifier: GPL-2.0+
#
add_custom_command(

14
doc/Makefile.am
View File

@ -5,19 +5,8 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
# SPDX-License-Identifier: GPL-2.0+
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
# We include dependencies on ../config.h in order to
# capture when $(VERSION) changes.
@ -326,7 +315,6 @@ EXTRA_DIST = \
capinfos.pod \
captype.pod \
ciscodump.pod \
dfilter2pod.pl \
dftest.pod \
dumpcap.pod \
editcap.pod \

14
doc/README.stats_tree
View File

@ -47,19 +47,7 @@ A small example of a very basic stats_tree plugin follows.
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
* SPDX-License-Identifier: GPL-2.0+
*/
#include "config.h"

140
doc/dfilter2pod.pl
View File

@ -1,140 +0,0 @@
#!/usr/bin/perl
#
# Reads the display filter keyword dump produced by 'tshark -G' and
# formats it for a pod document. The pod document is then used to
# make a manpage
#
# STDIN is the wireshark glossary
# arg1 is the pod template file. The =insert_dfilter_table token
# will be replaced by the pod-formatted glossary
# STDOUT is the output
#
# Gilbert Ramirez <gram [AT] alumni.rice.edu>
#
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use Getopt::Std;
%ftenum_names = (
'FT_NONE', 'No value',
'FT_PROTOCOL', 'Protocol',
'FT_BOOLEAN', 'Boolean',
'FT_UINT8', 'Unsigned 8-bit integer',
'FT_UINT16', 'Unsigned 16-bit integer',
'FT_UINT24', 'Unsigned 24-bit integer',
'FT_UINT32', 'Unsigned 32-bit integer',
'FT_UINT64', 'Unsigned 64-bit integer',
'FT_INT8', 'Signed 8-bit integer',
'FT_INT16', 'Signed 16-bit integer',
'FT_INT24', 'Signed 24-bit integer',
'FT_INT32', 'Signed 32-bit integer',
'FT_INT64', 'Signed 64-bit integer',
'FT_FLOAT', 'Single-precision floating point',
'FT_DOUBLE', 'Double-precision floating point',
'FT_ABSOLUTE_TIME', 'Date/Time stamp',
'FT_RELATIVE_TIME', 'Time duration',
'FT_STRING', 'String',
'FT_STRINGZ', 'NULL terminated string',
'FT_EBCDIC', 'EBCDIC string',
'FT_UINT_STRING', 'Length string pair',
'FT_ETHER', '6-byte Hardware (MAC) Address',
'FT_BYTES', 'Byte array',
'FT_UINT_BYTES', 'Length byte array pair',
'FT_IPv4', 'IPv4 address',
'FT_IPv6', 'IPv6 address',
'FT_IPXNET', 'IPX network or server name',
'FT_FRAMENUM', 'Frame number',
'FT_PCRE', 'Perl Compatible Regular Expression',
'FT_GUID', 'Globally Unique Identifier',
'FT_OID', 'Object Identifier',
'FT_REL_OID', 'Relative Object Identifier',
);
getopts('e');
if ($opt_e) {
$proto_abbrev{'Unable to generate filter documentation'} =
'Please refer to https://www.wireshark.org/docs/dfref/';
printf STDERR "Creating empty filter list.\n";
} else {
# Read all the data into memory
while (<STDIN>) {
next unless (/^([PF])/);
$record_type = $1;
# Strip the line from its line-end sequence
# chomp($_) won't work on Win32/CygWin as it leaves the '\r' character.
$_ =~ s/[\r\n]//g;
# Store protocol information
if ($record_type eq 'P') {
($junk, $name, $abbrev) = split(/\t+/, $_);
$proto_abbrev{$name} = $abbrev;
}
# Store header field information
else {
($junk, $name, $abbrev, $type, $parent, $blurb) =
split(/\t+/, $_);
push(@{$field_abbrev{$parent}}, $abbrev);
$field_info{$abbrev} = [ $name, $type, $blurb ];
}
}
}
# if there was no input on stdin, bail out
if ($record_type ne 'P' and $record_type ne 'F' and !defined($opt_e)) {
exit;
}
$template = shift(@ARGV);
open(TEMPLATE, $template) || die "Can't open $template for reading: $!\n";
while (<TEMPLATE>) {
if (/=insert_dfilter_table/) {
&create_dfilter_table;
}
else {
print;
}
}
close(TEMPLATE) || die "Can't close $template: $!\n";
sub create_dfilter_table {
# Print each protocol
for $proto_name (sort keys %proto_abbrev) {
print "=head2 $proto_name ($proto_abbrev{$proto_name})\n\n";
# If this proto has children fields, print those
if ($field_abbrev{$proto_abbrev{$proto_name}}) {
for $field_abbrev (sort @{$field_abbrev{$proto_abbrev{$proto_name}}}) {
print " $field_abbrev ", $field_info{$field_abbrev}[0],"\n",
" ", $ftenum_names{$field_info{$field_abbrev}[1]},
"\n";
print " ", $field_info{$field_abbrev}[2], "\n"
if $field_info{$field_abbrev}[2];
print "\n";
}
}
}
}

13
doc/extcap_example.py
View File

@ -6,19 +6,8 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
# SPDX-License-Identifier: GPL-2.0+
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""
This is a generic example, which produces pcap packages every n seconds, and

13
doc/make-authors-format.pl
View File

@ -9,19 +9,8 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
# SPDX-License-Identifier: GPL-2.0+
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use strict;

13
doc/make-authors-short.pl
View File

@ -9,19 +9,8 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
# SPDX-License-Identifier: GPL-2.0+
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use strict;

14
doc/packet-PROTOABBREV.c
View File

@ -6,19 +6,7 @@
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
* SPDX-License-Identifier: GPL-2.0+
*/
/*

14
doc/perlnoutf.pl
View File

@ -9,20 +9,8 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
# SPDX-License-Identifier: GPL-2.0+
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use strict;

14
doc/plugins.example/Makefile.am
View File

@ -4,19 +4,7 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
# SPDX-License-Identifier: GPL-2.0+
#
WARNFLAGS = -Wall -Wextra

14
doc/plugins.example/hello.c
View File

@ -4,19 +4,7 @@
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
* SPDX-License-Identifier: GPL-2.0+
*/
#ifdef HAVE_CONFIG_H

14
docbook/CMakeLists.txt
View File

@ -4,19 +4,7 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
# SPDX-License-Identifier: GPL-2.0+
#
find_package( LYNX )

1
docbook/Makefile.am
View File

@ -564,7 +564,6 @@ EXTRA_DIST = \
$(WSUG_DIST) \
$(WSDG_DIST) \
$(RELEASE_NOTES_SOURCE) \
dfilter2xml.pl \
make-wsluarm.pl \
README.txt \
CMakeLists.txt

181
docbook/dfilter2xml.pl
View File

@ -1,181 +0,0 @@
#!/usr/bin/perl
#
# Reads the display filter keyword dump produced by 'tshark -G' and
# formats it for a pod document. The pod document is then used to
# make a manpage
#
# STDIN is the wireshark glossary
# arg1 is the pod template file. The =insert_dfilter_table token
# will be replaced by the pod-formatted glossary
# STDOUT is the output
#
# Gilbert Ramirez <gram [AT] alumni.rice.edu>
#
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
%ftenum_names = (
'FT_NONE', 'No value',
'FT_PROTOCOL', 'Protocol',
'FT_BOOLEAN', 'Boolean',
'FT_UINT8', 'Unsigned 8-bit integer',
'FT_UINT16', 'Unsigned 16-bit integer',
'FT_UINT24', 'Unsigned 24-bit integer',
'FT_UINT32', 'Unsigned 32-bit integer',
'FT_UINT64', 'Unsigned 64-bit integer',
'FT_INT8', 'Signed 8-bit integer',
'FT_INT16', 'Signed 16-bit integer',
'FT_INT24', 'Signed 24-bit integer',
'FT_INT32', 'Signed 32-bit integer',
'FT_INT64', 'Signed 64-bit integer',
'FT_FLOAT', 'Single-precision floating point',
'FT_DOUBLE', 'Double-precision floating point',
'FT_ABSOLUTE_TIME', 'Date/Time stamp',
'FT_RELATIVE_TIME', 'Time duration',
'FT_STRING', 'String',
'FT_STRINGZ', 'NULL terminated string',
'FT_EBCDIC', 'EBCDIC string',
'FT_UINT_STRING', 'Length string pair',
'FT_ETHER', '6-byte Hardware (MAC) Address',
'FT_BYTES', 'Byte array',
'FT_UINT_BYTES', 'Length byte array pair',
'FT_IPv4', 'IPv4 address',
'FT_IPv6', 'IPv6 address',
'FT_IPXNET', 'IPX network or server name',
'FT_FRAMENUM', 'Frame number',
'FT_PCRE', 'Perl Compatible Regular Expression',
'FT_GUID', 'Globally Unique Identifier',
'FT_OID', 'Object Identifier',
'FT_REL_OID', 'Relative Object Identifier',
);
# Read all the data into memory
while (<STDIN>) {
next unless (/^([PF])/);
$record_type = $1;
# Strip the line from its line-end sequence
# chomp($_) won't work on Win32/CygWin as it leaves the '\r' character.
$_ =~ s/[\r\n]//g;
$_ =~ s/\&/\&amp\;/g;
$_ =~ s/\>/\&gt;/g;
$_ =~ s/\</\&lt\;/g;
# Store protocol information
if ($record_type eq 'P') {
($junk, $name, $abbrev) = split(/\t+/, $_);
$proto_abbrev{$name} = $abbrev;
}
# Store header field information
else {
($junk, $name, $abbrev, $type, $parent, $blurb) =
split(/\t+/, $_);
push(@{$field_abbrev{$parent}}, $abbrev);
$field_info{$abbrev} = [ $name, $type, $blurb ];
}
}
# if there was no input on stdin, bail out
if ($record_type ne 'P' and $record_type ne 'F') {
exit;
}
$template = shift(@ARGV);
open(TEMPLATE, $template) || die "Can't open $template for reading: $!\n";
while (<TEMPLATE>) {
if (/=insert_dfilter_table/) {
&create_dfilter_table;
}
else {
print;
}
}
close(TEMPLATE) || die "Can't close $template: $!\n";
sub create_dfilter_table {
print "<appendix id=\"AppFiltFields\"><title>Wireshark Display Filter Fields</title>\n";
$pn_counter = 1;
# Print each protocol
for $proto_name (sort keys %proto_abbrev) {
$ns_proto_name = $proto_name;
$ns_proto_name =~ s/\s//g;
$ns_proto_name =~ s/\)//g;
$ns_proto_name =~ s/\(//g;
$ns_proto_name =~ s/_//g;
$ns_proto_name =~ s/\+/plus/g;
$ns_proto_name =~ s/\//slash/g;
$ns_proto_name =~ s/,/comma/g;
$ns_proto_name =~ s/:/colon/g;
$ns_proto_name =~ s/'/apos/g;
# The maximum token name length is apparently 44 characters.
# That's what NAMELEN is defined as in docbook 4.1, at least.
if (length ($ns_proto_name) > 41) { # "SID" and "TID" are prepended below
$ns_proto_name = sprintf ("%s%04d", substr($ns_proto_name, 0,
37), $pn_counter);
$pn_counter++;
}
print "<section id=\"SID$ns_proto_name\"><title>$proto_name ($proto_abbrev{$proto_name})</title>\n\n";
print "<table id=\"TID$ns_proto_name\"><title>$proto_name ($proto_abbrev{$proto_name})</title>\n";
print "<tgroup cols=\"4\">\n";
# print "<colspec colnum=\"1\" colwidth=\"80pt\">\n";
# print "<colspec colnum=\"2\" colwidth=\"80pt\"\n>";
print "<thead>\n <row>\n ";
print "<entry>Field</>\n <entry>Field Name</>\n <entry>Type</>\n <entry>Description</>\n\n";
print " </row>\n</thead>\n<tbody>\n";
# If this proto has children fields, print those
if ($field_abbrev{$proto_abbrev{$proto_name}}) {
for $field_abbrev (sort @{$field_abbrev{$proto_abbrev{$proto_name}}}) {
print " <row>\n";
print " <entry>$field_abbrev</entry>\n";
print " <entry>", $field_info{$field_abbrev}[0], "</entry>\n";
print " <entry>", $ftenum_names{$field_info{$field_abbrev}[1]}, "</entry>\n";
print " <entry>", $field_info{$field_abbrev}[2], "</>\n";
print " </row>\n\n";
}
}
else {
print " <row>\n <entry></entry>\n <entry></entry>\n <entry></entry><entry></entry>\n";
print " </row>\n";
}
print "</tbody></tgroup></table>\n";
print "</section>\n\n";
}
print "</appendix>\n";
}

14
docbook/make-wsluarm.pl
View File

@ -9,19 +9,7 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
# SPDX-License-Identifier: GPL-2.0+
#
# (-: I don't even think writing this in Lua :-)
# ...well I wished you had!