~chrisppy/beagles

ref: 0ef7727f984cfc303652417ec35ed325e4e6a6f8 beagles/doc/beagles.1.scd -rw-r--r-- 3.1 KiB
0ef7727fChris Palmer Added stub for restore and updated manpage 1 year, 4 months ago
                                                                                
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
beagles(1)

# NAME

beagles - TUI RSS feed aggregator

# SYNOPSIS

*beagles* [POSIX style options] [command] ...

# DESCRIPTION

_beagles_ is a terminal user interface RSS aggregator that allows++
you to keep track of RSS feeds, favorite them for quick reference,++
or even play the podcasts available on the feed.

# OPTIONS

*-c [directory]*
	Set the config directory.  If not set, use *XDG_CONFIG_HOME*/beagles.

*-d [directory]*
	Set the database directory.  If not set, use *XDG_DATA_HOME*/beagles.

*-D*
	Print debug lines.

*-f [file]*
	Set the file used to import or restore.

*-g [directory]*
	Set the directory for your gemini known_hosts.  If not set, use++
*XDG_DATA_HOME*/gemini.

*-h*
	Print basic usage options.

*-l [directory]*
	Set the logging directory.  If not set, use *XDG_CACHE_HOME*/beagles.

*-p [directory]*
	Set the directory to use for export or backup.

*-s [directory]*
	Set the download directory. If not set use *XDG_DATA_HOME*/beagles.

*-V*
	Print version information

# COMMANDS

*import*
	Import feeds from an OPML file.  Must be used with the *-f* option.

*export*
	Export feeds to an OPML file.  Must be used with the *-p* option.

*backup*
	Backup all feed details to a barefeed file.  Must be used with the++
*-p* option.

*restore*
	Restore feed details from a barefeed file.  Must be used with the++
*-f* option.  *Note this will replace all data*.

# USAGE

## GENERAL

*L*
	display list page

*S*
	display subscriptions page

*F*
	display favorites page

*?*
	display help page

*h*
	move to the left section (if applicable)

*j*
	navigate down in the current section (if applicable)

*k*
	navigate up in the current section (if applicable)

*l*
	move the the right section (if applicable)

*PgUp*
	navigate upward quicker (if applicable)

*PgDn*
	navigate downward quicker (if applicable)

*m*
	mark current post as read when in LIST, CONTENT, or SUBSCRIPTIONS

*u*
	mark current post as unread when in CONTENT or SUBSCRIPTIONS

*f*
	mark current post as favorite when in LIST, CONTENT, or
SUBSCRIPTIONS

*c*
	unmark current post as favorite when in LIST, CONTENT,++
SUBSCRIPTIONS, or FAVORITES

*n*
	open post url when in LIST, CONTENT, SUBSCRIPTIONS, or FAVORITES

*d*
	download a single podcast when in LIST, CONTENT, SUBSCRIPTIONS,++
or FAVORITES

*p*
	play single podcast when in LIST, CONTENT, SUBSCRIPTIONS, or++
FAVORITES

*ENTER*
	expand/collapse subscription in SUBSCRIPTIONS

*:*
	enter command mode

## COMMAND MODE

*add* [url]
	add a feed

*export* [path]
	export an opml file

*help, h*
	display help page

*hide*
	hide read posts in SUBSCRIPTIONS

*import* [path]
	import an opml file

*quit, q*
	exit the application

*remove, rm* [url]
	remove the feed, note you can omit the url if you are in the++
subscription page on a current feed

*unhide*
	unhide read posts in SUBSCRIPTIONS

*update, up*
	update all feeds


# CONFIGURATION

See *beagles-config*(5)

# BUGS

https://todo.sr.ht/~chrisppy/beagles

# HOMEPAGE

https://sr.ht/~chrisppy/beagles

# SEE ALSO

*beagles-config*(5)

# AUTHORS

Written and maintained by Chris Palmer

beagles v0.2.0 is available under the terms of the GPL-3.0 license.

Copyright © 2020  Chris Palmer <chris@red-oxide.org>