feed: Disable feedparser's PREFERRED_XML_PARSERS

[rss2email.git] / r2e.1

diff --git a/r2e.1 b/r2e.1
index 16451370b15fb91bd340f1654d6e267c9956d134..19da7008e1bd328543f399e7474db5ead2f72934 100644 (file)
--- a/r2e.1
+++ b/r2e.1
@@ -29,12 +29,14 @@ Print the rss2email help and exit.
 Print the rss2email version and exit.
 .TP
 \-c, \-\-config \fI<path>\fR
-The program is configured by ~/\&.config/rss2mail/config by
-default. Use this option to set a different config file.
+The program configuration is read from $XDG_CONFIG_HOME/rss2mail.cfg
+by default (see also FILES and ENVIRONMENT VARIABLES below).  Use this
+option to set a different configuration file.
 .TP
 \-d, \-\-data \fI<path>\fR
-The program is configured by ~/\&.config/rss2mail/config by
-default. Use this option to set a different config file.
+Dynamic program data is read from $XDG_DATA_HOME/rss2mail\&.json by
+default (see also FILES and ENVIRONMENT VARIABLES below).  Use this
+option to set a different data file.
 .TP
 \-V, \-\-verbose
 Increment the logging verbosity.
@@ -99,10 +101,11 @@ data will be written.  If \fI<path>\fR is not given \fBr2e\fR writes
 the data to stdout.
 .SH "CONFIGURATION"
 The program's behavior can be controlled via the
-~/.config/rss2email/config file. The file format is similar to a
-Microsoft Windows INI file.  It is parsed by Python's ConfigParser
-class, so see the Python documentation at
-http://docs\&.python\&.org/py3k/library/configparser\&.html for format
+$XDG_CONFIG_HOME/rss2email.cfg (see also FILES and ENVIRONMENT
+VARIABLES below). The file format is similar to a Microsoft Windows
+INI file.  It is parsed by Python's ConfigParser class, so see the
+Python documentation at
+http://docs\&.python\&.org/3/library/configparser\&.html for format
 details.
 .P
 The config file stores general configuration (applied to all feeds) in
@@ -118,11 +121,11 @@ setting to the feed-specific section.  Here is an example overriding
 .RS 4
 .nf
 [DEFAULT]
-from = bozo@dev.null.invalid
+from = user@rss2email.invalid
 force-from = False
 use-publisher-email = False
 friendly-name = True
-...
+  .\|.\|.
 verbose = warning
 
 [feed.feedname]
@@ -132,17 +135,41 @@ friendly-name = False
 .RE
 .P
 .SH FILES
+.TP 4
+.B $XDG_CONFIG_HOME/rss2email.cfg
+If this file exists, it it read to configure the program.
 .TP
-.B ~/.rss2email/feeds\&.dat
+.B $XDG_DATA_HOME/rss2email\&.json
 The database of feeds. Use \fBr2e\fR to add, remove, or modify feeds,
 do not edit it directly.
-.TP
-.B ~/.rss2email/config\&.py
-If this file exists, it it read to configure the program.
+.SH "ENVIRONMENT VARIABLES"
+The environment variables used by \fBr2e\fR are all defined in the XDG
+Base Directory Specification, which aims to standardize locations for
+user-specific configuration and data files.
+.TP 4
+.B XDG_CONFIG_HOME
+The preferred directory for configuration files.  Defaults to
+$HOME/\&.config.
+.TP
+.B XDG_DATA_HOME
+The preferred directory for data files.  Defaults to
+$HOME/\&.local/share.
+.TP
+.B XDG_CONFIG_DIRS
+A colon ':' separated, preference ordered list of base directories for
+configuration files in addition to $XDG_CONFIG_HOME.  Defaults to
+/etc/xdg.  If multiple configuration files are found in this path,
+they will all be read by the ConfigParser class (see also
+CONFIGURATION above).
+.TP
+.B XDG_DATA_DIRS
+A colon ':' separated, preference ordered list of base directories for
+data files.  Defaults to /usr/local/share/:/usr/share/.  Only the
+first matching file is used.
+.B 
 .SH AUTHORS
 rss2email was started by Aaron Swartz, and is currently maintained by
-Lindsey Smith.  For a more complete list of contributors, see the
-__contributors__ list in rss2email\&.py.
-.SH "REPORTING BUGS"                                                            
-Report bugs to the current maintainer (see the __author__ string in
-rss2email\&.py).
+W. Trevor King.  For a more complete list of contributors, see the
+__contributors__ list in rss2email/__init__\&.py.
+.SH "REPORTING BUGS"
+Report bugs to the mailing list (see the README for details).