blaze-config(1)

1BLAZE-CONFIG(1)           BlazeBlogger Documentation           BLAZE-CONFIG(1)
2
3
4

NAME

6       blaze-config - displays or sets BlazeBlogger configuration options
7

SYNOPSIS

9       blaze-config [-qV] [-b directory] [-E editor] option [value...]
10
11       blaze-config -e [-b directory]
12
13       blaze-config -h|-v
14

DESCRIPTION

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

OPTIONS

21   Command Line Options
22       -b directory, --blogdir directory
23           Allows you to specify a directory in which the BlazeBlogger
24           repository is placed. The default option is a current working
25           directory.
26
27       -E editor, --editor editor
28           Allows you to specify an external text editor. When supplied, this
29           option overrides the relevant configuration option.
30
31       -e, --edit
32           Allows you to edit the configuration in a text editor.
33
34       -q, --quiet
35           Disables displaying of unnecessary messages.
36
37       -V, --verbose
38           Enables displaying of all messages. This is the default option.
39
40       -h, --help
41           Displays usage information and exits.
42
43       -v, --version
44           Displays version information and exits.
45
46   Configuration Options
47       blog.title=string
48           A title of your blog.
49
50       blog.subtitle=string
51           A subtitle of your blog.
52
53       blog.theme=string
54           A theme for your blog. Note that it must point to an existing file
55           in the ".blaze/theme/" directory. The default option is
56           "default.html".
57
58       blog.style=string
59           A style sheet for your blog. Note that it must point to an existing
60           file in the ".blaze/style/" directory. The default option is
61           "default.css".
62
63       blog.lang=string
64           A translation of your blog. Note that it must point to an existing
65           file in the ".blaze/lang/" directory. The default option is
66           "en_US".
67
68       blog.posts=integer
69           A number of blog posts to be listed on a single page. The default
70           option is 10.
71
72       color.list=boolean
73           A boolean to enable ("true") or disable ("false") colors in the
74           blaze-list output. The default option is "false".
75
76       color.log=boolean
77           A boolean to enable ("true") or disable ("false") colors in the
78           blaze-log output. The default option is "false".
79
80       core.doctype=string
81           A document type. It can be either "html" for HTML, or "xhtml" for
82           the XHTML standard. The default option is "html".
83
84       core.extension=string
85           A file extension. The default option is "html".
86
87       core.encoding=string
88           A character encoding. Note that it has to be in a form that is
89           recognized by W3C standards. The default option is "UTF-8".
90
91       core.editor=string
92           An external text editor. When supplied, this option overrides the
93           system-wide settings.
94
95       core.processor=string
96           An external application to be used to process newly added or edited
97           blog posts and pages. Note that you must supply "%in%" and "%out%"
98           in place of an input and output file name respectively. This option
99           is disabled by default.
100
101       feed.baseurl=string
102           A URL of your blog, for example "http://example.com".
103
104       feed.posts=integer
105           A number of blog posts to be listed in the feed. The default option
106           is 10.
107
108       feed.fullposts=boolean
109           A boolean to enable ("true") or disable ("false") inclusion of the
110           whole content of a blog post in the feed, even though the <!--
111           break --> form is used. The default option is "false".
112
113       post.author=string
114           A location of a blog post author name. It can be placed above the
115           post ("top"), below it ("bottom"), or nowhere on the page ("none").
116           The default option is "top".
117
118       post.date=string
119           A location of a date of publishing. It can be placed above the post
120           ("top"), below it ("bottom"), or nowhere on the page ("none"). The
121           default option is top.
122
123       post.tags=string
124           A location of post tags. They can be placed above the post ("top"),
125           below it ("bottom"), or nowhere on the page ("none"). The default
126           option is "top".
127
128       user.name=string
129           Your full name to be used in the copyright notice, and as the
130           default post author. The default option is "admin".
131
132       user.nickname=string
133           Your nickname to be used as the default post author. When supplied,
134           it overrides the user.name setting. This option is disabled by
135           default.
136
137       user.email=string
138           Your email address. The default option is "admin@localhost".
139

ENVIRONMENT

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

FILES

146       .blaze/config
147           A file containing the configuration.
148
149       .blaze/theme/
150           A directory containing blog themes.
151
152       .blaze/style/
153           A directory containing style sheets.
154
155       .blaze/lang/
156           A directory containing language files.
157

EXAMPLE USAGE

159       Configure the default text editor:
160
161         ~]$ blaze-config core.editor nano
162         The option has been successfully saved.
163
164       Configure the user information:
165
166         ~]$ blaze-config user.name Jaromir Hradilek
167         The option has been successfully saved.
168         ~]$ blaze-config user.email jhradilek@gmail.com
169         The option has been successfully saved.
170
171       Configure the blog appearance:
172
173         ~]$ blaze-config blog.title BlazeBlogger
174         The option has been successfully saved.
175         ~]$ blaze-config blog.subtitle a CMS without boundaries
176         The option has been successfully saved.
177         ~]$ blaze-config blog.theme keepitsimple.html
178         The option has been successfully saved.
179         ~]$ blaze-config blog.style keepitsimple.css
180         The option has been successfully saved.
181
182       Configure the RSS feed:
183
184         ~]$ blaze-config feed.fullposts true
185         The option has been successfully saved.
186         ~]$ blaze-config feed.posts 10
187         The option has been successfully saved.
188         ~]$ blaze-config feed.baseurl http://blaze.blackened.cz/
189         The option has been successfully saved.
190
191       Open the configuration in a text editor:
192
193         ~]$ blaze-config -e
194

BUGS

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

COPYRIGHT

204       Copyright (C) 2008-2010 Jaromir Hradilek
205
206       This program is free software; see the source for copying conditions.
207       It is distributed in the hope that it will be useful, but WITHOUT ANY
208       WARRANTY; without even the implied warranty of MERCHANTABILITY or
209       FITNESS FOR A PARTICULAR PURPOSE.
210
211
212
213Version 1.1.2                     2010-11-08                   BLAZE-CONFIG(1)