aboutsummaryrefslogtreecommitdiffstats
path: root/docbook
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2022-06-30 09:45:49 -0700
committerGerald Combs <gerald@wireshark.org>2022-07-06 15:04:25 +0000
commit75efbb1ac4590f0e086bd3d028bc8b525b8eb3c6 (patch)
treeea83ae6be0c205a8bab41e1463807cd460a96c16 /docbook
parent78ebafd70821d5c2de9b9e085097780d736cdfac (diff)
Rename Logwolf to Logray
Switch to the name "Logray" for the log analyzer. Rays are biological cousins of sharks and more people like the name "Logray" in a completely unscientific survey here. Apologies for any inconvenience this might cause.
Diffstat (limited to 'docbook')
-rw-r--r--docbook/attributes.adoc2
-rw-r--r--docbook/logray-quick-start.adoc (renamed from docbook/logwolf-quick-start.adoc)24
-rw-r--r--docbook/wsdg_src/WSDG_chapter_quick_setup.adoc2
-rw-r--r--docbook/wsdg_src/WSDG_chapter_sources.adoc4
4 files changed, 16 insertions, 16 deletions
diff --git a/docbook/attributes.adoc b/docbook/attributes.adoc
index c6450b73b6..bc892afc1b 100644
--- a/docbook/attributes.adoc
+++ b/docbook/attributes.adoc
@@ -1,7 +1,7 @@
// Common attributes
:wireshark-version: 3.7.2
-:logwolf-version: 0.9.0
+:logray-version: 0.9.0
// Required for btn, kbd:, and menu: macros.
:experimental:
diff --git a/docbook/logwolf-quick-start.adoc b/docbook/logray-quick-start.adoc
index 0273852373..2e053c64e1 100644
--- a/docbook/logwolf-quick-start.adoc
+++ b/docbook/logray-quick-start.adoc
@@ -1,18 +1,18 @@
-= Logwolf Quick Start
+= Logray Quick Start
-Logwolf is a sibling application for Wireshark which focuses on log messages.
+Logray is a sibling application for Wireshark which focuses on log messages.
It helps people understand, troubleshoot, and secure their systems via log messages similar to the way Wireshark helps people understand, troubleshoot, and secure their networks via packets.
-This document provides brief instructions for building Logwolf until more complete documentation comparable to the Wireshark Developer’s and User’s Guides can be written.
+This document provides brief instructions for building Logray until more complete documentation comparable to the Wireshark Developer’s and User’s Guides can be written.
-== Building Logwolf
+== Building Logray
-Logwolf requires the same build environment as Wireshark.
+Logray requires the same build environment as Wireshark.
See the https://www.wireshark.org/docs/wsdg_html_chunked/[Wireshark Developer’s Guide] for instructions on setting that up.
It additionally requires libsinsp and libscap from https://github.com/falcosecurity/libs/[falcosecurity/libs] and any desired plugins from https://github.com/falcosecurity/plugins/[falcosecurity/plugins].
-In order to build Logwolf, do the following:
+In order to build Logray, do the following:
1. https://falco.org/docs/getting-started/source/[Build falcosecurity/libs].
@@ -22,31 +22,31 @@ In order to build Logwolf, do the following:
+
--
[horizontal]
-BUILD_logwolf:: Must be enabled, e.g. set to ON
+BUILD_logray:: Must be enabled, e.g. set to ON
SINSP_INCLUDEDIR:: The path to your local falcosecurity/libs directory
SINSP_LIBDIR:: The path to your falcosecurity/libs build directory
--
-4. Create a directory named `falco` in your Logwolf plugins directory, and either copy in or symlink any desired Falco plugins.
+4. Create a directory named `falco` in your Logray plugins directory, and either copy in or symlink any desired Falco plugins.
.Example 1: Building on macOS using Ninja
[sh]
----
cmake -G Ninja \
- -DBUILD_logwolf=ON \
+ -DBUILD_logray=ON \
-DSINSP_INCLUDEDIR=/path/to/falcosecurity/libs \
-DSINSP_LIBDIR=/path/to/falcosecurity/libs/build \
..
ninja
-mkdir run/Logwolf.app/Contents/PlugIns/logwolf/3-7/falco
-(cd run/Logwolf.app/Contents/PlugIns/logwolf/3-7/falco ; ln -sn /path/to/falcosecurity-plugins/plugins/cloudtrail/libcloudtrail.so )
+mkdir run/Logray.app/Contents/PlugIns/logray/3-7/falco
+(cd run/Logray.app/Contents/PlugIns/logray/3-7/falco ; ln -sn /path/to/falcosecurity-plugins/plugins/cloudtrail/libcloudtrail.so )
----
.Example 2: Building on Linux using Make
[sh]
----
cmake \
- -DBUILD_logwolf=ON \
+ -DBUILD_logray=ON \
-DSINSP_INCLUDEDIR=/path/to/falcosecurity/libs \
-DSINSP_LIBDIR=/path/to/falcosecurity/libs/build \
..
diff --git a/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc b/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc
index c2642b6039..9817b5e57c 100644
--- a/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc
+++ b/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc
@@ -171,7 +171,7 @@ https://appimage.org[AppImage] package::
Build the `wireshark_appimage` target.
macOS .dmg package containing an application bundle::
- Build the `wireshark_dmg` or `logwolf_dmg` targets.
+ Build the `wireshark_dmg` or `logray_dmg` targets.
Installable packages typically require building Wireshark first.
diff --git a/docbook/wsdg_src/WSDG_chapter_sources.adoc b/docbook/wsdg_src/WSDG_chapter_sources.adoc
index 82e65922c8..41bce5c3d8 100644
--- a/docbook/wsdg_src/WSDG_chapter_sources.adoc
+++ b/docbook/wsdg_src/WSDG_chapter_sources.adoc
@@ -1011,9 +1011,9 @@ In your build directory, type:
[source,sh]
----
-ninja wireshark_dmg logwolf_dmg # (Modify as needed)
+ninja wireshark_dmg logray_dmg # (Modify as needed)
# ...or, if you're using GNU make...
-make wireshark_dmg logwolf_dmg # (Modify as needed)
+make wireshark_dmg logray_dmg # (Modify as needed)
----
to build the macOS Packages.