2 # Make the "Wireshark User Guide" and "Wireshark Developer Guide"
4 # See the README.adoc file for instructions.
7 ############### YOU SHOULDN'T HAVE TO EDIT ANYTHING BELOW THIS LINE! ################
10 wsug_src/WSUG_app_files.asciidoc \
11 wsug_src/WSUG_app_howitworks.asciidoc \
12 wsug_src/WSUG_app_messages.asciidoc \
13 wsug_src/WSUG_app_protocols.asciidoc \
14 wsug_src/WSUG_app_tools.asciidoc \
15 wsug_src/WSUG_chapter_advanced.asciidoc \
16 wsug_src/WSUG_chapter_build_install.asciidoc \
17 wsug_src/WSUG_chapter_capture.asciidoc \
18 wsug_src/WSUG_chapter_customize.asciidoc \
19 wsug_src/WSUG_chapter_introduction.asciidoc \
20 wsug_src/WSUG_chapter_io.asciidoc \
21 wsug_src/WSUG_chapter_statistics.asciidoc \
22 wsug_src/WSUG_chapter_telephony.asciidoc \
23 wsug_src/WSUG_chapter_troubleshoot.asciidoc \
24 wsug_src/WSUG_chapter_use.asciidoc \
25 wsug_src/WSUG_chapter_work.asciidoc \
26 wsug_src/WSUG_preface.asciidoc \
29 WSUG_TOOLS_HELP_FILES = \
30 wsug_src/capinfos-h.txt \
31 wsug_src/dumpcap-h.txt \
32 wsug_src/editcap-F.txt \
33 wsug_src/editcap-T.txt \
34 wsug_src/editcap-h.txt \
35 wsug_src/mergecap-h.txt \
36 wsug_src/rawshark-h.txt \
37 wsug_src/reordercap-h.txt \
38 wsug_src/text2pcap-h.txt \
41 WSUG_GENERATED_SOURCE = \
45 wsug_graphics/captureOptions.png \
46 wsug_graphics/related-ack.png \
47 wsug_graphics/related-dup-ack.png \
48 wsug_graphics/related-last.png \
49 wsug_graphics/related-request.png \
50 wsug_graphics/related-segment.png \
51 wsug_graphics/related-current.png \
52 wsug_graphics/related-first.png \
53 wsug_graphics/related-other.png \
54 wsug_graphics/related-response.png \
55 wsug_graphics/ws-analyze-menu.png \
56 wsug_graphics/ws-bytes-pane-tabs.png \
57 wsug_graphics/ws-bytes-pane.png \
58 wsug_graphics/ws-capture-info.png \
59 wsug_graphics/ws-capture-interfaces.png \
60 wsug_graphics/ws-capture-interface-details.png \
61 wsug_graphics/ws-capture-interfaces-win32.png \
62 wsug_graphics/ws-capture-menu.png \
63 wsug_graphics/ws-capture-options.png \
64 wsug_graphics/ws-capture-options-compile-selected-bpfs.png \
65 wsug_graphics/ws-capture-options-output.png \
66 wsug_graphics/ws-capture-options-manage-interfaces-local.png \
67 wsug_graphics/ws-capture-options-manage-interfaces-pipes.png \
68 wsug_graphics/ws-capture-options-manage-interfaces-remote-plus.png \
69 wsug_graphics/ws-capture-options-manage-interfaces-remote.png \
70 wsug_graphics/ws-capture-options-manage-interfaces.png \
71 wsug_graphics/ws-capture-options-remote-capture.png \
72 wsug_graphics/ws-capture-options-remote-interface.png \
73 wsug_graphics/ws-capture-options-remote-settings.png \
74 wsug_graphics/ws-capture-options-settings.png \
75 wsug_graphics/ws-capture-preferences.png \
76 wsug_graphics/ws-choose-color-rule.png \
77 wsug_graphics/ws-coloring-fields.png \
78 wsug_graphics/ws-coloring-rules-dialog.png \
79 wsug_graphics/ws-column-header-popup-menu.png \
80 wsug_graphics/ws-decode-as-show.png \
81 wsug_graphics/ws-decode-as.png \
82 wsug_graphics/ws-details-pane-popup-menu.png \
83 wsug_graphics/ws-details-pane.png \
84 wsug_graphics/ws-display-filter-tcp.png \
85 wsug_graphics/ws-edit-menu.png \
86 wsug_graphics/ws-enabled-protocols.png \
87 wsug_graphics/ws-expert-colored-tree.png \
88 wsug_graphics/ws-expert-column.png \
89 wsug_graphics/ws-expert-infos.png \
90 wsug_graphics/ws-export-objects.png \
91 wsug_graphics/ws-export-pdml.png \
92 wsug_graphics/ws-export-plain.png \
93 wsug_graphics/ws-export-ps.png \
94 wsug_graphics/ws-export-psml.png \
95 wsug_graphics/ws-export-selected.png \
96 wsug_graphics/ws-file-import.png \
97 wsug_graphics/ws-file-menu.png \
98 wsug_graphics/ws-file-set-dialog.png \
99 wsug_graphics/ws-filter-add-expression.png \
100 wsug_graphics/ws-filter-toolbar.png \
101 wsug_graphics/ws-filters.png \
102 wsug_graphics/ws-find-packet.png \
103 wsug_graphics/ws-follow-stream.png \
104 wsug_graphics/ws-go-menu.png \
105 wsug_graphics/ws-goto-packet.png \
106 wsug_graphics/ws-gui-colors-preferences.png \
107 wsug_graphics/ws-gui-columns-preferences.png \
108 wsug_graphics/ws-gui-config-profiles.png \
109 wsug_graphics/ws-gui-font-preferences.png \
110 wsug_graphics/ws-gui-interface-options.png \
111 wsug_graphics/ws-gui-layout-preferences.png \
112 wsug_graphics/ws-gui-preferences.png \
113 wsug_graphics/ws-help-menu.png \
114 wsug_graphics/ws-internals-menu.png \
115 wsug_graphics/ws-list-pane.png \
116 wsug_graphics/ws-logo.png \
117 wsug_graphics/ws-main-toolbar.png \
118 wsug_graphics/ws-main.png \
119 wsug_graphics/ws-menu.png \
120 wsug_graphics/ws-merge-gtk24.png \
121 wsug_graphics/ws-merge-win32.png \
122 wsug_graphics/ws-nameresolution-preferences.png \
123 wsug_graphics/ws-open-gtk24.png \
124 wsug_graphics/ws-open-win32.png \
125 wsug_graphics/ws-packet-format.png \
126 wsug_graphics/ws-packet-pane-popup-menu.png \
127 wsug_graphics/ws-packet-range.png \
128 wsug_graphics/ws-packet-selected.png \
129 wsug_graphics/ws-packet-sep-win.png \
130 wsug_graphics/ws-print.png \
131 wsug_graphics/ws-printing-preferences.png \
132 wsug_graphics/ws-save-as-gtk24.png \
133 wsug_graphics/ws-save-as-win32.png \
134 wsug_graphics/ws-statistics-menu.png \
135 wsug_graphics/ws-stats-compare.png \
136 wsug_graphics/ws-stats-conversations.png \
137 wsug_graphics/ws-stats-endpoints.png \
138 wsug_graphics/ws-stats-hierarchy.png \
139 wsug_graphics/ws-stats-iographs.png \
140 wsug_graphics/ws-stats-srt-dcerpc-filter.png \
141 wsug_graphics/ws-stats-srt-dcerpc.png \
142 wsug_graphics/ws-stats-summary.png \
143 wsug_graphics/ws-stats-lte-mac-traffic.png \
144 wsug_graphics/ws-stats-lte-rlc-traffic.png \
145 wsug_graphics/ws-stats-wlan-traffic.png \
146 wsug_graphics/ws-statusbar-empty.png \
147 wsug_graphics/ws-statusbar-filter.png \
148 wsug_graphics/ws-statusbar-loaded.png \
149 wsug_graphics/ws-statusbar-profile.png \
150 wsug_graphics/ws-statusbar-selected.png \
151 wsug_graphics/ws-tel-rtpstream-analysis.png \
152 wsug_graphics/ws-telephony-menu.png \
153 wsug_graphics/ws-tools-menu.png \
154 wsug_graphics/ws-time-reference.png \
155 wsug_graphics/ws-view-menu.png \
156 wsug_graphics/toolbar/autoscroll_24.png \
157 wsug_graphics/toolbar/capture_filter_24.png \
158 wsug_graphics/toolbar/capture_interfaces_24.png \
159 wsug_graphics/toolbar/capture_options_24.png \
160 wsug_graphics/toolbar/capture_restart_24.png \
161 wsug_graphics/toolbar/capture_start_24.png \
162 wsug_graphics/toolbar/capture_stop_24.png \
163 wsug_graphics/toolbar/colorize_24.png \
164 wsug_graphics/toolbar/display_filter_24.png \
165 wsug_graphics/toolbar/resize_columns_24.png \
166 wsug_graphics/toolbar/stock_add_24.png \
167 wsug_graphics/toolbar/stock_apply_20.png \
168 wsug_graphics/toolbar/stock_bottom_24.png \
169 wsug_graphics/toolbar/stock_clear_24.png \
170 wsug_graphics/toolbar/stock_close_24.png \
171 wsug_graphics/toolbar/stock_colorselector_24.png \
172 wsug_graphics/toolbar/stock_help_24.png \
173 wsug_graphics/toolbar/stock_jump_to_24.png \
174 wsug_graphics/toolbar/stock_left_arrow_24.png \
175 wsug_graphics/toolbar/stock_open_24.png \
176 wsug_graphics/toolbar/stock_preferences_24.png \
177 wsug_graphics/toolbar/stock_print_24.png \
178 wsug_graphics/toolbar/stock_properties_24.png \
179 wsug_graphics/toolbar/stock_refresh_24.png \
180 wsug_graphics/toolbar/stock_right_arrow_24.png \
181 wsug_graphics/toolbar/stock_save_24.png \
182 wsug_graphics/toolbar/stock_save_as_24.png \
183 wsug_graphics/toolbar/stock_search_24.png \
184 wsug_graphics/toolbar/stock_stop_24.png \
185 wsug_graphics/toolbar/stock_top_24.png \
186 wsug_graphics/toolbar/stock_zoom_1_24.png \
187 wsug_graphics/toolbar/stock_zoom_in_24.png \
188 wsug_graphics/toolbar/stock_zoom_out_24.png
191 wsdg_src/WSDG_chapter_build_intro.asciidoc \
192 wsdg_src/WSDG_chapter_capture.asciidoc \
193 wsdg_src/WSDG_chapter_dissection.asciidoc \
194 wsdg_src/WSDG_chapter_env_intro.asciidoc \
195 wsdg_src/WSDG_chapter_libraries.asciidoc \
196 wsdg_src/WSDG_chapter_quick_setup.asciidoc \
197 wsdg_src/WSDG_chapter_sources.asciidoc \
198 wsdg_src/WSDG_chapter_tools.asciidoc \
199 wsdg_src/WSDG_chapter_userinterface.asciidoc \
200 wsdg_src/WSDG_chapter_works.asciidoc \
201 wsdg_src/WSDG_preface.asciidoc \
205 WSDG_GENERATED_SOURCE = \
209 wsdg_graphics/ws-capture-sync.dia \
210 wsdg_graphics/ws-capture-sync.png \
211 wsdg_graphics/ws-capture_internals.dia \
212 wsdg_graphics/ws-capture_internals.png \
213 wsdg_graphics/ws-function-blocks.dia \
214 wsdg_graphics/ws-function-blocks.png \
215 wsdg_graphics/ws-logo.png \
216 wsdg_graphics/toolbar/dummy.dummy
219 common_src/GPL_appendix.asciidoc \
220 common_src/typographic_conventions.asciidoc
223 common_graphics/note.svg \
224 common_graphics/tip.svg \
225 common_graphics/warning.svg
227 # user-guide.xml must be first in the list (to match $<)
229 user-guide.asciidoc \
230 attributes.asciidoc \
231 custom_layer_chm.xsl \
232 custom_layer_single_html.xsl \
234 $(WSUG_TOOLS_HELP_FILES) \
239 WSUG_SOURCE = $(WSUG_GENERATED_SOURCE) $(WSUG_DIST)
241 # developer-guide.asciidoc must be first in the list (to match $<)
243 developer-guide.asciidoc \
244 attributes.asciidoc \
245 custom_layer_chm.xsl \
246 custom_layer_single_html.xsl \
252 WSDG_SOURCE = $(WSDG_GENERATED_SOURCE) $(WSDG_DIST)
254 RELEASE_NOTES_SOURCE = \
255 release-notes.asciidoc
263 $(WSDG_GENERATED_SOURCE) \
264 $(WSUG_GENERATED_SOURCE) \
267 wsdg_html_chunked.zip \
270 wsug_html_chunked.zip \
285 # Note: file order here MATTERS!
286 # new WSLUA_MODULE files must come right before any WSLUA_CONTINUE_MODULE
287 # files for the same module
289 $(top_srcdir)/epan/wslua/wslua_dumper.c \
290 $(top_srcdir)/epan/wslua/wslua_field.c \
291 $(top_srcdir)/epan/wslua/wslua_gui.c \
292 $(top_srcdir)/epan/wslua/wslua_listener.c \
293 $(top_srcdir)/epan/wslua/wslua_pinfo.c \
294 $(top_srcdir)/epan/wslua/wslua_address.c \
295 $(top_srcdir)/epan/wslua/wslua_column.c \
296 $(top_srcdir)/epan/wslua/wslua_nstime.c \
297 $(top_srcdir)/epan/wslua/wslua_proto.c \
298 $(top_srcdir)/epan/wslua/wslua_dissector.c \
299 $(top_srcdir)/epan/wslua/wslua_pref.c \
300 $(top_srcdir)/epan/wslua/wslua_proto_expert.c \
301 $(top_srcdir)/epan/wslua/wslua_proto_field.c \
302 $(top_srcdir)/epan/wslua/wslua_int64.c \
303 $(top_srcdir)/epan/wslua/wslua_struct.c \
304 $(top_srcdir)/epan/wslua/wslua_tree.c \
305 $(top_srcdir)/epan/wslua/wslua_tvb.c \
306 $(top_srcdir)/epan/wslua/wslua_byte_array.c \
307 $(top_srcdir)/epan/wslua/wslua_file.c \
308 $(top_srcdir)/epan/wslua/wslua_file_handler.c \
309 $(top_srcdir)/epan/wslua/wslua_frame_info.c \
310 $(top_srcdir)/epan/wslua/wslua_capture_info.c \
311 $(top_srcdir)/epan/wslua/wslua_dir.c \
312 $(top_srcdir)/epan/wslua/wslua_util.c
314 COMMON_XSLTPROC_ARGS = \
315 --stringparam use.id.as.filename 1 \
316 --stringparam admon.graphics 1 \
317 --stringparam admon.graphics.extension .svg \
318 --stringparam section.autolabel 1 \
319 --stringparam section.label.includes.component.label 1 \
320 --stringparam html.stylesheet ws.css
322 WSUG_XSLTPROC_ARGS = \
323 --stringparam admon.graphics.path wsug_graphics/
325 WSDG_XSLTPROC_ARGS = \
326 --stringparam admon.graphics.path wsdg_graphics/
328 SINGLE_XSLTPROC_ARGS = \
329 --nonet custom_layer_single_html.xsl
331 CHUNKED_XSLTPROC_ARGS = \
332 --stringparam chunker.output.encoding UTF-8 \
333 --nonet http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl
335 HTMLHELP_XSLTPROC_ARGS = \
336 --nonet custom_layer_chm.xsl
337 # --nonet http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl
339 ASCIIDOCTOR_COMMON_ARGS = \
340 --require $(srcdir)/asciidoctor-macros/commaize-block.rb \
341 --require $(srcdir)/asciidoctor-macros/cve_idlink-inline-macro.rb \
342 --require $(srcdir)/asciidoctor-macros/ws_buglink-inline-macro.rb \
343 --require $(srcdir)/asciidoctor-macros/ws_salink-inline-macro.rb
345 ASCIIDOCTOR_COMMON_COMMAND = TZ=UTC ASCIIDOCTORJ_OPTS="-Xmx800m ${ASCIIDOCTORJ_OPTS}" \
347 $(ASCIIDOCTOR_COMMON_ARGS)
350 $(ASCIIDOCTOR_COMMON_COMMAND) --backend pdf --out-file $@ $<
353 $(ASCIIDOCTOR_COMMON_COMMAND) --backend docbook --out-file $@ $<
355 docbook_all_local_targets =
357 docbook_all_local_targets += wsug_html_chunked
359 all-local: $(docbook_all_local_targets)
361 all-html: wsug wsdg release_notes
363 all-pdf: wsug_pdf wsdg_pdf
365 # Wireshark User Guide
366 wsug: wsug_html_chunked wsug_html
368 wsug_pdf: wsug user-guide.pdf
370 user-guide.xml: user-guide.asciidoc $(WSUG_FILES)
372 user-guide.pdf: user-guide.asciidoc $(WSUG_FILES)
375 # create html single page file
377 wsug_html: wsug_html/index.html
380 wsug_html/index.html: user-guide.xml
381 @ echo --- WSUG - HTML SINGLE PAGE ---
382 mkdir -p wsug_html/wsug_graphics/toolbar
383 cp $(srcdir)/wsug_graphics/*.* wsug_html/wsug_graphics
384 cp $(srcdir)/common_graphics/*.* wsug_html/wsug_graphics
385 cp $(srcdir)/wsug_graphics/toolbar/* wsug_html/wsug_graphics/toolbar
386 cp $(srcdir)/ws.css wsug_html
387 $(XSLTPROC) --stringparam base.dir wsug_html/ $(COMMON_XSLTPROC_ARGS) \
388 $(WSUG_XSLTPROC_ARGS) $(SINGLE_XSLTPROC_ARGS) $< > $@
389 -chmod -R og+rX wsug_html
391 # create html chunked page files
393 wsug_html_chunked: wsug_html_chunked/index.html
396 wsug_html_chunked/index.html: user-guide.xml
397 @ echo --- WSUG - HTML CHUNKED ---
398 mkdir -p wsug_html_chunked/wsug_graphics/toolbar
399 cp $(srcdir)/wsug_graphics/*.* wsug_html_chunked/wsug_graphics
400 cp $(srcdir)/common_graphics/*.* wsug_html_chunked/wsug_graphics
401 cp $(srcdir)/wsug_graphics/toolbar/* wsug_html_chunked/wsug_graphics/toolbar
402 cp $(srcdir)/ws.css wsug_html_chunked
403 $(XSLTPROC) --stringparam base.dir wsug_html_chunked/ $(COMMON_XSLTPROC_ARGS) \
404 $(WSUG_XSLTPROC_ARGS) $(CHUNKED_XSLTPROC_ARGS) $<
405 -chmod -R og+rX wsug_html_chunked
407 wsluarm: make-wsluarm.pl $(WSLUA_MODULES)
409 $(PERL) $(srcdir)/make-wsluarm.pl $(WSLUA_MODULES)
413 # Wireshark Developer Guide
414 wsdg: wsdg_html_chunked wsdg_html
417 wsdg_pdf: developer-guide.pdf
420 developer-guide.xml: developer-guide.asciidoc $(WSDG_FILES) wsluarm
422 developer-guide.pdf: developer-guide.asciidoc $(WSDG_FILES) wsluarm
424 # create html single page file
426 wsdg_html: wsdg_html/index.html
429 wsdg_html/index.html: developer-guide.xml
430 @ echo --- WSDG - HTML SINGLE PAGE ---
431 mkdir -p wsdg_html/wsdg_graphics/toolbar
432 cp $(srcdir)/wsdg_graphics/*.* wsdg_html/wsdg_graphics
433 cp $(srcdir)/common_graphics/*.* wsdg_html/wsdg_graphics
434 cp $(srcdir)/wsdg_graphics/toolbar/* wsdg_html/wsdg_graphics/toolbar/
435 cp $(srcdir)/ws.css wsdg_html
436 $(XSLTPROC) --stringparam base.dir wsdg_html/ $(COMMON_XSLTPROC_ARGS) \
437 --path .:wsluarm_src \
438 $(WSDG_XSLTPROC_ARGS) $(SINGLE_XSLTPROC_ARGS) $< > $@
439 -chmod -R og+rX wsdg_html
441 # create html chunked page files
443 wsdg_html_chunked: developer-guide.xml wsdg_html_chunked/index.html
446 wsdg_html_chunked/index.html: developer-guide.xml
447 @ echo --- WSDG - HTML CHUNKED ---
448 mkdir -p wsdg_html_chunked/wsdg_graphics/toolbar
449 cp $(srcdir)/wsdg_graphics/*.* wsdg_html_chunked/wsdg_graphics
450 cp $(srcdir)/common_graphics/*.* wsdg_html_chunked/wsdg_graphics
451 cp $(srcdir)/wsdg_graphics/toolbar/* wsdg_html_chunked/wsdg_graphics/toolbar/
452 cp $(srcdir)/ws.css wsdg_html_chunked
453 $(XSLTPROC) --stringparam base.dir wsdg_html_chunked/ $(COMMON_XSLTPROC_ARGS) \
454 --path .:wsluarm_src \
455 $(WSDG_XSLTPROC_ARGS) $(CHUNKED_XSLTPROC_ARGS) $<
456 -chmod -R og+rX wsdg_html_chunked
460 release_note_deps = release-notes.html
462 release_note_deps += release-notes.txt
465 release_notes: $(release_note_deps)
467 # create html single page file
468 release-notes.html: $(RELEASE_NOTES_SOURCE)
469 @ echo --- RELEASE NOTES - HTML ---
470 $(ASCIIDOCTOR_COMMON_COMMAND) \
472 --out-file $(builddir)/release-notes.html \
473 $(srcdir)/release-notes.asciidoc
475 # create txt single page file (through HTML)
476 release-notes.txt: release-notes.html
477 @ echo --- RELEASE NOTES - TXT ---
480 $(builddir)/release-notes.html \
481 > $(builddir)/release-notes.txt
483 news: release-notes.txt
484 cp release-notes.txt ../NEWS
485 -cp release-notes.txt $(top_srcdir)/NEWS
489 $(MKDIR_P) $(DESTDIR)$(docdir)/guides
490 cp -rf $(builddir)/wsug_html_chunked $(DESTDIR)$(docdir)/guides
494 rm -rf $(DESTDIR)$(docdir)
503 $(RELEASE_NOTES_SOURCE) \