diff --git a/docs/source/configure.rst b/docs/source/configure.rst index a16fd82..ad68ebb 100644 --- a/docs/source/configure.rst +++ b/docs/source/configure.rst @@ -8,19 +8,19 @@ As a prerequisite to use Feed2toot, you need to authorize a Mastodon app for you Just use the script register_feed2toot_app to register the feed2toot app for your account.:: $ ./register_feed2toot_app - + This script generates the Mastodon application credentials for Feed2toot. feed2toot_clientcred.txt and feed2toot_usercred.txt will be written in the current directory: /home/me/feed2toot. WARNING: previous files with the same names will be overwritten. - + A connection is also initiated to create the application. Your password is *not* stored. - + Mastodon instance URL (defaults to https://mastodon.social): https://framapiaf.org Mastodon login: toto@titi.com - Mastodon password: - + Mastodon password: + The appĀ feed2toot was added to your Preferences=>Accounts=>Authorized apps page. The file feed2toot_clientcred.txt and feed2toot_usercred.txt were created in the current directory. @@ -94,7 +94,7 @@ For the [rss] section: - uri: the url of the rss feed to parse - uri_list: a path to a file with several adresses of rss feeds, one by line. Absolute path is mandatory. -- toot: format of the toot you want to post. It should use existing entries of the RSS fields like {title} or {link}. Launch it with this field empty to display all available entries. If you want to shorten the size of a field, you can use the syntax {summary:.100} to cut the field "summary" of the rss feed after the first 100 characters (starting from version 0.10). To add new lines you can use \n (starting from version 0.14) +- toot: format of the toot you want to post. It should use existing entries of the RSS fields like {title} or {link}. Launch it with this field empty to display all available entries. If you want to shorten the size of a field, you can use the syntax {summary:.100} to cut the field "summary" of the rss feed after the first 100 characters (starting from version 0.10). To add new lines you can use \\n (starting from version 0.14) - toot_max_len: the max length of a toot can be defined here. If the toot size is longer, the toot is truncated and "..." added at the end. Defaults is 500 characters. - {one field of the rss feed}_pattern: takes a string representing a pattern to match for a specified field of each rss entry of the rss feed, like title_pattern or summary_pattern. - {one field of the rss feed}_pattern_case_sensitive: either the pattern matching for the specified field should be case sensitive or not. Default to true if not specified. @@ -176,4 +176,3 @@ In you rsslist.txt, just don't give anything else than the needed feed url to ge https://blog.linuxjobs.fr/feed.php?rss The last line of the file above only has the url of a rss feed. All entries from this feed will be tooted. -