debian/blosxom.7

   1 .\" Man page for blosxom in debian's distribution.
   2 .\" Marc Nozell <marc@nozell.com>
   3 .\" Further changed  <edd@debian.org>
   4 .TH BLOSXOM 7 "February 5, 2003" Blosxom "7"
   5 .SH NAME
   6 blosxom \- A lightweight yet feature-packed weblog
   7 .SH SYNOPSIS
   8 .B blosxom
   9 is a simple web log (blog) CGI script written in perl.
  10 .SH DESCRIPTION
  11 .PP
  12 \fBBlosxom\fP (pronounced "\fIblossom\fR") is a lightweight yet
  13 feature-packed weblog application designed from the ground up with
  14 simplicity, usability, and interoperability in mind.
  15
  16 Fundamental is its reliance upon the file system, folders and files as
  17 its content database. Blosxom's weblog entries are plain text files
  18 like any other. Write from the comfort of your favorite text editor
  19 and hit the Save button. Create, edit, rename, and delete entries on
  20 the command-line, via FTP, WebDAV, or anything else you might use to
  21 manipulate your files. There's no import or export; entries are
  22 nothing more complex than title on the first line, body being
  23 everything thereafter.
  24
  25 Despite its tiny footprint, Blosxom doesn't skimp on features,
  26 sporting the majority of features one would find in any other Weblog
  27 application.
  28
  29 Blosxom is simple, straightforward, minimalist Perl affording even the
  30 dabbler an opportunity for experimentation and customization. And
  31 last, but not least, Blosxom is open source and free for the taking
  32 and altering.
  33
  34 .SH USAGE
  35 Write a weblog entry, and place it into the main data directory. Place the
  36 the title is on the first line; the body is everything afterwards.  For
  37 example, create a file named \fIfirst.txt\fR and put in it something like
  38 this.
  39 .nf
  40
  41   First Blosxom Post!
  42
  43   I have successfully installed blosxom on this system.  For more
  44   information on blosxom, see the author's <a
  45   href="http://www.blosxom.com/">blosxom site</a>.
  46
  47 .fi
  48 Place the file in the directory under the \fI$datadir\fR points to.  Be sure
  49 to change the default location to be somewhere accessible by the web
  50 server that runs blosxom as a CGI program. On Debian systems, this location
  51 default to \fI/var/lib/blosxom/data\fR.
  52
  53
  54 .SH OPTIONS
  55
  56 Configuration of the \fBblosxom\fR can be controlled via the configuration
  57 file \fI/etc/blosxom/blosxom.conf\fR. Some of the possible configuration
  58 variables are:
  59
  60 .TP
  61 .B $blog_title
  62 Title of this blog. (default: "Blosxom")
  63
  64 .TP
  65 .B $blog_description
  66 Description of the blog used for RSS generation. (default "Yet another Blosxom blog")
  67
  68 .TP
  69 .B $blog_language
  70 This blog's primary language used for outgoing RSS feed. (default "en")
  71
  72 .TP
  73 .B $datadir
  74 Where are this blog's entries kept? (default on Debian:
  75 "/var/lib/blosxom/data")
  76
  77 .TP
  78 .B $url
  79 Preferred base URL for this blog (leave blank for automatic) (default: "")
  80
  81 .TP
  82 .B $file_extension
  83 Preferred ending of blog entry files (default: "txt"). Other files are ignored.
  84
  85 .TP
  86 .B $default_flavour
  87 Blog style can be controlled via templates, or flavours. (default: "html").
  88
  89 .SH FILES
  90 .br
  91 .nf
  92 \fI/usr/lib/cgi-bin/blosxom\fR the CGI script
  93 \fI/etc/blosxom/blosxom.conf\fR the configuration on Debian systems
  94
  95 .SH AUTHOR
  96
  97 Rael Dornfest is the author of blosxom <rael@oreilly.com> See
  98 \fIhttp://www.blosxom.com\fR and \fIhttp://www.raelity.org\fR for more
  99 information.
 100
 101 This manual page was written by Marc Nozell <marc@nozell.com> and Dirk
 102 Eddelbuettel <edd@debian.org> for the Debian GNU/Linux distribution but may
 103 be used by others.