sbrs.1 (3039B)
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 .Brc 12 .Sh DESCRIPTION 13 .Nm 14 generates an article post page and RSS feed. 15 .Sh OPTIONS 16 The options are as follows: 17 .Bl -tag -width Ds 18 .It Fl n 19 Prompt the user to write a new article in HTML. 20 .Nm 21 will open the editor set in the 'EDITOR' environmental variable. 22 In case it is not set, it will set 'EDITOR' to Vi. 23 .It Fl p 24 Publish one of the posts stored in the '.drafts' directory. 25 After a post has been published, it will be deleted from '.drafts' along \ 26 with all the files related to it and will be moved to the article directory. 27 This option also automatically creates an RSS feed for the post. 28 .It Fl e 29 Edit one of the posts stored in the '.drafts' directory. 30 .It Fl v 31 View one of the posts stored in the '.drafts' directory. 32 .Nm 33 creates a temporary file that looks like the finished post, but is deleted 34 after 35 .Nm 36 has exited. 37 The 'BROWSER' environmental variable has to be set in order for this \ 38 option to work. 39 .It Fl t 40 Delete one of the posts stored in the '.drafts' directory. 41 .It Fl r 42 Revise a published post stored in the article directory. 43 After you're done revising you don't need to re-publish the post again, since 44 .Nm 45 edits the post directly. 46 .It Fl c 47 Change a published post's title. 48 This option will replace every instance of the old title with the new one both. 49 The filename will also be changed. 50 .It Fl o 51 View a published post stored in the article directory on your default browser. 52 Same with the -v option; the 'BROWSER' environmental variable has to be set 53 in order for this option to work. 54 .It Fl d 55 Delete a published post stored in the article directory. 56 This option will delete the post from the articles' index file and the RSS feed. 57 .It Fl l 58 List all posts stored in the article directory. 59 .El 60 .Pp 61 Only one option at a time can be used. 62 .Sh PREPARATION 63 Inside the 64 .Nm 65 script, edit the variables at the top of the file to match your own configuration. 66 .Pp 67 In case you don't edit the script further, the structure of your website's 68 directory should look like this: 69 .Pp 70 ├── .drafts/ 71 | └── unpublished articles live here 72 ├── articles/ 73 | └── articles live here 74 ├── article_index.html 75 ├── template.html 76 └── rss.xml 77 .Pp 78 Inside 'article_index.html' (or whatever you name it) and 'rss.xml' 79 .Nm 80 will search for an <!--SBRS--> comment in order to put the article 81 listings and RSS feed below it. 82 .Pp 83 The 'template.html' file is an outline of the article page. 84 Take a look at the 'template.html' provided. 85 The 'TITLE', 'HEADER' and 'AUTHOR' get replaced by 86 .Nm . 87 .Sh USAGE 88 You must always run 89 .Nm 90 inside the website's main directory. 91 Only one option can be used 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