Changed

- Order of Pushover user key and api token

Fixed
- Help output not displaying proper timeout defaults
- Missing details in man page

Author: John Smith III

CHANGELOG.md

@@ -7,10 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- none
+
+## [1.2.1] - 2024-11-26
+
 ### Changed
 
 - Order of Pushover user key and api token
 
+### Fixed
+
+- Help output not displaying proper timeout defaults
+- Missing details in man page
+
 ## [1.2.0] - 2024-11-26
 
 ### Added

README.md

@@ -281,7 +281,7 @@ Run the script with the desired options. Below are some examples:
 
 ## Configuration
 
-NoirNet uses a configuration file to store default settings. The default location is `$HOME/.config/noirnet.conf`. You can initialize a configuration file with default settings using:
+NoirNet uses a configuration file to store default settings. The default location is `~/.config/noirnet.conf`. You can initialize a configuration file with default settings using:
 
 ```bash
 ./noirnet --init
@@ -293,7 +293,7 @@ NoirNet uses a configuration file to store default settings. The default locatio
 # NoirNet Configuration File
 CACHE_DIR="/tmp/noirnet_cache"
 LOG_FILE="/tmp/noirnet_cache/noirnet.log"
-CONFIG_FILE="$HOME/.config/noirnet.conf"
+CONFIG_FILE="~/.config/noirnet.conf"
 CHECK_INTERVAL=5
 TIMEOUT=5
 SYSTEM_NAME="My System"

noirnet

@@ -6,9 +6,12 @@
 
 # App version and name
 APP_NAME="NoirNet"
-VERSION=1.2.0
+VERSION=1.2.1
 LAST_UPDATED="2024-11-26"
 
+# TODO:
+#  - Add more notification methods (email, slack, discord, etc.)
+
 # ==============================
 # Application Specific Variables
 # ==============================
@@ -461,9 +464,9 @@ send_pushover_notification() {
     local response
 
     if [ "$PUSHOVER_NOTIFICATION" = true ]; then
-        log_message "DEBUG" " Processing Pushover notification: $website_url" "$LINENO"
-        log_message "DEBUG" " Url: $website_url" "$LINENO"
-        log_message "DEBUG" " Message: $message" "$LINENO"
+        log_message "DEBUG" "- Processing Pushover notification: $website_url" "$LINENO"
+        log_message "DEBUG" "- Url: $website_url" "$LINENO"
+        log_message "DEBUG" "- Message: $message" "$LINENO"
 
         # Check if PUSHOVER_API_TOKEN is set
         if [[ -z "$PUSHOVER_API_TOKEN" ]]; then
@@ -508,7 +511,7 @@ send_pushover_notification() {
             return 1
         fi
 
-        log_message "DEBUG" " Pushover notification sent successfully." "$LINENO"
+        log_message "DEBUG" "- Pushover notification sent successfully." "$LINENO"
         return 0
     fi
 }
@@ -799,10 +802,10 @@ show_help() {
 
     # Network Check Configuration
     printf "\nNetwork Check Configuration:\n"
-    printf "  -i, --interval <seconds>    Set the interval between checks (default: %d seconds).\n" "${CHECK_INTERVAL:-5}"
-    printf "  -T, --timeout <seconds>     Set the timeout for ping and DNS tests (default: %d seconds).\n" "${DNS_TEST_TIMEOUT:-5}"
-    printf "  -P, --ping-target <IP>      Set a custom ping target (default: %s).\n" "${PING_TARGET:-8.8.8.8}"
-    printf "  -D, --dns-test-domain <domain>  Set a custom DNS test domain (default: %s).\n" "${DNS_TEST_DOMAIN:-example.com}"
+    printf "  -i, --interval <seconds>    Set the interval between checks (default: %d seconds).\n" "${CHECK_INTERVAL}"
+    printf "  -T, --timeout <seconds>     Set the connection timeout for remote connections (default: %d seconds).\n" "${TIMEOUT}"
+    printf "  -P, --ping-target <IP>      Set a custom ping target (default: %s).\n" "${PING_TARGET}"
+    printf "  -D, --dns-test-domain <domain>  Set a custom DNS test domain (default: %s).\n" "${DNS_TEST_DOMAIN}"
 
     # Process Management Functions
     printf "\nProcess Management:\n"

noirnet.1

@@ -1,4 +1,4 @@
-.TH NOIRNET 1 "November 26, 2024" "Version 1.2.0" "User Commands"
+.TH NOIRNET 1 "November 26, 2024" "Version 1.2.1" "User Commands"
 .SH NAME
 NoirNet \- Monitors internet and DNS access and sends notifications.
 
@@ -18,13 +18,13 @@ Display this help message.
 \fB\-V\fR, \fB\-\-version\fR
 Display the application version.
 .TP
-\fB\-c\fR, \fB\-\-config\fR \fI<config_file>\fR
-Specify a custom configuration file (default: noirnet.conf).
+.B \-c, \--config <config_file>
+Specify a custom configuration file (default: ~/.config/noirwatch.conf).
 .TP
-\fB\-I\fR, \fB\-\-init\fR
+.B \-I, \--init
 Initialize the configuration file.
 .TP
-\fB\-F\fR, \fB\-\-force\-init\fR
+.B \-F, \--force-init
 Force initialize the configuration file if one exists.
 .TP
 \fB\-s\fR, \fB\-\-show\-config\fR
@@ -37,7 +37,7 @@ Show the configuration file.
 Delete all cached files.
 .TP
 \fB\-k\fR, \fB\-\-cache\-dir\fR \fI<path>\fR
-Specify a custom cache directory (default: noirnet_cache).
+Specify a custom cache directory (default: /tmp/noirnet_cache/).
 .TP
 \fB\-n\fR, \fB\-\-system\-name\fR \fI<name>\fR
 Name of the system running the script (default: system hostname).
@@ -61,7 +61,7 @@ Enable verbose output.
 Log the log file to the screen.
 .TP
 \fB\-o\fR, \fB\-\-output\fR \fI<file>\fR
-Specify a custom log file location (default: noirnet.log).
+Specify a custom log file location (default: /tmp/noirnet_cache/noirnet.log).
 .TP
 \fB\-L\fR, \fB\-\-log\-level\fR \fI<level>\fR
 Set the log level (FATAL, ERROR, WARN, INFO, DEBUG).
@@ -109,13 +109,13 @@ Stop the service:
 
 .SH FILES
 .TP
-.B noirnet.conf
+.B ~/.config/noirnet.conf
 Default configuration file.
 .TP
-.B noirnet_cache/
+.B /tmp/noirnet_cache/
 Directory for cached files.
 .TP
-.B noirnet.log
+.B /tmp/noirnet_cache/noirnet.log
 Default log file.
 
 .SH AUTHOR
@@ -125,4 +125,7 @@ John Smith III
 MIT License
 
 .SH SEE ALSO
-ping(8), nslookup(1), curl(1), sed(1), cat(1)
+.BR curl (1),
+.BR xmllint (1),
+.BR notify-send (1),
+.BR osascript (1)