File: nrss.1

package info (click to toggle)
nrss 0.3.9-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, lenny, squeeze, stretch, wheezy
  • size: 204 kB
  • ctags: 380
  • sloc: ansic: 2,603; makefile: 74
file content (137 lines) | stat: -rw-r--r-- 2,431 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
.TH NRSS 1 "26 February 2008" "Version 0.3.9" "NRSS"

.SH NAME
NRSS \- An ncurses RSS reader
.SH DESCRIPTION
NRSS is an RSS reader built to use minimal amounts of external libraries,
using a minimal interface while maintaining a featureful client.

.SH COMMAND LINE USAGE
.TP
\-h
Simple help

.TP
\-v
Print version

.TP
\-c [num]
Set number of columns

.TP
\-D [path]
Set the configuration directory (default: ~/.nrss/)

.TP
\-C [path]
Set the configuration file (default: ~/.nrss/config)

.TP
\-F [path]
Set the feed directory (default: ~/.nrss/feeds)

.TP
\-L [path]
Set the log file (default: ~/.nrss/log)

.SH INTERNAL USAGE
Within the program you can use the following (default) keys.
These can be changed in your configuration file by using the
"key" command.

.TP
UP or DOWN
Select previous or next item/feed (next) (prev)

.TP
PGUP or PGDOWN
Goto previous or next feed (next-feed) (prev-feed)

.TP
h
Display usage (toggle-usage)

.TP
C
Toggle collapse all feeds (toggle-collapse-all)

.TP
Space
Collapse a feed or read a story (default)

.TP
g
Use the defined browser to goto the item's URL (goto)

.TP
x
Show all items in feed (toggle-expand)

.TP
r
Refresh the current feed (refresh)

.TP
R
Refresh all (refresh-all)

.TP
M
Mark all read (mark-all-read)

.TP
D
Redraw screen (redraw)

.TP
q
Quit NRSS (quit)

.SH CONFIGURATION
The ~/.nrss/config file is where all of the configuration is. You can start by using the example config below.

.SH EXAMPLE CONFIG
.sp 1
.nf
default_rate "5"
default_show "30"
default_maxitems "50"

#Add some feeds
add "http://rss.slashdot.org/Slashdot/slashdot" "Slashdot"
add "http://www.digg.com/rss/index.xml" "Digg All"
add "http://newsrss.bbc.co.uk/rss/newsonline_world_edition/front_page/rss.xml" "BBC"
add "http://www.osnews.com/files/recent.xml" "OSNews"
add "http://distrowatch.com/news/dw.xml" "DistroWatch"

#Change rate for Slashdot
rate "30" "Slashdot"

#These aren't defaults, but examples
browser "/usr/bin/elinks %u"

#Text browsers should enable this
browser_wait "1"

.SH FILES
.TP
.I ~/.nrss/config
Main configuration file. For advanced usage, see the online configuration documentation: http://codezen.org/nrss-config

.TP
.I ~/.nrss/log
Everyday log file.

.TP
.I ~/.nrss/feeds/
This is where the raw XML is stored.

.SH BUGS
None known, but it's not outside of the realm of possibility =P.  

.SH HOMEPAGE
http://codezen.org/nrss

.SH AUTHOR
Jack Miller <jjm2n4@umr.edu>