diff options
| -rw-r--r-- | CMakeLists.txt | 159 | ||||
| -rw-r--r-- | debian/tshark.manpages | 2 | ||||
| -rw-r--r-- | debian/wireshark-common.manpages | 24 | ||||
| -rw-r--r-- | debian/wireshark-dev.manpages | 6 | ||||
| -rw-r--r-- | debian/wireshark-qt.manpages | 2 | ||||
| -rw-r--r-- | doc/CMakeLists.txt | 185 | ||||
| -rw-r--r-- | doc/Makefile.am | 3 |
7 files changed, 205 insertions, 176 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index fb36b19a4b..d00f645135 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1020,6 +1020,7 @@ add_subdirectory( asn1 EXCLUDE_FROM_ALL ) add_subdirectory( capchild ) add_subdirectory( caputils ) add_subdirectory( codecs ) +add_subdirectory( doc ) add_subdirectory( docbook ) add_subdirectory( epan ) add_subdirectory( randpkt_core ) @@ -1312,35 +1313,14 @@ set(INSTALL_DIRS ) set(INSTALL_FILES - ${CMAKE_BINARY_DIR}/androiddump.html - ${CMAKE_BINARY_DIR}/sshdump.html - ${CMAKE_BINARY_DIR}/AUTHORS-SHORT - ${CMAKE_BINARY_DIR}/capinfos.html - ${CMAKE_BINARY_DIR}/captype.html cfilters colorfilters dfilters - ${CMAKE_BINARY_DIR}/dftest.html - ${CMAKE_BINARY_DIR}/dumpcap.html - ${CMAKE_BINARY_DIR}/editcap.html - ${CMAKE_BINARY_DIR}/extcap.html - ${CMAKE_BINARY_DIR}/asn2deb.html - ${CMAKE_BINARY_DIR}/idl2deb.html - ${CMAKE_BINARY_DIR}/idl2wrs.html ipmap.html manuf - ${CMAKE_BINARY_DIR}/mergecap.html pdml2html.xsl - ${CMAKE_BINARY_DIR}/randpkt.html - ${CMAKE_BINARY_DIR}/randpktdump.html - ${CMAKE_BINARY_DIR}/rawshark.html - ${CMAKE_BINARY_DIR}/reordercap.html services smi_modules - ${CMAKE_BINARY_DIR}/text2pcap.html - ${CMAKE_BINARY_DIR}/tshark.html - ${CMAKE_BINARY_DIR}/wireshark-filter.html - ${CMAKE_BINARY_DIR}/wireshark.html docbook/ws.css ) @@ -1353,30 +1333,6 @@ else() set(INSTALL_FILES COPYING ${INSTALL_FILES}) endif() -set(MAN1_FILES - ${CMAKE_BINARY_DIR}/androiddump.1 - ${CMAKE_BINARY_DIR}/capinfos.1 - ${CMAKE_BINARY_DIR}/captype.1 - ${CMAKE_BINARY_DIR}/dftest.1 - ${CMAKE_BINARY_DIR}/dumpcap.1 - ${CMAKE_BINARY_DIR}/editcap.1 - ${CMAKE_BINARY_DIR}/extcap.4 - ${CMAKE_BINARY_DIR}/idl2wrs.1 - ${CMAKE_BINARY_DIR}/mergecap.1 - ${CMAKE_BINARY_DIR}/randpkt.1 - ${CMAKE_BINARY_DIR}/androiddump.1 - ${CMAKE_BINARY_DIR}/rawshark.1 - ${CMAKE_BINARY_DIR}/reordercap.1 - ${CMAKE_BINARY_DIR}/sshdump.1 - ${CMAKE_BINARY_DIR}/text2pcap.1 - ${CMAKE_BINARY_DIR}/tshark.1 - ${CMAKE_BINARY_DIR}/wireshark.1 -) - -set(MAN4_FILES - ${CMAKE_BINARY_DIR}/wireshark-filter.4 -) - set(LIBEPAN_LIBS # @NSL_LIBS@ # -lnsl # @SOCKET_LIBS@ # -lsocket @@ -1611,7 +1567,6 @@ foreach(_install_file ${INSTALL_FILES}) "${_output_file}" WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} DEPENDS - html_docs "${_install_file}" ) list(APPEND copy_data_files_depends "${_output_file}") @@ -2426,57 +2381,6 @@ if(BUILD_randpktdump) install(TARGETS randpktdump RUNTIME DESTINATION ${EXTCAP_DIR}) endif() -ADD_CUSTOM_COMMAND( - OUTPUT ${CMAKE_BINARY_DIR}/AUTHORS-SHORT - COMMAND ${PERL_EXECUTABLE} - ${CMAKE_SOURCE_DIR}/doc/perlnoutf.pl - ${CMAKE_SOURCE_DIR}/doc/make-authors-short.pl - < ${CMAKE_SOURCE_DIR}/AUTHORS - > ${CMAKE_BINARY_DIR}/AUTHORS-SHORT - DEPENDS - ${CMAKE_SOURCE_DIR}/doc/perlnoutf.pl - ${CMAKE_SOURCE_DIR}/doc/make-authors-short.pl - ${CMAKE_SOURCE_DIR}/AUTHORS -) - -ADD_CUSTOM_COMMAND( - OUTPUT ${CMAKE_BINARY_DIR}/AUTHORS-SHORT-FORMAT - COMMAND ${PERL_EXECUTABLE} - ${CMAKE_SOURCE_DIR}/doc/perlnoutf.pl - ${CMAKE_SOURCE_DIR}/doc/make-authors-format.pl - < ${CMAKE_BINARY_DIR}/AUTHORS-SHORT - > ${CMAKE_BINARY_DIR}/AUTHORS-SHORT-FORMAT - DEPENDS - ${CMAKE_SOURCE_DIR}/doc/perlnoutf.pl - ${CMAKE_SOURCE_DIR}/doc/make-authors-format.pl - ${CMAKE_BINARY_DIR}/AUTHORS-SHORT -) - -if(WIN32) -FILE(TO_NATIVE_PATH ${CMAKE_SOURCE_DIR}/doc/wireshark.pod.template WPT_WIN_PATH) -FILE(TO_NATIVE_PATH ${CMAKE_BINARY_DIR}/AUTHORS-SHORT-FORMAT ASF_WIN_PATH) -FILE(TO_NATIVE_PATH ${CMAKE_BINARY_DIR}/wireshark.pod WP_WIN_PATH) -ADD_CUSTOM_COMMAND( - OUTPUT ${CMAKE_BINARY_DIR}/wireshark.pod - COMMAND copy /B ${WPT_WIN_PATH} + ${ASF_WIN_PATH} ${WP_WIN_PATH} - DEPENDS - ${CMAKE_SOURCE_DIR}/doc/wireshark.pod.template - ${CMAKE_BINARY_DIR}/AUTHORS-SHORT-FORMAT -) -else() - -ADD_CUSTOM_COMMAND( - OUTPUT ${CMAKE_BINARY_DIR}/wireshark.pod - COMMAND cat - ${CMAKE_SOURCE_DIR}/doc/wireshark.pod.template - ${CMAKE_BINARY_DIR}/AUTHORS-SHORT-FORMAT - > ${CMAKE_BINARY_DIR}/wireshark.pod - DEPENDS - ${CMAKE_SOURCE_DIR}/doc/wireshark.pod.template - ${CMAKE_BINARY_DIR}/AUTHORS-SHORT-FORMAT -) -endif() - if(ENABLE_APPLICATION_BUNDLE) add_custom_target(app_bundle) set_target_properties(app_bundle PROPERTIES FOLDER "Copy Tasks") @@ -2533,53 +2437,6 @@ if(ENABLE_APPLICATION_BUNDLE) endif() -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/androiddump 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/capinfos 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/captype 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/dftest 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/dumpcap 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/editcap 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/extcap 4 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/asn2deb 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/idl2deb 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/idl2wrs 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/mergecap 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/randpkt 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/randpktdump 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/rawshark 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/reordercap 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/sshdump 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/text2pcap 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/tshark 1 ) -pod2manhtml( ${CMAKE_BINARY_DIR}/wireshark 1 ) -pod2manhtml( ${CMAKE_SOURCE_DIR}/doc/wireshark-filter 4 ) - -add_custom_target( - html_docs ALL - DEPENDS - ${CMAKE_BINARY_DIR}/AUTHORS-SHORT - androiddump.html - capinfos.html - captype.html - dftest.html - dumpcap.html - editcap.html - asn2deb.html - idl2deb.html - idl2wrs.html - mergecap.html - randpkt.html - randpktdump.html - rawshark.html - reordercap.html - sshdump.html - text2pcap.html - tshark.html - wireshark.html - wireshark-filter.html -) -set_target_properties(html_docs PROPERTIES FOLDER "Docs") - set(CLEAN_FILES ${wireshark_FILES} ${tshark_FILES} @@ -2614,20 +2471,6 @@ install( install( FILES - ${MAN1_FILES} - DESTINATION - ${CMAKE_INSTALL_MANDIR}/man1 -) - -install( - FILES - ${MAN4_FILES} - DESTINATION - ${CMAKE_INSTALL_MANDIR}/man4 -) - -install( - FILES "${CMAKE_BINARY_DIR}/wireshark.pc" DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig diff --git a/debian/tshark.manpages b/debian/tshark.manpages index 83cc1abd40..8e9f3646c2 100644 --- a/debian/tshark.manpages +++ b/debian/tshark.manpages @@ -1 +1 @@ -obj-*/tshark.1 +obj-*/doc/tshark.1 diff --git a/debian/wireshark-common.manpages b/debian/wireshark-common.manpages index f6e26d5388..c9a375295e 100644 --- a/debian/wireshark-common.manpages +++ b/debian/wireshark-common.manpages @@ -1,12 +1,12 @@ -obj-*/androiddump.1 -obj-*/sshdump.1 -obj-*/randpktdump.1 -obj-*/editcap.1 -obj-*/extcap.4 -obj-*/mergecap.1 -obj-*/text2pcap.1 -obj-*/wireshark-filter.4 -obj-*/capinfos.1 -obj-*/dumpcap.1 -obj-*/rawshark.1 -obj-*/reordercap.1 +obj-*/doc/androiddump.1 +obj-*/doc/sshdump.1 +obj-*/doc/randpktdump.1 +obj-*/doc/editcap.1 +obj-*/doc/extcap.4 +obj-*/doc/mergecap.1 +obj-*/doc/text2pcap.1 +obj-*/doc/wireshark-filter.4 +obj-*/doc/capinfos.1 +obj-*/doc/dumpcap.1 +obj-*/doc/rawshark.1 +obj-*/doc/reordercap.1 diff --git a/debian/wireshark-dev.manpages b/debian/wireshark-dev.manpages index f284a8f0f6..1d678f9e53 100644 --- a/debian/wireshark-dev.manpages +++ b/debian/wireshark-dev.manpages @@ -1,3 +1,3 @@ -obj-*/idl2wrs.1 -obj-*/idl2deb.1 -obj-*/asn2deb.1 +obj-*/doc/idl2wrs.1 +obj-*/doc/idl2deb.1 +obj-*/doc/asn2deb.1 diff --git a/debian/wireshark-qt.manpages b/debian/wireshark-qt.manpages index 4c4e4b106e..f8d254eaf2 100644 --- a/debian/wireshark-qt.manpages +++ b/debian/wireshark-qt.manpages @@ -1 +1 @@ -obj-*/wireshark.1 +obj-*/doc/wireshark.1 diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 0000000000..32a8c47d94 --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,185 @@ +# CMakeLists.txt +# +# Wireshark - Network traffic analyzer +# By Gerald Combs <gerald@wireshark.org> +# Copyright 1998 Gerald Combs +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 2 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +# + +add_custom_command( + OUTPUT AUTHORS-SHORT + COMMAND ${PERL_EXECUTABLE} + ${CMAKE_CURRENT_SOURCE_DIR}/perlnoutf.pl + ${CMAKE_CURRENT_SOURCE_DIR}/make-authors-short.pl + < ${CMAKE_SOURCE_DIR}/AUTHORS + > ${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT + DEPENDS + ${CMAKE_CURRENT_SOURCE_DIR}/perlnoutf.pl + ${CMAKE_CURRENT_SOURCE_DIR}/make-authors-short.pl + ${CMAKE_SOURCE_DIR}/AUTHORS +) + +add_custom_command( + OUTPUT AUTHORS-SHORT-FORMAT + COMMAND ${PERL_EXECUTABLE} + ${CMAKE_CURRENT_SOURCE_DIR}/perlnoutf.pl + ${CMAKE_CURRENT_SOURCE_DIR}/make-authors-format.pl + < ${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT + > ${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT-FORMAT + DEPENDS + ${CMAKE_CURRENT_SOURCE_DIR}/perlnoutf.pl + ${CMAKE_CURRENT_SOURCE_DIR}/make-authors-format.pl + ${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT +) + +if(WIN32) + file(TO_NATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/wireshark.pod.template WPT_WIN_PATH) + file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT-FORMAT ASF_WIN_PATH) + file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/wireshark.pod WP_WIN_PATH) + add_custom_command( + OUTPUT wireshark.pod + COMMAND copy /B ${WPT_WIN_PATH} + ${ASF_WIN_PATH} ${WP_WIN_PATH} + DEPENDS + ${CMAKE_CURRENT_SOURCE_DIR}/wireshark.pod.template + ${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT-FORMAT + ) +else() + add_custom_command( + OUTPUT wireshark.pod + COMMAND cat + ${CMAKE_CURRENT_SOURCE_DIR}/wireshark.pod.template + ${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT-FORMAT + > ${CMAKE_CURRENT_BINARY_DIR}/wireshark.pod + DEPENDS + ${CMAKE_CURRENT_SOURCE_DIR}/wireshark.pod.template + ${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT-FORMAT + ) +endif() + +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/androiddump 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/asn2deb 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/capinfos 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/captype 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/dftest 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/dumpcap 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/editcap 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/idl2deb 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/idl2wrs 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/mergecap 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/randpkt 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/randpktdump 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/rawshark 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/reordercap 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/sshdump 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/text2pcap 1) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/tshark 1) +pod2manhtml(${CMAKE_CURRENT_BINARY_DIR}/wireshark 1) + +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/extcap 4) +pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/wireshark-filter 4) + +set(MAN1_INSTALL_FILES + ${CMAKE_CURRENT_BINARY_DIR}/asn2deb.1 + ${CMAKE_CURRENT_BINARY_DIR}/androiddump.1 + ${CMAKE_CURRENT_BINARY_DIR}/capinfos.1 + ${CMAKE_CURRENT_BINARY_DIR}/captype.1 + ${CMAKE_CURRENT_BINARY_DIR}/dftest.1 + ${CMAKE_CURRENT_BINARY_DIR}/dumpcap.1 + ${CMAKE_CURRENT_BINARY_DIR}/editcap.1 + ${CMAKE_CURRENT_BINARY_DIR}/idl2deb.1 + ${CMAKE_CURRENT_BINARY_DIR}/idl2wrs.1 + ${CMAKE_CURRENT_BINARY_DIR}/mergecap.1 + ${CMAKE_CURRENT_BINARY_DIR}/randpkt.1 + ${CMAKE_CURRENT_BINARY_DIR}/randpktdump.1 + ${CMAKE_CURRENT_BINARY_DIR}/rawshark.1 + ${CMAKE_CURRENT_BINARY_DIR}/reordercap.1 + ${CMAKE_CURRENT_BINARY_DIR}/sshdump.1 + ${CMAKE_CURRENT_BINARY_DIR}/text2pcap.1 + ${CMAKE_CURRENT_BINARY_DIR}/tshark.1 + ${CMAKE_CURRENT_BINARY_DIR}/wireshark.1 +) + +set(MAN4_INSTALL_FILES + ${CMAKE_CURRENT_BINARY_DIR}/extcap.4 + ${CMAKE_CURRENT_BINARY_DIR}/wireshark-filter.4 +) + +set(HTML_INSTALL_FILES + ${CMAKE_CURRENT_BINARY_DIR}/asn2deb.html + ${CMAKE_CURRENT_BINARY_DIR}/androiddump.html + ${CMAKE_CURRENT_BINARY_DIR}/capinfos.html + ${CMAKE_CURRENT_BINARY_DIR}/captype.html + ${CMAKE_CURRENT_BINARY_DIR}/dftest.html + ${CMAKE_CURRENT_BINARY_DIR}/dumpcap.html + ${CMAKE_CURRENT_BINARY_DIR}/editcap.html + ${CMAKE_CURRENT_BINARY_DIR}/extcap.html + ${CMAKE_CURRENT_BINARY_DIR}/idl2deb.html + ${CMAKE_CURRENT_BINARY_DIR}/idl2wrs.html + ${CMAKE_CURRENT_BINARY_DIR}/mergecap.html + ${CMAKE_CURRENT_BINARY_DIR}/randpkt.html + ${CMAKE_CURRENT_BINARY_DIR}/randpktdump.html + ${CMAKE_CURRENT_BINARY_DIR}/rawshark.html + ${CMAKE_CURRENT_BINARY_DIR}/reordercap.html + ${CMAKE_CURRENT_BINARY_DIR}/sshdump.html + ${CMAKE_CURRENT_BINARY_DIR}/text2pcap.html + ${CMAKE_CURRENT_BINARY_DIR}/tshark.html + ${CMAKE_CURRENT_BINARY_DIR}/wireshark.html + ${CMAKE_CURRENT_BINARY_DIR}/wireshark-filter.html +) + +add_custom_target( + docs ALL + DEPENDS + ${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT-FORMAT + ${MAN1_INSTALL_FILES} + ${MAN4_INSTALL_FILES} + ${HTML_INSTALL_FILES} +) +set_target_properties(docs PROPERTIES FOLDER "Docs") + +install( + FILES + ${MAN1_INSTALL_FILES} + DESTINATION + ${CMAKE_INSTALL_MANDIR}/man1 +) + +install( + FILES + ${MAN4_INSTALL_FILES} + DESTINATION + ${CMAKE_INSTALL_MANDIR}/man4 +) + +install( + FILES + ${HTML_INSTALL_FILES} + DESTINATION + ${CMAKE_INSTALL_DATADIR}/${CPACK_PACKAGE_NAME} +) + +# +# Editor modelines - http://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/doc/Makefile.am b/doc/Makefile.am index 91f367bdad..66ad3335cb 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -315,5 +315,6 @@ EXTRA_DIST = \ text2pcap.pod \ tshark.pod \ wireshark-filter.pod \ - wireshark.pod.template + wireshark.pod.template \ + CMakeLists.txt |