forked from osmocom/wireshark
Migrate the wslua ref man into wsug
svn path=/trunk/; revision=22369
This commit is contained in:
Luis Ontanon
parent
fa67b9959c
commit
06d1d9bfbb
|
|
@ -31,7 +31,6 @@ HTML2TXT?=lynx -dump -width=72 -nolist -stdin
|
|||
|
||||
PERL = perl
|
||||
|
||||
|
||||
############### YOU SHOULDN'T HAVE TO EDIT ANYTHING BELOW THIS LINE! ################
|
||||
|
||||
include Makefile.common
|
||||
|
|
@ -48,7 +47,7 @@ XMLLINT?="xmllint"
|
|||
FOP_OPTS=$(FOP_OPTS) JAVA_OPTS=$(FOP_OPTS) $(FOP) $< $@
|
||||
|
||||
|
||||
all: svn_version_check wsug.validated wsdg.validated wsluarm.validated release_notes.validated wsug wsdg release_notes wsluarm
|
||||
all: svn_version_check wsug.validated wsdg.validated release_notes.validated wsug wsdg release_notes
|
||||
|
||||
clean:
|
||||
rm -rf $(CLEANFILES)
|
||||
|
|
@ -67,7 +66,7 @@ svn_version_check: FORCE
|
|||
svn_version.xml: svn_version_check
|
||||
|
||||
|
||||
wsug: wsug_html_chunked user-guide.html user-guide-a4.pdf user-guide-us.pdf
|
||||
wsug: wsug_html_chunked user-guide.html user-guide-a4.pdf user-guide-us.pdf wsluarm
|
||||
|
||||
# validate the content
|
||||
wsug.validated: $(WSUG_SOURCE)
|
||||
|
|
@ -201,44 +200,8 @@ ifdef FOP
|
|||
$(XSLTPROC) --stringparam paper.type A4 --nonet custom_layer_pdf.xsl $< > $@
|
||||
endif
|
||||
|
||||
|
||||
$(WSLUA_FILES): wsluarm.xml
|
||||
|
||||
wsluarm.xml: make-wsluarm.pl template-wsluarm.xml $(WSLUA_MODULES)
|
||||
wsluarm: make-wsluarm.pl $(WSLUA_MODULES)
|
||||
$(PERL) make-wsluarm.pl $(WSLUA_MODULES)
|
||||
|
||||
wsluarm: wsluarm.html wsluarm.txt wsluarm-a4.pdf wsluarm-us.pdf
|
||||
|
||||
# validate the content
|
||||
wsluarm.validated: $(WSLUARM_SOURCE)
|
||||
@ echo --- WSLUARM - VALIDATING XML ---
|
||||
$(XMLLINT) --valid --noout $<
|
||||
touch $@
|
||||
|
||||
# create html single page file
|
||||
wsluarm.html: $(WSLUARM_SOURCE)
|
||||
@ echo --- WSLUARM - HTML ---
|
||||
$(XSLTPROC) --nonet http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< > $@
|
||||
|
||||
# create txt single page file (through HTML)
|
||||
wsluarm.txt: $(WSLUARM_SOURCE)
|
||||
@ echo --- WSLUARM - TXT ---
|
||||
$(XSLTPROC) --stringparam generate.toc "article nop" --nonet http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< | $(HTML2TXT) > $@
|
||||
|
||||
# create pdf file (through XSL-FO), portrait pages on US letter paper (the default)
|
||||
# you will get lot's of errors, but that's ok
|
||||
wsluarm-us.fo: $(WSLUARM_SOURCE) custom_layer_pdf.xsl
|
||||
ifdef FOP
|
||||
@ echo --- WSLUARM - PDF US PAPER ---
|
||||
$(XSLTPROC) --stringparam paper.type letter --nonet custom_layer_pdf.xsl $< > $@
|
||||
endif
|
||||
|
||||
# create pdf file (through XSL-FO), portrait pages on A4 paper
|
||||
# you will get lot's of errors, but that's ok
|
||||
wsluarm-a4.fo: $(WSLUARM_SOURCE) custom_layer_pdf.xsl
|
||||
ifdef FOP
|
||||
@ echo --- WSLUARM - PDF A4 PAPER ---
|
||||
$(XSLTPROC) --stringparam paper.type A4 --nonet custom_layer_pdf.xsl $< > $@
|
||||
endif
|
||||
touch wsluarm
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -201,7 +201,7 @@ CLEANFILES = \
|
|||
release-notes.txt \
|
||||
svn_version.xml \
|
||||
user-guide.zip \
|
||||
wsluarm.xml \
|
||||
wsluarm \
|
||||
wsluarm_src/*.xml
|
||||
|
||||
|
||||
|
|
@ -216,20 +216,3 @@ WSLUA_MODULES = \
|
|||
../epan/wslua/wslua_tvb.c \
|
||||
../epan/wslua/wslua_util.c
|
||||
|
||||
WSLUA_FILES = \
|
||||
wslua_dumper.xml \
|
||||
wslua_field.xml \
|
||||
wslua_gui.xml \
|
||||
wslua_listener.xml \
|
||||
wslua_pinfo.xml \
|
||||
wslua_proto.xml \
|
||||
wslua_tree.xml \
|
||||
wslua_tvb.xml \
|
||||
wslua_util.xml
|
||||
|
||||
WSLUARM_SOURCE = \
|
||||
wsluarm.xml \
|
||||
svn_version.xml \
|
||||
Makefile \
|
||||
$(WSLUA_FILES)
|
||||
|
||||
|
|
|
|||
|
|
@ -53,9 +53,9 @@ my $function;
|
|||
my @functions;
|
||||
|
||||
my $docbook_template = {
|
||||
module_header => "<chapter id='lua_module_%s'>\n",
|
||||
module_header => "<section id='lua_module_%s'>\n",
|
||||
module_desc => "\t<title>%s</title>\n",
|
||||
module_footer => "</chapter>\n",
|
||||
module_footer => "</section>\n",
|
||||
class_header => "\t<section id='lua_class_%s'><title>%s</title>\n",
|
||||
class_desc => "\t\t<para>%s</para>\n",
|
||||
class_footer => "\t</section> <!-- class_footer: %s -->\n",
|
||||
|
|
@ -230,7 +230,14 @@ sub {
|
|||
$name .= ".$2";
|
||||
push @{${$class}{attributes}}, { name => $name, descr => gorolla($4), mode=>$3 };
|
||||
} ],
|
||||
|
||||
[ 'WSLUA_ATTR_GET\s+([A-Za-z]+)_([a-z_]+).*?' . $TRAILING_COMMENT_RE,
|
||||
sub {
|
||||
deb ">at=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
my $name = "$1";
|
||||
$name =~ tr/A-Z/a-z/;
|
||||
$name .= ".$2";
|
||||
push @{${$class}{attributes}}, { name => $name, descr => gorolla($4), mode=>$3 };
|
||||
} ],
|
||||
[ '/\052\s+WSLUA_MOREARGS\s+([A-Za-z_]+)\s+(.*?)\052/',
|
||||
sub {
|
||||
deb ">ma=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
|
|
@ -387,27 +394,27 @@ while ( $file = shift) {
|
|||
close D;
|
||||
}
|
||||
|
||||
my $wsluarm = '';
|
||||
open B, "< template-wsluarm.xml";
|
||||
$wsluarm .= $_ while(<B>);
|
||||
close B;
|
||||
|
||||
my $ents = '';
|
||||
my $txt = '';
|
||||
|
||||
for my $module_name (sort keys %modules) {
|
||||
$ents .= <<"_ENT";
|
||||
<!ENTITY $module_name SYSTEM "wsluarm_src/$modules{$module_name}">
|
||||
_ENT
|
||||
$txt .= "&$module_name;\n";
|
||||
}
|
||||
|
||||
$wsluarm =~ s/<!-- WSLUA_MODULE_ENTITIES -->/$ents/;
|
||||
$wsluarm =~ s/<!-- WSLUA_MODULE_TEXT -->/$txt/;
|
||||
|
||||
open X, "> wsluarm.xml";
|
||||
print X $wsluarm;
|
||||
close X;
|
||||
#my $wsluarm = '';
|
||||
#open B, "< template-wsluarm.xml";
|
||||
#$wsluarm .= $_ while(<B>);
|
||||
#close B;
|
||||
#
|
||||
#my $ents = '';
|
||||
#my $txt = '';
|
||||
#
|
||||
#for my $module_name (sort keys %modules) {
|
||||
# $ents .= <<"_ENT";
|
||||
# <!ENTITY $module_name SYSTEM "wsluarm_src/$modules{$module_name}">
|
||||
#_ENT
|
||||
# $txt .= "&$module_name;\n";
|
||||
#}
|
||||
#
|
||||
#$wsluarm =~ s/<!-- WSLUA_MODULE_ENTITIES -->/$ents/;
|
||||
#$wsluarm =~ s/<!-- WSLUA_MODULE_TEXT -->/$txt/;
|
||||
#
|
||||
#open X, "> wsluarm.xml";
|
||||
#print X $wsluarm;
|
||||
#close X;
|
||||
|
||||
sub function_descr {
|
||||
my $f = $_[0];
|
||||
|
|
|
|||
|
|
@ -1,77 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
|
||||
|
||||
<!-- $Id$ -->
|
||||
|
||||
<!--
|
||||
BIOGRAPHICAL SECTION
|
||||
-Use this section to encode all biographical information
|
||||
-->
|
||||
|
||||
<!-- Author's Names -->
|
||||
<!ENTITY AuthorFullName "Luis E. Garcia Ontanon">
|
||||
<!ENTITY AuthorFirstName "Luis">
|
||||
<!ENTITY AuthorOtherName "Enrrique">
|
||||
<!ENTITY AuthorSurname "Garcia Ontanon">
|
||||
|
||||
<!--Author's Affiliation -->
|
||||
<!ENTITY AuthorShortAffiliation "">
|
||||
<!ENTITY AuthorJobTitle "">
|
||||
<!ENTITY AuthorOrgName "">
|
||||
<!ENTITY AuthorOrgDiv "">
|
||||
<!ENTITY AuthorEmail "luis.ontanon[at]gmail.com">
|
||||
|
||||
<!--
|
||||
DOCUMENT SECTION
|
||||
-Use this section to encode all document information
|
||||
-->
|
||||
|
||||
<!ENTITY DocumentTitle "Wireshark's LUA API Reference Manual">
|
||||
<!ENTITY DocumentSubTitle "&SvnVersion; for Wireshark &WiresharkCurrentVersion;">
|
||||
<!ENTITY DocumentTitleAbbreviation "WSLUARM">
|
||||
|
||||
<!ENTITY DocumentCopyrightHolder1 "Luis E. Garcia Ontanon">
|
||||
<!ENTITY DocumentCopyrightYear "2006">
|
||||
|
||||
<!ENTITY DocumentEdition "First ">
|
||||
<!ENTITY DocumentVersion "V0.1">
|
||||
<!ENTITY DocumentPubDate "2006">
|
||||
|
||||
<!ENTITY DocumentLegalNotice "<para>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.</para><para>All logos and trademarks in this document are property of their respective owner.</para>">
|
||||
|
||||
<!--
|
||||
Wireshark Info
|
||||
-->
|
||||
<!ENTITY WiresharkCurrentVersion "0.99.3">
|
||||
|
||||
<!--
|
||||
Gnu info
|
||||
-->
|
||||
<!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
|
||||
|
||||
<!--
|
||||
Timezone info
|
||||
-->
|
||||
<!ENTITY TimezoneGMTSite "http://wwp.greenwichmeantime.com/">
|
||||
<!ENTITY TimezoneWorldClockSite "http://www.timeanddate.com/worldclock/">
|
||||
<!ENTITY NTPSite "http://www.ntp.org/">
|
||||
<!ENTITY WikipediaWebsite "http://en.wikipedia.org">
|
||||
<!ENTITY WikipediaTimezone "&WikipediaWebsite;/wiki/Time_zone">
|
||||
<!ENTITY WikipediaDaylightSaving "&WikipediaWebsite;/wiki/Daylight_saving">
|
||||
<!ENTITY WikipediaUTC "&WikipediaWebsite;/wiki/Coordinated_Universal_Time">
|
||||
|
||||
<!--
|
||||
FILE SECTION
|
||||
-Use this section to specify the files that make up the book. Use FPI (public identifiers)
|
||||
-->
|
||||
<!-- These refer to graphics files and figures contained in the document -->
|
||||
|
||||
<!-- These are the actual files that make up the document -->
|
||||
<!-- WSLUA_MODULE_ENTITIES -->
|
||||
]>
|
||||
|
||||
<book>
|
||||
<title>&DocumentTitle;</title>
|
||||
<!-- WSLUA_MODULE_TEXT -->
|
||||
</book>
|
||||
|
|
@ -24,6 +24,12 @@ BIOGRAPHICAL SECTION
|
|||
<!ENTITY AuthorFirstName3 "Ed">
|
||||
<!ENTITY AuthorOtherName3 "">
|
||||
<!ENTITY AuthorSurname3 "Warnicke">
|
||||
|
||||
<!ENTITY AuthorFullName4 "Luis E. Garcia Ontanon">
|
||||
<!ENTITY AuthorFirstName4 "Luis">
|
||||
<!ENTITY AuthorOtherName4 "Enrique">
|
||||
<!ENTITY AuthorSurname4 "Garcia Ontanon">
|
||||
|
||||
|
||||
<!--Author's Affiliation -->
|
||||
<!ENTITY AuthorShortAffiliation "">
|
||||
|
|
@ -44,6 +50,12 @@ BIOGRAPHICAL SECTION
|
|||
<!ENTITY AuthorOrgDiv3 "">
|
||||
<!ENTITY AuthorEmail3 "hagbard[AT]physics.rutgers.edu">
|
||||
|
||||
<!ENTITY AuthorShortAffiliation4 "">
|
||||
<!ENTITY AuthorJobTitle4 "">
|
||||
<!ENTITY AuthorOrgName4 "">
|
||||
<!ENTITY AuthorOrgDiv4 "">
|
||||
<!ENTITY AuthorEmail4 "luis.ontanon[at]gmail.com">
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -281,6 +293,20 @@ FILE SECTION
|
|||
<!ENTITY AppTools SYSTEM "wsug_src/WSUG_app_tools.xml">
|
||||
<!ENTITY AppGPL SYSTEM "GPL_appendix.xml">
|
||||
|
||||
|
||||
<!--
|
||||
WSLua Reference Manual
|
||||
-->
|
||||
<!ENTITY WsLuaDumper SYSTEM "wsluarm_src/wslua_dumper.xml">
|
||||
<!ENTITY WsLuaField SYSTEM "wsluarm_src/wslua_field.xml">
|
||||
<!ENTITY WsLuaGui SYSTEM "wsluarm_src/wslua_gui.xml">
|
||||
<!ENTITY WsLuaListener SYSTEM "wsluarm_src/wslua_listener.xml">
|
||||
<!ENTITY WsLuaPinfo SYSTEM "wsluarm_src/wslua_pinfo.xml">
|
||||
<!ENTITY WsLuaProto SYSTEM "wsluarm_src/wslua_proto.xml">
|
||||
<!ENTITY WsLuaTree SYSTEM "wsluarm_src/wslua_tree.xml">
|
||||
<!ENTITY WsLuaTvb SYSTEM "wsluarm_src/wslua_tvb.xml">
|
||||
<!ENTITY WsLuaUtility SYSTEM "wsluarm_src/wslua_util.xml">
|
||||
|
||||
]>
|
||||
|
||||
<book>
|
||||
|
|
@ -316,4 +342,17 @@ FILE SECTION
|
|||
&ChapterTroubleshoot;
|
||||
-->
|
||||
|
||||
<chapter id="wsluarm">
|
||||
<title>Wireshark's Lua API Reference Manual</title>
|
||||
&WsLuaDumper;
|
||||
&WsLuaField;
|
||||
&WsLuaGui;
|
||||
&WsLuaListener;
|
||||
&WsLuaPinfo;
|
||||
&WsLuaProto;
|
||||
&WsLuaTree;
|
||||
&WsLuaTvb;
|
||||
&WsLuaUtility;
|
||||
</chapter>
|
||||
|
||||
</book>
|
||||
|
|
|
|||
|
|
@ -1238,7 +1238,7 @@ warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.]]>
|
|||
</section>
|
||||
</section>
|
||||
<section id="ChToolsLexx">
|
||||
<title>lexx (flex)</title>
|
||||
<title>flex</title>
|
||||
<para>Flex is a free implementation of lexx.</para>
|
||||
<section id="ChToolsUnixLexx">
|
||||
<title>UNIX or Win32 Cygwin: flex</title>
|
||||
|
|
|
|||
Loading…
Reference in New Issue