= mastorss(1)
:doctype:       manpage
:Author:        tastytea
:Email:         tastytea@tastytea.de
:Date:          2019-12-25
:Revision:      0.0.0
:man source:    mastorss
:man manual:    General Commands Manual

== NAME

mastorss - Another RSS to Mastodon bot.

== SYNOPSIS

*mastorss* [--help|--version] <profile>

== DESCRIPTION

*mastorss* reads RSS feeds and posts the items via the Mastodon API. Does not
support Atom at the moment.

== OPTIONS

*--help*::
Show help message.

*--version*::
Show version, copyright and license.

// == EXAMPLES

== 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

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.

Example: `http_proxy="http://localhost:3128/" mastorss`

== FILES

* *Configuration file directory*: `${XDG_CONFIG_HOME}/mastorss/`

`${XDG_CONFIG_HOME}` is usually `~/.config`.

== ERROR CODES

[cols=">,<"]
|===========================================================
| Code | Explanation

|    1 | No profile specified.
|    2 | Network error.
|    3 | File error.
|    4 | Mastodon API error.
|    9 | Unknown error.
|===========================================================

== DEBUGGING

Define the variable `MASTORSS_DEBUG` to enable debug output.

.Debug mastorss while using the profile “example”.
================================================================================
[source,shell]
--------------------------------------------------------------------------------
MASTORSS_DEBUG=1 mastorss example
--------------------------------------------------------------------------------
================================================================================

== SEE ALSO

*curl*(1), *crontab*(1), *crontab*(5)

== REPORTING BUGS

Bugtracker: https://schlomp.space/tastytea/mastorss/issues

E-mail: tastytea@tastytea.de
