~chrisppy/beagles

ref: fc86f6d2c37351aa3f06fd83970c91df9ff840f1 beagles/doc/beagles-config.5.scd -rw-r--r-- 4.2 KiB
fc86f6d2Chris Palmer stay on current item in list on update 1 year, 1 month 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-config(5)

# NAME

beagles-config - configuration file format for *beagles*(1)

# CONFIG FILE

The config file for beagles is config.toml, by default it is located in++
~/.config/beagles. If no config file is found, a default will be created.

As indicated by the extension, the config file is in the TOML format.

# OPTIONS

Colors can be specified either as W3C color names or RGB hexadecimal strings
(e.g. #88c0d0).  Also Note that if the object colors are not defined it will,
inherit the colors from *background_color* and *foreground_color*.

Keys can be either a single character or defined by the KeyNames in the tcell
library (e.g. PgUp).

*theme* - object

	*background_color* - string
		The main background color of the application.

	*foreground_color* - string
		The main foreground color of the application.

	*error_color* - string
		The color of error messages.

	*separator_color* - string
		The color of separator objects.

	*read_color* - string
		The color of items marked as read.

	*command_line* - object, optional

		*background_color* - string
			The background color of the command line.

		*foreground_color* - string
			The foreground color of the command line.

	*status_line* - object, optional

		*background_color* - string
			The background color of the status line.

		*foreground_color* - string
			The foreground color of the status line.

	*title_line* - object, optional

		*background_color* - string
			The background color of the title line.

		*foreground_color* - string
			The foreground color of the title line.

	*list* - object, optional

		*background_color* - string
			The background color of the list pane.

		*foreground_color* - string
			The foreground color of the list pane.

	*tree* - object, optional

		*background_color* - string
			The background color of the tree pane.

		*foreground_color* - string
			The foreground color of the tree pane.

	*content* - object, optional

		*background_color* - string
			The background color of the content pane.

		*foreground_color* - string
			The foreground color of the content pane.

*auto_update_interval* - string
	Time between automatic feed update checks, specified by numbers with
	suffixes to denote the units, e.g. "90m", "1h30m45s".  Setting this
	to "0" disables the feature.

*key_commands* - object

	*list* - string
		The key used to switch the list page.

	*subscription* - string
		The key used to switch the subscription page.

	*favorite* - string
		The key used to switch the favorite page.

	*mark_read* - string
		The key used to make a post as read.

	*mark_unread* - string
		The key used to make a post as unread.

	*mark_favorite* - string
		The key used to make a post as favorite.

	*mark_unfavorite* - string
		The key used to make a post as unfavorite.

	*open_url* - string
		The key used to open the url of the post.

	*download* - string
		The key used to download a single podcast.

	*play* - string
		The key used to play a podcast.

	*left* - string
		The key, other than the left arrow, to move to the left.
		section

	*up* - string
		The key, other than the up arrow, to move up in the current
		section

	*down* - string
		The key, other than the down arrow, to move down in the current.
		section

	*right* - string
		The key, other than the right arrow, to move to the right.
		section

	*page_up* - string
		The key to navigate upward quicker in the current section.

	*page_down* - string
		The key to navigate downward quicker in the current section.

*browser* - object, optional

	*http* - object, optional

		*bin* - string
			The program to open the url with.

		*args* - array
			The arguments to pass to the program, must have [URL] as
			one of the arguments as that will substitute the url to
			open.

*podcast* - object

	*auto_download* - boolean
		New podcasts that are found during an update will be downloaded.

	*external_player* - object, optional

		*bin* - string
			The program to play the podcast with.

		*args* - array
			The arguments to pass to the program, must have [FILE]
			as one of the arguments as that will substitute the
			podcast file to play.


# SEE ALSO
	*beagles*(1)

# AUTHORS

Written and maintained by Chris Palmer

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

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