readr

Minimal Terminal RSS Reader
Log | Files | Refs | README | LICENSE

readr.1 (1265B)



.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "READR" "1" "2025-10-28"
.PP
.SH NAME
.PP
readr
.PP
.SH SYNOPSIS
.PP
Small RSS viewer in terminal
.PP
.SH DESCRIPTION
.PP
readr is a minimal RSS viewer for the terminal, it reads feeds URLS from a file and displays the posts for quick viewing.\&
.PP
.SH OPTIONS
.PP
See config.\&h, overwrite at will and recompile.\&
.PP
.SH INSTALLATION
.PP
make install
.PP
.SH REQUIREMENTS
.PP
\fBlibcurl\fR(1), \fBlibmrss\fR(1), \fBsqlite3\fR(1)
.PP
.SH EXAMPLES
.PP
Feeds are loaded from a config file; create a file `~/.\&config/readr/feeds`
.PP
Fill it with RSS feeds URLS, one per line, e.\&g.\&
.PP
.nf
.RS 4
https://example1\&.com/rss
https://example2\&.com/rss
https://example3\&.com/rss
.fi
.RE
.PP
Note that currently we load feeds before the UI, so loading readr will take O(n x loadtime)
.PP
.SH KEY BINDINGS
.PP
.PD 0
.IP \(bu 4
Use \fBARROWS\fR to select feeds / posts,
.IP \(bu 4
press \fBENTER\fR to open the post'\&s link,
.IP \(bu 4
press \fBSPACE\fR to open comments, if comments are available.\&
.PD
.PP
.SH AUTHORS
.PP
citbl, 2025
.PP
.SH LICENSE
.PP
Apache-2.\&0