From 4272aa162fc4170ec5fe455352395976e3399cfd Mon Sep 17 00:00:00 2001 From: pezcurrel Date: Fri, 25 Oct 2024 17:59:29 +0200 Subject: [PATCH] Updated to help text as in 70c09b4 commit --- README.md | 44 +++++++++++++++++++++++++++++++++++--------- 1 file changed, 35 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index fe0fceb..fd99902 100644 --- a/README.md +++ b/README.md @@ -77,22 +77,48 @@ post_visibility = unlisted # «fedi_hostname»; it can be used for testing purposes or just to keep the # posts shorter than they would be otherwise; for example: max_post_length = 840 + +# «always_link_gancio_post» is optional and if unspecified it defaults to +# «false», which means that GancioFF adds to the Mastodon post a link to the +# original Gancio post only if the latter is too long to fit into the first +# (i.e. into the Mastodon instance “max post length”, or into the +# «max_post_length» specified in this configuration file - see above); this +# way, GancioFF reduces the burden on the Gancio instance that is due to the +# requests that it gets from every Mastodon instance where a Mastodon post +# with a link to the original Gancio post will end up, in order for each of +# them to generate a “link preview”; such burden gets reduced in different +# measures depending on the average length of a post on the Gancio instance +# and on the “max post length” on the Mastodon instance that GancioFF is using +# to post (or on the «max_post_length» explicitly specified in this file). +# If set to «true», GancioFF will instead always add a link to the original +# Gancio post. +always_link_gancio_post = true --- End of example configuration file --- [[[ OPTIONS ]]] -h / --help Show this help text and exit. +-t / --test + Do a test: GancioFF will try as always to read the configuration file, fetch + the defined Mastodon instance’s info, load the state file and fetch the feed, + but it will post only the first event it may find there, with a visibility of + «direct», even if according to the state file it has already been posted, and + won’t update the state file. -p / --do-post - Setting this option to «n» («no») will make GancioFF skip posting. Note that - even in this case it will save into the state file the GUIDs of new events - it may find in the feed, so it won’t post them even on subsequent runs. - Also note that, in order to prevent you from flooding your instance’s local - timeline on GancioFF first run on a given feed (i.e. when the state file - specified in the configuration file doesn’t exist yet), if events in the feed - are more than 5 and «posts_visibility» is set to «public» GancioFF refuses to - post them unless you explicitly set this option to «n» («no») or «y» («yes»). - When the state file exists, this option defaults to «y» («yes»). + When a state file already exists, this option defaults to «y» («yes»), which + means that GancioFF will try to post all the new events it may find in the + feed; if set to «n» («no»), GancioFF will not try to post them, but it will + save their GUIDs into the state file nonetheless, so they won’t be posted + again on subsequent runs. + This is mainly useful on GancioFF’s first run on a given feed, i.e. when + the state file specified in the configuration file doesn’t exist yet and thus + all the events in the feed will be considered “new”: in this case, GancioFF + refuses to run unless you explicitly set this option to «y» or «n»: this is a + way to prevent you from unintentionally flooding your Mastodon instance with + all the events in the feed. + When “test mode” is active (see the previous option description), setting + this option has no effect. -v / --verbose Show some more messages about what the script is doing. --