summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authornytpu <alex@nytpu.com>2021-03-23 08:12:53 -0600
committernytpu <alex@nytpu.com>2021-03-23 08:15:36 -0600
commit2cd16124f8cd1f3ff527b37cb7d18a7b818841af (patch)
tree6a262f2455899b2b96a246f77737bbbb2d4318c6 /doc
parent9549e569f98ae703f7d8865a3315ceb74f13bf7f (diff)
add timeout flag to refresh
Diffstat (limited to 'doc')
-rw-r--r--doc/comitium.1.scd10
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/comitium.1.scd b/doc/comitium.1.scd
index 607d911..0d12540 100644
--- a/doc/comitium.1.scd
+++ b/doc/comitium.1.scd
@@ -33,7 +33,7 @@ variety of feed formats:
automatically picked depending on the feed type. For Gemini feeds, the
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.
+ itself is used. Use *-w* to watch a page for changes.
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.
@@ -68,6 +68,10 @@ command-specific flags that are not universally recognized.
the servers you're hitting and to other people on your network. Defaults to
5.
+*-t* _NUM_, *--timeout* _NUM_
+ Set a timeout for requests, in seconds. Defaults to 10 seconds per
+ request.
+
## ADD FLAGS
*-w*, *--watch*
@@ -115,7 +119,9 @@ Within the data directory, the following files are used:
*header.gmi*
This file is neither created nor modified by comitium. If it exists and is
nonempty, then it is read and used as custom header for *feed.gmi*. If it
- doesn't exist or is empty, then a default header is used.
+ doesn't exist or is empty, then a default header is used. The generated
+ contents of *feed.gmi* will be appended to the contents of *header.gmi*
+ separated by one newline.
*feed.gmi*
The outputted text/gemini file containing the subscription items. Is what