From c69be165a8944b18d10f1712b18a11e28b0db4bc Mon Sep 17 00:00:00 2001 From: pezcurrel Date: Sat, 26 Oct 2024 23:12:54 +0200 Subject: [PATCH] Updated to help text as in fdf343a commit --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index dc1b5db..da1c23c 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ gancioff [options] [[[ DESCRIPTION ]]] -This is GancioFF v0.3, a CLI PHP script that can be used to periodically +This is GancioFF v0.4, a CLI PHP script that can be used to periodically fetch the RSS feed from an instance of Gancio (https://gancio.org) and post its new entries – the events – on the fediverse through a Mastodon account, keeping track of already posted events’ GUIDs (Global Unique IDentifiers) in @@ -99,12 +99,6 @@ always_link_gancio_post = true -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 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 @@ -117,10 +111,18 @@ always_link_gancio_post = true 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. + When “test mode” is active (see the next option description), setting this + option has no effect. +-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. + This option also activates “verbose mode” (see below). -v / --verbose - Show some more messages about what the script is doing. + When this option is not set GancioFF prints only warning and error messages; + when it is set it also prints informational messages about what it’s doing. -- Treat every possible subsequent argument as non-options. Useful only in the very improbable case your config file is named «--help» or as another option.