blaze-config

BLAZE-CONFIG(1)           BlazeBlogger Documentation           BLAZE-CONFIG(1)



NAME
       blaze-config - displays or sets BlazeBlogger configuration options

SYNOPSIS
       blaze-config [-qV] [-b directory] [-E editor] option [value...]

       blaze-config -e [-b directory]

       blaze-config -h|-v

DESCRIPTION
       blaze-config either sets BlazeBlogger configuration options, or
       displays their current value. Additionally, it can also open a
       configuration file in an external text editor.

OPTIONS
   Command Line Options
       -b directory, --blogdir directory
           Allows you to specify a directory in which the BlazeBlogger
           repository is placed. The default option is a current working
           directory.

       -E editor, --editor editor
           Allows you to specify an external text editor. When supplied, this
           option overrides the relevant configuration option.

       -e, --edit
           Allows you to edit the configuration in a text editor.

       -q, --quiet
           Disables displaying of unnecessary messages.

       -V, --verbose
           Enables displaying of all messages. This is the default option.

       -h, --help
           Displays usage information and exits.

       -v, --version
           Displays version information and exits.

   Configuration Options
       blog.title=string
           A title of your blog.

       blog.subtitle=string
           A subtitle of your blog.

       blog.description=string
           A brief description of your blog.

       blog.keywords=list
           A comma-separated list of keywords.

       blog.theme=string
           A theme for your blog. Note that it must point to an existing file
           in the ".blaze/theme/" directory. The default option is
           "default.html".

       blog.style=string
           A style sheet for your blog. Note that it must point to an existing
           file in the ".blaze/style/" directory. The default option is
           "default.css".

       blog.lang=string
           A translation of your blog. Note that it must point to an existing
           file in the ".blaze/lang/" directory. The default option is
           "en_US".

       blog.posts=integer
           A number of blog posts to be listed on a single page. The default
           option is 10.

       color.list=boolean
           A boolean to enable ("true") or disable ("false") colors in the
           blaze-list output. The default option is "false".

       color.log=boolean
           A boolean to enable ("true") or disable ("false") colors in the
           blaze-log output. The default option is "false".

       core.doctype=string
           A document type. It can be either "html" for HTML, or "xhtml" for
           the XHTML standard. The default option is "html".

       core.extension=string
           A file extension. The default option is "html".

       core.encoding=string
           A character encoding. Note that it has to be in a form that is
           recognized by W3C standards. The default option is "UTF-8".

       core.editor=string
           An external text editor. When supplied, this option overrides the
           system-wide settings.

       core.processor=string
           An external application to be used to process newly added or edited
           blog posts and pages. Note that you must supply "%in%" and "%out%"
           in place of an input and output file name respectively. This option
           is disabled by default.

       feed.baseurl=string
           A URL of your blog, for example "http://example.com".

       feed.posts=integer
           A number of blog posts to be listed in the feed. The default option
           is 10.

       feed.fullposts=boolean
           A boolean to enable ("true") or disable ("false") inclusion of the
           whole content of a blog post in the feed, even though the <!--
           break --> form is used. The default option is "false".

       post.author=string
           A location of a blog post author name. It can be placed above the
           post ("top"), below it ("bottom"), or nowhere on the page ("none").
           The default option is "top".

       post.date=string
           A location of a date of publishing. It can be placed above the post
           ("top"), below it ("bottom"), or nowhere on the page ("none"). The
           default option is top.

       post.tags=string
           A location of post tags. They can be placed above the post ("top"),
           below it ("bottom"), or nowhere on the page ("none"). The default
           option is "top".

       user.name=string
           Your full name to be used in the copyright notice, and as the
           default post author. The default option is "admin".

       user.nickname=string
           Your nickname to be used as the default post author. When supplied,
           it overrides the user.name setting. This option is disabled by
           default.

       user.email=string
           Your email address. The default option is "admin@localhost".

ENVIRONMENT
       EDITOR
           Unless the core.editor option is set, BlazeBlogger tries to use
           system-wide settings to decide which editor to use.

FILES
       .blaze/config
           A file containing the configuration.

       .blaze/theme/
           A directory containing blog themes.

       .blaze/style/
           A directory containing style sheets.

       .blaze/lang/
           A directory containing language files.

EXAMPLE USAGE
       Configure the default text editor:

         ~]$ blaze-config core.editor nano
         The option has been successfully saved.

       Configure the user information:

         ~]$ blaze-config user.name Jaromir Hradilek
         The option has been successfully saved.
         ~]$ blaze-config user.email jhradilek@gmail.com
         The option has been successfully saved.

       Configure the blog appearance:

         ~]$ blaze-config blog.title BlazeBlogger
         The option has been successfully saved.
         ~]$ blaze-config blog.subtitle a CMS without boundaries
         The option has been successfully saved.
         ~]$ blaze-config blog.theme keepitsimple.html
         The option has been successfully saved.
         ~]$ blaze-config blog.style keepitsimple.css
         The option has been successfully saved.

       Configure the RSS feed:

         ~]$ blaze-config feed.fullposts true
         The option has been successfully saved.
         ~]$ blaze-config feed.posts 10
         The option has been successfully saved.
         ~]$ blaze-config feed.baseurl http://blaze.blackened.cz/
         The option has been successfully saved.

       Open the configuration in a text editor:

         ~]$ blaze-config -e

SEE ALSO
       blaze-init(1)

BUGS
       To report a bug or to send a patch, please, add a new issue to the bug
       tracker at <http://code.google.com/p/blazeblogger/issues/>, or visit
       the discussion group at <http://groups.google.com/group/blazeblogger/>.

COPYRIGHT
       Copyright (C) 2008-2011 Jaromir Hradilek

       This program is free software; see the source for copying conditions.
       It is distributed in the hope that it will be useful, but WITHOUT ANY
       WARRANTY; without even the implied warranty of MERCHANTABILITY or
       FITNESS FOR A PARTICULAR PURPOSE.



Version 1.2.0                     2011-02-18                   BLAZE-CONFIG(1)