readr.html (3498B)
1 <!DOCTYPE html> 2 <html> 3 <!-- This is an automatically generated file. Do not edit. 4 Generated by scdoc 1.11.3 5 Complete documentation for this program is not available as a GNU info page 6 --> 7 <head> 8 <meta charset="utf-8"/> 9 <meta name="viewport" content="width=device-width, initial-scale=1.0"/> 10 <style> 11 table.head, table.foot { width: 100%; } 12 td.head-rtitle, td.foot-os { text-align: right; } 13 td.head-vol { text-align: center; } 14 .Nd, .Bf, .Op { display: inline; } 15 .Pa, .Ad { font-style: italic; } 16 .Ms { font-weight: bold; } 17 .Bl-diag > dt { font-weight: bold; } 18 code.Nm, .Fl, .Cm, .Ic, code.In, .Fd, .Fn, .Cd { font-weight: bold; 19 font-family: inherit; } 20 </style> 21 <title>READR(1)</title> 22 <style>html{background: #333; color: #eee; max-width: 50rem; margin: 1rem auto; font-family: sans-serif;} a{color: white;}</style></head> 23 <body> 24 <table class="head"> 25 <tr> 26 <td class="head-ltitle">READR(1)</td> 27 <td class="head-vol">General Commands Manual</td> 28 <td class="head-rtitle">READR(1)</td> 29 </tr> 30 </table> 31 <div class="manual-text"> 32 <section class="Sh"> 33 <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> 34 <p class="Pp">readr</p> 35 </section> 36 <section class="Sh"> 37 <h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> 38 <p class="Pp">Small RSS viewer in terminal</p> 39 </section> 40 <section class="Sh"> 41 <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> 42 <p class="Pp">readr is a minimal RSS viewer for the terminal, it reads feeds 43 URLS from a file and displays the posts for quick viewing.</p> 44 </section> 45 <section class="Sh"> 46 <h1 class="Sh" id="OPTIONS"><a class="permalink" href="#OPTIONS">OPTIONS</a></h1> 47 <p class="Pp">See config.h, overwrite at will and recompile.</p> 48 </section> 49 <section class="Sh"> 50 <h1 class="Sh" id="INSTALLATION"><a class="permalink" href="#INSTALLATION">INSTALLATION</a></h1> 51 <p class="Pp">make install</p> 52 </section> 53 <section class="Sh"> 54 <h1 class="Sh" id="REQUIREMENTS"><a class="permalink" href="#REQUIREMENTS">REQUIREMENTS</a></h1> 55 <p class="Pp"><b>libcurl</b>(1), <b>libmrss</b>(1), <b>sqlite3</b>(1)</p> 56 </section> 57 <section class="Sh"> 58 <h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> 59 <p class="Pp">Feeds are loaded from a config file; create a file 60 `~/.config/readr/feeds`</p> 61 <p class="Pp">Fill it with RSS feeds URLS, one per line, e.g.</p> 62 <p class="Pp"></p> 63 <div class="Bd-indent"> 64 <pre>https://example1.com/rss 65 https://example2.com/rss 66 https://example3.com/rss</pre> 67 </div> 68 <p class="Pp">Note that currently we load feeds before the UI, so loading readr 69 will take O(n x loadtime)</p> 70 </section> 71 <section class="Sh"> 72 <h1 class="Sh" id="KEY_BINDINGS"><a class="permalink" href="#KEY_BINDINGS">KEY 73 BINDINGS</a></h1> 74 <ul class="Bl-bullet"> 75 <li>Use <b>ARROWS</b> to select feeds / posts,</li> 76 <li>press <b>ENTER</b> to open the post's link,</li> 77 <li>press <b>SPACE</b> to open comments, if comments are available.</li> 78 </ul> 79 </section> 80 <section class="Sh"> 81 <h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> 82 <p class="Pp">citbl, 2025</p> 83 </section> 84 <section class="Sh"> 85 <h1 class="Sh" id="LICENSE"><a class="permalink" href="#LICENSE">LICENSE</a></h1> 86 <p class="Pp">Apache-2.0</p> 87 </section> 88 </div> 89 <table class="foot"> 90 <tr> 91 <td class="foot-date">2025-10-28</td> 92 <td class="foot-os"></td> 93 </tr> 94 </table> 95 </body> 96 </html>