summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authornytpu <alex@nytpu.com>2021-03-20 09:55:51 -0600
committernytpu <alex@nytpu.com>2021-03-20 09:59:50 -0600
commitd342b6f542ebe4f8766315f262cf764f6ac52de4 (patch)
tree6e624c51c277e4e94935b131dccefeb779ab5982 /doc
parentfece24eed984978d47120d676a2a70020a871485 (diff)
add regenerate command
Diffstat (limited to 'doc')
-rw-r--r--doc/comitium.1.scd7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/comitium.1.scd b/doc/comitium.1.scd
index 825e29a..fe70106 100644
--- a/doc/comitium.1.scd
+++ b/doc/comitium.1.scd
@@ -23,6 +23,10 @@ variety of feed formats:
*refresh* [_FLAGS_]
Check for new updates to subscriptions and update aggregator page.
+*regenerate*
+ Will regenerate all the files created by comitium using cached entries
+ without fetching any feeds.
+
*add* [_FLAGS_] <_LINK_> [_TITLE_]
Add a new subscription. _LINK_ is a link to the feed or watched URL.
_TITLE_ is an optional title for the feed, otherwise a title will be
@@ -30,6 +34,9 @@ variety of feed formats:
first heading on a page is used as a title. For ATOM, RSS, and JSON feeds,
the provided title is used. For a page being watched for changes, the URL
itself is used.
+ Also to note: when adding a new subscription, you *do not* need to run
+ *refresh* afterwards, *add* will automatically fetch the entries and
+ regenerate the .gmi and .json files.
*remove* <_LINK_>
Remove a subscription at _LINK_.