commit b65996634e3c4734803ff91a6e93c98142038bb6
parent 21a0ec1711b660cc6d377b01b9cd9304b757f2ea
Author: Paco Esteban <paco@e1e0.net>
Date: Wed, 1 Jul 2020 19:56:42 +0200
update man page
Diffstat:
1 file changed, 20 insertions(+), 3 deletions(-)
diff --git a/ssnail.1 b/ssnail.1
@@ -24,6 +24,9 @@
.Op Fl f Ar footer
.Op Fl h Ar header
.Op Fl i
+.Op Fl r
+.Fl t Ar title
+.Fl u Ar main_url
.Ar src_folder
.Ar dst_folder
.Sh DESCRIPTION
@@ -31,7 +34,7 @@
takes all Markdown files on
.Ar src_folder
and generates corresponding HTML files on
-.Ar dst_file .
+.Ar dst_folder .
It uses
.Xr lowdown 3
internally to do the conversion.
@@ -48,8 +51,8 @@ are replaced by the Markdown metadata.
On the footer, only the string
.Sq $title$
is replaced.
-It can also generate an index file.
-For a file to be included on the index, it has to have a
+It can also generate index and RSS files.
+For a file to be included on the index and RSS, it has to have a
.Sq Type: article
on the Markdown metadata.
.Pp
@@ -65,6 +68,20 @@ Header HTML template.
.Pq defaults to _header.html
.It Fl i
Generate index HTML file.
+.It Fl r
+Generate RSS file.
+.It Fl t Ar title
+Title of the website.
+Required to generate index and RSS.
+.It Fl u Ar main_url
+Main url of the site.
+Required.
+.It Ar src_folder
+Folder where all Markdown and other files are located.
+Required.
+.It Ar dst_folder
+Folder where HTML will be generated and other files copied.
+Required.
.El
.Sh EXIT STATUS
.Ex -std