~chrisppy/beagles

d122400ed35bc611d8b3f918bb015ced2996ec11 — Chris Palmer a month ago 8884c65
man page updates
2 files changed, 146 insertions(+), 119 deletions(-)

M doc/beagles-config.5.scd
M doc/beagles.1.scd
M doc/beagles-config.5.scd => doc/beagles-config.5.scd +133 -102
@@ 4,160 4,191 @@ beagles-config(5)

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

# CONFIG FILE
# DESCRIPTION

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.
*beagles* allows configuring of many of the core functionality within++
the beagles configuration file (config). By default it is located in++
~/.config/beagles. If no config file is found, a default will be++
created.  The configuration file follows the scfg standard

# 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
*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.

## THEME

Theme is defined within a _theme_ _{_ _}_ block.  Colors must 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*.  Note this++
is a required block.

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

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

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

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

	*background-color* - string
		The main background color of the application.
*read-color* - string
	Text color of items marked as read.

	*foreground-color* - string
		The main foreground color of the application.
*COMMAND LINE*
	Command line is defined within a _command-line_ _{_ _}_ block inside a++
	_theme_ _{_ _}_ block.

	*error-color* - string
		The color of error messages.
	*background-color* <color>
		Background color of the command line.

	*separator-color* - string
		The color of separator objects.
	*foreground-color* <color>
		Foreground color of the command line.

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

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

		*background-color* - string
			The background color of the command line.
	*background-color* <color>
		Background color of the status line.

		*foreground-color* - string
			The foreground color of the command line.
	*foreground-color* <color>
		Foreground color of the status line.

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

		*background-color* - string
			The background color of the status line.
	*background-color* <color>
		Background color of the title bar.

		*foreground-color* - string
			The foreground color of the status line.
	*foreground-color* <color>
		Foreground color of the title bar.

	*title-line* - object, optional
*LIST*
	List is defined within a _list_ _{_ _}_ block inside a++
	_theme_ _{_ _}_ block.  This will theme the LIST and++
	FAVORITES pages.

		*background-color* - string
			The background color of the title line.
	*background-color* <color>
		Background color of the list.

		*foreground-color* - string
			The foreground color of the title line.
	*foreground-color* <color>
		Foreground color of the list.

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

		*background-color* - string
			The background color of the list pane.
	*background-color* <color>
		Background color of the tree.

		*foreground-color* - string
			The foreground color of the list pane.
	*foreground-color* <color>
		Foreground color of the tree.

	*tree* - object, optional
*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.

		*background-color* - string
			The background color of the tree pane.
	*background-color* <color>
		Background color of the content.

		*foreground-color* - string
			The foreground color of the tree pane.
	*foreground-color* <color>
		Foreground color of the content.

	*content* - object, optional
## KEY COMMANDS

		*background-color* - string
			The background color of the content pane.
Key commands are defined within a _key-commands_ _{_ _}_ block.  Keys++
can be either a single character or defined by the KeyNames in++
the tcell library (e.g. PgUp).  Note this is a required block.

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

*auto-update-interval* - string, optional
	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.
*list* <key>
	Key used to switch the list page.

*key-commands* - object
*subscription* <key>
	Key used to switch the subscription page.

	*list* - string
		The key used to switch the list page.
*favorite* <key>
	Key used to switch the favorite page.

	*subscription* - string
		The key used to switch the subscription page.
*mark-read* <key>
	Key used to make a post as read.

	*favorite* - string
		The key used to switch the favorite page.
*mark-unread* <key>
	Key used to make a post as unread.

	*mark-read* - string
		The key used to make a post as read.
*mark-favorite* <key>
	Key used to make a post as favorite.

	*mark-unread* - string
		The key used to make a post as unread.
*mark-unfavorite* <key>
	Key used to make a post as unfavorite.

	*mark-favorite* - string
		The key used to make a post as favorite.
*open-url* <key>
	Key used to open the url of the post.

	*mark-unfavorite* - string
		The key used to make a post as unfavorite.
*download* <key>
	Key used to download a single podcast.

	*open-url* - string
		The key used to open the url of the post.
*play* <key>
	Key used to play a podcast.

	*download* - string
		The key used to download a single podcast.
*left* <key>
	Key, other than the left arrow, to move to the++
	left section.

	*play* - string
		The key used to play a podcast.
*up* <key>
	Key, other than the up arrow, to move up in the++
	current	section.

	*left* - string
		The key, other than the left arrow, to move to the left.
		section
*down* <key>
	Key, other than the down arrow, to move down in++
	the current section.

	*up* - string
		The key, other than the up arrow, to move up in the current
		section
*right* <key>
	Key, other than the right arrow, to move to the++
	right section.

	*down* - string
		The key, other than the down arrow, to move down in the current.
		section
*page-up* <key>
	Key to navigate upward quicker in the current++
	section.

	*right* - string
		The key, other than the right arrow, to move to the right.
		section
*page-down* <key>
	Key to navigate downward quicker in the current++
	section.

	*page-up* - string
		The key to navigate upward quicker in the current section.
## BROWSER

	*page-down* - string
		The key to navigate downward quicker in the current section.
Browser is defined within a _browser_ _"http"_ _{_ _}_ block.

*browser "http"* - object, optional
*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.

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

*podcast* - object
Podcast is defined within a _podcast_ _{_ _}_ block.

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

	*external_player* - array, optional
		The caommand to pass to the program, must have [FILE] as one of
		the arguments as that will substitute the podcast file to play.
*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.


# SEE ALSO

M doc/beagles.1.scd => doc/beagles.1.scd +13 -17
@@ 16,13 16,11 @@ or even play the podcasts available on the feed.

# OPTIONS

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

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

*-D*
	Print debug lines.


@@ 30,13 28,11 @@ or even play the podcasts available on the feed.
*-h*
	Print basic usage options.

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

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

*-V*
	Print version information


@@ 84,22 80,22 @@ or even play the podcasts available on the feed.

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

*c*
	mark current post as unfavorite when in LIST, CONTENT,++
	SUBSCRIPTIONS, or FAVORITES
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
or FAVORITES

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

*ENTER*
	expand/collapse subscription in SUBSCRIPTIONS


@@ 114,7 110,7 @@ or even play the podcasts available on the feed.

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

*update, up*
	update all feeds