From 1e0f5799527a4772d1d0b62ae395de23c0a88c15 Mon Sep 17 00:00:00 2001 From: John Thacker Date: Thu, 28 Apr 2022 07:46:56 -0400 Subject: [PATCH] docs: Remove references to configure Remove some leftover references to configure in the INSTALL file and README.* files in root directory. --- INSTALL | 15 +++++++------- README.bsd | 60 +++++++---------------------------------------------- README.hpux | 17 +++++++-------- 3 files changed, 24 insertions(+), 68 deletions(-) diff --git a/INSTALL b/INSTALL index 3ec5e7308a..97ccb33c8f 100644 --- a/INSTALL +++ b/INSTALL @@ -1,11 +1,12 @@ -See also https://gitlab.com/wireshark/wireshark/-/wikis/Development. +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. Installation ============ -These are installation instructions for Unix and Unix-like systems -that can run the "configure" script in this same directory. These -are not the installation instructions for Windows systems; see +These are installation instructions for Unix and Unix-like systems. +These are not the installation instructions for Windows systems; see README.windows for those instructions. 0. This is software. Beware. @@ -146,7 +147,7 @@ README.windows for those instructions. use -DENABLE_PCAP=OFF to avoid using libpcap. -DENABLE_ZLIB=OFF - By default, if 'configure' finds zlib (a.k.a, libz), the + By default, if 'cmake' finds zlib (a.k.a, libz), the wiretap library will be built so that it can read compressed capture files. If you have zlib but do not wish to build it into the wiretap library, used by Wireshark, TShark, and @@ -154,7 +155,7 @@ README.windows for those instructions. this switch. -DENABLE_BROTLI=OFF - By default, if 'configure' finds brotli, the wiretap library + By default, if 'cmake' finds brotli, the wiretap library will be built so that it can read brotli compressed capture files. If you have brotli but do not wish to build it into the wiretap library, used by Wireshark, TShark, and the @@ -194,7 +195,7 @@ README.windows for those instructions. dpkg-buildpackage -us -uc -rfakeroot in the source directory right after extracting of checking out - Wireshark's source code. (You don't have to run configure/make/etc. + Wireshark's source code. (You don't have to run CMake/make/Ninja/etc. prior to running dpkg-buildpackage) diff --git a/README.bsd b/README.bsd index 94654c01fe..19cb07a405 100644 --- a/README.bsd +++ b/README.bsd @@ -1,59 +1,15 @@ Installing Wireshark on FreeBSD/OpenBSD/NetBSD/DragonFly BSD ======================================================================== - 1. Extra packages required - 2. Compiling Wireshark - 3. Berkeley Packet Filter (BPF) requirement - 4. Running Wireshark as a non-root user + 1. Berkeley Packet Filter (BPF) requirement + 2. Running Wireshark as a non-root user +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 +follow. -1. Extra packages required ---------------------------- -Wireshark requires a number of additional programs to function. -Install the latest versions of the following programs before compiling: - -The easiest way to install these is by using your operating system's -ports or packages system. If you prefer to build from source, the programs -can be found at the following sites: - - glib 2.32 or later: - ftp.gnome.org:/pub/gnome/sources/glib/ - http://ftp.gnome.org/pub/gnome/sources/glib/ - - pkgconfig: - http://pkgconfig.freedesktop.org/releases/ - - python 3.4 or later: - https://www.python.org/downloads/source/ - -If you want to use the Wireshark GUI, install one or both of these toolkits: - - Qt 5.3 or later: - http://download.qt-project.org/official_releases/qt/ - - -(These programs may require additional dependencies) - -Additional programs can be used to enhance Wireshark's functionality. -These can be found by typing ./configure --help or looking at the output -at the end of running the configure script. - - -2. Compiling Wireshark ------------------------ -To compile Wireshark with the default options, run configure, make and -make install (you may have to run "autogen.sh" first): - - ./configure - make - make install - -The configure and make steps can be run as a non-root user and you can -run Wireshark from the compilation directory itself. You must run make -install as root in order to copy the program to the proper directories. - - -3. Berkeley Packet Filter (BPF) requirement +1. Berkeley Packet Filter (BPF) requirement -------------------------------------------- In order to capture packets (with Wireshark/TShark, tcpdump, or any other packet capture program) on a BSD system, your kernel must have the @@ -74,7 +30,7 @@ use. Recent versions of most BSDs will create bpf devices as needed, so you don't have to configure the number of devices that will be available. -4. Running wireshark as a non-root user +2. Running wireshark as a non-root user ------------------------------------------- Since the bpf devices are read-only by the owner (root), you normally have to run packet capturing programs such as Wireshark as root. It is diff --git a/README.hpux b/README.hpux index 4ecd82c8f2..c1eeed5de5 100644 --- a/README.hpux +++ b/README.hpux @@ -1,13 +1,12 @@ Note: We *probably* don't support HP-UX any more, at least not in the -sense that you can run `configure; make` or `cmake ... ; make` and -expect everything to work out of the box. At the time of this writing -(August 2017) the most recent version of Wireshark available at the -HP-UX Porting and Archive Centre is 1.10.5 and the most recently -reported HP-UX bug (#6550) was from 2012. The Porting and Archive Centre -provides libraries required to build TShark, and while the GTK+ packages -are current (2.24.31) they are 32-bit only. Recent Qt packages are not -provided. +sense that you can run `cmake ... ; make` and expect everything to work +out of the box. At the time of this writing (August 2017) the most recent +version of Wireshark available at the HP-UX Porting and Archive Centre is +1.10.5 and the most recently reported HP-UX bug (#6550) was from 2012. The +Porting and Archive Centre provides libraries required to build TShark, +and while the GTK+ packages are current (2.24.31) they are 32-bit only. +Recent Qt packages are not provided. Contents: @@ -49,7 +48,7 @@ By default, HP's C compiler doesn't support "long long int" to provide 64-bit integral data types on 32-bit platforms; the "-Ae" flag must be supplied to enable extensions such as that. -Wireshark's "configure" script automatically includes that flag if it +Wireshark's CMake script automatically includes that flag if it detects that the native compiler is being used on HP-UX; however, the configure scripts for GTK+ and GLib don't do so, which means that 64-bit integer support won't be enabled.