commit f90e439701e070fa8919538107eefa15171d6751
parent c5ef6a8d7a1f5ec3535c995f033e93e32089a322
Author: Christos Margiolis <christos@margiolis.net>
Date: Mon, 16 Nov 2020 22:09:01 +0200
updated manpage
Diffstat:
| M | README | | | 2 | +- |
| M | sbrs.1 | | | 52 | ++++++++++++++++++++++++++++++---------------------- |
2 files changed, 31 insertions(+), 23 deletions(-)
diff --git a/README b/README
@@ -8,7 +8,7 @@ Inside the 'sbrs' script, change the 'WEBSITE' and 'AUTHOR' variables
to match your website's URL and your name.
In case you don't edit the script further, the structure of your
-website's directory should should like this. The
+website's directory should look like this. The
files below need to exist with the same names.
├── blog
diff --git a/sbrs.1 b/sbrs.1
@@ -45,31 +45,39 @@ List all posts stored in the blog directory.
.El
.Pp
Only one option at a time can be used.
-.Sh USAGE
-.Pp
-Run the script inside your website's main directory and edit the website and author
-to match your own information. Make sure that the rest of the variables are properly
-set to match your website's structure. By default, all blog posts are stored in blog/.
-.Sh REQUIREMENTS
+.Sh PREPARATION
.Pp
-The following files have to exist in the same directory
+Inside the
.Nm
-is called:
-.Bl -tag -width Ds
-.It index.html
-Main page.
-.It blogindex.html
-Blog page index.
-.It template.html
-A template file that will be used to format the blog post.
-The TITLE, HEADER and AUTHOR fields must exist and be left as is.
-.It rss.xml
-The RSS feed.
-.El
+script, change the 'WEBSITE' and 'AUTHOR' variables to match your website's URL
+and your name.
+.Pp
+In case you don't edit the script further, the structure of your website's
+directory should look like this. The files below need to exist with the same
+names.
.Pp
-Inside the files mentioned above
+ ├── blog
+ | └── here reside your blog posts
+ ├── index.html
+ ├── blogindex.html
+ ├── template.html
+ └── rss.xml
+.Pp
+Inside 'index.html', 'blogindex.html' and 'rss.xml'
.Nm
-will search for <!--BLOG--> in order to put the appropriate blog contents.
-These comments should not be edited or removed.
+will search for
+<!--BLOG--> in order to put the blog post listings and RSS feed below it.
+.Pp
+The 'template.html' file is how you want your blog post's page to look like.
+See my own 'template.html' for more. The 'TITLE', 'HEADER' and 'AUTHOR'
+fields must exist and be left as is.
+.Sh USAGE
+.Pp
+You must always run the script inside your website's main directory.
+Run it with one of the following options. Only one option can be used
+at a time.
+.Sh NOTES
+Do NOT edit the various comments that the script writes inside the files,
+otherwise it'll not work properly, or work at all.
.Sh AUTHORS
.An Christos Margiolis Aq Mt christos@christosmarg.xyz
