commit ded4df750c33005934b50605dd106addbe05b682
from: witcher <witcher@wiredspace.de>
date: Mon Aug 15 14:34:58 2022 UTC

Add man page

commit - 3fe96bd12a76b76458f85d936050cf782bce0c16
commit + ded4df750c33005934b50605dd106addbe05b682
blob - fc6fa7d0e8b13276f78ae6d6173d35d71553a977
blob + d501bd96814e3c15dae8ac01938587069f50cdc2
--- README.md
+++ README.md
@@ -7,13 +7,20 @@ Fetch new RSS feed items and send them via E-Mail.
 Install the dependencies:
 
 - Rust
+- scdoc (optional)
 
-Then compile rss-email:
+Then compile `rss-email`:
 
 ```
 cargo build
 ```
 
+To build the man page, use `scdoc`:
+
+```
+scdoc < docs/rss-email.1.scd > docs/rss-email.1
+```
+
 ## Usage
 
 - Copy the `config.example.toml` to `~/rss-email/config.toml` and adjust the
@@ -23,7 +30,8 @@ values
 The database used with `rss-email` is generated automatically if it doesn't exist
 yet
 
-See `-h` for more info.
+See the man page or `-h` for more info. You can view the man page after
+generating it with `scdoc` with `man -l docs/rss-email.1`.
 
 ## Resources
 
blob - /dev/null
blob + a0e196a905d65bb01a094f6f4b9980fdfa6275a4 (mode 644)
--- /dev/null
+++ docs/rss-email.1.scd
@@ -0,0 +1,43 @@
+rss-email(1)
+
+# NAME
+
+rss-email - Fetch new RSS feed items and send them via E-Mail
+
+# SYNOPSIS
+
+*rss-email* [--config <config-path>] [--database <database-path>] [--dry-run] [-h|--help] [--urls <urls-path>] [-V|--version]
+
+# DESCRIPTION
+
+*rss-email* fetches a list of RSS feeds, saves the items in a database and
+sends new feeds via E-Mail.
+
+A custom path for the configuration, database or urls file can be specified via the commandline.
+
+The database used is *sqlite3*.
+
+## OPTIONS
+
+The following options are recognized by *rss-email*:
+
+*--config* _config-path_
+	Specifies a custom configuration to be used instead of the default one at
+	*$XDG_CONFIG_HOME/rss-email/config.toml*
+
+*--database* _database-path_
+	Specifies a custom database to be used instead of the default one at
+	*$XDG_CONFIG_HOME/rss-email/cache.db*
+
+*--dry-run*
+	Don't send any E-Mails, just fetch new feed items and mark them as read
+
+*--urls* _urls-path_
+	Specifies a custom urls file to be used instead of the default one at
+	*$XDG_CONFIG_HOME/rss-email/urls*
+
+# AUTHORS
+
+Maintained by witcher <witcher@wiredspace.de>. Up-to-date source code can be
+found at https://git.sr.ht/~witcher/rss-email/, and bugs/patches can be
+submitted by email to ~witcher/public-inbox@lists.sr.ht.