sbrs

Simple blog and RSS system
git clone git://git.margiolis.net/sbrs.git
Log | Files | Refs | README | LICENSE

sbrs.1 (3151B)


      1 .Dd sbrs\-VERSION
      2 .Dt SBRS 1
      3 .Os
      4 .Sh NAME
      5 .Nm sbrs
      6 .Nd simple blog and RSS system
      7 .Sh SYNOPSIS
      8 .Nm
      9 .Bro
     10 .Cm -n | -p | -e | -v | -t | -r | -c | -o | -d | -l
     11 .Sh DESCRIPTION
     12 .Nm
     13 generates an article post page and RSS feed.
     14 .Sh OPTIONS
     15 The options are as follows:
     16 .Bl -tag -width Ds
     17 .It Fl n
     18 Prompt the user to write a new article in HTML.
     19 .Nm
     20 will open the editor set in the 'EDITOR' environmental variable. In case
     21 it is not set, it will set Vim as 'EDITOR'.
     22 .It Fl p
     23 Publish one of the posts stored in the '.drafts' directory. After a post
     24 has been published, it will be deleted from '.drafts' along with all the
     25 files related to it and will be moved to 'articles'. This option also automatically
     26 creates an RSS feed for the post.
     27 .It Fl e
     28 Edit one of the posts stored in the '.drafts' directory.
     29 .It Fl v
     30 View one of the posts stored in the '.drafts' directory.
     31 .Nm
     32 creates a temporary file that looks like the finished post, but is deleted
     33 after
     34 .Nm
     35 has exited. The 'BROWSER' environmental variable has to be set
     36 in order for this option to work.
     37 .It Fl t
     38 Delete one of the posts stored in the '.drafts' directory.
     39 .It Fl r
     40 Revise a published post stored in the 'articles' directory. After you're done
     41 revising you don't need to re-publish the post again, since
     42 .Nm
     43 edits the post directly.
     44 .It Fl c
     45 Change a published post's title. This option will replace every instance
     46 of the old title with the new one both. The filename will also
     47 be changed.
     48 .It Fl o
     49 View a published post stored in the 'articles' directory on your default browser.
     50 Same with the -v option; the 'BROWSER' environmental variable has to be set
     51 in order for this option to work.
     52 .It Fl d
     53 Delete a published post stored in the 'articles' directory. This option will delete
     54 the post from the articles' index file, the RSS feed, as well as the main page in
     55 case it is found there too.
     56 .It Fl l
     57 List all posts stored in the 'articles' directory.
     58 .El
     59 .Pp
     60 Only one option at a time can be used.
     61 .Sh PREPARATION
     62 .Pp
     63 Inside the
     64 .Nm
     65 script, change the 'WEBSITE' and 'AUTHOR' variables to match your website's URL
     66 and your name.
     67 .Pp
     68 In case you don't edit the script further, the structure of your website's
     69 directory should look like this. The files below need to exist with the same
     70 names.
     71 .Pp
     72         ├── articles 
     73         |   └── here reside your articles
     74         ├── index.html
     75         ├── articles.html
     76         ├── template.html
     77         └── rss.xml
     78 .Pp
     79 Inside 'index.html', 'articles.html' and 'rss.xml'
     80 .Nm
     81 will search for
     82 <!--SBRS--> in order to put the article listings and RSS feed below it.
     83 .Pp
     84 The 'template.html' file is how you want your article's page to look like.
     85 See my own 'template.html' for more. The 'TITLE', 'HEADER' and 'AUTHOR'
     86 fields must exist and be left as is.
     87 .Sh USAGE
     88 .Pp
     89 You must always run the script inside your website's main directory.
     90 Run it with one of the following options. Only one option can be used
     91 at a time.
     92 .Sh NOTES
     93 Do NOT edit the various comments that the script writes inside the files,
     94 otherwise it'll not work properly, or work at all.
     95 .Sh AUTHORS
     96 .An Christos Margiolis Aq Mt christos@margiolis.net