]> git.deb.at Git - pkg/blosxom.git/blobdiff - debian/blosxom.7
Initial import of debian package files
[pkg/blosxom.git] / debian / blosxom.7
diff --git a/debian/blosxom.7 b/debian/blosxom.7
new file mode 100644 (file)
index 0000000..9610ef5
--- /dev/null
@@ -0,0 +1,103 @@
+.\" Man page for blosxom in debian's distribution. 
+.\" Marc Nozell <marc@nozell.com>
+.\" Further changed  <edd@debian.org>
+.TH BLOSXOM 7 "February 5, 2003" Blosxom "7"
+.SH NAME 
+blosxom \- A lightweight yet feature-packed weblog
+.SH SYNOPSIS
+.B blosxom 
+is a simple web log (blog) CGI script written in perl. 
+.SH DESCRIPTION
+.PP
+\fBBlosxom\fP (pronounced "\fIblossom\fR") is a lightweight yet
+feature-packed weblog application designed from the ground up with
+simplicity, usability, and interoperability in mind.
+
+Fundamental is its reliance upon the file system, folders and files as
+its content database. Blosxom's weblog entries are plain text files
+like any other. Write from the comfort of your favorite text editor
+and hit the Save button. Create, edit, rename, and delete entries on
+the command-line, via FTP, WebDAV, or anything else you might use to
+manipulate your files. There's no import or export; entries are
+nothing more complex than title on the first line, body being
+everything thereafter.
+
+Despite its tiny footprint, Blosxom doesn't skimp on features,
+sporting the majority of features one would find in any other Weblog
+application.
+
+Blosxom is simple, straightforward, minimalist Perl affording even the
+dabbler an opportunity for experimentation and customization. And
+last, but not least, Blosxom is open source and free for the taking
+and altering.
+
+.SH USAGE
+Write a weblog entry, and place it into the main data directory. Place the
+the title is on the first line; the body is everything afterwards.  For
+example, create a file named \fIfirst.txt\fR and put in it something like
+this.
+.nf
+
+  First Blosxom Post!
+
+  I have successfully installed blosxom on this system.  For more
+  information on blosxom, see the author's <a
+  href="http://www.blosxom.com/">blosxom site</a>.
+
+.fi
+Place the file in the directory under the \fI$datadir\fR points to.  Be sure
+to change the default location to be somewhere accessable by the web
+server that runs blosxom as a CGI program. On Debian systems, this location
+default to \fI/var/lib/blosxom/data\fR.
+
+
+.SH OPTIONS
+
+Configuration of the \fBblosxom\fR can be controlled via the configuration
+file \fI/etc/blosxom/blosxom.conf\fR. Some of the possible configuration
+variables are:
+
+.TP
+.B $blog_title
+Title of this blog. (default: "Blosxom")
+
+.TP
+.B $blog_description 
+Description of the blog used for RSS generation. (default "Yet another Blosxom blog")
+
+.TP
+.B $blog_language 
+This blog's primary language used for outgoing RSS feed. (default "en")
+
+.TP
+.B $datadir
+Where are this blog's entries kept? (default on Debian:
+"/var/lib/blosxom/data")
+
+.TP
+.B $url
+Preferred base URL for this blog (leave blank for automatic) (default: "")
+
+.TP
+.B $file_extension
+Preferred ending of blog entry files (default: "txt"). Other files are ignored.
+
+.TP
+.B $default_flavour
+Blog style can be controlled via templates, or flavours. (default: "html"). 
+
+.SH FILES
+.br
+.nf
+\fI/usr/lib/cgi-bin/blosxom\fR the CGI script
+\fI/etc/blosxom/blosxom.conf\fR the configuration on Debian systems
+
+.SH AUTHOR
+
+Rael Dornfest is the author of blosxom <rael@oreilly.com> See
+\fIhttp://www.blosxom.com\fR and \fIhttp://www.raelity.org\fR for more
+information.
+
+This manual page was written by Marc Nozell <marc@nozell.com> and Dirk
+Eddelbuettel <edd@debian.org> for the Debian GNU/Linux distribution but may
+be used by others.