.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "BLAZE-CONFIG 1" .TH BLAZE-CONFIG 1 "2019-10-07" "Version 1.2.0" "BlazeBlogger Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" blaze\-config \- displays or sets BlazeBlogger configuration options .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBblaze-config\fR [\fB\-qV\fR] [\fB\-b\fR \fIdirectory\fR] [\fB\-E\fR \fIeditor\fR] \fIoption\fR [\fIvalue\fR...] .PP \&\fBblaze-config\fR \fB\-e\fR [\fB\-b\fR \fIdirectory\fR] .PP \&\fBblaze-config\fR \fB\-h\fR|\fB\-v\fR .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBblaze-config\fR either sets BlazeBlogger configuration options, or displays their current value. Additionally, it can also open a configuration file in an external text editor. .SH "OPTIONS" .IX Header "OPTIONS" .SS "Command Line Options" .IX Subsection "Command Line Options" .IP "\fB\-b\fR \fIdirectory\fR, \fB\-\-blogdir\fR \fIdirectory\fR" 4 .IX Item "-b directory, --blogdir directory" Allows you to specify a \fIdirectory\fR in which the BlazeBlogger repository is placed. The default option is a current working directory. .IP "\fB\-E\fR \fIeditor\fR, \fB\-\-editor\fR \fIeditor\fR" 4 .IX Item "-E editor, --editor editor" Allows you to specify an external text \fIeditor\fR. When supplied, this option overrides the relevant configuration option. .IP "\fB\-e\fR, \fB\-\-edit\fR" 4 .IX Item "-e, --edit" Allows you to edit the configuration in a text editor. .IP "\fB\-q\fR, \fB\-\-quiet\fR" 4 .IX Item "-q, --quiet" Disables displaying of unnecessary messages. .IP "\fB\-V\fR, \fB\-\-verbose\fR" 4 .IX Item "-V, --verbose" Enables displaying of all messages. This is the default option. .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Displays usage information and exits. .IP "\fB\-v\fR, \fB\-\-version\fR" 4 .IX Item "-v, --version" Displays version information and exits. .SS "Configuration Options" .IX Subsection "Configuration Options" .IP "\fBblog.title\fR=\fIstring\fR" 4 .IX Item "blog.title=string" A title of your blog. .IP "\fBblog.subtitle\fR=\fIstring\fR" 4 .IX Item "blog.subtitle=string" A subtitle of your blog. .IP "\fBblog.description\fR=\fIstring\fR" 4 .IX Item "blog.description=string" A brief description of your blog. .IP "\fBblog.keywords\fR=\fIlist\fR" 4 .IX Item "blog.keywords=list" A comma-separated list of keywords. .IP "\fBblog.theme\fR=\fIstring\fR" 4 .IX Item "blog.theme=string" A theme for your blog. Note that it must point to an existing file in the \&\f(CW\*(C`.blaze/theme/\*(C'\fR directory. The default option is \f(CW\*(C`default.html\*(C'\fR. .IP "\fBblog.style\fR=\fIstring\fR" 4 .IX Item "blog.style=string" A style sheet for your blog. Note that it must point to an existing file in the \f(CW\*(C`.blaze/style/\*(C'\fR directory. The default option is \f(CW\*(C`default.css\*(C'\fR. .IP "\fBblog.lang\fR=\fIstring\fR" 4 .IX Item "blog.lang=string" A translation of your blog. Note that it must point to an existing file in the \f(CW\*(C`.blaze/lang/\*(C'\fR directory. The default option is \f(CW\*(C`en_US\*(C'\fR. .IP "\fBblog.posts\fR=\fIinteger\fR" 4 .IX Item "blog.posts=integer" A number of blog posts to be listed on a single page. The default option is \&\f(CW10\fR. .IP "\fBcolor.list\fR=\fIboolean\fR" 4 .IX Item "color.list=boolean" A boolean to enable (\f(CW\*(C`true\*(C'\fR) or disable (\f(CW\*(C`false\*(C'\fR) colors in the \&\fBblaze-list\fR output. The default option is \f(CW\*(C`false\*(C'\fR. .IP "\fBcolor.log\fR=\fIboolean\fR" 4 .IX Item "color.log=boolean" A boolean to enable (\f(CW\*(C`true\*(C'\fR) or disable (\f(CW\*(C`false\*(C'\fR) colors in the \&\fBblaze-log\fR output. The default option is \f(CW\*(C`false\*(C'\fR. .IP "\fBcore.doctype\fR=\fIstring\fR" 4 .IX Item "core.doctype=string" A document type. It can be either \f(CW\*(C`html\*(C'\fR for \s-1HTML,\s0 or \f(CW\*(C`xhtml\*(C'\fR for the \&\s-1XHTML\s0 standard. The default option is \f(CW\*(C`html\*(C'\fR. .IP "\fBcore.extension\fR=\fIstring\fR" 4 .IX Item "core.extension=string" A file extension. The default option is \f(CW\*(C`html\*(C'\fR. .IP "\fBcore.encoding\fR=\fIstring\fR" 4 .IX Item "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 \f(CW\*(C`UTF\-8\*(C'\fR. .IP "\fBcore.editor\fR=\fIstring\fR" 4 .IX Item "core.editor=string" An external text editor. When supplied, this option overrides the system-wide settings. .IP "\fBcore.processor\fR=\fIstring\fR" 4 .IX Item "core.processor=string" An external application to be used to process newly added or edited blog posts and pages. Note that you must supply \f(CW\*(C`%in%\*(C'\fR and \f(CW\*(C`%out%\*(C'\fR in place of an input and output file name respectively. This option is disabled by default. .IP "\fBfeed.baseurl\fR=\fIstring\fR" 4 .IX Item "feed.baseurl=string" A \s-1URL\s0 of your blog, for example \f(CW\*(C`http://example.com\*(C'\fR. .IP "\fBfeed.posts\fR=\fIinteger\fR" 4 .IX Item "feed.posts=integer" A number of blog posts to be listed in the feed. The default option is \&\f(CW10\fR. .IP "\fBfeed.fullposts\fR=\fIboolean\fR" 4 .IX Item "feed.fullposts=boolean" A boolean to enable (\f(CW\*(C`true\*(C'\fR) or disable (\f(CW\*(C`false\*(C'\fR) inclusion of the whole content of a blog post in the feed, even though the \fB\fR form is used. The default option is \f(CW\*(C`false\*(C'\fR. .IP "\fBpost.author\fR=\fIstring\fR" 4 .IX Item "post.author=string" A location of a blog post author name. It can be placed above the post (\f(CW\*(C`top\*(C'\fR), below it (\f(CW\*(C`bottom\*(C'\fR), or nowhere on the page (\f(CW\*(C`none\*(C'\fR). The default option is \f(CW\*(C`top\*(C'\fR. .IP "\fBpost.date\fR=\fIstring\fR" 4 .IX Item "post.date=string" A location of a date of publishing. It can be placed above the post (\f(CW\*(C`top\*(C'\fR), below it (\f(CW\*(C`bottom\*(C'\fR), or nowhere on the page (\f(CW\*(C`none\*(C'\fR). The default option is top. .IP "\fBpost.tags\fR=\fIstring\fR" 4 .IX Item "post.tags=string" A location of post tags. They can be placed above the post (\f(CW\*(C`top\*(C'\fR), below it (\f(CW\*(C`bottom\*(C'\fR), or nowhere on the page (\f(CW\*(C`none\*(C'\fR). The default option is \&\f(CW\*(C`top\*(C'\fR. .IP "\fBuser.name\fR=\fIstring\fR" 4 .IX Item "user.name=string" Your full name to be used in the copyright notice, and as the default post author. The default option is \f(CW\*(C`admin\*(C'\fR. .IP "\fBuser.nickname\fR=\fIstring\fR" 4 .IX Item "user.nickname=string" Your nickname to be used as the default post author. When supplied, it overrides the \fBuser.name\fR setting. This option is disabled by default. .IP "\fBuser.email\fR=\fIstring\fR" 4 .IX Item "user.email=string" Your email address. The default option is \f(CW\*(C`admin@localhost\*(C'\fR. .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" .IP "\fB\s-1EDITOR\s0\fR" 4 .IX Item "EDITOR" Unless the \fBcore.editor\fR option is set, BlazeBlogger tries to use system-wide settings to decide which editor to use. .SH "FILES" .IX Header "FILES" .IP "\fI.blaze/config\fR" 4 .IX Item ".blaze/config" A file containing the configuration. .IP "\fI.blaze/theme/\fR" 4 .IX Item ".blaze/theme/" A directory containing blog themes. .IP "\fI.blaze/style/\fR" 4 .IX Item ".blaze/style/" A directory containing style sheets. .IP "\fI.blaze/lang/\fR" 4 .IX Item ".blaze/lang/" A directory containing language files. .SH "EXAMPLE USAGE" .IX Header "EXAMPLE USAGE" Configure the default text editor: .PP .Vb 2 \& ~]$ blaze\-config core.editor nano \& The option has been successfully saved. .Ve .PP Configure the user information: .PP .Vb 4 \& ~]$ 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. .Ve .PP Configure the blog appearance: .PP .Vb 8 \& ~]$ 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. .Ve .PP Configure the \s-1RSS\s0 feed: .PP .Vb 6 \& ~]$ 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. .Ve .PP Open the configuration in a text editor: .PP .Vb 1 \& ~]$ blaze\-config \-e .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBblaze-init\fR(1) .SH "BUGS" .IX Header "BUGS" To report a bug or to send a patch, please, add a new issue to the bug tracker at , or visit the discussion group at . .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2008\-2011 Jaromir Hradilek .PP This program is free software; see the source for copying conditions. It is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0