blaze-config (1) - Linux Manuals

blaze-config: display or set the BlazeBlogger repository options

Command to display blaze-config manual in Linux: $ man 1 blaze-config

NAME

blaze-config - display or set the BlazeBlogger repository options

SYNOPSIS

blaze-config [-qV] [-b directory] name [value...]

blaze-config -e [-b directory]

blaze-config -h | -v

DESCRIPTION

blaze-config is a simple configuration tool for the BlazeBlogger. Depending on the number of given command-line arguments, it either displays the current value of the specified option, or sets/replaces it with the new one.

The accepted option name is in the form of dot separated section and key (e.g. user.name). For the complete list of available options along with the explanation of their meaning, see the appropriate section below.

OPTIONS

Command-line options

-b, --blogdir directory: Specify the directory where the BlazeBlogger repository is placed. The default option is the current working directory.
-e, --edit: Open the configuration file in the external text editor.
-q, --quiet: Avoid displaying messages that are not necessary.
-V, --verbose: Display all messages. This is the default option.
-h, --help: Display usage information and exit.
-v, --version: Display version information and exit.

Available option names

blog.title: Blog title.
blog.subtitle: Blog subtitle, supposedly a brief, single-line description of what should an occasional visitor expect to find.
blog.theme: Blog theme; the value should point to an existing file in the .blaze/theme directory.
blog.style: Blog stylesheet; the value should point to an existing file, either in ".blaze/style" (recommended), or in the destination directory where the static content is to be placed.
blog.lang: Blog language; the value should point to an existing file in the ".blaze/lang" directory.
blog.posts: Number of posts to be listed on a single page; the default value is 10.
blog.url: Blog base url; required for RSS feeds only.
color.list: Whether to use coloured post/pages listing; the value has to be either "true", or "false". Colours are turned off by default.
color.log: Whether to use coloured log listing; the value has to be either "true", or "false". Colours are turned off by default.
core.encoding: Records encoding in the form recognised by the W3C HTML 4.01 standard (e.g. the default UTF-8).
core.extension: File extension for the generated pages. By default, the "html" is used as a reasonable choice.
core.editor: Text editor to be used for editing purposes. Unless this option is set, BlazeBlogger tries to use system wide settings by looking for "EDITOR" environment variable, and if neither of these options is supplied, "vi" is used as a considerably reasonable option.
core.processor: Optional external application to be used to process the entries; use "%in%" and "%out%" in place of input and output file names (e.g. "markdown --html4tags %in% > %out%"). Nevertheless, if you intend to write your content in HTML directly, feel free to leave this option empty (the default setting).
post.author: Location of the post author information; available options are "top", "bottom", or "none". Author is placed above the post (below its heading) by default.
post.date: Location of the post date of publishing information; available options are "top", "bottom", or "none". Date of publishing is placed above the post (below its heading) by default.
post.tags: Location of the post tags; available options are "top", "bottom", or "none". Tags are placed above the post (below its heading) by default.
user.name: User's name to be used as a default posts' author and optionally anywhere on the page, depending on the theme (e.g. in the copyright notice).
user.email: User's e-mail. Depending on the theme, it can be used anywhere on the page (e.g. in the copyright notice). However, non of the official themes actually use it.

ENVIRONMENT

EDITOR: Unless the BlazeBlogger specific option core.editor is set, blaze-edit tries to use system wide settings to decide which editor to run. If neither of these options are supplied, the vi is used instead as a considerably reasonable choice.

FILES

.blaze/config: BlazeBlogger configuration file.

BUGS

To report bug or even send patch, either add new issue to the project bugtracker at <http://code.google.com/p/blazeblogger/issues/>, or visit the discussion group at <http://groups.google.com/group/blazeblogger/>. You can also contact the author directly via e-mail.

AUTHOR

Written by Jaromir Hradilek <jhradilek [at] gmail.com>.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.

A copy of the license is included as a file called FDL in the main directory of the BlazeBlogger source package.

COPYRIGHT

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.