diff --git a/CMakeLists.txt b/CMakeLists.txt index 5b4e0b4978..75e6582503 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1698,7 +1698,6 @@ set(PLUGIN_INSTALL_VERSION_LIBDIR "${PLUGIN_INSTALL_LIBDIR}/${PLUGIN_PATH_ID}") set(PLUGIN_VERSION_DIR "plugins/${PLUGIN_PATH_ID}") add_subdirectory( capture ) -add_subdirectory( doc ) add_subdirectory( epan ) add_subdirectory( extcap ) add_subdirectory( randpkt_core ) @@ -1754,9 +1753,9 @@ endif() # learn about the directory location. add_subdirectory( wsutil ) -# docbook must be added after DATAFILE_DIR is set so that the guides can be +# doc/ must be added after DATAFILE_DIR is set so that the guides can be # copied there for running from the build directory -add_subdirectory( docbook EXCLUDE_FROM_ALL ) +add_subdirectory( doc EXCLUDE_FROM_ALL ) if(BUILD_wireshark AND QT_FOUND) add_subdirectory( ui/qt ) @@ -4091,13 +4090,13 @@ install( if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE) install( - DIRECTORY "${CMAKE_BINARY_DIR}/docbook/wsug_html_chunked" + DIRECTORY "${CMAKE_BINARY_DIR}/doc/wsug_html_chunked" DESTINATION "${CMAKE_INSTALL_DOCDIR}" COMPONENT "UserGuide" EXCLUDE_FROM_ALL ) install( - DIRECTORY "${CMAKE_BINARY_DIR}/docbook/wsdg_html_chunked" + DIRECTORY "${CMAKE_BINARY_DIR}/doc/wsdg_html_chunked" DESTINATION "${CMAKE_INSTALL_DOCDIR}" COMPONENT "DeveloperGuide" EXCLUDE_FROM_ALL diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1fbbc94866..531184fa84 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,6 +41,6 @@ Complete details on doing so can be found in the [Developer’s Guide](https://w When you submit a merge request, a series of automated tests will be run in order to ensure that compiles across different platforms and conforms to our coding guidelines. The change will also be manually reviewed by a core developer and will be merged when the change passes both automated and manual review. -The Wireshark User’s Guide and Developer’s Guide are maintained in the [docbook directory](https://gitlab.com/wireshark/wireshark/-/tree/master/docbook) in the main repository. +The Wireshark User’s Guide and Developer’s Guide are maintained in the [doc directory](https://gitlab.com/wireshark/wireshark/-/tree/master/doc) in the main repository. You don’t need a complete development environment to contribute to them, but you do need git and a text editor. Documentation updates must be made via a merge request similar to source code changes. diff --git a/INSTALL b/INSTALL index 3f91b3af20..812de8e789 100644 --- a/INSTALL +++ b/INSTALL @@ -1,6 +1,6 @@ See also https://gitlab.com/wireshark/wireshark/-/wikis/Development and the Developer's Guide located at https://www.wireshark.org/docs/ -and in the docbook/ subdirectory. +and in the doc/ subdirectory. Installation ============ diff --git a/README.bsd b/README.bsd index 19cb07a405..4c43219221 100644 --- a/README.bsd +++ b/README.bsd @@ -6,7 +6,7 @@ Installing Wireshark on FreeBSD/OpenBSD/NetBSD/DragonFly BSD For general installation instructions, see the INSTALL file, along with the Developer's Guide located at https://www.wireshark.org/docs/ and -in the docbook/ directory. Additional BSD specific notes and requirements +in the doc/ directory. Additional BSD specific notes and requirements follow. 1. Berkeley Packet Filter (BPF) requirement diff --git a/cmake/modules/FindAsciidoctor.cmake b/cmake/modules/FindAsciidoctor.cmake index 3d17f5b39b..c92a9957d9 100644 --- a/cmake/modules/FindAsciidoctor.cmake +++ b/cmake/modules/FindAsciidoctor.cmake @@ -45,7 +45,7 @@ if(ASCIIDOCTOR_EXECUTABLE) # --failure-level=WARN # --trace --quiet - --attribute build_dir=${CMAKE_BINARY_DIR}/docbook + --attribute build_dir=${CMAKE_BINARY_DIR}/doc --attribute css_dir=${CMAKE_SOURCE_DIR}/doc --require ${CMAKE_SOURCE_DIR}/doc/asciidoctor-macros/ws_utils.rb --require ${CMAKE_SOURCE_DIR}/doc/asciidoctor-macros/commaize-block.rb diff --git a/cmake/modules/FindXSLTPROC.cmake b/cmake/modules/FindXSLTPROC.cmake index 96756dafaf..c5d05df8cb 100644 --- a/cmake/modules/FindXSLTPROC.cmake +++ b/cmake/modules/FindXSLTPROC.cmake @@ -93,7 +93,7 @@ MACRO(XML2HTML _target_dep _dir_pfx _mode _dbk_source _gfx_sources) SET(_modeparams --stringparam chunker.output.encoding UTF-8 --stringparam chunk.quietly 1) ELSE() # single-page SET(_basedir ${_dir_pfx}_html) - SET(_stylesheet ${CMAKE_SOURCE_DIR}/docbook/custom_layer_single_html.xsl) + SET(_stylesheet ${CMAKE_SOURCE_DIR}/doc/custom_layer_single_html.xsl) SET(_modeparams --output ${_basedir}/index.html) ENDIF() diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index d9898b2792..52165f114e 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -180,6 +180,453 @@ if(ASCIIDOCTOR_FOUND) ) endif() +# +# Wireshark User's and Developer's Guides +# + +set(COMMON_GUIDE_FILES + common_src/gpl_appendix.adoc + common_src/typographic_conventions.adoc +) + +set(WSUG_TITLE "Wireshark User's Guide") + +set(WSUG_FILES + wsug_src/wsug_advanced.adoc + wsug_src/wsug_build_install.adoc + wsug_src/wsug_capture.adoc + wsug_src/wsug_customize.adoc + wsug_src/wsug_files.adoc + wsug_src/wsug_howitworks.adoc + wsug_src/wsug_introduction.adoc + wsug_src/wsug_io.adoc + wsug_src/wsug_mate.adoc + wsug_src/wsug_messages.adoc + wsug_src/wsug_preface.adoc + wsug_src/wsug_protocols.adoc + wsug_src/wsug_statistics.adoc + wsug_src/wsug_telephony.adoc + wsug_src/wsug_tools.adoc + wsug_src/wsug_troubleshoot.adoc + wsug_src/wsug_use.adoc + wsug_src/wsug_work.adoc + wsug_src/capinfos-h.txt + wsug_src/dumpcap-h.txt + wsug_src/editcap-F.txt + wsug_src/editcap-T.txt + wsug_src/editcap-h.txt + wsug_src/mergecap-h.txt + wsug_src/rawshark-h.txt + wsug_src/reordercap-h.txt + wsug_src/text2pcap-h.txt + wsug_src/tshark-h.txt + wsug_src/wireshark-h.txt + ${COMMON_GUIDE_FILES} +) + +# Note: Images should be minimized using tools/compress-pngs.py. +set(WSUG_GRAPHICS + wsug_src/images/caution.svg + wsug_src/images/important.svg + wsug_src/images/note.svg + wsug_src/images/related-ack.png + wsug_src/images/related-current.png + wsug_src/images/related-dup-ack.png + wsug_src/images/related-first.png + wsug_src/images/related-last.png + wsug_src/images/related-other.png + wsug_src/images/related-request.png + wsug_src/images/related-response.png + wsug_src/images/related-segment.png + wsug_src/images/tip.svg + wsug_src/images/toolbar/document-open.png + wsug_src/images/toolbar/edit-find.png + wsug_src/images/toolbar/filter-toolbar-add.png + wsug_src/images/toolbar/filter-toolbar-apply.png + wsug_src/images/toolbar/filter-toolbar-bookmark.png + wsug_src/images/toolbar/filter-toolbar-clear.png + wsug_src/images/toolbar/filter-toolbar-input.png + wsug_src/images/toolbar/filter-toolbar-recent.png + wsug_src/images/toolbar/go-first.png + wsug_src/images/toolbar/go-jump.png + wsug_src/images/toolbar/go-last.png + wsug_src/images/toolbar/go-next.png + wsug_src/images/toolbar/go-previous.png + wsug_src/images/toolbar/x-capture-file-close.png + wsug_src/images/toolbar/x-capture-file-reload.png + wsug_src/images/toolbar/x-capture-file-save.png + wsug_src/images/toolbar/x-capture-options.png + wsug_src/images/toolbar/x-capture-restart.png + wsug_src/images/toolbar/x-capture-start.png + wsug_src/images/toolbar/x-capture-stop.png + wsug_src/images/toolbar/x-colorize-packets.png + wsug_src/images/toolbar/x-resize-columns.png + wsug_src/images/toolbar/x-stay-last.png + wsug_src/images/toolbar/zoom-in.png + wsug_src/images/toolbar/zoom-original.png + wsug_src/images/toolbar/zoom-out.png + wsug_src/images/warning.svg + wsug_src/images/ws-about-codecs.png + wsug_src/images/ws-analyze-menu.png + wsug_src/images/ws-bytes-pane-popup-menu.png + wsug_src/images/ws-bytes-pane-tabs.png + wsug_src/images/ws-bytes-pane.png + wsug_src/images/ws-capture-file-properties.png + wsug_src/images/ws-capture-info.png + wsug_src/images/ws-capture-interfaces-main-macos.png + wsug_src/images/ws-capture-interfaces-main-win32.png + wsug_src/images/ws-capture-menu.png + wsug_src/images/ws-capture-options-compile-selected-bpfs.png + wsug_src/images/ws-capture-options-options.png + wsug_src/images/ws-capture-options-output.png + wsug_src/images/ws-capture-options-output.png + wsug_src/images/ws-capture-options.png + wsug_src/images/ws-choose-color-rule.png + wsug_src/images/ws-coloring-fields.png + wsug_src/images/ws-coloring-rules-dialog.png + wsug_src/images/ws-column-header-popup-menu.png + wsug_src/images/ws-decode-as.png + wsug_src/images/ws-details-pane-popup-menu.png + wsug_src/images/ws-details-pane.png + wsug_src/images/ws-diagram-pane-popup-menu.png + wsug_src/images/ws-diagram-pane.png + wsug_src/images/ws-display-filter-tcp.png # GTK+ + wsug_src/images/ws-edit-menu.png + wsug_src/images/ws-enabled-protocols.png + wsug_src/images/ws-expert-colored-tree.png + wsug_src/images/ws-expert-column.png + wsug_src/images/ws-expert-information.png + wsug_src/images/ws-export-objects.png + wsug_src/images/ws-export-packet-dissections.png + wsug_src/images/ws-export-selected.png + wsug_src/images/ws-export-specified-packets.png + wsug_src/images/ws-file-import.png + wsug_src/images/ws-file-menu.png + wsug_src/images/ws-file-set-dialog.png # GTK+ + wsug_src/images/ws-filter-add-expression.png # GTK+ + wsug_src/images/ws-filter-toolbar.png + wsug_src/images/ws-filters.png # GTK+ + wsug_src/images/ws-find-packet.png + wsug_src/images/ws-follow-http2-stream.png + wsug_src/images/ws-follow-sip-stream.png + wsug_src/images/ws-follow-stream.png + wsug_src/images/ws-go-menu.png + wsug_src/images/ws-goto-packet.png + wsug_src/images/ws-help-menu.png + wsug_src/images/ws-list-pane.png # Outdated + wsug_src/images/ws-main-toolbar.png + wsug_src/images/ws-main.png + wsug_src/images/ws-manage-interfaces.png + wsug_src/images/ws-mate-analysis.png + wsug_src/images/ws-mate-dns_pane.png + wsug_src/images/ws-mate-dns_pdu.png + wsug_src/images/ws-mate-ftp_over_gre.png + wsug_src/images/ws-mate-gop_analysis.png + wsug_src/images/ws-mate-isup_over_mtp3_over_ip.png + wsug_src/images/ws-mate-mmse_over_http.png + wsug_src/images/ws-mate-pdu_analysis.png + wsug_src/images/ws-mate-tcp-output.png + wsug_src/images/ws-mate-transform.png + wsug_src/images/ws-menu.png + wsug_src/images/ws-merge-qt5.png + wsug_src/images/ws-merge-win32.png + wsug_src/images/ws-open-qt5.png + wsug_src/images/ws-open-win32.png + wsug_src/images/ws-packet-format.png + wsug_src/images/ws-packet-pane-popup-menu.png + wsug_src/images/ws-packet-range.png + wsug_src/images/ws-packet-selected.png + wsug_src/images/ws-packet-sep-win.png + wsug_src/images/ws-pref-advanced.png + wsug_src/images/ws-pref-appearance-columns.png + wsug_src/images/ws-pref-appearance-fonts-and-colors.png + wsug_src/images/ws-pref-appearance-layout.png + wsug_src/images/ws-pref-appearance.png + wsug_src/images/ws-pref-capture.png + wsug_src/images/ws-pref-expert.png + wsug_src/images/ws-pref-filter-buttons.png + wsug_src/images/ws-pref-name-resolution.png + wsug_src/images/ws-pref-protocols.png + wsug_src/images/ws-pref-rsa-keys.png + wsug_src/images/ws-pref-statistics.png + wsug_src/images/ws-print.png + wsug_src/images/ws-save-as-qt5.png + wsug_src/images/ws-save-as-win32.png + wsug_src/images/ws-statistics-menu.png + wsug_src/images/ws-stats-conversations.png + wsug_src/images/ws-stats-endpoints.png + wsug_src/images/ws-stats-hierarchy.png + wsug_src/images/ws-stats-iographs.png + wsug_src/images/ws-stats-lte-mac-traffic.png + wsug_src/images/ws-stats-lte-rlc-traffic.png + wsug_src/images/ws-stats-packet-lengths.png + wsug_src/images/ws-stats-srt-smb2.png + wsug_src/images/ws-stats-wlan-traffic.png # GTK+ + wsug_src/images/ws-statusbar-empty.png + wsug_src/images/ws-statusbar-filter.png + wsug_src/images/ws-statusbar-loaded.png + wsug_src/images/ws-statusbar-profile.png + wsug_src/images/ws-statusbar-selected.png + wsug_src/images/ws-tcp-analysis.png + wsug_src/images/ws-tel-playlist.png + wsug_src/images/ws-tel-rtp-player_1.png + wsug_src/images/ws-tel-rtp-player_2.png + wsug_src/images/ws-tel-rtp-player_3.png + wsug_src/images/ws-tel-rtp-player_button.png + wsug_src/images/ws-tel-rtp-streams.png + wsug_src/images/ws-tel-rtpstream-analysis_1.png + wsug_src/images/ws-tel-rtpstream-analysis_2.png + wsug_src/images/ws-tel-rtpstream-analysis_3.png + wsug_src/images/ws-tel-seq-dialog.png + wsug_src/images/ws-tel-voip-calls.png + wsug_src/images/ws-telephony-menu.png + wsug_src/images/ws-time-reference.png # GTK+ + wsug_src/images/ws-tools-menu.png + wsug_src/images/ws-view-menu.png +) + +set(WSDG_TITLE "Wireshark Developer's Guide") + +set(WSDG_FILES + wsdg_src/wsdg_asn2wrs.adoc + wsdg_src/wsdg_build_intro.adoc + wsdg_src/wsdg_capture.adoc + wsdg_src/wsdg_dissection.adoc + wsdg_src/wsdg_env_intro.adoc + wsdg_src/wsdg_libraries.adoc + wsdg_src/wsdg_lua_support.adoc + wsdg_src/wsdg_preface.adoc + wsdg_src/wsdg_quick_setup.adoc + wsdg_src/wsdg_sources.adoc + wsdg_src/wsdg_tests.adoc + wsdg_src/wsdg_tools.adoc + wsdg_src/wsdg_userinterface.adoc + wsdg_src/wsdg_works.adoc + ${COMMON_GUIDE_FILES} +) + +set(WSDG_GRAPHICS + wsdg_src/images/caution.svg + wsdg_src/images/git-triangular-workflow.gv + wsdg_src/images/git-triangular-workflow.svg + wsdg_src/images/important.svg + wsdg_src/images/note.svg + wsdg_src/images/tip.svg + wsdg_src/images/warning.svg + wsdg_src/images/ws-capture_internals.dia + wsdg_src/images/ws-capture_internals.png + wsdg_src/images/ws-capture-sync.dia + wsdg_src/images/ws-capture-sync.png + wsdg_src/images/ws-capture-sync.png + wsdg_src/images/ws-function-blocks.dia + wsdg_src/images/ws-function-blocks.svg + wsdg_src/images/ws-logo.png +) + +set(WSUG_SOURCE + ${WSUG_FILES} + ${WSUG_GRAPHICS} +) + +set(WSDG_SOURCE + ${WSDG_FILES} + ${WSDG_GRAPHICS} +) + +# Note: file order here MATTERS! +# new WSLUA_MODULE files must come right before any WSLUA_CONTINUE_MODULE +# files for the same module +set(WSLUA_MODULES + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dumper.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_field.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_gui.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_int64.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_listener.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_pinfo.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_address.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_column.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_nstime.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dissector.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_pref.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto_expert.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto_field.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tree.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tvb.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_byte_array.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_file.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_file_handler.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_frame_info.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_capture_info.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dir.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_wtap.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_utility.c + ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_struct.c +) + +# Empty file to trigger wsluarm generation. +ADD_CUSTOM_COMMAND( + OUTPUT + wsluarm + COMMAND ${CMAKE_COMMAND} -E make_directory wsluarm_src + COMMAND ${Python3_EXECUTABLE} + ${CMAKE_SOURCE_DIR}/tools/make-wsluarm.py + --output-directory wsluarm_src + ${WSLUA_MODULES} + COMMAND ${CMAKE_COMMAND} -E touch + wsluarm + DEPENDS + ${CMAKE_SOURCE_DIR}/tools/make-wsluarm.py + ${WSLUA_MODULES} +) + +set( WSDG_BUILT_DEPS wsluarm ) + +set( ASCIIDOC_CONF_FILES + ${CMAKE_CURRENT_SOURCE_DIR}/attributes.adoc + # XXX Add macros +) + +if(ASCIIDOCTOR_FOUND) + # Generate the DocBook sources of user and developer guides + + ASCIIDOCTOR2DOCBOOK(wsug_src/user-guide.adoc ${ASCIIDOC_CONF_FILES} ${WSUG_SOURCE} ${WSUG_BUILT_DEPS}) + add_custom_target(user_guide_docbook DEPENDS generate_user-guide.xml) + set_doc_target_properties(user_guide_docbook) + + ASCIIDOCTOR2DOCBOOK(wsdg_src/developer-guide.adoc ${ASCIIDOC_CONF_FILES} ${WSDG_SOURCE} ${WSDG_BUILT_DEPS}) + add_custom_target(developer_guide_docbook DEPENDS generate_developer-guide.xml) + set_doc_target_properties(developer_guide_docbook) + + # Top-level guide targets. + + add_custom_target(user_guides DEPENDS user_guide_docbook) + set_doc_target_properties(user_guides) + + add_custom_target(developer_guides DEPENDS developer_guide_docbook) + set_doc_target_properties(developer_guides) + + add_custom_target(all_guides DEPENDS user_guides developer_guides ) + set_doc_target_properties(all_guides) +endif() + +# User's Guide chain. +if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE) + XML2HTML( + user_guide + wsug + single-page + user-guide.xml + WSUG_GRAPHICS + ) + + XML2HTML( + user_guide + wsug + chunked + user-guide.xml + WSUG_GRAPHICS + ) + add_custom_target( + user_guide_html + DEPENDS + wsug_html/index.html + wsug_html_chunked/index.html + ) + set_doc_target_properties(user_guide_html) + add_dependencies(user_guides user_guide_html) + # Copy the WSUG to the build directory so that when running + # from the build directory ui/help_url.c will find the local file. + # It expects the WSUG in a different directory on Windows. + if(WIN32) + set(WSUG_DIR "${DATAFILE_DIR}/${WSUG_TITLE}") + else() + set(WSUG_DIR "${DATAFILE_DIR}/wsug_html_chunked") + endif() + # CMake 3.26 has copy_directory_if_different + add_custom_command( + TARGET user_guide_html + COMMAND ${CMAKE_COMMAND} -E copy_directory + "${CMAKE_CURRENT_BINARY_DIR}/wsug_html_chunked" "${WSUG_DIR}" + VERBATIM + ) +endif() + +if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE) + ASCIIDOCTOR2PDF(${WSUG_TITLE} wsug_src/user-guide.adoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS}) + + add_custom_target( + user_guide_pdf + DEPENDS + "${WSUG_TITLE}.pdf" + ) + set_doc_target_properties(user_guide_pdf) + add_dependencies(user_guides user_guide_pdf) +endif() + +if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_EPUB_EXECUTABLE) + ASCIIDOCTOR2EPUB(${WSUG_TITLE} wsug_src/user-guide.adoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS}) + + add_custom_target( + user_guide_epub + DEPENDS + "${WSUG_TITLE}.epub" + ) + set_doc_target_properties(user_guide_epub) + add_dependencies(user_guides user_guide_epub) +endif() + +# Developer's Guide chain. +if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE) + XML2HTML( + developer_guide + wsdg + single-page + developer-guide.xml + WSDG_GRAPHICS + ) + + XML2HTML( + developer_guide + wsdg + chunked + developer-guide.xml + WSDG_GRAPHICS + ) + add_custom_target( + developer_guide_html + DEPENDS + wsdg_html/index.html + wsdg_html_chunked/index.html + ) + set_doc_target_properties(developer_guide_html) + add_dependencies(developer_guides developer_guide_html) +endif() + +if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE) + ASCIIDOCTOR2PDF(${WSDG_TITLE} wsdg_src/developer-guide.adoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS}) + + add_custom_target( + developer_guide_pdf + DEPENDS + "${WSDG_TITLE}.pdf" + ) + set_doc_target_properties(developer_guide_pdf) + add_dependencies(developer_guides developer_guide_pdf) +endif() + +if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_EPUB_EXECUTABLE) + ASCIIDOCTOR2EPUB(${WSDG_TITLE} wsdg_src/developer-guide.adoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS}) + + add_custom_target( + developer_guide_epub + DEPENDS + "${WSDG_TITLE}.epub" + ) + set_doc_target_properties(developer_guide_epub) + add_dependencies(developer_guides developer_guide_epub) +endif() + # # Editor modelines - https://www.wireshark.org/tools/modelines.html # diff --git a/docbook/README.adoc b/doc/README.documentation.adoc similarity index 68% rename from docbook/README.adoc rename to doc/README.documentation.adoc index bbfc397690..b4118fc12c 100644 --- a/docbook/README.adoc +++ b/doc/README.documentation.adoc @@ -93,44 +93,3 @@ _developer-guide.adoc_ include _attributes.adoc_. As a result, some markup will be incomplete. You can work around this somewhat by adding some attributes such as `compat-mode experimental` to your Live Preview settings. - -= HTML Help Alternatives - -Ideally we would ship documentation with Wireshark that is pleasant to -read, browsable, and searchable. Unfortunately we don't have an easy way -to do this. The closest we've been able to come is by shipping an HTML -Help (.chm) file on Windows. However, HTML Help a) is limited to Windows, -b) crusty on normal displays, and c) really crusty on HiDPI displays. - -The following alternative formats are available, each with advantages -and disadvantages: - -== WebHelp - -https://en.wikipedia.org/wiki/Webhelp[WebHelp] has three main -dependencies: - -- DocBook XSL, including... -- webhelpindexer.jar -- The user's local web browser - -This format generates both HTML pages and JavaScript, which might not run -reliably on end user machines. - -== PDF - -PDF output is page oriented, with static page sizes. This _usually_ isn't -a problem with modern reader software. However it doesn't look like we -can reliably load a PDF file and jump to specific section on some -platforms. For example, loading +++file:///path/to/user_guide.pdf#location+++ -works in Firefox & Chrome, but not in Safari, Preview, or Internet Explorer. - -== Qt Help - -Qt provides an extensive https://doc.qt.io/qt-5/qthelp-framework.html[help system]. -However, to use it we need to generate a Qt Help Project (.qhp) file, -which isn't currently supported by Asciidoctor or via DocBook XSL. - -The default help application (Qt Assistant) is ugly. We'd probably want -to write our own help viewer app or integrate help directly via -QHelpEngine. diff --git a/doc/README.wslua b/doc/README.wslua index a4f0950f01..1129bac848 100644 --- a/doc/README.wslua +++ b/doc/README.wslua @@ -45,8 +45,8 @@ Both of the scripts above are given the C-source files to search through by the make process, generated from the lists in epan/wslua/CMakeLists.txt. Naturally if you add new source files, you need to add them to the list in epan/wslua/CMakeLists.txt. You also have to add the module name into -docbook/user-guide.xml and docbook/wsluarm.xml, and the source files into -docbook/CMakeLists.txt, to get it to be generated in the user guide. +doc/user-guide.xml and doc/wsluarm.xml, and the source files into +doc/CMakeLists.txt, to get it to be generated in the user guide. Due to those documentation and registration scripts, you MUST follow some very specific conventions in the functions you write to expose C-side code to Lua, @@ -286,14 +286,14 @@ from anything with a 'WSLUA_FUNCTION' macro (as opposed to class member functions, which use the 'WSLUA_METHOD' and 'WSLUA_CONSTRUCTOR' macros). Also, to make new wslua files generate documentation, it is not sufficient to just add this macro to a new file and add the file to the CMakeLists.txt; you also -have to add the module name into docbook/user-guide.xml, and docbook/wsluarm.xml. +have to add the module name into doc/user-guide.xml, and doc/wsluarm.xml. WSLUA_CONTINUE_MODULE - like WSLUA_MODULE, except used at the top of a .c file to continue defining classes/functions/etc. within a previously declared module in a previous file (i.e., one that used WSLUA_MODULE). The module name must match the original one, and the .c file must be listed after the original one in the -CMakeLists.txt lists in the docbook directory. +CMakeLists.txt lists in the doc directory. WSLUA_ATTRIBUTE - this is another documentation-only "macro", only used within diff --git a/docbook/common_src/gpl_appendix.adoc b/doc/common_src/gpl_appendix.adoc similarity index 100% rename from docbook/common_src/gpl_appendix.adoc rename to doc/common_src/gpl_appendix.adoc diff --git a/docbook/common_src/typographic_conventions.adoc b/doc/common_src/typographic_conventions.adoc similarity index 100% rename from docbook/common_src/typographic_conventions.adoc rename to doc/common_src/typographic_conventions.adoc diff --git a/docbook/custom_layer_single_html.xsl b/doc/custom_layer_single_html.xsl similarity index 100% rename from docbook/custom_layer_single_html.xsl rename to doc/custom_layer_single_html.xsl diff --git a/docbook/wsdg_src/developer-guide-docinfo.xml b/doc/wsdg_src/developer-guide-docinfo.xml similarity index 100% rename from docbook/wsdg_src/developer-guide-docinfo.xml rename to doc/wsdg_src/developer-guide-docinfo.xml diff --git a/docbook/wsdg_src/developer-guide.adoc b/doc/wsdg_src/developer-guide.adoc similarity index 100% rename from docbook/wsdg_src/developer-guide.adoc rename to doc/wsdg_src/developer-guide.adoc diff --git a/docbook/wsdg_src/images/caution.svg b/doc/wsdg_src/images/caution.svg similarity index 100% rename from docbook/wsdg_src/images/caution.svg rename to doc/wsdg_src/images/caution.svg diff --git a/docbook/wsdg_src/images/git-triangular-workflow.gv b/doc/wsdg_src/images/git-triangular-workflow.gv similarity index 90% rename from docbook/wsdg_src/images/git-triangular-workflow.gv rename to doc/wsdg_src/images/git-triangular-workflow.gv index 809877a8f1..cb4fb17419 100644 --- a/docbook/wsdg_src/images/git-triangular-workflow.gv +++ b/doc/wsdg_src/images/git-triangular-workflow.gv @@ -1,4 +1,4 @@ -// dot -Tsvg -o docbook/wsdg_graphics/git-triangular-workflow.svg docbook/wsdg_graphics/git-triangular-workflow.gv +// dot -Tsvg -o doc/wsdg_graphics/git-triangular-workflow.svg doc/wsdg_graphics/git-triangular-workflow.gv digraph G { // XXX Integrate ws.css. Match it manually for now. diff --git a/docbook/wsdg_src/images/git-triangular-workflow.svg b/doc/wsdg_src/images/git-triangular-workflow.svg similarity index 100% rename from docbook/wsdg_src/images/git-triangular-workflow.svg rename to doc/wsdg_src/images/git-triangular-workflow.svg diff --git a/docbook/wsdg_src/images/important.svg b/doc/wsdg_src/images/important.svg similarity index 100% rename from docbook/wsdg_src/images/important.svg rename to doc/wsdg_src/images/important.svg diff --git a/docbook/wsdg_src/images/note.svg b/doc/wsdg_src/images/note.svg similarity index 100% rename from docbook/wsdg_src/images/note.svg rename to doc/wsdg_src/images/note.svg diff --git a/docbook/wsdg_src/images/tip.svg b/doc/wsdg_src/images/tip.svg similarity index 100% rename from docbook/wsdg_src/images/tip.svg rename to doc/wsdg_src/images/tip.svg diff --git a/docbook/wsdg_src/images/warning.svg b/doc/wsdg_src/images/warning.svg similarity index 100% rename from docbook/wsdg_src/images/warning.svg rename to doc/wsdg_src/images/warning.svg diff --git a/docbook/wsdg_src/images/ws-capture-sync.dia b/doc/wsdg_src/images/ws-capture-sync.dia similarity index 100% rename from docbook/wsdg_src/images/ws-capture-sync.dia rename to doc/wsdg_src/images/ws-capture-sync.dia diff --git a/docbook/wsdg_src/images/ws-capture-sync.png b/doc/wsdg_src/images/ws-capture-sync.png similarity index 100% rename from docbook/wsdg_src/images/ws-capture-sync.png rename to doc/wsdg_src/images/ws-capture-sync.png diff --git a/docbook/wsdg_src/images/ws-capture_internals.dia b/doc/wsdg_src/images/ws-capture_internals.dia similarity index 100% rename from docbook/wsdg_src/images/ws-capture_internals.dia rename to doc/wsdg_src/images/ws-capture_internals.dia diff --git a/docbook/wsdg_src/images/ws-capture_internals.png b/doc/wsdg_src/images/ws-capture_internals.png similarity index 100% rename from docbook/wsdg_src/images/ws-capture_internals.png rename to doc/wsdg_src/images/ws-capture_internals.png diff --git a/docbook/wsdg_src/images/ws-dev-guide-cover.png b/doc/wsdg_src/images/ws-dev-guide-cover.png similarity index 100% rename from docbook/wsdg_src/images/ws-dev-guide-cover.png rename to doc/wsdg_src/images/ws-dev-guide-cover.png diff --git a/docbook/wsdg_src/images/ws-function-blocks.dia b/doc/wsdg_src/images/ws-function-blocks.dia similarity index 100% rename from docbook/wsdg_src/images/ws-function-blocks.dia rename to doc/wsdg_src/images/ws-function-blocks.dia diff --git a/docbook/wsdg_src/images/ws-function-blocks.svg b/doc/wsdg_src/images/ws-function-blocks.svg similarity index 100% rename from docbook/wsdg_src/images/ws-function-blocks.svg rename to doc/wsdg_src/images/ws-function-blocks.svg diff --git a/docbook/wsdg_src/images/ws-logo.png b/doc/wsdg_src/images/ws-logo.png similarity index 100% rename from docbook/wsdg_src/images/ws-logo.png rename to doc/wsdg_src/images/ws-logo.png diff --git a/docbook/wsdg_src/images/wslua-new-dialog.png b/doc/wsdg_src/images/wslua-new-dialog.png similarity index 100% rename from docbook/wsdg_src/images/wslua-new-dialog.png rename to doc/wsdg_src/images/wslua-new-dialog.png diff --git a/docbook/wsdg_src/images/wslua-progdlg.png b/doc/wsdg_src/images/wslua-progdlg.png similarity index 100% rename from docbook/wsdg_src/images/wslua-progdlg.png rename to doc/wsdg_src/images/wslua-progdlg.png diff --git a/docbook/wsdg_src/images/wslua-textwindow.png b/doc/wsdg_src/images/wslua-textwindow.png similarity index 100% rename from docbook/wsdg_src/images/wslua-textwindow.png rename to doc/wsdg_src/images/wslua-textwindow.png diff --git a/docbook/wsdg_src/wsdg_asn2wrs.adoc b/doc/wsdg_src/wsdg_asn2wrs.adoc similarity index 100% rename from docbook/wsdg_src/wsdg_asn2wrs.adoc rename to doc/wsdg_src/wsdg_asn2wrs.adoc diff --git a/docbook/wsdg_src/wsdg_build_intro.adoc b/doc/wsdg_src/wsdg_build_intro.adoc similarity index 100% rename from docbook/wsdg_src/wsdg_build_intro.adoc rename to doc/wsdg_src/wsdg_build_intro.adoc diff --git a/docbook/wsdg_src/wsdg_capture.adoc b/doc/wsdg_src/wsdg_capture.adoc similarity index 100% rename from docbook/wsdg_src/wsdg_capture.adoc rename to doc/wsdg_src/wsdg_capture.adoc diff --git a/docbook/wsdg_src/wsdg_dissection.adoc b/doc/wsdg_src/wsdg_dissection.adoc similarity index 100% rename from docbook/wsdg_src/wsdg_dissection.adoc rename to doc/wsdg_src/wsdg_dissection.adoc diff --git a/docbook/wsdg_src/wsdg_env_intro.adoc b/doc/wsdg_src/wsdg_env_intro.adoc similarity index 100% rename from docbook/wsdg_src/wsdg_env_intro.adoc rename to doc/wsdg_src/wsdg_env_intro.adoc diff --git a/docbook/wsdg_src/wsdg_libraries.adoc b/doc/wsdg_src/wsdg_libraries.adoc similarity index 100% rename from docbook/wsdg_src/wsdg_libraries.adoc rename to doc/wsdg_src/wsdg_libraries.adoc diff --git a/docbook/wsdg_src/wsdg_lua_support.adoc b/doc/wsdg_src/wsdg_lua_support.adoc similarity index 100% rename from docbook/wsdg_src/wsdg_lua_support.adoc rename to doc/wsdg_src/wsdg_lua_support.adoc diff --git a/docbook/wsdg_src/wsdg_preface.adoc b/doc/wsdg_src/wsdg_preface.adoc similarity index 100% rename from docbook/wsdg_src/wsdg_preface.adoc rename to doc/wsdg_src/wsdg_preface.adoc diff --git a/docbook/wsdg_src/wsdg_quick_setup.adoc b/doc/wsdg_src/wsdg_quick_setup.adoc similarity index 99% rename from docbook/wsdg_src/wsdg_quick_setup.adoc rename to doc/wsdg_src/wsdg_quick_setup.adoc index b0772da6ae..4bd9fdffaa 100644 --- a/docbook/wsdg_src/wsdg_quick_setup.adoc +++ b/doc/wsdg_src/wsdg_quick_setup.adoc @@ -224,7 +224,7 @@ to run it by entering `wireshark`. To build the Wireshark User's Guide and the Wireshark Developer's Guide, build the `all_guides` target, e.g. `make all_guides` or `ninja all_guides`. Detailed information to build these guides can be found in -the file _docbook/README.adoc_ in the Wireshark sources. +the file _doc/README.documentation.adoc_ in the Wireshark sources. ==== Optional: Create an installable or source code package @@ -734,7 +734,7 @@ on using the <>. To build the Wireshark User's Guide and the Wireshark Developer's Guide, build the `all_guides` target, e.g. `msbuild all_guides.vcxproj`. Detailed information to build these guides can be found in the file -_docbook\README.adoc_ in the Wireshark sources. +_doc\README.adoc_ in the Wireshark sources. ==== Optional: Create a Wireshark Installer diff --git a/docbook/wsdg_src/wsdg_sources.adoc b/doc/wsdg_src/wsdg_sources.adoc similarity index 99% rename from docbook/wsdg_src/wsdg_sources.adoc rename to doc/wsdg_src/wsdg_sources.adoc index 54d702dbc2..0a334fd856 100644 --- a/docbook/wsdg_src/wsdg_sources.adoc +++ b/doc/wsdg_src/wsdg_sources.adoc @@ -958,8 +958,8 @@ $ git cherry-pick -x 1ab2c3d4 $ ninja $ ... -# OPTIONAL: Add entries to docbook/release-notes.adoc. -$EDITOR docbook/release-notes.adoc +# OPTIONAL: Add entries to doc/release-notes.adoc. +$EDITOR doc/release-notes.adoc # If you made any changes, update your commit. git commit --amend -a diff --git a/docbook/wsdg_src/wsdg_tests.adoc b/doc/wsdg_src/wsdg_tests.adoc similarity index 100% rename from docbook/wsdg_src/wsdg_tests.adoc rename to doc/wsdg_src/wsdg_tests.adoc diff --git a/docbook/wsdg_src/wsdg_tools.adoc b/doc/wsdg_src/wsdg_tools.adoc similarity index 98% rename from docbook/wsdg_src/wsdg_tools.adoc rename to doc/wsdg_src/wsdg_tools.adoc index d228599511..09f1b5762a 100644 --- a/docbook/wsdg_src/wsdg_tools.adoc +++ b/doc/wsdg_src/wsdg_tools.adoc @@ -487,9 +487,7 @@ Edition, it will include an SDK. === Documentation Toolchain Wireshark’s documentation is split across two directories. -The `doc` directory contains man pages written in Asciidoctor markup. -The `docbook` directory contains the User’s Guide, Developer’s Guide, and the release notes, which are also written in Asciidoctor markup. -The split is for historical reasons (described below), and the documentation will likely be consolidated into one directory in the future. +The `doc` directory contains man pages, User’s Guide, Developer’s Guide, and the release notes, which are written in Asciidoctor markup. Our various output formats are generated using the following tools. Intermediate formats are in _italics_. diff --git a/docbook/wsdg_src/wsdg_userinterface.adoc b/doc/wsdg_src/wsdg_userinterface.adoc similarity index 100% rename from docbook/wsdg_src/wsdg_userinterface.adoc rename to doc/wsdg_src/wsdg_userinterface.adoc diff --git a/docbook/wsdg_src/wsdg_works.adoc b/doc/wsdg_src/wsdg_works.adoc similarity index 100% rename from docbook/wsdg_src/wsdg_works.adoc rename to doc/wsdg_src/wsdg_works.adoc diff --git a/docbook/wsug_src/capinfos-h.txt b/doc/wsug_src/capinfos-h.txt similarity index 100% rename from docbook/wsug_src/capinfos-h.txt rename to doc/wsug_src/capinfos-h.txt diff --git a/docbook/wsug_src/dumpcap-h.txt b/doc/wsug_src/dumpcap-h.txt similarity index 100% rename from docbook/wsug_src/dumpcap-h.txt rename to doc/wsug_src/dumpcap-h.txt diff --git a/docbook/wsug_src/editcap-F.txt b/doc/wsug_src/editcap-F.txt similarity index 100% rename from docbook/wsug_src/editcap-F.txt rename to doc/wsug_src/editcap-F.txt diff --git a/docbook/wsug_src/editcap-T.txt b/doc/wsug_src/editcap-T.txt similarity index 100% rename from docbook/wsug_src/editcap-T.txt rename to doc/wsug_src/editcap-T.txt diff --git a/docbook/wsug_src/editcap-h.txt b/doc/wsug_src/editcap-h.txt similarity index 100% rename from docbook/wsug_src/editcap-h.txt rename to doc/wsug_src/editcap-h.txt diff --git a/docbook/wsug_src/images/caution.svg b/doc/wsug_src/images/caution.svg similarity index 100% rename from docbook/wsug_src/images/caution.svg rename to doc/wsug_src/images/caution.svg diff --git a/docbook/wsug_src/images/important.svg b/doc/wsug_src/images/important.svg similarity index 100% rename from docbook/wsug_src/images/important.svg rename to doc/wsug_src/images/important.svg diff --git a/docbook/wsug_src/images/note.svg b/doc/wsug_src/images/note.svg similarity index 100% rename from docbook/wsug_src/images/note.svg rename to doc/wsug_src/images/note.svg diff --git a/docbook/wsug_src/images/related-ack.png b/doc/wsug_src/images/related-ack.png similarity index 100% rename from docbook/wsug_src/images/related-ack.png rename to doc/wsug_src/images/related-ack.png diff --git a/docbook/wsug_src/images/related-current.png b/doc/wsug_src/images/related-current.png similarity index 100% rename from docbook/wsug_src/images/related-current.png rename to doc/wsug_src/images/related-current.png diff --git a/docbook/wsug_src/images/related-dup-ack.png b/doc/wsug_src/images/related-dup-ack.png similarity index 100% rename from docbook/wsug_src/images/related-dup-ack.png rename to doc/wsug_src/images/related-dup-ack.png diff --git a/docbook/wsug_src/images/related-first.png b/doc/wsug_src/images/related-first.png similarity index 100% rename from docbook/wsug_src/images/related-first.png rename to doc/wsug_src/images/related-first.png diff --git a/docbook/wsug_src/images/related-last.png b/doc/wsug_src/images/related-last.png similarity index 100% rename from docbook/wsug_src/images/related-last.png rename to doc/wsug_src/images/related-last.png diff --git a/docbook/wsug_src/images/related-other.png b/doc/wsug_src/images/related-other.png similarity index 100% rename from docbook/wsug_src/images/related-other.png rename to doc/wsug_src/images/related-other.png diff --git a/docbook/wsug_src/images/related-request.png b/doc/wsug_src/images/related-request.png similarity index 100% rename from docbook/wsug_src/images/related-request.png rename to doc/wsug_src/images/related-request.png diff --git a/docbook/wsug_src/images/related-response.png b/doc/wsug_src/images/related-response.png similarity index 100% rename from docbook/wsug_src/images/related-response.png rename to doc/wsug_src/images/related-response.png diff --git a/docbook/wsug_src/images/related-segment.png b/doc/wsug_src/images/related-segment.png similarity index 100% rename from docbook/wsug_src/images/related-segment.png rename to doc/wsug_src/images/related-segment.png diff --git a/docbook/wsug_src/images/tip.svg b/doc/wsug_src/images/tip.svg similarity index 100% rename from docbook/wsug_src/images/tip.svg rename to doc/wsug_src/images/tip.svg diff --git a/docbook/wsug_src/images/toolbar/document-open.png b/doc/wsug_src/images/toolbar/document-open.png similarity index 100% rename from docbook/wsug_src/images/toolbar/document-open.png rename to doc/wsug_src/images/toolbar/document-open.png diff --git a/docbook/wsug_src/images/toolbar/edit-find.png b/doc/wsug_src/images/toolbar/edit-find.png similarity index 100% rename from docbook/wsug_src/images/toolbar/edit-find.png rename to doc/wsug_src/images/toolbar/edit-find.png diff --git a/docbook/wsug_src/images/toolbar/filter-toolbar-add.png b/doc/wsug_src/images/toolbar/filter-toolbar-add.png similarity index 100% rename from docbook/wsug_src/images/toolbar/filter-toolbar-add.png rename to doc/wsug_src/images/toolbar/filter-toolbar-add.png diff --git a/docbook/wsug_src/images/toolbar/filter-toolbar-apply.png b/doc/wsug_src/images/toolbar/filter-toolbar-apply.png similarity index 100% rename from docbook/wsug_src/images/toolbar/filter-toolbar-apply.png rename to doc/wsug_src/images/toolbar/filter-toolbar-apply.png diff --git a/docbook/wsug_src/images/toolbar/filter-toolbar-bookmark.png b/doc/wsug_src/images/toolbar/filter-toolbar-bookmark.png similarity index 100% rename from docbook/wsug_src/images/toolbar/filter-toolbar-bookmark.png rename to doc/wsug_src/images/toolbar/filter-toolbar-bookmark.png diff --git a/docbook/wsug_src/images/toolbar/filter-toolbar-clear.png b/doc/wsug_src/images/toolbar/filter-toolbar-clear.png similarity index 100% rename from docbook/wsug_src/images/toolbar/filter-toolbar-clear.png rename to doc/wsug_src/images/toolbar/filter-toolbar-clear.png diff --git a/docbook/wsug_src/images/toolbar/filter-toolbar-input.png b/doc/wsug_src/images/toolbar/filter-toolbar-input.png similarity index 100% rename from docbook/wsug_src/images/toolbar/filter-toolbar-input.png rename to doc/wsug_src/images/toolbar/filter-toolbar-input.png diff --git a/docbook/wsug_src/images/toolbar/filter-toolbar-recent.png b/doc/wsug_src/images/toolbar/filter-toolbar-recent.png similarity index 100% rename from docbook/wsug_src/images/toolbar/filter-toolbar-recent.png rename to doc/wsug_src/images/toolbar/filter-toolbar-recent.png diff --git a/docbook/wsug_src/images/toolbar/go-first.png b/doc/wsug_src/images/toolbar/go-first.png similarity index 100% rename from docbook/wsug_src/images/toolbar/go-first.png rename to doc/wsug_src/images/toolbar/go-first.png diff --git a/docbook/wsug_src/images/toolbar/go-jump.png b/doc/wsug_src/images/toolbar/go-jump.png similarity index 100% rename from docbook/wsug_src/images/toolbar/go-jump.png rename to doc/wsug_src/images/toolbar/go-jump.png diff --git a/docbook/wsug_src/images/toolbar/go-last.png b/doc/wsug_src/images/toolbar/go-last.png similarity index 100% rename from docbook/wsug_src/images/toolbar/go-last.png rename to doc/wsug_src/images/toolbar/go-last.png diff --git a/docbook/wsug_src/images/toolbar/go-next.png b/doc/wsug_src/images/toolbar/go-next.png similarity index 100% rename from docbook/wsug_src/images/toolbar/go-next.png rename to doc/wsug_src/images/toolbar/go-next.png diff --git a/docbook/wsug_src/images/toolbar/go-previous.png b/doc/wsug_src/images/toolbar/go-previous.png similarity index 100% rename from docbook/wsug_src/images/toolbar/go-previous.png rename to doc/wsug_src/images/toolbar/go-previous.png diff --git a/docbook/wsug_src/images/toolbar/x-capture-file-close.png b/doc/wsug_src/images/toolbar/x-capture-file-close.png similarity index 100% rename from docbook/wsug_src/images/toolbar/x-capture-file-close.png rename to doc/wsug_src/images/toolbar/x-capture-file-close.png diff --git a/docbook/wsug_src/images/toolbar/x-capture-file-reload.png b/doc/wsug_src/images/toolbar/x-capture-file-reload.png similarity index 100% rename from docbook/wsug_src/images/toolbar/x-capture-file-reload.png rename to doc/wsug_src/images/toolbar/x-capture-file-reload.png diff --git a/docbook/wsug_src/images/toolbar/x-capture-file-save.png b/doc/wsug_src/images/toolbar/x-capture-file-save.png similarity index 100% rename from docbook/wsug_src/images/toolbar/x-capture-file-save.png rename to doc/wsug_src/images/toolbar/x-capture-file-save.png diff --git a/docbook/wsug_src/images/toolbar/x-capture-options.png b/doc/wsug_src/images/toolbar/x-capture-options.png similarity index 100% rename from docbook/wsug_src/images/toolbar/x-capture-options.png rename to doc/wsug_src/images/toolbar/x-capture-options.png diff --git a/docbook/wsug_src/images/toolbar/x-capture-restart.png b/doc/wsug_src/images/toolbar/x-capture-restart.png similarity index 100% rename from docbook/wsug_src/images/toolbar/x-capture-restart.png rename to doc/wsug_src/images/toolbar/x-capture-restart.png diff --git a/docbook/wsug_src/images/toolbar/x-capture-start.png b/doc/wsug_src/images/toolbar/x-capture-start.png similarity index 100% rename from docbook/wsug_src/images/toolbar/x-capture-start.png rename to doc/wsug_src/images/toolbar/x-capture-start.png diff --git a/docbook/wsug_src/images/toolbar/x-capture-stop.png b/doc/wsug_src/images/toolbar/x-capture-stop.png similarity index 100% rename from docbook/wsug_src/images/toolbar/x-capture-stop.png rename to doc/wsug_src/images/toolbar/x-capture-stop.png diff --git a/docbook/wsug_src/images/toolbar/x-colorize-packets.png b/doc/wsug_src/images/toolbar/x-colorize-packets.png similarity index 100% rename from docbook/wsug_src/images/toolbar/x-colorize-packets.png rename to doc/wsug_src/images/toolbar/x-colorize-packets.png diff --git a/docbook/wsug_src/images/toolbar/x-resize-columns.png b/doc/wsug_src/images/toolbar/x-resize-columns.png similarity index 100% rename from docbook/wsug_src/images/toolbar/x-resize-columns.png rename to doc/wsug_src/images/toolbar/x-resize-columns.png diff --git a/docbook/wsug_src/images/toolbar/x-stay-last.png b/doc/wsug_src/images/toolbar/x-stay-last.png similarity index 100% rename from docbook/wsug_src/images/toolbar/x-stay-last.png rename to doc/wsug_src/images/toolbar/x-stay-last.png diff --git a/docbook/wsug_src/images/toolbar/zoom-in.png b/doc/wsug_src/images/toolbar/zoom-in.png similarity index 100% rename from docbook/wsug_src/images/toolbar/zoom-in.png rename to doc/wsug_src/images/toolbar/zoom-in.png diff --git a/docbook/wsug_src/images/toolbar/zoom-original.png b/doc/wsug_src/images/toolbar/zoom-original.png similarity index 100% rename from docbook/wsug_src/images/toolbar/zoom-original.png rename to doc/wsug_src/images/toolbar/zoom-original.png diff --git a/docbook/wsug_src/images/toolbar/zoom-out.png b/doc/wsug_src/images/toolbar/zoom-out.png similarity index 100% rename from docbook/wsug_src/images/toolbar/zoom-out.png rename to doc/wsug_src/images/toolbar/zoom-out.png diff --git a/docbook/wsug_src/images/warning.svg b/doc/wsug_src/images/warning.svg similarity index 100% rename from docbook/wsug_src/images/warning.svg rename to doc/wsug_src/images/warning.svg diff --git a/docbook/wsug_src/images/ws-about-codecs.png b/doc/wsug_src/images/ws-about-codecs.png similarity index 100% rename from docbook/wsug_src/images/ws-about-codecs.png rename to doc/wsug_src/images/ws-about-codecs.png diff --git a/docbook/wsug_src/images/ws-analyze-menu.png b/doc/wsug_src/images/ws-analyze-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-analyze-menu.png rename to doc/wsug_src/images/ws-analyze-menu.png diff --git a/docbook/wsug_src/images/ws-asap-statistics.png b/doc/wsug_src/images/ws-asap-statistics.png similarity index 100% rename from docbook/wsug_src/images/ws-asap-statistics.png rename to doc/wsug_src/images/ws-asap-statistics.png diff --git a/docbook/wsug_src/images/ws-bluetooth-devices.png b/doc/wsug_src/images/ws-bluetooth-devices.png similarity index 100% rename from docbook/wsug_src/images/ws-bluetooth-devices.png rename to doc/wsug_src/images/ws-bluetooth-devices.png diff --git a/docbook/wsug_src/images/ws-bt-hci-summary.png b/doc/wsug_src/images/ws-bt-hci-summary.png similarity index 100% rename from docbook/wsug_src/images/ws-bt-hci-summary.png rename to doc/wsug_src/images/ws-bt-hci-summary.png diff --git a/docbook/wsug_src/images/ws-bytes-pane-popup-menu.png b/doc/wsug_src/images/ws-bytes-pane-popup-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-bytes-pane-popup-menu.png rename to doc/wsug_src/images/ws-bytes-pane-popup-menu.png diff --git a/docbook/wsug_src/images/ws-bytes-pane-tabs.png b/doc/wsug_src/images/ws-bytes-pane-tabs.png similarity index 100% rename from docbook/wsug_src/images/ws-bytes-pane-tabs.png rename to doc/wsug_src/images/ws-bytes-pane-tabs.png diff --git a/docbook/wsug_src/images/ws-bytes-pane.png b/doc/wsug_src/images/ws-bytes-pane.png similarity index 100% rename from docbook/wsug_src/images/ws-bytes-pane.png rename to doc/wsug_src/images/ws-bytes-pane.png diff --git a/docbook/wsug_src/images/ws-calcappprotocol-statistics.png b/doc/wsug_src/images/ws-calcappprotocol-statistics.png similarity index 100% rename from docbook/wsug_src/images/ws-calcappprotocol-statistics.png rename to doc/wsug_src/images/ws-calcappprotocol-statistics.png diff --git a/docbook/wsug_src/images/ws-capture-file-properties.png b/doc/wsug_src/images/ws-capture-file-properties.png similarity index 100% rename from docbook/wsug_src/images/ws-capture-file-properties.png rename to doc/wsug_src/images/ws-capture-file-properties.png diff --git a/docbook/wsug_src/images/ws-capture-info.png b/doc/wsug_src/images/ws-capture-info.png similarity index 100% rename from docbook/wsug_src/images/ws-capture-info.png rename to doc/wsug_src/images/ws-capture-info.png diff --git a/docbook/wsug_src/images/ws-capture-interfaces-main-macos.png b/doc/wsug_src/images/ws-capture-interfaces-main-macos.png similarity index 100% rename from docbook/wsug_src/images/ws-capture-interfaces-main-macos.png rename to doc/wsug_src/images/ws-capture-interfaces-main-macos.png diff --git a/docbook/wsug_src/images/ws-capture-interfaces-main-win32.png b/doc/wsug_src/images/ws-capture-interfaces-main-win32.png similarity index 100% rename from docbook/wsug_src/images/ws-capture-interfaces-main-win32.png rename to doc/wsug_src/images/ws-capture-interfaces-main-win32.png diff --git a/docbook/wsug_src/images/ws-capture-menu.png b/doc/wsug_src/images/ws-capture-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-capture-menu.png rename to doc/wsug_src/images/ws-capture-menu.png diff --git a/docbook/wsug_src/images/ws-capture-options-compile-selected-bpfs.png b/doc/wsug_src/images/ws-capture-options-compile-selected-bpfs.png similarity index 100% rename from docbook/wsug_src/images/ws-capture-options-compile-selected-bpfs.png rename to doc/wsug_src/images/ws-capture-options-compile-selected-bpfs.png diff --git a/docbook/wsug_src/images/ws-capture-options-options.png b/doc/wsug_src/images/ws-capture-options-options.png similarity index 100% rename from docbook/wsug_src/images/ws-capture-options-options.png rename to doc/wsug_src/images/ws-capture-options-options.png diff --git a/docbook/wsug_src/images/ws-capture-options-output.png b/doc/wsug_src/images/ws-capture-options-output.png similarity index 100% rename from docbook/wsug_src/images/ws-capture-options-output.png rename to doc/wsug_src/images/ws-capture-options-output.png diff --git a/docbook/wsug_src/images/ws-capture-options.png b/doc/wsug_src/images/ws-capture-options.png similarity index 100% rename from docbook/wsug_src/images/ws-capture-options.png rename to doc/wsug_src/images/ws-capture-options.png diff --git a/docbook/wsug_src/images/ws-choose-color-rule.png b/doc/wsug_src/images/ws-choose-color-rule.png similarity index 100% rename from docbook/wsug_src/images/ws-choose-color-rule.png rename to doc/wsug_src/images/ws-choose-color-rule.png diff --git a/docbook/wsug_src/images/ws-coloring-fields.png b/doc/wsug_src/images/ws-coloring-fields.png similarity index 100% rename from docbook/wsug_src/images/ws-coloring-fields.png rename to doc/wsug_src/images/ws-coloring-fields.png diff --git a/docbook/wsug_src/images/ws-coloring-rules-dialog.png b/doc/wsug_src/images/ws-coloring-rules-dialog.png similarity index 100% rename from docbook/wsug_src/images/ws-coloring-rules-dialog.png rename to doc/wsug_src/images/ws-coloring-rules-dialog.png diff --git a/docbook/wsug_src/images/ws-column-header-popup-menu.png b/doc/wsug_src/images/ws-column-header-popup-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-column-header-popup-menu.png rename to doc/wsug_src/images/ws-column-header-popup-menu.png diff --git a/docbook/wsug_src/images/ws-csp-statistics.png b/doc/wsug_src/images/ws-csp-statistics.png similarity index 100% rename from docbook/wsug_src/images/ws-csp-statistics.png rename to doc/wsug_src/images/ws-csp-statistics.png diff --git a/docbook/wsug_src/images/ws-decode-as.png b/doc/wsug_src/images/ws-decode-as.png similarity index 100% rename from docbook/wsug_src/images/ws-decode-as.png rename to doc/wsug_src/images/ws-decode-as.png diff --git a/docbook/wsug_src/images/ws-details-pane-popup-menu.png b/doc/wsug_src/images/ws-details-pane-popup-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-details-pane-popup-menu.png rename to doc/wsug_src/images/ws-details-pane-popup-menu.png diff --git a/docbook/wsug_src/images/ws-details-pane.png b/doc/wsug_src/images/ws-details-pane.png similarity index 100% rename from docbook/wsug_src/images/ws-details-pane.png rename to doc/wsug_src/images/ws-details-pane.png diff --git a/docbook/wsug_src/images/ws-diagram-pane-popup-menu.png b/doc/wsug_src/images/ws-diagram-pane-popup-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-diagram-pane-popup-menu.png rename to doc/wsug_src/images/ws-diagram-pane-popup-menu.png diff --git a/docbook/wsug_src/images/ws-diagram-pane.png b/doc/wsug_src/images/ws-diagram-pane.png similarity index 100% rename from docbook/wsug_src/images/ws-diagram-pane.png rename to doc/wsug_src/images/ws-diagram-pane.png diff --git a/docbook/wsug_src/images/ws-display-filter-tcp.png b/doc/wsug_src/images/ws-display-filter-tcp.png similarity index 100% rename from docbook/wsug_src/images/ws-display-filter-tcp.png rename to doc/wsug_src/images/ws-display-filter-tcp.png diff --git a/docbook/wsug_src/images/ws-dns.png b/doc/wsug_src/images/ws-dns.png similarity index 100% rename from docbook/wsug_src/images/ws-dns.png rename to doc/wsug_src/images/ws-dns.png diff --git a/docbook/wsug_src/images/ws-edit-menu.png b/doc/wsug_src/images/ws-edit-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-edit-menu.png rename to doc/wsug_src/images/ws-edit-menu.png diff --git a/docbook/wsug_src/images/ws-enabled-protocols.png b/doc/wsug_src/images/ws-enabled-protocols.png similarity index 100% rename from docbook/wsug_src/images/ws-enabled-protocols.png rename to doc/wsug_src/images/ws-enabled-protocols.png diff --git a/docbook/wsug_src/images/ws-enrp-statistics.png b/doc/wsug_src/images/ws-enrp-statistics.png similarity index 100% rename from docbook/wsug_src/images/ws-enrp-statistics.png rename to doc/wsug_src/images/ws-enrp-statistics.png diff --git a/docbook/wsug_src/images/ws-expert-colored-tree.png b/doc/wsug_src/images/ws-expert-colored-tree.png similarity index 100% rename from docbook/wsug_src/images/ws-expert-colored-tree.png rename to doc/wsug_src/images/ws-expert-colored-tree.png diff --git a/docbook/wsug_src/images/ws-expert-column.png b/doc/wsug_src/images/ws-expert-column.png similarity index 100% rename from docbook/wsug_src/images/ws-expert-column.png rename to doc/wsug_src/images/ws-expert-column.png diff --git a/docbook/wsug_src/images/ws-expert-information.png b/doc/wsug_src/images/ws-expert-information.png similarity index 100% rename from docbook/wsug_src/images/ws-expert-information.png rename to doc/wsug_src/images/ws-expert-information.png diff --git a/docbook/wsug_src/images/ws-export-objects.png b/doc/wsug_src/images/ws-export-objects.png similarity index 100% rename from docbook/wsug_src/images/ws-export-objects.png rename to doc/wsug_src/images/ws-export-objects.png diff --git a/docbook/wsug_src/images/ws-export-packet-dissections.png b/doc/wsug_src/images/ws-export-packet-dissections.png similarity index 100% rename from docbook/wsug_src/images/ws-export-packet-dissections.png rename to doc/wsug_src/images/ws-export-packet-dissections.png diff --git a/docbook/wsug_src/images/ws-export-pdus-to-file.png b/doc/wsug_src/images/ws-export-pdus-to-file.png similarity index 100% rename from docbook/wsug_src/images/ws-export-pdus-to-file.png rename to doc/wsug_src/images/ws-export-pdus-to-file.png diff --git a/docbook/wsug_src/images/ws-export-selected.png b/doc/wsug_src/images/ws-export-selected.png similarity index 100% rename from docbook/wsug_src/images/ws-export-selected.png rename to doc/wsug_src/images/ws-export-selected.png diff --git a/docbook/wsug_src/images/ws-export-specified-packets.png b/doc/wsug_src/images/ws-export-specified-packets.png similarity index 100% rename from docbook/wsug_src/images/ws-export-specified-packets.png rename to doc/wsug_src/images/ws-export-specified-packets.png diff --git a/docbook/wsug_src/images/ws-fgp-statistics.png b/doc/wsug_src/images/ws-fgp-statistics.png similarity index 100% rename from docbook/wsug_src/images/ws-fgp-statistics.png rename to doc/wsug_src/images/ws-fgp-statistics.png diff --git a/docbook/wsug_src/images/ws-file-import-regex.png b/doc/wsug_src/images/ws-file-import-regex.png similarity index 100% rename from docbook/wsug_src/images/ws-file-import-regex.png rename to doc/wsug_src/images/ws-file-import-regex.png diff --git a/docbook/wsug_src/images/ws-file-import.png b/doc/wsug_src/images/ws-file-import.png similarity index 100% rename from docbook/wsug_src/images/ws-file-import.png rename to doc/wsug_src/images/ws-file-import.png diff --git a/docbook/wsug_src/images/ws-file-menu.png b/doc/wsug_src/images/ws-file-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-file-menu.png rename to doc/wsug_src/images/ws-file-menu.png diff --git a/docbook/wsug_src/images/ws-file-set-dialog.png b/doc/wsug_src/images/ws-file-set-dialog.png similarity index 100% rename from docbook/wsug_src/images/ws-file-set-dialog.png rename to doc/wsug_src/images/ws-file-set-dialog.png diff --git a/docbook/wsug_src/images/ws-filter-add-expression.png b/doc/wsug_src/images/ws-filter-add-expression.png similarity index 100% rename from docbook/wsug_src/images/ws-filter-add-expression.png rename to doc/wsug_src/images/ws-filter-add-expression.png diff --git a/docbook/wsug_src/images/ws-filter-macros.png b/doc/wsug_src/images/ws-filter-macros.png similarity index 100% rename from docbook/wsug_src/images/ws-filter-macros.png rename to doc/wsug_src/images/ws-filter-macros.png diff --git a/docbook/wsug_src/images/ws-filter-toolbar.png b/doc/wsug_src/images/ws-filter-toolbar.png similarity index 100% rename from docbook/wsug_src/images/ws-filter-toolbar.png rename to doc/wsug_src/images/ws-filter-toolbar.png diff --git a/docbook/wsug_src/images/ws-filters.png b/doc/wsug_src/images/ws-filters.png similarity index 100% rename from docbook/wsug_src/images/ws-filters.png rename to doc/wsug_src/images/ws-filters.png diff --git a/docbook/wsug_src/images/ws-find-packet.png b/doc/wsug_src/images/ws-find-packet.png similarity index 100% rename from docbook/wsug_src/images/ws-find-packet.png rename to doc/wsug_src/images/ws-find-packet.png diff --git a/docbook/wsug_src/images/ws-flow-graph.png b/doc/wsug_src/images/ws-flow-graph.png similarity index 100% rename from docbook/wsug_src/images/ws-flow-graph.png rename to doc/wsug_src/images/ws-flow-graph.png diff --git a/docbook/wsug_src/images/ws-follow-http2-stream.png b/doc/wsug_src/images/ws-follow-http2-stream.png similarity index 100% rename from docbook/wsug_src/images/ws-follow-http2-stream.png rename to doc/wsug_src/images/ws-follow-http2-stream.png diff --git a/docbook/wsug_src/images/ws-follow-sip-stream.png b/doc/wsug_src/images/ws-follow-sip-stream.png similarity index 100% rename from docbook/wsug_src/images/ws-follow-sip-stream.png rename to doc/wsug_src/images/ws-follow-sip-stream.png diff --git a/docbook/wsug_src/images/ws-follow-stream.png b/doc/wsug_src/images/ws-follow-stream.png similarity index 100% rename from docbook/wsug_src/images/ws-follow-stream.png rename to doc/wsug_src/images/ws-follow-stream.png diff --git a/docbook/wsug_src/images/ws-go-menu.png b/doc/wsug_src/images/ws-go-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-go-menu.png rename to doc/wsug_src/images/ws-go-menu.png diff --git a/docbook/wsug_src/images/ws-goto-packet.png b/doc/wsug_src/images/ws-goto-packet.png similarity index 100% rename from docbook/wsug_src/images/ws-goto-packet.png rename to doc/wsug_src/images/ws-goto-packet.png diff --git a/docbook/wsug_src/images/ws-gui-config-profiles.png b/doc/wsug_src/images/ws-gui-config-profiles.png similarity index 100% rename from docbook/wsug_src/images/ws-gui-config-profiles.png rename to doc/wsug_src/images/ws-gui-config-profiles.png diff --git a/docbook/wsug_src/images/ws-help-menu.png b/doc/wsug_src/images/ws-help-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-help-menu.png rename to doc/wsug_src/images/ws-help-menu.png diff --git a/docbook/wsug_src/images/ws-list-pane.png b/doc/wsug_src/images/ws-list-pane.png similarity index 100% rename from docbook/wsug_src/images/ws-list-pane.png rename to doc/wsug_src/images/ws-list-pane.png diff --git a/docbook/wsug_src/images/ws-main-toolbar.png b/doc/wsug_src/images/ws-main-toolbar.png similarity index 100% rename from docbook/wsug_src/images/ws-main-toolbar.png rename to doc/wsug_src/images/ws-main-toolbar.png diff --git a/docbook/wsug_src/images/ws-main.png b/doc/wsug_src/images/ws-main.png similarity index 100% rename from docbook/wsug_src/images/ws-main.png rename to doc/wsug_src/images/ws-main.png diff --git a/docbook/wsug_src/images/ws-manage-interfaces.png b/doc/wsug_src/images/ws-manage-interfaces.png similarity index 100% rename from docbook/wsug_src/images/ws-manage-interfaces.png rename to doc/wsug_src/images/ws-manage-interfaces.png diff --git a/docbook/wsug_src/images/ws-mate-analysis.png b/doc/wsug_src/images/ws-mate-analysis.png similarity index 100% rename from docbook/wsug_src/images/ws-mate-analysis.png rename to doc/wsug_src/images/ws-mate-analysis.png diff --git a/docbook/wsug_src/images/ws-mate-dns_pane.png b/doc/wsug_src/images/ws-mate-dns_pane.png similarity index 100% rename from docbook/wsug_src/images/ws-mate-dns_pane.png rename to doc/wsug_src/images/ws-mate-dns_pane.png diff --git a/docbook/wsug_src/images/ws-mate-dns_pdu.png b/doc/wsug_src/images/ws-mate-dns_pdu.png similarity index 100% rename from docbook/wsug_src/images/ws-mate-dns_pdu.png rename to doc/wsug_src/images/ws-mate-dns_pdu.png diff --git a/docbook/wsug_src/images/ws-mate-ftp_over_gre.png b/doc/wsug_src/images/ws-mate-ftp_over_gre.png similarity index 100% rename from docbook/wsug_src/images/ws-mate-ftp_over_gre.png rename to doc/wsug_src/images/ws-mate-ftp_over_gre.png diff --git a/docbook/wsug_src/images/ws-mate-gop_analysis.png b/doc/wsug_src/images/ws-mate-gop_analysis.png similarity index 100% rename from docbook/wsug_src/images/ws-mate-gop_analysis.png rename to doc/wsug_src/images/ws-mate-gop_analysis.png diff --git a/docbook/wsug_src/images/ws-mate-isup_over_mtp3_over_ip.png b/doc/wsug_src/images/ws-mate-isup_over_mtp3_over_ip.png similarity index 100% rename from docbook/wsug_src/images/ws-mate-isup_over_mtp3_over_ip.png rename to doc/wsug_src/images/ws-mate-isup_over_mtp3_over_ip.png diff --git a/docbook/wsug_src/images/ws-mate-mmse_over_http.png b/doc/wsug_src/images/ws-mate-mmse_over_http.png similarity index 100% rename from docbook/wsug_src/images/ws-mate-mmse_over_http.png rename to doc/wsug_src/images/ws-mate-mmse_over_http.png diff --git a/docbook/wsug_src/images/ws-mate-pdu_analysis.png b/doc/wsug_src/images/ws-mate-pdu_analysis.png similarity index 100% rename from docbook/wsug_src/images/ws-mate-pdu_analysis.png rename to doc/wsug_src/images/ws-mate-pdu_analysis.png diff --git a/docbook/wsug_src/images/ws-mate-tcp-output.png b/doc/wsug_src/images/ws-mate-tcp-output.png similarity index 100% rename from docbook/wsug_src/images/ws-mate-tcp-output.png rename to doc/wsug_src/images/ws-mate-tcp-output.png diff --git a/docbook/wsug_src/images/ws-mate-transform.png b/doc/wsug_src/images/ws-mate-transform.png similarity index 100% rename from docbook/wsug_src/images/ws-mate-transform.png rename to doc/wsug_src/images/ws-mate-transform.png diff --git a/docbook/wsug_src/images/ws-menu.png b/doc/wsug_src/images/ws-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-menu.png rename to doc/wsug_src/images/ws-menu.png diff --git a/docbook/wsug_src/images/ws-merge-qt5.png b/doc/wsug_src/images/ws-merge-qt5.png similarity index 100% rename from docbook/wsug_src/images/ws-merge-qt5.png rename to doc/wsug_src/images/ws-merge-qt5.png diff --git a/docbook/wsug_src/images/ws-merge-win32.png b/doc/wsug_src/images/ws-merge-win32.png similarity index 100% rename from docbook/wsug_src/images/ws-merge-win32.png rename to doc/wsug_src/images/ws-merge-win32.png diff --git a/docbook/wsug_src/images/ws-netperfmeter-statistics.png b/doc/wsug_src/images/ws-netperfmeter-statistics.png similarity index 100% rename from docbook/wsug_src/images/ws-netperfmeter-statistics.png rename to doc/wsug_src/images/ws-netperfmeter-statistics.png diff --git a/docbook/wsug_src/images/ws-open-qt5.png b/doc/wsug_src/images/ws-open-qt5.png similarity index 100% rename from docbook/wsug_src/images/ws-open-qt5.png rename to doc/wsug_src/images/ws-open-qt5.png diff --git a/docbook/wsug_src/images/ws-open-win32.png b/doc/wsug_src/images/ws-open-win32.png similarity index 100% rename from docbook/wsug_src/images/ws-open-win32.png rename to doc/wsug_src/images/ws-open-win32.png diff --git a/docbook/wsug_src/images/ws-packet-format.png b/doc/wsug_src/images/ws-packet-format.png similarity index 100% rename from docbook/wsug_src/images/ws-packet-format.png rename to doc/wsug_src/images/ws-packet-format.png diff --git a/docbook/wsug_src/images/ws-packet-pane-popup-menu.png b/doc/wsug_src/images/ws-packet-pane-popup-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-packet-pane-popup-menu.png rename to doc/wsug_src/images/ws-packet-pane-popup-menu.png diff --git a/docbook/wsug_src/images/ws-packet-range.png b/doc/wsug_src/images/ws-packet-range.png similarity index 100% rename from docbook/wsug_src/images/ws-packet-range.png rename to doc/wsug_src/images/ws-packet-range.png diff --git a/docbook/wsug_src/images/ws-packet-selected.png b/doc/wsug_src/images/ws-packet-selected.png similarity index 100% rename from docbook/wsug_src/images/ws-packet-selected.png rename to doc/wsug_src/images/ws-packet-selected.png diff --git a/docbook/wsug_src/images/ws-packet-sep-win.png b/doc/wsug_src/images/ws-packet-sep-win.png similarity index 100% rename from docbook/wsug_src/images/ws-packet-sep-win.png rename to doc/wsug_src/images/ws-packet-sep-win.png diff --git a/docbook/wsug_src/images/ws-pingpongprotocol-statistics.png b/doc/wsug_src/images/ws-pingpongprotocol-statistics.png similarity index 100% rename from docbook/wsug_src/images/ws-pingpongprotocol-statistics.png rename to doc/wsug_src/images/ws-pingpongprotocol-statistics.png diff --git a/docbook/wsug_src/images/ws-pref-advanced.png b/doc/wsug_src/images/ws-pref-advanced.png similarity index 100% rename from docbook/wsug_src/images/ws-pref-advanced.png rename to doc/wsug_src/images/ws-pref-advanced.png diff --git a/docbook/wsug_src/images/ws-pref-appearance-columns.png b/doc/wsug_src/images/ws-pref-appearance-columns.png similarity index 100% rename from docbook/wsug_src/images/ws-pref-appearance-columns.png rename to doc/wsug_src/images/ws-pref-appearance-columns.png diff --git a/docbook/wsug_src/images/ws-pref-appearance-fonts-and-colors.png b/doc/wsug_src/images/ws-pref-appearance-fonts-and-colors.png similarity index 100% rename from docbook/wsug_src/images/ws-pref-appearance-fonts-and-colors.png rename to doc/wsug_src/images/ws-pref-appearance-fonts-and-colors.png diff --git a/docbook/wsug_src/images/ws-pref-appearance-layout.png b/doc/wsug_src/images/ws-pref-appearance-layout.png similarity index 100% rename from docbook/wsug_src/images/ws-pref-appearance-layout.png rename to doc/wsug_src/images/ws-pref-appearance-layout.png diff --git a/docbook/wsug_src/images/ws-pref-appearance.png b/doc/wsug_src/images/ws-pref-appearance.png similarity index 100% rename from docbook/wsug_src/images/ws-pref-appearance.png rename to doc/wsug_src/images/ws-pref-appearance.png diff --git a/docbook/wsug_src/images/ws-pref-capture.png b/doc/wsug_src/images/ws-pref-capture.png similarity index 100% rename from docbook/wsug_src/images/ws-pref-capture.png rename to doc/wsug_src/images/ws-pref-capture.png diff --git a/docbook/wsug_src/images/ws-pref-expert.png b/doc/wsug_src/images/ws-pref-expert.png similarity index 100% rename from docbook/wsug_src/images/ws-pref-expert.png rename to doc/wsug_src/images/ws-pref-expert.png diff --git a/docbook/wsug_src/images/ws-pref-filter-buttons.png b/doc/wsug_src/images/ws-pref-filter-buttons.png similarity index 100% rename from docbook/wsug_src/images/ws-pref-filter-buttons.png rename to doc/wsug_src/images/ws-pref-filter-buttons.png diff --git a/docbook/wsug_src/images/ws-pref-name-resolution.png b/doc/wsug_src/images/ws-pref-name-resolution.png similarity index 100% rename from docbook/wsug_src/images/ws-pref-name-resolution.png rename to doc/wsug_src/images/ws-pref-name-resolution.png diff --git a/docbook/wsug_src/images/ws-pref-protocols.png b/doc/wsug_src/images/ws-pref-protocols.png similarity index 100% rename from docbook/wsug_src/images/ws-pref-protocols.png rename to doc/wsug_src/images/ws-pref-protocols.png diff --git a/docbook/wsug_src/images/ws-pref-rsa-keys.png b/doc/wsug_src/images/ws-pref-rsa-keys.png similarity index 100% rename from docbook/wsug_src/images/ws-pref-rsa-keys.png rename to doc/wsug_src/images/ws-pref-rsa-keys.png diff --git a/docbook/wsug_src/images/ws-pref-statistics.png b/doc/wsug_src/images/ws-pref-statistics.png similarity index 100% rename from docbook/wsug_src/images/ws-pref-statistics.png rename to doc/wsug_src/images/ws-pref-statistics.png diff --git a/docbook/wsug_src/images/ws-print.png b/doc/wsug_src/images/ws-print.png similarity index 100% rename from docbook/wsug_src/images/ws-print.png rename to doc/wsug_src/images/ws-print.png diff --git a/docbook/wsug_src/images/ws-resolved-addr.png b/doc/wsug_src/images/ws-resolved-addr.png similarity index 100% rename from docbook/wsug_src/images/ws-resolved-addr.png rename to doc/wsug_src/images/ws-resolved-addr.png diff --git a/docbook/wsug_src/images/ws-rlc-graph.png b/doc/wsug_src/images/ws-rlc-graph.png similarity index 100% rename from docbook/wsug_src/images/ws-rlc-graph.png rename to doc/wsug_src/images/ws-rlc-graph.png diff --git a/docbook/wsug_src/images/ws-save-as-qt5.png b/doc/wsug_src/images/ws-save-as-qt5.png similarity index 100% rename from docbook/wsug_src/images/ws-save-as-qt5.png rename to doc/wsug_src/images/ws-save-as-qt5.png diff --git a/docbook/wsug_src/images/ws-save-as-win32.png b/doc/wsug_src/images/ws-save-as-win32.png similarity index 100% rename from docbook/wsug_src/images/ws-save-as-win32.png rename to doc/wsug_src/images/ws-save-as-win32.png diff --git a/docbook/wsug_src/images/ws-sctp-1-association.png b/doc/wsug_src/images/ws-sctp-1-association.png similarity index 100% rename from docbook/wsug_src/images/ws-sctp-1-association.png rename to doc/wsug_src/images/ws-sctp-1-association.png diff --git a/docbook/wsug_src/images/ws-sctp.png b/doc/wsug_src/images/ws-sctp.png similarity index 100% rename from docbook/wsug_src/images/ws-sctp.png rename to doc/wsug_src/images/ws-sctp.png diff --git a/docbook/wsug_src/images/ws-ssp-statistics.png b/doc/wsug_src/images/ws-ssp-statistics.png similarity index 100% rename from docbook/wsug_src/images/ws-ssp-statistics.png rename to doc/wsug_src/images/ws-ssp-statistics.png diff --git a/docbook/wsug_src/images/ws-statistics-menu.png b/doc/wsug_src/images/ws-statistics-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-statistics-menu.png rename to doc/wsug_src/images/ws-statistics-menu.png diff --git a/docbook/wsug_src/images/ws-stats-conversations.png b/doc/wsug_src/images/ws-stats-conversations.png similarity index 100% rename from docbook/wsug_src/images/ws-stats-conversations.png rename to doc/wsug_src/images/ws-stats-conversations.png diff --git a/docbook/wsug_src/images/ws-stats-endpoints.png b/doc/wsug_src/images/ws-stats-endpoints.png similarity index 100% rename from docbook/wsug_src/images/ws-stats-endpoints.png rename to doc/wsug_src/images/ws-stats-endpoints.png diff --git a/docbook/wsug_src/images/ws-stats-hierarchy.png b/doc/wsug_src/images/ws-stats-hierarchy.png similarity index 100% rename from docbook/wsug_src/images/ws-stats-hierarchy.png rename to doc/wsug_src/images/ws-stats-hierarchy.png diff --git a/docbook/wsug_src/images/ws-stats-http-requestsequences.png b/doc/wsug_src/images/ws-stats-http-requestsequences.png similarity index 100% rename from docbook/wsug_src/images/ws-stats-http-requestsequences.png rename to doc/wsug_src/images/ws-stats-http-requestsequences.png diff --git a/docbook/wsug_src/images/ws-stats-iographs.png b/doc/wsug_src/images/ws-stats-iographs.png similarity index 100% rename from docbook/wsug_src/images/ws-stats-iographs.png rename to doc/wsug_src/images/ws-stats-iographs.png diff --git a/docbook/wsug_src/images/ws-stats-lte-mac-traffic.png b/doc/wsug_src/images/ws-stats-lte-mac-traffic.png similarity index 100% rename from docbook/wsug_src/images/ws-stats-lte-mac-traffic.png rename to doc/wsug_src/images/ws-stats-lte-mac-traffic.png diff --git a/docbook/wsug_src/images/ws-stats-lte-rlc-traffic.png b/doc/wsug_src/images/ws-stats-lte-rlc-traffic.png similarity index 100% rename from docbook/wsug_src/images/ws-stats-lte-rlc-traffic.png rename to doc/wsug_src/images/ws-stats-lte-rlc-traffic.png diff --git a/docbook/wsug_src/images/ws-stats-packet-lengths.png b/doc/wsug_src/images/ws-stats-packet-lengths.png similarity index 100% rename from docbook/wsug_src/images/ws-stats-packet-lengths.png rename to doc/wsug_src/images/ws-stats-packet-lengths.png diff --git a/docbook/wsug_src/images/ws-stats-srt-smb2.png b/doc/wsug_src/images/ws-stats-srt-smb2.png similarity index 100% rename from docbook/wsug_src/images/ws-stats-srt-smb2.png rename to doc/wsug_src/images/ws-stats-srt-smb2.png diff --git a/docbook/wsug_src/images/ws-stats-wlan-traffic.png b/doc/wsug_src/images/ws-stats-wlan-traffic.png similarity index 100% rename from docbook/wsug_src/images/ws-stats-wlan-traffic.png rename to doc/wsug_src/images/ws-stats-wlan-traffic.png diff --git a/docbook/wsug_src/images/ws-statusbar-empty.png b/doc/wsug_src/images/ws-statusbar-empty.png similarity index 100% rename from docbook/wsug_src/images/ws-statusbar-empty.png rename to doc/wsug_src/images/ws-statusbar-empty.png diff --git a/docbook/wsug_src/images/ws-statusbar-filter.png b/doc/wsug_src/images/ws-statusbar-filter.png similarity index 100% rename from docbook/wsug_src/images/ws-statusbar-filter.png rename to doc/wsug_src/images/ws-statusbar-filter.png diff --git a/docbook/wsug_src/images/ws-statusbar-loaded.png b/doc/wsug_src/images/ws-statusbar-loaded.png similarity index 100% rename from docbook/wsug_src/images/ws-statusbar-loaded.png rename to doc/wsug_src/images/ws-statusbar-loaded.png diff --git a/docbook/wsug_src/images/ws-statusbar-profile.png b/doc/wsug_src/images/ws-statusbar-profile.png similarity index 100% rename from docbook/wsug_src/images/ws-statusbar-profile.png rename to doc/wsug_src/images/ws-statusbar-profile.png diff --git a/docbook/wsug_src/images/ws-statusbar-selected.png b/doc/wsug_src/images/ws-statusbar-selected.png similarity index 100% rename from docbook/wsug_src/images/ws-statusbar-selected.png rename to doc/wsug_src/images/ws-statusbar-selected.png diff --git a/docbook/wsug_src/images/ws-tcp-analysis.png b/doc/wsug_src/images/ws-tcp-analysis.png similarity index 100% rename from docbook/wsug_src/images/ws-tcp-analysis.png rename to doc/wsug_src/images/ws-tcp-analysis.png diff --git a/docbook/wsug_src/images/ws-tel-playlist.dia b/doc/wsug_src/images/ws-tel-playlist.dia similarity index 100% rename from docbook/wsug_src/images/ws-tel-playlist.dia rename to doc/wsug_src/images/ws-tel-playlist.dia diff --git a/docbook/wsug_src/images/ws-tel-playlist.png b/doc/wsug_src/images/ws-tel-playlist.png similarity index 100% rename from docbook/wsug_src/images/ws-tel-playlist.png rename to doc/wsug_src/images/ws-tel-playlist.png diff --git a/docbook/wsug_src/images/ws-tel-rtp-player_1.png b/doc/wsug_src/images/ws-tel-rtp-player_1.png similarity index 100% rename from docbook/wsug_src/images/ws-tel-rtp-player_1.png rename to doc/wsug_src/images/ws-tel-rtp-player_1.png diff --git a/docbook/wsug_src/images/ws-tel-rtp-player_1.xcf b/doc/wsug_src/images/ws-tel-rtp-player_1.xcf similarity index 100% rename from docbook/wsug_src/images/ws-tel-rtp-player_1.xcf rename to doc/wsug_src/images/ws-tel-rtp-player_1.xcf diff --git a/docbook/wsug_src/images/ws-tel-rtp-player_2.png b/doc/wsug_src/images/ws-tel-rtp-player_2.png similarity index 100% rename from docbook/wsug_src/images/ws-tel-rtp-player_2.png rename to doc/wsug_src/images/ws-tel-rtp-player_2.png diff --git a/docbook/wsug_src/images/ws-tel-rtp-player_2.xcf b/doc/wsug_src/images/ws-tel-rtp-player_2.xcf similarity index 100% rename from docbook/wsug_src/images/ws-tel-rtp-player_2.xcf rename to doc/wsug_src/images/ws-tel-rtp-player_2.xcf diff --git a/docbook/wsug_src/images/ws-tel-rtp-player_3.png b/doc/wsug_src/images/ws-tel-rtp-player_3.png similarity index 100% rename from docbook/wsug_src/images/ws-tel-rtp-player_3.png rename to doc/wsug_src/images/ws-tel-rtp-player_3.png diff --git a/docbook/wsug_src/images/ws-tel-rtp-player_button.png b/doc/wsug_src/images/ws-tel-rtp-player_button.png similarity index 100% rename from docbook/wsug_src/images/ws-tel-rtp-player_button.png rename to doc/wsug_src/images/ws-tel-rtp-player_button.png diff --git a/docbook/wsug_src/images/ws-tel-rtp-streams.png b/doc/wsug_src/images/ws-tel-rtp-streams.png similarity index 100% rename from docbook/wsug_src/images/ws-tel-rtp-streams.png rename to doc/wsug_src/images/ws-tel-rtp-streams.png diff --git a/docbook/wsug_src/images/ws-tel-rtpstream-analysis_1.png b/doc/wsug_src/images/ws-tel-rtpstream-analysis_1.png similarity index 100% rename from docbook/wsug_src/images/ws-tel-rtpstream-analysis_1.png rename to doc/wsug_src/images/ws-tel-rtpstream-analysis_1.png diff --git a/docbook/wsug_src/images/ws-tel-rtpstream-analysis_2.png b/doc/wsug_src/images/ws-tel-rtpstream-analysis_2.png similarity index 100% rename from docbook/wsug_src/images/ws-tel-rtpstream-analysis_2.png rename to doc/wsug_src/images/ws-tel-rtpstream-analysis_2.png diff --git a/docbook/wsug_src/images/ws-tel-rtpstream-analysis_3.png b/doc/wsug_src/images/ws-tel-rtpstream-analysis_3.png similarity index 100% rename from docbook/wsug_src/images/ws-tel-rtpstream-analysis_3.png rename to doc/wsug_src/images/ws-tel-rtpstream-analysis_3.png diff --git a/docbook/wsug_src/images/ws-tel-seq-dialog.png b/doc/wsug_src/images/ws-tel-seq-dialog.png similarity index 100% rename from docbook/wsug_src/images/ws-tel-seq-dialog.png rename to doc/wsug_src/images/ws-tel-seq-dialog.png diff --git a/docbook/wsug_src/images/ws-tel-voip-calls.png b/doc/wsug_src/images/ws-tel-voip-calls.png similarity index 100% rename from docbook/wsug_src/images/ws-tel-voip-calls.png rename to doc/wsug_src/images/ws-tel-voip-calls.png diff --git a/docbook/wsug_src/images/ws-telephony-menu.png b/doc/wsug_src/images/ws-telephony-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-telephony-menu.png rename to doc/wsug_src/images/ws-telephony-menu.png diff --git a/docbook/wsug_src/images/ws-time-reference.png b/doc/wsug_src/images/ws-time-reference.png similarity index 100% rename from docbook/wsug_src/images/ws-time-reference.png rename to doc/wsug_src/images/ws-time-reference.png diff --git a/docbook/wsug_src/images/ws-time-shift-details.png b/doc/wsug_src/images/ws-time-shift-details.png similarity index 100% rename from docbook/wsug_src/images/ws-time-shift-details.png rename to doc/wsug_src/images/ws-time-shift-details.png diff --git a/docbook/wsug_src/images/ws-time-shift.png b/doc/wsug_src/images/ws-time-shift.png similarity index 100% rename from docbook/wsug_src/images/ws-time-shift.png rename to doc/wsug_src/images/ws-time-shift.png diff --git a/docbook/wsug_src/images/ws-tls-session-keys.png b/doc/wsug_src/images/ws-tls-session-keys.png similarity index 100% rename from docbook/wsug_src/images/ws-tls-session-keys.png rename to doc/wsug_src/images/ws-tls-session-keys.png diff --git a/docbook/wsug_src/images/ws-tools-menu.png b/doc/wsug_src/images/ws-tools-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-tools-menu.png rename to doc/wsug_src/images/ws-tools-menu.png diff --git a/docbook/wsug_src/images/ws-udp-multicast-stream.png b/doc/wsug_src/images/ws-udp-multicast-stream.png similarity index 100% rename from docbook/wsug_src/images/ws-udp-multicast-stream.png rename to doc/wsug_src/images/ws-udp-multicast-stream.png diff --git a/docbook/wsug_src/images/ws-user-guide-cover.png b/doc/wsug_src/images/ws-user-guide-cover.png similarity index 100% rename from docbook/wsug_src/images/ws-user-guide-cover.png rename to doc/wsug_src/images/ws-user-guide-cover.png diff --git a/docbook/wsug_src/images/ws-view-menu.png b/doc/wsug_src/images/ws-view-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-view-menu.png rename to doc/wsug_src/images/ws-view-menu.png diff --git a/docbook/wsug_src/images/ws-wireless-ieee-80211-pref.png b/doc/wsug_src/images/ws-wireless-ieee-80211-pref.png similarity index 100% rename from docbook/wsug_src/images/ws-wireless-ieee-80211-pref.png rename to doc/wsug_src/images/ws-wireless-ieee-80211-pref.png diff --git a/docbook/wsug_src/images/ws-wireless-key-examples.png b/doc/wsug_src/images/ws-wireless-key-examples.png similarity index 100% rename from docbook/wsug_src/images/ws-wireless-key-examples.png rename to doc/wsug_src/images/ws-wireless-key-examples.png diff --git a/docbook/wsug_src/images/ws-wireless-key-type.png b/doc/wsug_src/images/ws-wireless-key-type.png similarity index 100% rename from docbook/wsug_src/images/ws-wireless-key-type.png rename to doc/wsug_src/images/ws-wireless-key-type.png diff --git a/docbook/wsug_src/images/ws-wireless-menu.png b/doc/wsug_src/images/ws-wireless-menu.png similarity index 100% rename from docbook/wsug_src/images/ws-wireless-menu.png rename to doc/wsug_src/images/ws-wireless-menu.png diff --git a/docbook/wsug_src/mergecap-h.txt b/doc/wsug_src/mergecap-h.txt similarity index 100% rename from docbook/wsug_src/mergecap-h.txt rename to doc/wsug_src/mergecap-h.txt diff --git a/docbook/wsug_src/rawshark-h.txt b/doc/wsug_src/rawshark-h.txt similarity index 100% rename from docbook/wsug_src/rawshark-h.txt rename to doc/wsug_src/rawshark-h.txt diff --git a/docbook/wsug_src/reordercap-h.txt b/doc/wsug_src/reordercap-h.txt similarity index 100% rename from docbook/wsug_src/reordercap-h.txt rename to doc/wsug_src/reordercap-h.txt diff --git a/docbook/wsug_src/text2pcap-h.txt b/doc/wsug_src/text2pcap-h.txt similarity index 100% rename from docbook/wsug_src/text2pcap-h.txt rename to doc/wsug_src/text2pcap-h.txt diff --git a/docbook/wsug_src/tshark-h.txt b/doc/wsug_src/tshark-h.txt similarity index 100% rename from docbook/wsug_src/tshark-h.txt rename to doc/wsug_src/tshark-h.txt diff --git a/docbook/wsug_src/user-guide-docinfo.xml b/doc/wsug_src/user-guide-docinfo.xml similarity index 100% rename from docbook/wsug_src/user-guide-docinfo.xml rename to doc/wsug_src/user-guide-docinfo.xml diff --git a/docbook/wsug_src/user-guide.adoc b/doc/wsug_src/user-guide.adoc similarity index 100% rename from docbook/wsug_src/user-guide.adoc rename to doc/wsug_src/user-guide.adoc diff --git a/docbook/wsug_src/wireshark-h.txt b/doc/wsug_src/wireshark-h.txt similarity index 100% rename from docbook/wsug_src/wireshark-h.txt rename to doc/wsug_src/wireshark-h.txt diff --git a/docbook/wsug_src/wsug_advanced.adoc b/doc/wsug_src/wsug_advanced.adoc similarity index 100% rename from docbook/wsug_src/wsug_advanced.adoc rename to doc/wsug_src/wsug_advanced.adoc diff --git a/docbook/wsug_src/wsug_build_install.adoc b/doc/wsug_src/wsug_build_install.adoc similarity index 100% rename from docbook/wsug_src/wsug_build_install.adoc rename to doc/wsug_src/wsug_build_install.adoc diff --git a/docbook/wsug_src/wsug_capture.adoc b/doc/wsug_src/wsug_capture.adoc similarity index 100% rename from docbook/wsug_src/wsug_capture.adoc rename to doc/wsug_src/wsug_capture.adoc diff --git a/docbook/wsug_src/wsug_customize.adoc b/doc/wsug_src/wsug_customize.adoc similarity index 100% rename from docbook/wsug_src/wsug_customize.adoc rename to doc/wsug_src/wsug_customize.adoc diff --git a/docbook/wsug_src/wsug_files.adoc b/doc/wsug_src/wsug_files.adoc similarity index 100% rename from docbook/wsug_src/wsug_files.adoc rename to doc/wsug_src/wsug_files.adoc diff --git a/docbook/wsug_src/wsug_howitworks.adoc b/doc/wsug_src/wsug_howitworks.adoc similarity index 100% rename from docbook/wsug_src/wsug_howitworks.adoc rename to doc/wsug_src/wsug_howitworks.adoc diff --git a/docbook/wsug_src/wsug_introduction.adoc b/doc/wsug_src/wsug_introduction.adoc similarity index 100% rename from docbook/wsug_src/wsug_introduction.adoc rename to doc/wsug_src/wsug_introduction.adoc diff --git a/docbook/wsug_src/wsug_io.adoc b/doc/wsug_src/wsug_io.adoc similarity index 100% rename from docbook/wsug_src/wsug_io.adoc rename to doc/wsug_src/wsug_io.adoc diff --git a/docbook/wsug_src/wsug_mate.adoc b/doc/wsug_src/wsug_mate.adoc similarity index 100% rename from docbook/wsug_src/wsug_mate.adoc rename to doc/wsug_src/wsug_mate.adoc diff --git a/docbook/wsug_src/wsug_messages.adoc b/doc/wsug_src/wsug_messages.adoc similarity index 100% rename from docbook/wsug_src/wsug_messages.adoc rename to doc/wsug_src/wsug_messages.adoc diff --git a/docbook/wsug_src/wsug_preface.adoc b/doc/wsug_src/wsug_preface.adoc similarity index 100% rename from docbook/wsug_src/wsug_preface.adoc rename to doc/wsug_src/wsug_preface.adoc diff --git a/docbook/wsug_src/wsug_protocols.adoc b/doc/wsug_src/wsug_protocols.adoc similarity index 100% rename from docbook/wsug_src/wsug_protocols.adoc rename to doc/wsug_src/wsug_protocols.adoc diff --git a/docbook/wsug_src/wsug_statistics.adoc b/doc/wsug_src/wsug_statistics.adoc similarity index 100% rename from docbook/wsug_src/wsug_statistics.adoc rename to doc/wsug_src/wsug_statistics.adoc diff --git a/docbook/wsug_src/wsug_telephony.adoc b/doc/wsug_src/wsug_telephony.adoc similarity index 100% rename from docbook/wsug_src/wsug_telephony.adoc rename to doc/wsug_src/wsug_telephony.adoc diff --git a/docbook/wsug_src/wsug_tools.adoc b/doc/wsug_src/wsug_tools.adoc similarity index 100% rename from docbook/wsug_src/wsug_tools.adoc rename to doc/wsug_src/wsug_tools.adoc diff --git a/docbook/wsug_src/wsug_troubleshoot.adoc b/doc/wsug_src/wsug_troubleshoot.adoc similarity index 100% rename from docbook/wsug_src/wsug_troubleshoot.adoc rename to doc/wsug_src/wsug_troubleshoot.adoc diff --git a/docbook/wsug_src/wsug_use.adoc b/doc/wsug_src/wsug_use.adoc similarity index 100% rename from docbook/wsug_src/wsug_use.adoc rename to doc/wsug_src/wsug_use.adoc diff --git a/docbook/wsug_src/wsug_wireless.adoc b/doc/wsug_src/wsug_wireless.adoc similarity index 100% rename from docbook/wsug_src/wsug_wireless.adoc rename to doc/wsug_src/wsug_wireless.adoc diff --git a/docbook/wsug_src/wsug_work.adoc b/doc/wsug_src/wsug_work.adoc similarity index 100% rename from docbook/wsug_src/wsug_work.adoc rename to doc/wsug_src/wsug_work.adoc diff --git a/docbook/CMakeLists.txt b/docbook/CMakeLists.txt deleted file mode 100644 index 54c414a2be..0000000000 --- a/docbook/CMakeLists.txt +++ /dev/null @@ -1,492 +0,0 @@ -# CMakeLists.txt -# -# Wireshark - Network traffic analyzer -# By Gerald Combs -# Copyright 1998 Gerald Combs -# -# SPDX-License-Identifier: GPL-2.0-or-later -# - -# To do: -# - Make the build targets top-level on Windows, similar to the NSIS, -# WiX, and PortableApps targets? - -function(set_docbook_target_properties _target) - set_target_properties(${_target} PROPERTIES - FOLDER "Documentation" - EXCLUDE_FROM_DEFAULT_BUILD True - ) -endfunction(set_docbook_target_properties) - -set(COMMON_FILES - common_src/gpl_appendix.adoc - common_src/typographic_conventions.adoc -) - -set(WSUG_TITLE "Wireshark User's Guide") - -set(WSUG_FILES - wsug_src/wsug_advanced.adoc - wsug_src/wsug_build_install.adoc - wsug_src/wsug_capture.adoc - wsug_src/wsug_customize.adoc - wsug_src/wsug_files.adoc - wsug_src/wsug_howitworks.adoc - wsug_src/wsug_introduction.adoc - wsug_src/wsug_io.adoc - wsug_src/wsug_mate.adoc - wsug_src/wsug_messages.adoc - wsug_src/wsug_preface.adoc - wsug_src/wsug_protocols.adoc - wsug_src/wsug_statistics.adoc - wsug_src/wsug_telephony.adoc - wsug_src/wsug_tools.adoc - wsug_src/wsug_troubleshoot.adoc - wsug_src/wsug_use.adoc - wsug_src/wsug_work.adoc - wsug_src/capinfos-h.txt - wsug_src/dumpcap-h.txt - wsug_src/editcap-F.txt - wsug_src/editcap-T.txt - wsug_src/editcap-h.txt - wsug_src/mergecap-h.txt - wsug_src/rawshark-h.txt - wsug_src/reordercap-h.txt - wsug_src/text2pcap-h.txt - wsug_src/tshark-h.txt - wsug_src/wireshark-h.txt - ${COMMON_FILES} -) - -# Note: Images should be minimized using tools/compress-pngs.py. -set(WSUG_GRAPHICS - wsug_src/images/caution.svg - wsug_src/images/important.svg - wsug_src/images/note.svg - wsug_src/images/related-ack.png - wsug_src/images/related-current.png - wsug_src/images/related-dup-ack.png - wsug_src/images/related-first.png - wsug_src/images/related-last.png - wsug_src/images/related-other.png - wsug_src/images/related-request.png - wsug_src/images/related-response.png - wsug_src/images/related-segment.png - wsug_src/images/tip.svg - wsug_src/images/toolbar/document-open.png - wsug_src/images/toolbar/edit-find.png - wsug_src/images/toolbar/filter-toolbar-add.png - wsug_src/images/toolbar/filter-toolbar-apply.png - wsug_src/images/toolbar/filter-toolbar-bookmark.png - wsug_src/images/toolbar/filter-toolbar-clear.png - wsug_src/images/toolbar/filter-toolbar-input.png - wsug_src/images/toolbar/filter-toolbar-recent.png - wsug_src/images/toolbar/go-first.png - wsug_src/images/toolbar/go-jump.png - wsug_src/images/toolbar/go-last.png - wsug_src/images/toolbar/go-next.png - wsug_src/images/toolbar/go-previous.png - wsug_src/images/toolbar/x-capture-file-close.png - wsug_src/images/toolbar/x-capture-file-reload.png - wsug_src/images/toolbar/x-capture-file-save.png - wsug_src/images/toolbar/x-capture-options.png - wsug_src/images/toolbar/x-capture-restart.png - wsug_src/images/toolbar/x-capture-start.png - wsug_src/images/toolbar/x-capture-stop.png - wsug_src/images/toolbar/x-colorize-packets.png - wsug_src/images/toolbar/x-resize-columns.png - wsug_src/images/toolbar/x-stay-last.png - wsug_src/images/toolbar/zoom-in.png - wsug_src/images/toolbar/zoom-original.png - wsug_src/images/toolbar/zoom-out.png - wsug_src/images/warning.svg - wsug_src/images/ws-about-codecs.png - wsug_src/images/ws-analyze-menu.png - wsug_src/images/ws-bytes-pane-popup-menu.png - wsug_src/images/ws-bytes-pane-tabs.png - wsug_src/images/ws-bytes-pane.png - wsug_src/images/ws-capture-file-properties.png - wsug_src/images/ws-capture-info.png - wsug_src/images/ws-capture-interfaces-main-macos.png - wsug_src/images/ws-capture-interfaces-main-win32.png - wsug_src/images/ws-capture-menu.png - wsug_src/images/ws-capture-options-compile-selected-bpfs.png - wsug_src/images/ws-capture-options-options.png - wsug_src/images/ws-capture-options-output.png - wsug_src/images/ws-capture-options-output.png - wsug_src/images/ws-capture-options.png - wsug_src/images/ws-choose-color-rule.png - wsug_src/images/ws-coloring-fields.png - wsug_src/images/ws-coloring-rules-dialog.png - wsug_src/images/ws-column-header-popup-menu.png - wsug_src/images/ws-decode-as.png - wsug_src/images/ws-details-pane-popup-menu.png - wsug_src/images/ws-details-pane.png - wsug_src/images/ws-diagram-pane-popup-menu.png - wsug_src/images/ws-diagram-pane.png - wsug_src/images/ws-display-filter-tcp.png # GTK+ - wsug_src/images/ws-edit-menu.png - wsug_src/images/ws-enabled-protocols.png - wsug_src/images/ws-expert-colored-tree.png - wsug_src/images/ws-expert-column.png - wsug_src/images/ws-expert-information.png - wsug_src/images/ws-export-objects.png - wsug_src/images/ws-export-packet-dissections.png - wsug_src/images/ws-export-selected.png - wsug_src/images/ws-export-specified-packets.png - wsug_src/images/ws-file-import.png - wsug_src/images/ws-file-menu.png - wsug_src/images/ws-file-set-dialog.png # GTK+ - wsug_src/images/ws-filter-add-expression.png # GTK+ - wsug_src/images/ws-filter-toolbar.png - wsug_src/images/ws-filters.png # GTK+ - wsug_src/images/ws-find-packet.png - wsug_src/images/ws-follow-http2-stream.png - wsug_src/images/ws-follow-sip-stream.png - wsug_src/images/ws-follow-stream.png - wsug_src/images/ws-go-menu.png - wsug_src/images/ws-goto-packet.png - wsug_src/images/ws-help-menu.png - wsug_src/images/ws-list-pane.png # Outdated - wsug_src/images/ws-main-toolbar.png - wsug_src/images/ws-main.png - wsug_src/images/ws-manage-interfaces.png - wsug_src/images/ws-mate-analysis.png - wsug_src/images/ws-mate-dns_pane.png - wsug_src/images/ws-mate-dns_pdu.png - wsug_src/images/ws-mate-ftp_over_gre.png - wsug_src/images/ws-mate-gop_analysis.png - wsug_src/images/ws-mate-isup_over_mtp3_over_ip.png - wsug_src/images/ws-mate-mmse_over_http.png - wsug_src/images/ws-mate-pdu_analysis.png - wsug_src/images/ws-mate-tcp-output.png - wsug_src/images/ws-mate-transform.png - wsug_src/images/ws-menu.png - wsug_src/images/ws-merge-qt5.png - wsug_src/images/ws-merge-win32.png - wsug_src/images/ws-open-qt5.png - wsug_src/images/ws-open-win32.png - wsug_src/images/ws-packet-format.png - wsug_src/images/ws-packet-pane-popup-menu.png - wsug_src/images/ws-packet-range.png - wsug_src/images/ws-packet-selected.png - wsug_src/images/ws-packet-sep-win.png - wsug_src/images/ws-pref-advanced.png - wsug_src/images/ws-pref-appearance-columns.png - wsug_src/images/ws-pref-appearance-fonts-and-colors.png - wsug_src/images/ws-pref-appearance-layout.png - wsug_src/images/ws-pref-appearance.png - wsug_src/images/ws-pref-capture.png - wsug_src/images/ws-pref-expert.png - wsug_src/images/ws-pref-filter-buttons.png - wsug_src/images/ws-pref-name-resolution.png - wsug_src/images/ws-pref-protocols.png - wsug_src/images/ws-pref-rsa-keys.png - wsug_src/images/ws-pref-statistics.png - wsug_src/images/ws-print.png - wsug_src/images/ws-save-as-qt5.png - wsug_src/images/ws-save-as-win32.png - wsug_src/images/ws-statistics-menu.png - wsug_src/images/ws-stats-conversations.png - wsug_src/images/ws-stats-endpoints.png - wsug_src/images/ws-stats-hierarchy.png - wsug_src/images/ws-stats-iographs.png - wsug_src/images/ws-stats-lte-mac-traffic.png - wsug_src/images/ws-stats-lte-rlc-traffic.png - wsug_src/images/ws-stats-packet-lengths.png - wsug_src/images/ws-stats-srt-smb2.png - wsug_src/images/ws-stats-wlan-traffic.png # GTK+ - wsug_src/images/ws-statusbar-empty.png - wsug_src/images/ws-statusbar-filter.png - wsug_src/images/ws-statusbar-loaded.png - wsug_src/images/ws-statusbar-profile.png - wsug_src/images/ws-statusbar-selected.png - wsug_src/images/ws-tcp-analysis.png - wsug_src/images/ws-tel-playlist.png - wsug_src/images/ws-tel-rtp-player_1.png - wsug_src/images/ws-tel-rtp-player_2.png - wsug_src/images/ws-tel-rtp-player_3.png - wsug_src/images/ws-tel-rtp-player_button.png - wsug_src/images/ws-tel-rtp-streams.png - wsug_src/images/ws-tel-rtpstream-analysis_1.png - wsug_src/images/ws-tel-rtpstream-analysis_2.png - wsug_src/images/ws-tel-rtpstream-analysis_3.png - wsug_src/images/ws-tel-seq-dialog.png - wsug_src/images/ws-tel-voip-calls.png - wsug_src/images/ws-telephony-menu.png - wsug_src/images/ws-time-reference.png # GTK+ - wsug_src/images/ws-tools-menu.png - wsug_src/images/ws-view-menu.png -) - -set(WSDG_TITLE "Wireshark Developer's Guide") - -set(WSDG_FILES - wsdg_src/wsdg_asn2wrs.adoc - wsdg_src/wsdg_build_intro.adoc - wsdg_src/wsdg_capture.adoc - wsdg_src/wsdg_dissection.adoc - wsdg_src/wsdg_env_intro.adoc - wsdg_src/wsdg_libraries.adoc - wsdg_src/wsdg_lua_support.adoc - wsdg_src/wsdg_preface.adoc - wsdg_src/wsdg_quick_setup.adoc - wsdg_src/wsdg_sources.adoc - wsdg_src/wsdg_tests.adoc - wsdg_src/wsdg_tools.adoc - wsdg_src/wsdg_userinterface.adoc - wsdg_src/wsdg_works.adoc - ${COMMON_FILES} -) - -set(WSDG_GRAPHICS - wsdg_src/images/caution.svg - wsdg_src/images/git-triangular-workflow.gv - wsdg_src/images/git-triangular-workflow.svg - wsdg_src/images/important.svg - wsdg_src/images/note.svg - wsdg_src/images/tip.svg - wsdg_src/images/warning.svg - wsdg_src/images/ws-capture_internals.dia - wsdg_src/images/ws-capture_internals.png - wsdg_src/images/ws-capture-sync.dia - wsdg_src/images/ws-capture-sync.png - wsdg_src/images/ws-capture-sync.png - wsdg_src/images/ws-function-blocks.dia - wsdg_src/images/ws-function-blocks.svg - wsdg_src/images/ws-logo.png -) - -set(WSUG_SOURCE - ${WSUG_FILES} - ${WSUG_GRAPHICS} -) - -# Ensure ws.css is available when the user tries to open generated .html files. -if(NOT CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR) - add_custom_command( - OUTPUT ws.css - COMMAND ${CMAKE_COMMAND} -E copy_if_different - ${CMAKE_SOURCE_DIR}/doc/ws.css - ${CMAKE_CURRENT_BINARY_DIR}/ws.css - DEPENDS - ${CMAKE_SOURCE_DIR}/doc/ws.css - ) - add_custom_target(copy_ws.css DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/ws.css) -else() - add_custom_target(copy_ws.css) -endif() - -set( WSUG_BUILT_DEPS copy_ws.css) - -set(WSDG_SOURCE - ${WSDG_FILES} - ${WSDG_GRAPHICS} -) - -# Note: file order here MATTERS! -# new WSLUA_MODULE files must come right before any WSLUA_CONTINUE_MODULE -# files for the same module -set(WSLUA_MODULES - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dumper.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_field.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_gui.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_int64.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_listener.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_pinfo.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_address.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_column.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_nstime.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dissector.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_pref.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto_expert.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto_field.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tree.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tvb.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_byte_array.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_file.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_file_handler.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_frame_info.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_capture_info.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dir.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_wtap.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_utility.c - ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_struct.c -) - -# Empty file to trigger wsluarm generation. -ADD_CUSTOM_COMMAND( - OUTPUT - wsluarm - COMMAND ${CMAKE_COMMAND} -E make_directory wsluarm_src - COMMAND ${Python3_EXECUTABLE} - ${CMAKE_CURRENT_SOURCE_DIR}/make-wsluarm.py - --output-directory wsluarm_src - ${WSLUA_MODULES} - COMMAND ${CMAKE_COMMAND} -E touch - wsluarm - DEPENDS - ${CMAKE_CURRENT_SOURCE_DIR}/make-wsluarm.py - ${WSLUA_MODULES} -) - -set( WSDG_BUILT_DEPS copy_ws.css wsluarm ) - -set( ASCIIDOC_CONF_FILES - ${CMAKE_SOURCE_DIR}/doc/attributes.adoc - # XXX Add macros -) - -if(ASCIIDOCTOR_FOUND) - # Generate the DocBook sources of user and developer guides - - ASCIIDOCTOR2DOCBOOK(wsug_src/user-guide.adoc ${ASCIIDOC_CONF_FILES} ${WSUG_SOURCE} ${WSUG_BUILT_DEPS}) - add_custom_target(user_guide_docbook DEPENDS generate_user-guide.xml) - set_docbook_target_properties(user_guide_docbook) - - ASCIIDOCTOR2DOCBOOK(wsdg_src/developer-guide.adoc ${ASCIIDOC_CONF_FILES} ${WSDG_SOURCE} ${WSDG_BUILT_DEPS}) - add_custom_target(developer_guide_docbook DEPENDS generate_developer-guide.xml) - set_docbook_target_properties(developer_guide_docbook) - - # Top-level guide targets. - - add_custom_target(user_guides DEPENDS user_guide_docbook) - set_docbook_target_properties(user_guides) - - add_custom_target(developer_guides DEPENDS developer_guide_docbook) - set_docbook_target_properties(developer_guides) - - add_custom_target(all_guides DEPENDS user_guides developer_guides ) - set_docbook_target_properties(all_guides) -endif() - -# User's Guide chain. -if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE) - XML2HTML( - user_guide - wsug - single-page - user-guide.xml - WSUG_GRAPHICS - ) - - XML2HTML( - user_guide - wsug - chunked - user-guide.xml - WSUG_GRAPHICS - ) - add_custom_target( - user_guide_html - DEPENDS - wsug_html/index.html - wsug_html_chunked/index.html - ) - set_docbook_target_properties(user_guide_html) - add_dependencies(user_guides user_guide_html) - # Copy the WSUG to the build directory so that when running - # from the build directory ui/help_url.c will find the local file. - # It expects the WSUG in a different directory on Windows. - if(WIN32) - set(WSUG_DIR "${DATAFILE_DIR}/${WSUG_TITLE}") - else() - set(WSUG_DIR "${DATAFILE_DIR}/wsug_html_chunked") - endif() - # CMake 3.26 has copy_directory_if_different - add_custom_command( - TARGET user_guide_html - COMMAND ${CMAKE_COMMAND} -E copy_directory - "${CMAKE_CURRENT_BINARY_DIR}/wsug_html_chunked" "${WSUG_DIR}" - VERBATIM - ) -endif() - -if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE) - ASCIIDOCTOR2PDF(${WSUG_TITLE} wsug_src/user-guide.adoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS}) - - add_custom_target( - user_guide_pdf - DEPENDS - "${WSUG_TITLE}.pdf" - ) - set_docbook_target_properties(user_guide_pdf) - add_dependencies(user_guides user_guide_pdf) -endif() - -if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_EPUB_EXECUTABLE) - ASCIIDOCTOR2EPUB(${WSUG_TITLE} wsug_src/user-guide.adoc ${WSUG_SOURCE} ${WSUG_BUILT_DEPS}) - - add_custom_target( - user_guide_epub - DEPENDS - "${WSUG_TITLE}.epub" - ) - set_docbook_target_properties(user_guide_epub) - add_dependencies(user_guides user_guide_epub) -endif() - -# Developer's Guide chain. -if(ASCIIDOCTOR_FOUND AND XSLTPROC_EXECUTABLE) - XML2HTML( - developer_guide - wsdg - single-page - developer-guide.xml - WSDG_GRAPHICS - ) - - XML2HTML( - developer_guide - wsdg - chunked - developer-guide.xml - WSDG_GRAPHICS - ) - add_custom_target( - developer_guide_html - DEPENDS - wsdg_html/index.html - wsdg_html_chunked/index.html - ) - set_docbook_target_properties(developer_guide_html) - add_dependencies(developer_guides developer_guide_html) -endif() - -if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_PDF_EXECUTABLE) - ASCIIDOCTOR2PDF(${WSDG_TITLE} wsdg_src/developer-guide.adoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS}) - - add_custom_target( - developer_guide_pdf - DEPENDS - "${WSDG_TITLE}.pdf" - ) - set_docbook_target_properties(developer_guide_pdf) - add_dependencies(developer_guides developer_guide_pdf) -endif() - -if(ASCIIDOCTOR_FOUND AND ASCIIDOCTOR_EPUB_EXECUTABLE) - ASCIIDOCTOR2EPUB(${WSDG_TITLE} wsdg_src/developer-guide.adoc ${WSDG_SOURCE} ${WSDG_BUILT_DEPS}) - - add_custom_target( - developer_guide_epub - DEPENDS - "${WSDG_TITLE}.epub" - ) - set_docbook_target_properties(developer_guide_epub) - add_dependencies(developer_guides developer_guide_epub) -endif() - -# -# Editor modelines - https://www.wireshark.org/tools/modelines.html -# -# Local variables: -# c-basic-offset: 8 -# tab-width: 8 -# indent-tabs-mode: t -# End: -# -# vi: set shiftwidth=8 tabstop=8 noexpandtab: -# :indentSize=8:tabSize=8:noTabs=false: -# diff --git a/epan/dissectors/packet-tcp.c b/epan/dissectors/packet-tcp.c index cfa9896b3f..de07e00136 100644 --- a/epan/dissectors/packet-tcp.c +++ b/epan/dissectors/packet-tcp.c @@ -2226,7 +2226,7 @@ tcp_analyze_get_acked_struct(uint32_t frame, uint32_t seq, uint32_t ack, bool cr * New segments are always added to the head of the fwd/rev lists. * * Changes below should be synced with ChAdvTCPAnalysis in the User's - * Guide: docbook/wsug_src/WSUG_chapter_advanced.adoc + * Guide: doc/wsug_src/WSUG_chapter_advanced.adoc */ static void tcp_analyze_sequence_number(packet_info *pinfo, uint32_t seq, uint32_t ack, uint32_t seglen, uint16_t flags, uint32_t window, struct tcp_analysis *tcpd, struct tcp_per_packet_data_t *tcppd) diff --git a/packaging/debian/rules b/packaging/debian/rules index 545ffa337e..b6aacfac92 100755 --- a/packaging/debian/rules +++ b/packaging/debian/rules @@ -60,7 +60,7 @@ override_dh_auto_build: dh_auto_build $(MAKE) -C $(CURDIR)/obj-* user_guide_html developer_guide_html # fix links in documentation - sed -i "s|$(CURDIR)/docbook|..|" obj-*/docbook/ws*g_html_chunked/*.html + sed -i "s|$(CURDIR)/doc|..|" obj-*/doc/ws*g_html_chunked/*.html ifeq (,$(filter $(DEB_BUILD_OPTIONS),nocheck)) # Required for the "unittests" suite. $(MAKE) -C $(CURDIR)/obj-* test-programs diff --git a/packaging/debian/wireshark-doc.docs b/packaging/debian/wireshark-doc.docs index c95d3d9d6a..f085787efb 100644 --- a/packaging/debian/wireshark-doc.docs +++ b/packaging/debian/wireshark-doc.docs @@ -1,2 +1,2 @@ -obj-*/docbook/wsdg_html_chunked -obj-*/docbook/wsug_html_chunked +obj-*/doc/wsdg_html_chunked +obj-*/doc/wsug_html_chunked diff --git a/packaging/nsis/CMakeLists.txt b/packaging/nsis/CMakeLists.txt index 7ae88749f2..b413c09622 100644 --- a/packaging/nsis/CMakeLists.txt +++ b/packaging/nsis/CMakeLists.txt @@ -53,7 +53,6 @@ file(TO_NATIVE_PATH "${CMAKE_SOURCE_DIR}" TOP_SRC_DIR) # STAGING_DIR depends on the build configuration so we pass it # on the command line below. file(TO_NATIVE_PATH "${CMAKE_BINARY_DIR}/doc" DOC_DIR) -file(TO_NATIVE_PATH "${CMAKE_BINARY_DIR}/docbook" DOCBOOK_DIR) set (MMDBRESOLVE_EXE ${MAXMINDDB_FOUND}) # To do: diff --git a/packaging/nsis/logray-config.nsh.in b/packaging/nsis/logray-config.nsh.in index 93d8a08893..bb532875e2 100644 --- a/packaging/nsis/logray-config.nsh.in +++ b/packaging/nsis/logray-config.nsh.in @@ -23,7 +23,6 @@ #cmakedefine MMDBRESOLVE_EXE @MMDBRESOLVE_EXE@ # Skip the User's Guide and FAQ until we have one of our own. -#cmakeundefine DOCBOOK_DIR #cmakeundefine DOC_DIR #cmakedefine SMI_DIR "@SMI_DIR@" diff --git a/packaging/nsis/logray.nsi b/packaging/nsis/logray.nsi index 52d3a20ae7..2fc04cdbfa 100644 --- a/packaging/nsis/logray.nsi +++ b/packaging/nsis/logray.nsi @@ -1016,18 +1016,16 @@ Section "-Clear Partial Selected" !insertmacro ClearSectionFlag ${SecExtcapGroup} ${SF_PSELECTED} SectionEnd -!ifdef DOCBOOK_DIR !ifdef DOC_DIR Section "Documentation" SecDocumentation ;------------------------------------------- SetOutPath "$INSTDIR\Wireshark User's Guide" -File /r "${DOCBOOK_DIR}\wsug_html_chunked\*.*" +File /r "${DOC_DIR}\wsug_html_chunked\*.*" SetOutPath $INSTDIR File "${DOC_DIR}\faq.html" SectionEnd !endif -!endif Section "-Finally" diff --git a/packaging/nsis/wireshark-config.nsh.in b/packaging/nsis/wireshark-config.nsh.in index 10485cca03..075421db1b 100644 --- a/packaging/nsis/wireshark-config.nsh.in +++ b/packaging/nsis/wireshark-config.nsh.in @@ -30,7 +30,6 @@ #cmakedefine OPUS_FOUND #cmakedefine LIBSSH_FOUND -#cmakedefine DOCBOOK_DIR "@DOCBOOK_DIR@" #cmakedefine DOC_DIR "@DOC_DIR@" #cmakedefine SMI_DIR "@SMI_DIR@" diff --git a/packaging/nsis/wireshark.nsi b/packaging/nsis/wireshark.nsi index d657806317..0527f75982 100644 --- a/packaging/nsis/wireshark.nsi +++ b/packaging/nsis/wireshark.nsi @@ -1229,18 +1229,16 @@ Section "-Clear Partial Selected" !insertmacro ClearSectionFlag ${SecExtcapGroup} ${SF_PSELECTED} SectionEnd -!ifdef DOCBOOK_DIR !ifdef DOC_DIR Section "-Documentation" SetOutPath "$INSTDIR\Wireshark User's Guide" -File /r "${DOCBOOK_DIR}\wsug_html_chunked\*.*" +File /r "${DOC_DIR}\wsug_html_chunked\*.*" SetOutPath $INSTDIR File "${DOC_DIR}\faq.html" SectionEnd !endif -!endif Section "-Finally" diff --git a/packaging/wix/CMakeLists.txt b/packaging/wix/CMakeLists.txt index 26cffdc918..df25c7fe0e 100644 --- a/packaging/wix/CMakeLists.txt +++ b/packaging/wix/CMakeLists.txt @@ -60,7 +60,6 @@ set(PROGRAM_NAME ${CMAKE_PROJECT_NAME}) file(TO_NATIVE_PATH "${CMAKE_SOURCE_DIR}" TOP_SRC_DIR) # STAGING_DIR depends on the build configuration so we pass it # on the command line below. -file(TO_NATIVE_PATH "${CMAKE_BINARY_DIR}/docbook" DOCBOOK_DIR) file(TO_NATIVE_PATH "${CMAKE_BINARY_DIR}/doc" DOC_DIR) # To do: @@ -197,7 +196,7 @@ set(WIX_CANDLE_DEFINES -dQtTranslationDir=${ARCHIVE_OUTPUT_PATH}/${CMAKE_CFG_INTDIR}/translations -dRadiusDictDir=${ARCHIVE_OUTPUT_PATH}/${CMAKE_CFG_INTDIR}/radius -dSnmpMibDir=${ARCHIVE_OUTPUT_PATH}/${CMAKE_CFG_INTDIR}/snmp/mibs - -dUsersGuideDir=${ARCHIVE_OUTPUT_PATH}/${CMAKE_CFG_INTDIR}/docbook/wsug_html_chunked + -dUsersGuideDir=${ARCHIVE_OUTPUT_PATH}/${CMAKE_CFG_INTDIR}/doc/wsug_html_chunked -dVCRedistVersion=${MSVC_CRT_VERSION} -dVCRedistDir=${MERGE_MODULE_DIR} ${d_smi_dir} @@ -253,7 +252,7 @@ macro( ADD_WIX_PACKAGE_TARGET ) # UsersGuide.wxs. Collects the contents of wsug_html_chunked. # Generated with heat.exe add_custom_command(OUTPUT ${_wix_binary_dir}/UsersGuide.wxs - COMMAND ${WIX_HEAT_EXECUTABLE} dir ${CMAKE_BINARY_DIR}/docbook/wsug_html_chunked + COMMAND ${WIX_HEAT_EXECUTABLE} dir ${CMAKE_BINARY_DIR}/doc/wsug_html_chunked ${WIX_HEAT_FLAGS} -cg CG.Documentation -dr dirUsersGuide -var var.UsersGuideDir -out ${_wix_binary_dir}/UsersGuide.wxs ) diff --git a/packaging/wix/Features.wxi b/packaging/wix/Features.wxi index ffaa4d6038..8cf7ccc59e 100644 --- a/packaging/wix/Features.wxi +++ b/packaging/wix/Features.wxi @@ -109,7 +109,7 @@ - + diff --git a/tools/check_help_urls.py b/tools/check_help_urls.py index ddf3673eb1..c9ad6f3f7c 100755 --- a/tools/check_help_urls.py +++ b/tools/check_help_urls.py @@ -22,7 +22,7 @@ with open("ui/help_url.c") as f: chapter = url.group(1) found[chapter] = False -adoc_files = glob("docbook/wsug_src/*.adoc") +adoc_files = glob("doc/wsug_src/*.adoc") for adoc_file in adoc_files: with open(adoc_file) as f: diff --git a/tools/checklicenses.py b/tools/checklicenses.py index 436aa93fed..b0a0ef02e1 100755 --- a/tools/checklicenses.py +++ b/tools/checklicenses.py @@ -72,10 +72,10 @@ PATH_SPECIFIC_ALLOWED_LICENSES = { 'doc/': [ 'UNKNOWN', ], - 'docbook/custom_layer_chm.xsl': [ + 'doc/custom_layer_chm.xsl': [ 'UNKNOWN', ], - 'docbook/custom_layer_single_html.xsl': [ + 'doc/custom_layer_single_html.xsl': [ 'UNKNOWN', ], 'fix': [ diff --git a/docbook/make-wsluarm.py b/tools/make-wsluarm.py similarity index 100% rename from docbook/make-wsluarm.py rename to tools/make-wsluarm.py diff --git a/tools/update-tools-help.py b/tools/update-tools-help.py index f951e8ee39..4e7772c289 100755 --- a/tools/update-tools-help.py +++ b/tools/update-tools-help.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # -# update-tools-help.py - Update the command line help output in docbook/wsug_src. +# update-tools-help.py - Update the command line help output in doc/wsug_src. # # Wireshark - Network traffic analyzer # By Gerald Combs @@ -9,7 +9,7 @@ # SPDX-License-Identifier: GPL-2.0-or-later '''Update tools help -For each file that matches docbook/wsug_src/-.txt, run +For each file that matches doc/wsug_src/-.txt, run that command and flag. Update the file if the output differs. ''' @@ -28,7 +28,7 @@ def main(): args = parser.parse_args() this_dir = os.path.dirname(__file__) - wsug_src_dir = os.path.join(this_dir, '..', 'docbook', 'wsug_src') + wsug_src_dir = os.path.join(this_dir, '..', 'doc', 'wsug_src') tools_help_files = glob.glob(os.path.join(wsug_src_dir, '*-*.txt')) tools_help_files.sort()