reorganized code and functions and added additional information

Author: John Smith III

CHANGELOG.md

@@ -9,6 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - none
 
+## [1.0.1] - 2024-11-21
+
+### Changed
+
+- Showing the version information now includes last updated date
+- Reorganized functions for maintainability
+- Updated cli help and man page for better grouping of topics
+
 ## [1.0.0] - 2024-11-21
 
 ### Added

noirnet

@@ -3,12 +3,11 @@
 # Description: Monitors to see if the device has internet and DNS access and send notifications.
 # Author: John Smith III
 # License: MIT License
-# Version: 1.0.0
-# Last Updated: 2024-11-22
 
 # App version and name
-VERSION=1.0.0
+VERSION=1.0.1
 APP_NAME="NoirNet"
+LAST_UPDATED="2024-11-22"
 
 # Default configuration file location
 CONFIG_FILE="$HOME/.noirnetrc"
@@ -92,7 +91,8 @@ init_csv() {
 
 # Function: Show version information
 show_version() {
-    printf "$APP_NAME version: %s\n" "$VERSION"
+    printf "%s version: %s\n" "$APP_NAME" "$VERSION"
+    printf "Last updated: %s\n" "$LAST_UPDATE"
     exit 0
 }
 
@@ -592,9 +592,9 @@ init_config() {
 # This file contains the settings for the $APP_NAME application.
 
 # General Settings
-CONFIG_FILE="$CONFIG_FILE"
 CACHE_DIR="$CACHE_DIR"
 LOG_FILE="$LOG_FILE"
+CONFIG_FILE="$CONFIG_FILE"
 
 # Monitoring Settings (in seconds)
 CHECK_INTERVAL=$CHECK_INTERVAL
@@ -630,17 +630,17 @@ EOF
 
 # Function: Show configuration information
 show_config() {
-    [ -n "$CONFIG_FILE" ] && log_message "INFO" "Configuration file: $CONFIG_FILE" "$LINENO"
     [ -n "$CACHE_DIR" ] && log_message "INFO" "Cache directory: $CACHE_DIR" "$LINENO"
     [ -n "$LOG_FILE" ] && log_message "INFO" "Log file: $LOG_FILE" "$LINENO"
+    [ -n "$LOG_LEVEL" ] && log_message "INFO" "Log Level: $LOG_LEVEL" "$LINENO"
+    [ -n "$VERBOSE" ] && log_message "INFO" "Verbose enabled: $VERBOSE" "$LINENO"
+    [ -n "$CONFIG_FILE" ] && log_message "INFO" "Configuration file: $CONFIG_FILE" "$LINENO"
+    [ -n "$PUSHOVER_NOTIFICATION" ] && log_message "INFO" "Pushover enabled: $PUSHOVER_NOTIFICATION" "$LINENO"
+    [ -n "$DESKTOP_NOTIFICATION" ] && log_message "INFO" "Desktop notification enabled: $DESKTOP_NOTIFICATION" "$LINENO"
     [ -n "$PING_TARGET" ] && log_message "INFO" "Ping target: $PING_TARGET" "$LINENO"
     [ -n "$DNS_TEST_DOMAIN" ] && log_message "INFO" "Test domain target: $DNS_TEST_DOMAIN" "$LINENO"
     [ -n "$CHECK_INTERVAL" ] && log_message "INFO" "Check interval: $CHECK_INTERVAL sec(s)" "$LINENO"
     [ -n "$TIMEOUT" ] && log_message "INFO" "Timeout interval: $TIMEOUT sec(s)" "$LINENO"
-    [ -n "$PUSHOVER_NOTIFICATION" ] && log_message "INFO" "Pushover enabled: $PUSHOVER_NOTIFICATION" "$LINENO"
-    [ -n "$DESKTOP_NOTIFICATION" ] && log_message "INFO" "Desktop notification enabled: $DESKTOP_NOTIFICATION" "$LINENO"
-    [ -n "$LOG_LEVEL" ] && log_message "INFO" "Log Level: $LOG_LEVEL" "$LINENO"
-    [ -n "$VERBOSE" ] && log_message "INFO" "Verbose enabled: $VERBOSE" "$LINENO"
 }
 
 # ==============================
@@ -658,7 +658,6 @@ show_help() {
 
     # Configuration and Initialization
     printf "\nConfiguration and Initialization:\n"
-    printf "  -i, --interval <seconds>    Set the interval between checks (default: %d seconds).\n" "${CHECK_INTERVAL:-5}"
     printf "  -c, --config <config_file>  Specify a custom configuration file (default: %s).\n" "${CONFIG_FILE:-~/.config/noirnet.conf}"
     printf "  -I, --init                  Initialize the configuration file.\n"
     printf "  -F, --force-init            Force initialize of the configuration file if one exists.\n"
@@ -670,8 +669,8 @@ show_help() {
     printf "  -C, --clean                 Delete all cached files.\n"
     printf "  -k, --cache-dir  <path>     Specify a custom cache directory.\n"
 
-    # Execution Options
-    printf "\nExecution Options:\n"
+    # Notification Options
+    printf "\Notification Options:\n"
     printf "  -p, --pushover              Send Pushover notifications.\n"
     printf "  -a, --api-token <token>     Specify the API token for Pushover notifications.\n"
     printf "  -u, --user-key <key>        Specify the user key for Pushover notifications.\n"
@@ -686,6 +685,7 @@ 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 "  -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 "  -T, --timeout <seconds>     Set the timeout for ping and DNS tests (default: %d seconds).\n" "${DNS_TEST_TIMEOUT:-5}"
@@ -933,6 +933,7 @@ process_arguments() {
 # Network Monitoring Function
 # ==============================
 
+# Function: Start the monitoring process
 start_monitor() {
     local network_down_start dns_down_start
     local network_down=false dns_down=false

noirnet.1

@@ -1,14 +1,14 @@
-.TH NOIRNET 1 "November 22, 2024" "1.0.0" "NoirNet Manual"
+.TH NOIRNET 1 "November 22, 2024" "Version 1.0.1" "User Commands"
 .SH NAME
-NoirNet \- Monitors internet and DNS access and sends notifications
+NoirNet \- Monitors internet and DNS access and sends notifications.
 
 .SH SYNOPSIS
 .B noirnet
-[\fIoptions\fR]
+.RI [ options ]
 
 .SH DESCRIPTION
 .B NoirNet
-is a script that monitors the device's internet and DNS access and sends notifications via Pushover and desktop notifications.
+is a script designed to monitor the device's internet and DNS access. It logs downtime and sends notifications via desktop or Pushover.
 
 .SH OPTIONS
 .TP
@@ -18,37 +18,34 @@ Display this help message.
 .B \-V, \-\-version
 Display the application version.
 .TP
-.B \-i, \-\-interval \fIseconds\fR
-Set the interval between checks (default: 60 seconds).
-.TP
-.B \-c, \-\-config \fIconfig_file\fR
-Specify a custom configuration file (default: ~/.noirnetrc).
+.B \-c, \-\-config \fI<config_file>\fP
+Specify a custom configuration file (default: $HOME/.noirnetrc).
 .TP
 .B \-I, \-\-init
 Initialize the configuration file.
 .TP
-.B \-F, \-\-force-init
-Force initialize the configuration file if one exists.
+.B \-F, \-\-force\-init
+Force initialization of the configuration file if one exists.
 .TP
-.B \-s, \-\-show-config
+.B \-s, \-\-show\-config
 Show the configuration settings.
 .TP
-.B \-S, \-\-show-config-file
+.B \-S, \-\-show\-config\-file
 Show the configuration file.
 .TP
 .B \-C, \-\-clean
 Delete all cached files.
 .TP
-.B \-k, \-\-cache-dir \fIpath\fR
+.B \-k, \-\-cache\-dir \fI<path>\fP
 Specify a custom cache directory.
 .TP
 .B \-p, \-\-pushover
 Send Pushover notifications.
 .TP
-.B \-a, \-\-api-token \fItoken\fR
+.B \-a, \-\-api\-token \fI<token>\fP
 Specify the API token for Pushover notifications.
 .TP
-.B \-u, \-\-user-key \fIkey\fR
+.B \-u, \-\-user\-key \fI<key>\fP
 Specify the user key for Pushover notifications.
 .TP
 .B \-d, \-\-desktop
@@ -60,19 +57,22 @@ Enable verbose output.
 .B \-l, \-\-log
 Log the log file to the screen.
 .TP
-.B \-o, \-\-output \fIfile\fR
+.B \-o, \-\-output \fI<file>\fP
 Specify a custom log file location.
 .TP
-.B \-L, \-\-log-level \fIlevel\fR
+.B \-L, \-\-log\-level \fI<level>\fP
 Set the log level (FATAL, ERROR, WARN, INFO, DEBUG).
 .TP
-.B \-P, \-\-ping-target \fIIP\fR
+.B \-i, \-\-interval \fI<seconds>\fP
+Set the interval between checks (default: 60 seconds).
+.TP
+.B \-P, \-\-ping\-target \fI<IP>\fP
 Set a custom ping target (default: 8.8.8.8).
 .TP
-.B \-D, \-\-dns-test-domain \fIdomain\fR
+.B \-D, \-\-dns\-test\-domain \fI<domain>\fP
 Set a custom DNS test domain (default: example.com).
 .TP
-.B \-T, \-\-timeout \fIseconds\fR
+.B \-T, \-\-timeout \fI<seconds>\fP
 Set the timeout for ping and DNS tests (default: 5 seconds).
 .TP
 .B \-r, \-\-start
@@ -90,10 +90,10 @@ Run interactively with default settings:
 .B noirnet
 .TP
 Run interactively with custom targets:
-.B noirnet \-\-ping-target 1.1.1.1 \-\-dns-test-domain google.com
+.B noirnet \-\-ping\-target 1.1.1.1 \-\-dns\-test\-domain google.com
 .TP
 Start the service with custom targets:
-.B noirnet \-\-ping-target 1.1.1.1 \-\-dns-test-domain google.com \-\-start
+.B noirnet \-\-ping\-target 1.1.1.1 \-\-dns\-test\-domain google.com \-\-start
 .TP
 Check service status:
 .B noirnet \-\-status
@@ -107,5 +107,27 @@ John Smith III
 .SH LICENSE
 MIT License
 
+.SH FILES
+.TP
+.B $HOME/.noirnetrc
+Default configuration file.
+.TP
+.B /tmp/noirnet_cache
+Directory to store all cache files.
+.TP
+.B /tmp/noirnet_cache/noirnet.log
+Default log file location.
+.TP
+.B /tmp/noirnet_cache/noirnet.pid
+Lock file.
+.TP
+.B /tmp/noirnet_cache/network_downtime.csv
+CSV file for network downtime history.
+.TP
+.B /tmp/noirnet_cache/dns_downtime.csv
+CSV file for DNS downtime history.
+
 .SH SEE ALSO
-ping(8), nslookup(1), curl(1)
+.BR ping (8),
+.BR nslookup (1),
+.BR curl (1)