gitea2rss/gitea2rss.1.adoc

70 lines
2.0 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
2019-04-17 05:33:11 +02:00
gitea2rss - Generates RSS feeds from Gitea releases.
2019-04-17 00:17:26 +02:00
== 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
2019-04-17 06:34:48 +02:00
feed and dumps it to stdout. You can use it as a CGI script to generate the
feeds dynamically or simply use cron to generate the feeds at fixed intervals.
If you want to use gitea2rss as a CGI script, you have to set
*GITEA2RSS_BASEURL* to the basis URL of your instance, without the trailing
slash, for example: _https://git.example.com_. The *QUERY_STRING* must contain
_repo=user/project_.
2019-04-17 04:36:16 +02:00
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