SYNOPSIS

feed-commas [OPTIONS] ..

OPTIONS

The following parameters can be passed to Feed Commas when it’s started:

General options

-c, --config=CONFIG_FILE

Use a CONFIG_FILE as Feed Commas' configuration file. This file is used instead of the one which would be normally found by a default configuration search. If CONFIG_FILE doesn’t exists, it is created.

Feed Commas reports if CONFIG_FILE is incorrect somehow or if it couldn’t be created and quits in that case.

Program information

--help

Prints a short summary of available program options and quits.

--version

Prints a version of Feed Commas and quits.

CONFIGURATION

Feed Commas can be configured by setting options in a standard ini-style configuration file. If not specified via -c, --config flag, configuration 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 previous ones weren’t found:

  1. $XDG_CONFIG_HOME/feed-commas/config.ini. If $XDG_CONFIG_HOME is not set, it defaults to $HOME/.config.

  2. 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.

Before Feed Commas terminates, configuration written back.

Note
Specific configuration files

You can tell Feed Commas to use a specific configuration file by using -c, --config switch. Feed Commas will read it (or create it if it doesn’t exist) and everything else will work the same as with configuration found by above method.

$ feed-commas -c ~/feedcommasrc

Copyright © 2017 Michał Góral.

Feed Commas is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Feed Commas is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

BUGS AND ISSUES

SEE ALSO

Full Documentation

This man page doesn’t cover the whole usage of Feed Commas. A complete manual is available online: http://pythonhosted.org/feedcommas/.

You can also generate it by running make inside Feed Commas' docs directory.