noirwatch/noirwatch.1 at main · binarynoir/noirwatch · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
.TH NOIRWATCH 1 "January 1, 2025" "NoirWatch 1.3.3" "User Commands"
.SH NAME
NoirWatch \- Monitor specified websites for changes and send notifications.
.SH SYNOPSIS
.B noirwatch
.RI [ options ] " <url>..."
.SH DESCRIPTION
.B NoirWatch
is a Bash script designed to monitor specified websites for changes and send notifications when changes are detected. It supports various notification methods including desktop notifications and Pushover.
.SH OPTIONS
.TP
.B \-h, \--help
Display this help message.
.TP
.B \-V, \--version
Display the application version.
.TP
.B \-c, \--config <config_file>
Specify a custom configuration file (default: ~/.config/noirwatch.conf).
.TP
.B \-i, \--init
Initialize the configuration file.
.TP
.B \-f, \--force-init
Force initialize the configuration file if one exists.
.TP
.B \-S, \--show-config
Show the configuration settings.
.TP
.B \-e, \--show-config-file
Show the configuration file.
.TP
.B \-E, \--edit-config
Edit the configuration file.
.TP
.B \-x, \--clean
Clean the cache directory.
.TP
.B \-C, \--cache-dir <cache_dir>
Specify a custom cache directory.
.TP
.B \-n, \--system-name <name>
Specify the system name for notifications.
.TP
.B \-p, \--pushover
Enable Pushover notifications.
.TP
.B \-u, \--user-key <key>
Specify the Pushover user key.
.TP
.B \-a, \--api-token <token>
Specify the Pushover API token.
.TP
.B \-d, \--desktop
Enable desktop notifications.
.TP
.B \-l, \--log
Show the log.
.TP
.B \-o, \--output <file>
Specify the log file.
.TP
.B \-I, \--interval <seconds>
Specify the check interval in seconds.
.TP
.B \-T, \--timeout <seconds>
Specify the timeout duration in seconds.
.TP
.B \-N, \--repeat <count>
Specify the number of times to repeat the check.
.TP
.B \-U, \--list-urls
List the URLs being monitored.
.TP
.B \-H, \--threshold <value>
Specify the threshold value.
.TP
.B \-s, \--start
Start the monitoring service.
.TP
.B \-k, \--stop
Stop the monitoring service.
.TP
.B \-r, \--restart
Restart the monitoring service.
.TP
.B \-t, \--status
Show the status of the monitoring service.
.TP
.B \-\-
End of options.