readr

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

readr.1 (1265B)


      1 .\" Generated by scdoc 1.11.3
      2 .\" Complete documentation for this program is not available as a GNU info page
      3 .ie \n(.g .ds Aq \(aq
      4 .el       .ds Aq '
      5 .nh
      6 .ad l
      7 .\" Begin generated content:
      8 .TH "READR" "1" "2025-10-28"
      9 .PP
     10 .SH NAME
     11 .PP
     12 readr
     13 .PP
     14 .SH SYNOPSIS
     15 .PP
     16 Small RSS viewer in terminal
     17 .PP
     18 .SH DESCRIPTION
     19 .PP
     20 readr is a minimal RSS viewer for the terminal, it reads feeds URLS from a file and displays the posts for quick viewing.\&
     21 .PP
     22 .SH OPTIONS
     23 .PP
     24 See config.\&h, overwrite at will and recompile.\&
     25 .PP
     26 .SH INSTALLATION
     27 .PP
     28 make install
     29 .PP
     30 .SH REQUIREMENTS
     31 .PP
     32 \fBlibcurl\fR(1), \fBlibmrss\fR(1), \fBsqlite3\fR(1)
     33 .PP
     34 .SH EXAMPLES
     35 .PP
     36 Feeds are loaded from a config file; create a file `~/.\&config/readr/feeds`
     37 .PP
     38 Fill it with RSS feeds URLS, one per line, e.\&g.\&
     39 .PP
     40 .nf
     41 .RS 4
     42 https://example1\&.com/rss
     43 https://example2\&.com/rss
     44 https://example3\&.com/rss
     45 .fi
     46 .RE
     47 .PP
     48 Note that currently we load feeds before the UI, so loading readr will take O(n x loadtime)
     49 .PP
     50 .SH KEY BINDINGS
     51 .PP
     52 .PD 0
     53 .IP \(bu 4
     54 Use \fBARROWS\fR to select feeds / posts,
     55 .IP \(bu 4
     56 press \fBENTER\fR to open the post'\&s link,
     57 .IP \(bu 4
     58 press \fBSPACE\fR to open comments, if comments are available.\&
     59 .PD
     60 .PP
     61 .SH AUTHORS
     62 .PP
     63 citbl, 2025
     64 .PP
     65 .SH LICENSE
     66 .PP
     67 Apache-2.\&0