File: manpage.rst

package info (click to toggle)
urlwatch 2.29-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 880 kB
  • sloc: python: 4,003; sh: 53; makefile: 19
file content (158 lines) | stat: -rw-r--r-- 3,537 bytes parent folder | download
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
:orphan:

Manpage
=======

Synopsis
--------

urlwatch [options] [JOB ...]

Description
-----------

urlwatch is intended to help you watch changes in webpages and get
notified (via e-mail, in your terminal or through various third party
services) of any changes. The change notification will include the URL
that has changed and a unified diff of what has changed.

See :manpage:`urlwatch-intro(7)` for a quick start guide and tutorial,
and :manpage:`urlwatch-cookbook(7)` for usage recipes and tricks.

This manpage describes the CLI tool.

positional arguments:
   JOB
          indexes or tags of job(s) to run.
          If --tags is set, each JOB is a tag,
          if not, each JOB is an index numbered according to the --list command.

optional arguments:
   -h, --help
          show this help message and exit

   --tags
          use tags instead of indexes to select jobs to run

   --version
          show program's version number and exit

   -v, --verbose
          show debug output

files and directories:
   --urls FILE
          read job list (URLs) from FILE

   --config FILE
          read configuration from FILE

   --hooks FILE
          use FILE as hooks.py module

   --cache FILE
          use FILE as cache database

Authentication:
   --smtp-login
          Enter password for SMTP (store in keyring)

   --xmpp-login
          Enter password for XMPP (store in keyring)

   --telegram-chats
          List telegram chats the bot is joined to

   --test-reporter REPORTER
          Send a test notification

job list management:
   --list
          list jobs

   --add JOB
          add job (key1=value1,key2=value2,...)

   --delete JOB
          delete job by location or index

   --enable JOB
          enable job by location or index

   --disable JOB
          delete job by location or index

   --change_location JOB NEW_LOCATION
          change the location of an existing job by location or index

   --test-filter JOB
          test filter output of job by location or index

   --test-diff-filter JOB
          test diff filter output of job by location or index (needs at least 2 snapshots)

   --dump-history JOB
          dump historical cached data for a job

interactive commands ($EDITOR/$VISUAL):
   --edit
          edit URL/job list

   --edit-config
          edit configuration file

   --edit-hooks
          edit hooks script

miscellaneous:
   --features
          list supported jobs/filters/reporters

   --gc-cache RETAIN_LIMIT
          remove old cache entries, keeping the latest RETAIN_LIMIT (default: 1)


Files
-----

``$XDG_CONFIG_HOME/urlwatch/urls.yaml``
      Configured job and filter list, see :manpage:`urlwatch-jobs(5)` and :manpage:`urlwatch-filters(5)`

``$XDG_CONFIG_HOME/urlwatch/urlwatch.yaml``
      Global and reporter settings, see :manpage:`urlwatch-config(5)` and :manpage:`urlwatch-reporters(5)`

``$XDG_CONFIG_HOME/urlwatch/hooks.py``
      A Python 3 module that can implement new job types, filters and reporters

``$XDG_CACHE_HOME/urlwatch/cache.db``
      A SQLite 3 database (minidb) that contains the state history of jobs (for diffing)


See also
--------

:manpage:`urlwatch-intro(7)`,
:manpage:`urlwatch-cookbook(7)`,
:manpage:`urlwatch-deprecated(7)`,
:manpage:`urlwatch-jobs(5)`,
:manpage:`urlwatch-filters(5)`,
:manpage:`urlwatch-config(5)`,
:manpage:`urlwatch-reporters(5)`


Author
------

Thomas Perl <https://thp.io/>


Bug Tracker
-----------

https://github.com/thp/urlwatch/issues


Website
-------

https://thp.io/2008/urlwatch/