commit 48fc280aff79010f1244d532bf797605de0b7bb4
parent dd3c8753f4a096ec195d742bc18b5b416ee58691
Author: Paco Esteban <paco@e1e0.net>
Date: Tue, 16 Jun 2020 19:30:34 +0200
add man page
Diffstat:
M | ssnail.1 | | | 80 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 80 insertions(+), 0 deletions(-)
diff --git a/ssnail.1 b/ssnail.1
@@ -0,0 +1,80 @@
+.\" Copyright (c) 2020 Paco Esteban <paco@e1e0.net>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd June 16, 2020
+.Dt SSNAIL 1
+.Os
+.Sh NAME
+.Nm ssnail
+.Nd crappy and opinionated static website generator
+.Sh SYNOPSIS
+.Nm
+.Op Fl F
+.Op Fl f Ar footer
+.Op Fl h Ar header
+.Op Fl i
+.Ar src_folder
+.Ar dst_folder
+.Sh DESCRIPTION
+.Nm
+takes all Markdown files on
+.Ar src_folder
+and generates corresponding HTML files on
+.Ar dst_file .
+It uses
+.Xr lowdown 3
+internally to do the conversion.
+All other files are copied recursively.
+Files are copied/generated only if they don't exist on destination or exist but
+are newer on source.
+It uses header and footer templates to generate the HTML files.
+On the header, the strings
+.Sq $title$ ,
+.Sq $author$
+and
+.Sq $date$
+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
+.Sq Type: article
+on the Markdown metadata.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl F
+Force copy/generate all files.
+.It Fl f Ar footer
+Footer HTML template.
+.Pq defaults to _footer.html
+.It Fl h Ar header
+Header HTML template.
+.Pq defaults to _header.html
+.It Fl i
+Generate index HTML file.
+.El
+.Sh EXIT STATUS
+.Ex -std
+.Sh AUTHORS
+.An Paco Esteban
+.Mt paco@e1e0.net
+.Sh BUGS
+Probably many.
+Do not use this in production.
+This is only an educational project to learn in how many different ways I can
+shoot myself in the foot.
+If you find horrors, send patches to:
+.Mt patches@e1e0.net