2019-12-16 15:23:06 +01:00
|
|
|
= mastorss(1)
|
|
|
|
|
:doctype: manpage
|
|
|
|
|
:Author: tastytea
|
|
|
|
|
:Email: tastytea@tastytea.de
|
2019-12-25 02:09:22 +01:00
|
|
|
:Date: 2019-12-25
|
2019-12-16 15:23:06 +01:00
|
|
|
:Revision: 0.0.0
|
|
|
|
|
:man source: mastorss
|
|
|
|
|
:man manual: General Commands Manual
|
|
|
|
|
|
|
|
|
|
== NAME
|
|
|
|
|
|
|
|
|
|
mastorss - Another RSS to Mastodon bot.
|
|
|
|
|
|
|
|
|
|
== SYNOPSIS
|
|
|
|
|
|
2019-12-20 01:14:23 +01:00
|
|
|
*mastorss* [--help|--version] <profile>
|
2019-12-16 15:23:06 +01:00
|
|
|
|
2019-12-24 23:24:24 +01:00
|
|
|
== DESCRIPTION
|
|
|
|
|
|
|
|
|
|
*mastorss* reads RSS feeds and posts the items via the Mastodon API. Does not
|
|
|
|
|
support Atom at the moment.
|
2019-12-16 15:23:06 +01:00
|
|
|
|
2019-12-20 01:14:23 +01:00
|
|
|
== OPTIONS
|
|
|
|
|
|
|
|
|
|
*--help*::
|
|
|
|
|
Show help message.
|
|
|
|
|
|
|
|
|
|
*--version*::
|
|
|
|
|
Show version, copyright and license.
|
2019-12-16 15:23:06 +01:00
|
|
|
|
|
|
|
|
// == EXAMPLES
|
|
|
|
|
|
2019-12-20 01:14:23 +01:00
|
|
|
== PROTOCOL SUPPORT
|
|
|
|
|
|
|
|
|
|
Currently only HTTP and HTTPS are supported.
|
|
|
|
|
|
|
|
|
|
// == PROXY SERVERS
|
|
|
|
|
|
|
|
|
|
// Since mastorss is built on libcurl, it respects the same proxy environment
|
|
|
|
|
// variables. See *curl*(1), section _ENVIRONMENT_.
|
|
|
|
|
|
|
|
|
|
// .Tunnel connections through tor.
|
|
|
|
|
// ================================================================================
|
|
|
|
|
// [source,shell]
|
|
|
|
|
// --------------------------------------------------------------------------------
|
|
|
|
|
// ALL_PROXY="socks4a://[::1]:9050" mastorss example
|
|
|
|
|
// --------------------------------------------------------------------------------
|
|
|
|
|
// ================================================================================
|
|
|
|
|
|
|
|
|
|
== PROXY SERVERS
|
2019-12-16 15:23:06 +01:00
|
|
|
|
2019-12-20 01:14:23 +01:00
|
|
|
mastorss supports HTTP proxies set via the environment variable
|
|
|
|
|
_http_proxy_. Accepted formats are: _\http://[user[:password]@]host[:port]/_ or
|
|
|
|
|
_[user[:password]@]host[:port]_. No SOCKS proxy support yet, sorry.
|
2019-12-16 15:23:06 +01:00
|
|
|
|
2019-12-20 01:14:23 +01:00
|
|
|
Example: `http_proxy="http://localhost:3128/" mastorss`
|
2019-12-16 15:23:06 +01:00
|
|
|
|
|
|
|
|
== FILES
|
|
|
|
|
|
|
|
|
|
* *Configuration file directory*: `${XDG_CONFIG_HOME}/mastorss/`
|
|
|
|
|
|
|
|
|
|
`${XDG_CONFIG_HOME}` is usually `~/.config`.
|
|
|
|
|
|
|
|
|
|
== ERROR CODES
|
|
|
|
|
|
|
|
|
|
[cols=">,<"]
|
|
|
|
|
|===========================================================
|
|
|
|
|
| Code | Explanation
|
|
|
|
|
|
2019-12-20 01:14:23 +01:00
|
|
|
| 1 | No profile specified.
|
|
|
|
|
| 2 | Network error.
|
2019-12-24 18:53:00 +01:00
|
|
|
| 3 | File error.
|
2019-12-25 02:09:22 +01:00
|
|
|
| 4 | Mastodon API error.
|
2019-12-24 18:53:00 +01:00
|
|
|
| 9 | Unknown error.
|
2019-12-16 15:23:06 +01:00
|
|
|
|===========================================================
|
|
|
|
|
|
2019-12-24 18:53:45 +01:00
|
|
|
== DEBUGGING
|
|
|
|
|
|
|
|
|
|
Define the variable `MASTORSS_DEBUG` to enable debug output.
|
|
|
|
|
|
|
|
|
|
.Debug mastorss while using the profile “example”.
|
|
|
|
|
================================================================================
|
|
|
|
|
[source,shell]
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
MASTORSS_DEBUG=1 mastorss example
|
|
|
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
================================================================================
|
|
|
|
|
|
2019-12-16 15:23:06 +01:00
|
|
|
== SEE ALSO
|
|
|
|
|
|
2019-12-20 01:14:23 +01:00
|
|
|
*curl*(1), *crontab*(1), *crontab*(5)
|
2019-12-16 15:23:06 +01:00
|
|
|
|
|
|
|
|
== REPORTING BUGS
|
|
|
|
|
|
|
|
|
|
Bugtracker: https://schlomp.space/tastytea/mastorss/issues
|
|
|
|
|
|
|
|
|
|
E-mail: tastytea@tastytea.de
|
