~chrisppy/beagles

5d7a632c35c03b7735c15cf837cfcc93a5e595d0 — Chris Palmer a month ago 6dbb283
fixes for man page
1 files changed, 60 insertions(+), 62 deletions(-)

M doc/beagles-config.5.scd
M doc/beagles-config.5.scd => doc/beagles-config.5.scd +60 -62
@@ 13,12 13,10 @@ created.  The configuration file follows the scfg standard

# OPTIONS



*auto-update-interval* <duration>
*auto-update-interval* "<duration>"
	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.
numbers with suffixes to denote the units, e.g. "90m",++
"1h30m45s".  Setting this to "0" disables the feature.

## THEME



@@ 28,83 26,83 @@ Also Note that if the object colors are not defined it will, inherit++
the colors from *background-color* and *foreground-color*.  Note this++
is a required block.

*background-color* <color>
*background-color* "<color>"
	Background color of the application when not set in sub blocks.

*foreground-color* <color>
*foreground-color* "<color>"
	Foreground color of the application when not set in sub blocks.

*error-color* <color>
*error-color* "<color>"
	Text color of error messages.

*separator-color* <color>
*separator-color* "<color>"
	Color of separator objects.

*read-color* - string
*read-color* "<color>"
	Text color of items marked as read.

*COMMAND LINE*
	Command line is defined within a _command-line_ _{_ _}_ block inside a++
	_theme_ _{_ _}_ block.
_theme_ _{_ _}_ block.

	*background-color* <color>
	*background-color* "<color>"
		Background color of the command line.

	*foreground-color* <color>
	*foreground-color* "<color>"
		Foreground color of the command line.


*STATUS LINE*
	Status line is defined within a _status-line_ _{_ _}_ block inside a++
	_theme_ _{_ _}_ block.
_theme_ _{_ _}_ block.

	*background-color* <color>
	*background-color* "<color>"
		Background color of the status line.

	*foreground-color* <color>
	*foreground-color* "<color>"
		Foreground color of the status line.

*TITLE BAR*
	Title bar is defined within a _title-bar_ _{_ _}_ block inside a++
	_theme_ _{_ _}_ block.
_theme_ _{_ _}_ block.

	*background-color* <color>
	*background-color* "<color>"
		Background color of the title bar.

	*foreground-color* <color>
	*foreground-color* "<color>"
		Foreground color of the title bar.

*LIST*
	List is defined within a _list_ _{_ _}_ block inside a++
	_theme_ _{_ _}_ block.  This will theme the LIST and++
	FAVORITES pages.
_theme_ _{_ _}_ block.  This will theme the LIST and++
FAVORITES pages.

	*background-color* <color>
	*background-color* "<color>"
		Background color of the list.

	*foreground-color* <color>
	*foreground-color* "<color>"
		Foreground color of the list.

*TREE*
	Tree is defined within a _tree_ _{_ _}_ block inside a++
	_theme_ _{_ _}_ block.  This will theme the SUBSCRIPTION++
	page.
_theme_ _{_ _}_ block.  This will theme the SUBSCRIPTION++
page.

	*background-color* <color>
	*background-color* "<color>"
		Background color of the tree.

	*foreground-color* <color>
	*foreground-color* "<color>"
		Foreground color of the tree.

*CONTENT*
	Content is defined within a _content _{_ _}_ block inside a++
	_theme_ _{_ _}_ block.  This will theme the reading panes++
	with the LIST, SUBSCRIPTIONS, FAVORITES, and HELP pages.
	Content is defined within a _content_ _{_ _}_ block inside a++
_theme_ _{_ _}_ block.  This will theme the reading panes++
with the LIST, SUBSCRIPTIONS, FAVORITES, and HELP pages.

	*background-color* <color>
	*background-color* "<color>"
		Background color of the content.

	*foreground-color* <color>
	*foreground-color* "<color>"
		Foreground color of the content.

## KEY COMMANDS


@@ 114,81 112,81 @@ can be either a single character or defined by the KeyNames in++
the tcell library (e.g. PgUp).  Note this is a required block.


*list* <key>
*list* "<key>"
	Key used to switch the list page.

*subscription* <key>
*subscription* "<key>"
	Key used to switch the subscription page.

*favorite* <key>
*favorite* "<key>"
	Key used to switch the favorite page.

*mark-read* <key>
*mark-read* "<key>"
	Key used to make a post as read.

*mark-unread* <key>
*mark-unread* "<key>"
	Key used to make a post as unread.

*mark-favorite* <key>
*mark-favorite* "<key>"
	Key used to make a post as favorite.

*mark-unfavorite* <key>
*mark-unfavorite* "<key>"
	Key used to make a post as unfavorite.

*open-url* <key>
*open-url* "<key>"
	Key used to open the url of the post.

*download* <key>
*download* "<key>"
	Key used to download a single podcast.

*play* <key>
*play* "<key>"
	Key used to play a podcast.

*left* <key>
*left* "<key>"
	Key, other than the left arrow, to move to the++
	left section.
left section.

*up* <key>
*up* "<key>"
	Key, other than the up arrow, to move up in the++
	current	section.
current	section.

*down* <key>
*down* "<key>"
	Key, other than the down arrow, to move down in++
	the current section.
the current section.

*right* <key>
*right* "<key>"
	Key, other than the right arrow, to move to the++
	right section.
right section.

*page-up* <key>
*page-up* "<key>"
	Key to navigate upward quicker in the current++
	section.
section.

*page-down* <key>
*page-down* "<key>"
	Key to navigate downward quicker in the current++
	section.
section.

## BROWSER

Browser is defined within a _browser_ _"http"_ _{_ _}_ block.

*navigate* <command>
*navigate* "<command>"
	The command to pass to the program, must have [URL]++
	as one of the arguments as that will substitute the++
	url to open.
as one of the arguments as that will substitute the++
url to open.

## PODCAST

Podcast is defined within a _podcast_ _{_ _}_ block.

*auto-download* true|false
*auto-download* "true"|"false"
	New podcasts that are found during an update will++
	be downloaded.
be downloaded.

*external_player* <command>
*external_player* "<command>"
	The command to pass to the program, must have [FILE]++
	as one of the arguments as that will substitute the++
	podcast file to play.
as one of the arguments as that will substitute the++
podcast file to play.


# SEE ALSO