commit 93557fc66d29a4844af6665ed0eb7ea4fb36d665
parent 5021ecf96e62a7c352ce21ac2eb491c3c6fc1822
Author: Christos Margiolis <christos@margiolis.net>
Date: Mon, 21 Sep 2020 21:08:05 +0300
removed BSD syntax
Diffstat:
| M | autoblog.1 | | | 143 | +++++++++++++++++++++++++++++++++++-------------------------------------------- |
1 file changed, 64 insertions(+), 79 deletions(-)
diff --git a/autoblog.1 b/autoblog.1
@@ -1,91 +1,76 @@
-.Dd September 20, 2020
-.Dt AUTOBLOG 1
-.Os
-.Sh NAME
-.Nm autoblog
-.Nd automatic blog and RSS system
-.Sh SYNOPSIS
-.Nm
-.Op Fl n Ar new post
-.Op Fl p Ar publish draft
-.Op Fl e Ar edit draft
-.Op Fl v Ar view draft
-.Op Fl t Ar delete draft
-.Op Fl r Ar revise published
-.Op Fl o Ar view published
-.Op Fl d Ar delete published
-.Op Fl l Ar list all published
-.Sh DESCRIPTION
-.Nm
+.TH AUTOBLOG 1
+.SH NAME
+autoblog \- automatic blog and RSS system
+.SH SYNOPSIS
+.B autoblog
+.RB [ \-n \ new\ post ]
+.RB [ \-p \ publish\ draft ]
+.RB [ \-e \ edit\ draft ]
+.RB [ \-v \ view\ draft ]
+.RB [ \-t \ delete\ draft ]
+.RB [ \-r \ revise\ published ]
+.RB [ \-o \ view\ published ]
+.RB [ \-d \ delete\ published ]
+.RB [ \-l \ list\ all\ published ]
+.SH DESCRIPTION
+.B autoblog
generates a blog post page and RSS feed.
-.Pp
+.SH OPTIONS
The options are as follows:
-.Bl -tag -width Ds
-.It Fl n Ar new post
+.TP
+.BR \-n
Prompt the user to write a new blog post in HTML
-.It Fl p Ar publish draft
-Publish one of the posts stored in the
-.Ar .drafts
-directory.
-.It Fl e Ar edit draft
-Edit one of the posts stored in the
-.Ar .drafts
-directory.
-.It Fl v Ar view draft
-View one of the posts stored in the
-.Ar .drafts
-directory.
-.It Fl t Ar delete draft
-Delete one of the posts stored in the
-.Ar .drafts
-directory.
-.It Fl r Ar revise published
-Revise a published post stored in the
-.Ar blog
-directory.
-.It Fl o Ar view published
-View a published post stored in the
-.Ar blog
-directory on your default browser.
-.It Fl d Ar delete published
-Delete a published post stored in the
-.Ar blog
-directory.
-.It Fl l Ar list all published
-List all posts stored in the
-.Ar blog
-directory.
-.El
-.Pp
+.TP
+.BR \-p
+Publish one of the posts stored in the .drafts directory.
+.TP
+.BR \-e
+Edit one of the posts stored in the .drafts directory.
+.TP
+.BR \-v
+View one of the posts stored in the .drafts directory.
+.TP
+.BR \-t
+Delete one of the posts stored in the .drafts directory.
+.TP
+.BR \-r
+Revise a published post stored in the blog directory.
+.TP
+.BR \-o
+View a published post stored in the blog directory on your default browser.
+.TP
+.BR \-d
+Delete a published post stored in the blog directory.
+.TP
+.BR \-l
+List all posts stored in the blog directory.
+.P
Only one option at a time can be used.
-.Pp
-Run the script inside your website's main directory and edit the
-.Ar website
-and
-.Ar 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
-.Ar blog/
-.Pp
-.Nm autoblog
+.P
+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
+.I blog/
+.P
+.B autoblog
will search for <!--BLOG--> inside
-.Ar index.html
+.I index.html
and
-.Ar rss.xml
+.I rss.xml
in order to put the blog post listings and RSS feed respectively. Inside
-.Ar blogindex.html
+.I blogindex.html
however, it will search for <!--BLOG [Month Year]--> (e.g <!--BLOG January 1800->).
-.Pp
+.P
A
-.Ar template.html
-file needs to exist in your main directory in order for the script to run properly.
-That file is how you want your blog post's generated page to look like. The
-.Ar TITLE
+.I template.html
+file needs to exist in your main directory in order for the
+script to run properly. That file is how you want your blog post's generated page
+to look like. The
+.I TITLE
,
-.Ar HEADER
+.I HEADER
and
-.Ar AUTHOR
+.I AUTHOR
fields must exist and be left as is.
-.Sh AUTHORS
-.An Christos Margiolis Aq Mt christos@christosmarg.xyz
+.SH AUTHORS
+Christos Margiolis <christos@christosmarg.xyz>
