readr.html (3498B)
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
Generated by scdoc 1.11.3
Complete documentation for this program is not available as a GNU info page
-->
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<style>
table.head, table.foot { width: 100%; }
td.head-rtitle, td.foot-os { text-align: right; }
td.head-vol { text-align: center; }
.Nd, .Bf, .Op { display: inline; }
.Pa, .Ad { font-style: italic; }
.Ms { font-weight: bold; }
.Bl-diag > dt { font-weight: bold; }
code.Nm, .Fl, .Cm, .Ic, code.In, .Fd, .Fn, .Cd { font-weight: bold;
font-family: inherit; }
</style>
<title>READR(1)</title>
<style>html{background: #333; color: #eee; max-width: 50rem; margin: 1rem auto; font-family: sans-serif;} a{color: white;}</style></head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">READR(1)</td>
<td class="head-vol">General Commands Manual</td>
<td class="head-rtitle">READR(1)</td>
</tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp">readr</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">Small RSS viewer in terminal</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">readr is a minimal RSS viewer for the terminal, it reads feeds
URLS from a file and displays the posts for quick viewing.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="OPTIONS"><a class="permalink" href="#OPTIONS">OPTIONS</a></h1>
<p class="Pp">See config.h, overwrite at will and recompile.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="INSTALLATION"><a class="permalink" href="#INSTALLATION">INSTALLATION</a></h1>
<p class="Pp">make install</p>
</section>
<section class="Sh">
<h1 class="Sh" id="REQUIREMENTS"><a class="permalink" href="#REQUIREMENTS">REQUIREMENTS</a></h1>
<p class="Pp"><b>libcurl</b>(1), <b>libmrss</b>(1), <b>sqlite3</b>(1)</p>
</section>
<section class="Sh">
<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
<p class="Pp">Feeds are loaded from a config file; create a file
`~/.config/readr/feeds`</p>
<p class="Pp">Fill it with RSS feeds URLS, one per line, e.g.</p>
<p class="Pp"></p>
<div class="Bd-indent">
<pre>https://example1.com/rss
https://example2.com/rss
https://example3.com/rss</pre>
</div>
<p class="Pp">Note that currently we load feeds before the UI, so loading readr
will take O(n x loadtime)</p>
</section>
<section class="Sh">
<h1 class="Sh" id="KEY_BINDINGS"><a class="permalink" href="#KEY_BINDINGS">KEY
BINDINGS</a></h1>
<ul class="Bl-bullet">
<li>Use <b>ARROWS</b> to select feeds / posts,</li>
<li>press <b>ENTER</b> to open the post's link,</li>
<li>press <b>SPACE</b> to open comments, if comments are available.</li>
</ul>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">citbl, 2025</p>
</section>
<section class="Sh">
<h1 class="Sh" id="LICENSE"><a class="permalink" href="#LICENSE">LICENSE</a></h1>
<p class="Pp">Apache-2.0</p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">2025-10-28</td>
<td class="foot-os"></td>
</tr>
</table>
</body>
</html>