about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorNguyễn Gia Phong <cnx@loang.net>2025-06-15 21:53:53 +0900
committerNguyễn Gia Phong <cnx@loang.net>2025-06-15 21:53:53 +0900
commitc3d356c8b80659468a0a7429636a128c156509ae (patch)
tree8d7af71b623e1cfb360ee935f809411059e0ca76 /README.md
parent637e73f023107c142c1eecc187c18a5581c10794 (diff)
downloadscadere-c3d356c8b80659468a0a7429636a128c156509ae.tar.gz
Add examples to help and man pages
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index 9355b66..d1f40f4 100644
--- a/README.md
+++ b/README.md
@@ -27,11 +27,18 @@ It is recommended to run `scadere-check` as a cron job.
 
 ```console
 $ scadere-listen --help
-Usage: scadere-listen [-h] [-v] INPUT URL [[HOST][:PORT]]
+Usage: scadere-listen [-h] [-v] PATH URL [[HOST][:PORT]]
 
-Serve the TLS certificate expiration feed from INPUT file
-for base URL at HOST:PORT, where HOST defaults to localhost
-and PORT is selected randomly if not specified.
+Serve at URL Atom feeds for TLS certificate renewal reminder.
+It is possible for clients to filter domains
+using one or more "domain" URL queries.
+
+The certificate information is read from the file at PATH,
+which is generated by scadere-check(1).
+
+The server listens for TCP connections coming to HOST:PORT,
+where HOST defaults to localhost and PORT is selected randomly
+if not specified.
 
 Options:
   -h, --help     show this help message and exit