commit e36625bcf9d1aab00af5410ee9a11f7312a4eb95
from: witcher <witcher@wiredspace.de>
date: Sat Dec 17 20:50:19 2022 UTC

Add man page for configuration files

commit - e0754dd186ce05e3754a3ad7bb29fba6882200be
commit + e36625bcf9d1aab00af5410ee9a11f7312a4eb95
blob - 327351863194e350d63da0ae55423d7c19d2a798
blob + af9d0554f7d91b378e7e6efe85e559c10dce1314
--- docs/rss-email.1.scd
+++ docs/rss-email.1.scd
@@ -38,6 +38,10 @@ The following options are recognized by *rss-email*:
 	Specifies a custom urls file to be used instead of the default one at
 	*$XDG_CONFIG_HOME/rss-email/urls*
 
+# SEE ALSO
+
+*rss-email*(5)
+
 # AUTHORS
 
 Maintained by witcher <witcher@wiredspace.de>. Up-to-date source code can be
blob - /dev/null
blob + 3ea64a00623a1f692b97061969e7e90f4a409312 (mode 644)
--- /dev/null
+++ docs/rss-email.5.scd
@@ -0,0 +1,65 @@
+rss-email(5)
+
+# NAME
+
+rss-email - Configuration file
+
+# DESCRIPTION
+
+There exist 2 configuration files for *rss-email*(1):
+
+- *config.toml*, referred to as "configuration file"
+- *urls*, referred to as "URLs file"
+
+Both files can be found in *$XDG_CONFIG_HOME/rss-email/*, but alternative
+files in potentially different directories can be specified as command line
+arguments to *rss-email*(1).
+
+# Configuration file
+
+The configuration file contains all necessary configuration to
+send an email.
+
+## Global section
+
+The global section of the configuration file defines 2 attributes:
+
+- *from*: String
+- *to*: String
+
+They must be valid email addresses and will be used as the *From* and *To*
+header respectively.
+
+## SMTP section
+
+This section, defined as *smtp*, contains the necessary SMTP configuration for
+sending emails. The following attributes exist:
+
+- *user*: String
+- *password*: String
+- *server*: String
+- *port*: Int
+
+*user* and *password* define the username and password used to authenticate with
+SMTP. *server* and *port* define the server and port of the SMTP server that
+should be used.
+
+Note that it is currently not possible to specify a password in any other way
+than with the *password* attribute, meaning it has to be saved in plain-text.
+
+# URLs file
+
+The URLs file is a list of URLs with RSS/Atom feeds separated by newlines.
+
+Comments are supported only at the beginning of a line and are specified with
+*#*. If a line starts with the comment character it will be ignored completely.
+
+# SEE ALSO
+
+*rss-email*(1)
+
+# AUTHORS
+
+Maintained by witcher <witcher@wiredspace.de>. Up-to-date source code can be
+found at https://sr.ht/~witcher/rss-email/, and bugs/patches can be submitted by
+email to ~witcher/rss-email-devel@lists.sr.ht.