gitea2rss/gitea2rss.1.adoc

65 lines
1.7 KiB
Plaintext
Raw Normal View History

2019-04-17 00:17:26 +02:00
= gitea2rss(1)
:doctype: manpage
:Author: tastytea
:Email: tastytea@tastytea.de
:Date: 2019-04-17
:Revision: 0.0.0
:man source: gitea2rss
:man version: {revision}
:man manual: General Commands Manual
== NAME
gitea2rss - Turns Gitea releases into RSS feeds.
== SYNOPSIS
*gitea2rss* _URL of Gitea project_
2019-04-17 04:36:16 +02:00
== DESCRIPTION
gitea2rss fetches the releases from the Gitea API, converts the data into an RSS
feed and dumps it to stdout. You can use cron to generate the feed at fixed
internals.
2019-04-17 05:19:49 +02:00
The generated RSS feed contains the *channel* elements _title_, _link_,
_description_, _generator_ and _lastBuildDate_ and the *item* elements _title_,
_link_, _guid_, _pubDate_ and _description_.
2019-04-17 00:17:26 +02:00
== EXAMPLES
2019-04-17 04:36:16 +02:00
gitea2rss https://example.com/user/repo > repo.rss
2019-04-17 05:19:49 +02:00
=== Example rss feed
----
<rss version="2.0">
<channel>
<title>gitea2rss releases</title>
<link>https://schlomp.space/tastytea/gitea2rss</link>
<description>Releases of tastytea/gitea2rss</description>
<generator>gitea2rss 0.1.0</generator>
<lastBuildDate>Wed, 17 Apr 2019 05:07:25 +0200</lastBuildDate>
<item>
<title>gitea2rss: 0.1.0</title>
<link>https://schlomp.space/tastytea/gitea2rss/releases</link>
<guid isPermaLink="false">schlomp.space release 169</guid>
<pubDate>Wed, 17 Apr 2019 05:37:10 +0200</pubDate>
<description><![CDATA[<p><strong>Stable</strong></p><pre>
First release. Everything works, as far as I can tell.
</pre>]]></description>
</item>
</channel>
</rss>
----
2019-04-17 04:36:16 +02:00
== SEE ALSO
*crontab*(1) *crontab*(5)
2019-04-17 00:17:26 +02:00
== REPORTING BUGS
Bugtracker: https://schlomp.space/tastytea/gitea2rss/issues
E-mail: tastytea@tastytea.de