Jones/GancioF2F
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Updated to help text as in 12fc2c0 commit

Browse source
This commit is contained in:
pezcurrel 2024-10-28 10:15:03 +01:00
parent 12fc2c0963
commit d939664982
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -5,7 +5,7 @@ gancioff [options] <configuration file path>
[[[ DESCRIPTION ]]] [[[ DESCRIPTION ]]]
This is GancioFF v0.4.1, a CLI PHP script that can be used to periodically This is GancioFF v0.4.3, a CLI PHP script that can be used to periodically
fetch the RSS feed from an instance of Gancio (https://gancio.org) and post fetch the RSS feed from an instance of Gancio (https://gancio.org) and post
its new entries – the events announcements – on the fediverse through a its new entries – the events announcements – on the fediverse through a
Mastodon account, recording into a state file a reference to each already Mastodon account, recording into a state file a reference to each already
@ -59,6 +59,12 @@ fedi_token = w6oQ_Ot2LSAm_Q31hrvp0asfl22ip3O4ipYq1kV1ceY
# For example: # For example:
state_file_absolute_path = /var/local/cache/gancio.some.domain.feed.state state_file_absolute_path = /var/local/cache/gancio.some.domain.feed.state
# «timezone» is required to specify the timezone of the Gancio instance, in
# order for GancioFF to calculate the correct datetimes. You can list the
# supported timezones using option «-T» or «--timezones» (see the related
# entry in the «OPTIONS» section. For example:
timezone = Europe/Rome
# «posts_language» is required to specify the ISO 639-1 code for the language # «posts_language» is required to specify the ISO 639-1 code for the language
# of posts (see https://www.loc.gov/standards/iso639-2/php/code_list.php for # of posts (see https://www.loc.gov/standards/iso639-2/php/code_list.php for
# a complete list). For example: # a complete list). For example:
@ -125,6 +131,8 @@ always_link_gancio_post = true
-v / --verbose -v / --verbose
When this option is not set GancioFF prints only warning and error messages; 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. when it is set it also prints informational messages about what it’s doing.
-T / --timezones
List all the supported timezones.
-- --
Treat every possible subsequent argument as non-options. Useful only in the 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. very improbable case your config file is named «--help» or as another option.