SYNOPSIS
feedcommas
Configuration
Feed Commas can be configured by setting several options in a standard
ini-style configuration file. The file
is searched in a filesystem in a way described by XDG Base
Directory Specification. In practice it means that for most users it will be
located in ~/.config/feed-commas/config.ini
. However, any of below files can
be read if the none of the previous ones was found:
-
$XDG_CONFIG_HOME/feed-commas/config.ini
. If$XDG_CONFIG_HOME
is not set, it defaults to$HOME/.config
. -
any of
$XDG_DATA_DIRS/feed-commas/config.ini
.$XDG_DATA_DIRS
is colon-separated list of directories to check. If it is not set, it defaults to/etc/xdg
.
If configuration file is not found, Feed Commas will create one with default
parameters filled in a first suitable directory
($XDG_CONFIG_HOME/feed-commas
).
Before Feed Commas terminates, previously read configuration file is saved back to a filesystem.
Structure
INI files are made up of sections, and so is the one Feed Commas uses. Below is
example (but not complete) of file, which has [server]
and [keys]
sections.
[server] address = https://commafeed.com workers = 2 [keys] nav-up = k nav-down = j
Server
[server]
contains options for configuring access to CommaFeed server.
Option | Default value | Description |
---|---|---|
|
|
Address of CommaFeed instance with which Feed Commas will communicate. |
|
name used to login to CommaFeed instance. |
|
|
Plain text password which will be used to login to CommaFeed. Due to security reasons, it is not recommended leave passwords as plain text in any configuration file. Use password-cmd instead, which will dynamically get needed password. |
|
|
A command used to get password to login to CommaFeed. It takes precedence over password, even if the latter is set. |
|
|
|
Number of worker processes used to communicate with CommaFeed. If it is unset, workers will be spawned in a number equal to available CPU cores. |
Keys
[keys]
contains key mappings used in Feed Commas.
Option | Default value | Description |
---|---|---|
|
Navigates and scrolls up. It is used e.g. to navigate a menu and scroll article list. |
|
|
|
Navigates and scrolls down. It is used e.g. to navigate a menu and scroll article list. |
|
|
Navigates right. It is used e.g. to switch used panel from menu to article list. |
|
|
Navigates right. It is used e.g. to switch used panel from article list to menu. |
|
Toggles between read and unread state for currently selected article. |
|
|
|
Stars or unstars currently selected article. |
|
Shows both unread and read entries. |
|
|
Shows only unread entries. |
|
|
|
Refreshes list of articles. Also clears a cache. |
|
Downloads all feeds and categories for offline read. Only works if cache if
|
|
|
|
Opens selected article in a default web browser. Refer to the documentation
of your Operating System how to configure one. Usually setting |
|
|
Quits Feed Commas. |
Key values can contain modifiers, but they heavily depend on what keycodes terminal sends. For example, terminals usually won’t explicitly send kbd:[shift], but uppercase letters instead (so instead of mapping kbd:[shift+e], map kbd:[E]).
Any combination of kbd:[ctrl] and kbd:[alt] modifiers is available as c-
and
a-
prefixes. Other keys are also available:
Key on keyboard | config.ini notation |
---|---|
kbd:[ctrl] |
|
kbd:[alt] |
|
kbd:[shift] |
|
kbd:[↑] |
|
kbd:[↓] |
|
kbd:[←] |
|
kbd:[→] |
|
kbd:[Enter] |
|
kbd:[Return] |
|
kbd:[Page Up] |
|
kbd:[Page Down] |
|
kbd:[F5] |
|
Examples |
|
kbd:[ctrl+a] |
|
kbd:[alt+a] |
|
kbd:[ctrl+alt+←] |
|
kbd:[alt+Enter] |
|
Warning
|
Non-character keys should be written lower-case! Instead of typing F5 ,
type f5 , page down , enter and so on.
|
Settings
[settings]
section contains options affecting various behaviours of
Feed Commas.
Option | Default value | Description |
---|---|---|
|
|
Time (in seconds) after which currently selected article will be marked as read. If set to 0, articles will be marked as read immediately. If set to -1, articles won’t be automatically marked as read. Usually it’s advised to be kept as positive integer, which will prevent marking articles as unread when scrolling through an article list. |
|
|
If set to true, all articles will be shown on the article list. If set to
false, only unread articles will be shown. Using
|
|
|
Number of colors supported by terminal. Most terminals nowdays support at least 256 colors, so if things work for you, don’t change this setting. Valid values: 1, 16, 88, 256 |
|
|
Display bright colors as bold (some terminals work that way). Change it to true if you don’t see a difference when using bright colors. |
|
|
Method of filtering HTML in received entries so they’re readable. Can be either of the following:
|
|
Time (in minutes) for which each request to CommaFeed will be cached. If not set or set to 0, caching is disabled. |
Tip
|
html-filter commands usage
Both lynx and elinks work very well as The best results are achieved when they are configured with a dump wide enough, so that Feed Commas can take care of line wrapping: html-filter = elinks -dump -dump-width 500 html-filter = lynx -dump -width 500 -stdin |
Colors
Different parts of Feed Commas can be colorized to your liking by setting
different options in [colors]
section. Default values are sensible, but the
end-result depends on terminal’s color capabilities. Color can be empty, in
which case
Option | Default value | Affected elements |
---|---|---|
|
|
Color of article’s title. |
|
|
Color of currently selected article’s title. |
|
|
Color of currently selected article’s border. |
|
|
Various meta data information: article’s publication date, article’s header, various indicators on articles list, number of unread articles in menu etc. |
|
|
Foreground color of currently selected menu item. |
|
|
Background color of currently selected menu item. |
|
|
Color of currently active feed or category. |
|
|
Color of line separating menu and article list. |
|
|
Foreground color of errors displayed in commandline. |
|
|
Background color of errors displayed in commandline. |
Monochrome, 16-, 88- and 256-color terminals are supported. As a color name you can use any of standard color values: black, dark red, dark green, brown, dark blue, dark magenta, dark cyan, light gray, dark gray, light red, light green, yellow, light blue, light magenta, light cyan, white. For terminals which support that, you can also use other notations:
-
#fcc
: hex like HTML color; -
g40
: decimal value: 40% of gray -
g#cc
: hex value: 80% of gray -
h255
: color number 255
For different terminals colors are configured in different ways, but most often
they’re defined in ~/.Xresources
file. Consult your terminal’s documentation
for details.
Apart from color name, you can specify some text attributes, which should be placed after comma. These attributes include bold, underline, blink and standout. Color value can be omitted, in which case a default foreground or background color for your terminal will be used.
Setting | Description |
---|---|
|
Set color to "dark gray" standard color. |
|
Set font to bold red. |
|
Set font to bold. Default color will be used (depending on which option is set) |