'\" t
.\" Title: LAZYGAL.CONF
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1
.\" Date: August 2011
.\" Manual: File formats and conventions
.\" Source: lazygal
.\" Language: English
.\"
.TH "LAZYGAL\&.CONF" "5" "August 2011" "lazygal" "File formats and conventions"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
lazygal.conf \- Configuration file for lazygal, a static web gallery generator\&.
.SH "FORMAT DESCRIPTION"
.PP
\fBlazygal\fR(1)
is configured using JSON files\&. The format looks like this:
.sp
.if n \{\
.RS 4
.\}
.nf
{
"sectionname": {
"variable" : "string value ",
"boolean" : false,
"list" : ["foo", "bar"],
"dictionnary" : {
"key1": "value1",
"key2": "value2"
}
},
"othersection": {
"foo" : "bar"
}
}
.fi
.if n \{\
.RE
.\}
.PP
This format is the preferred way to configure
\fBlazygal\fR(1)\&.
.SH "LEGACY FORMAT DESCRIPTION (INI)"
.PP
The configuration file can also be an INI like file\&. The format looks like this:
.sp
.if n \{\
.RS 4
.\}
.nf
[sectionname]
variable = string value
boolean = Yes
list = foo, bar
dictionnary = key1=value1, key2=value2
[othersection]
foo = bar
.fi
.if n \{\
.RE
.\}
.PP
In this INI format, boolean values can be conveniently set in the following ways:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
For
True:
1,
yes,
true, and
on\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
For
False:
0,
no,
false, and
off\&.
.RE
.PP
Please refer to
\m[blue]\fBthe python ConfigParser documentation\fR\m[]\&\s-2\u[1]\d\s+2
for more information on the file format\&.
.SH "RUNTIME SECTION"
.PP
The
\fIruntime\fR
defines the runtime parameters\&.
.PP
quiet
.RS 4
Boolean\&. Same as
\fB\-\-quiet\fR
in
\fBlazygal\fR(1)
if
True\&. (default is
False)\&.
.RE
.PP
debug
.RS 4
Boolean\&. Same as
\fB\-\-debug\fR
in
\fBlazygal\fR(1)
if
True
(default is
False)\&.
.RE
.PP
check\-all\-dirs
.RS 4
Boolean\&. Same as
\fB\-\-check\-all\-dirs\fR
in
\fBlazygal\fR(1)
if
True\&. (default is
False)\&.
.RE
.SH "GLOBAL SECTION"
.PP
The
\fIglobal\fR
defines the global parameters\&. Those parameters apply to all the sub\-galleries\&.
.PP
output\-directory
.RS 4
Same as
\fB\-\-output\-directory=\fR\fB\fIDEST_DIR\fR\fR
in
\fBlazygal\fR(1)
(default is current directory)\&.
.RE
.PP
clean\-destination
.RS 4
Boolean\&. Same as
\fB\-\-clean\-destination\fR
in
\fBlazygal\fR(1)
if
True\&.
.RE
.PP
preserve
.RS 4
Same as
\fB\-\-preserve=\fR\fB\fIPATTERN\fR\fR
in
\fBlazygal\fR(1)\&. Multiple values may be separated by commas\&.
.RE
.PP
exclude
.RS 4
Same as
\fB\-\-exclude=\fR\fB\fIPATTERN\fR\fR
in
\fBlazygal\fR(1)\&. Multiple values may be separated by commas\&.
.RE
.PP
dir\-flattening\-depth
.RS 4
Same as
\fB\-\-dir\-flattening\-depth=\fR\fB\fILEVEL\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.PP
puburl
.RS 4
Same as
\fB\-\-puburl=\fR\fB\fIPUB_URL\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.PP
theme
.RS 4
Same as
\fB\-\-theme=\fR\fB\fITHEME\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.SH "WEBGAL SECTION"
.PP
The
\fIwebgal\fR
defines the parameters for a web\-gallery\&.
.PP
default\-style
.RS 4
Same as
\fB\-\-default\-style=\fR\fB\fIDEFAULT_STYLE\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.PP
webalbumpic\-bg
.RS 4
Same as
\fB\-\-webalbum\-pic\-bg=\fR\fB\fIWEBALBUMPIC_BG\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.PP
webalbumpic\-type
.RS 4
Same as
\fB\-\-webalbum\-pic\-type=\fR\fB\fIWEBALBUMPIC_BG\fR\fR
in
\fBlazygal\fR(1)\&. If you set this to \*(Aqtidy\*(Aq you may also consider setting
\fIwebalbumpic\-size\fR
(see below) to something smaller than the default 200x150\&.
.RE
.PP
webalbumpic\-size
.RS 4
Size of picture mash\-up representing galleries, eg\&. 200x150\&.
.RE
.PP
image\-size
.RS 4
Same as
\fB\-\-image\-size=\fR\fB\fIIMAGE_SIZE\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.PP
thumbnail\-size
.RS 4
Same as
\fB\-\-thumbnail\-size=\fR\fB\fITHUMBNAIL_SIZE\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.PP
video\-size
.RS 4
Size of videos, eg\&. 0x0\&. Refer to the IMAGE RESIZE DESCRIPTION section for more information on the available syntax\&.
.sp
In addition, size can be the name of a previously declared image\-size\&.
.RE
.PP
thumbs\-per\-page
.RS 4
Same as
\fB\-\-thumbs\-per\-page=\fR\fB\fITHUMBS_PER_PAGE\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.PP
sort\-medias
.RS 4
Same as
\fB\-\-pic\-sort\-by=\fR\fB\fIORDER\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.PP
sort\-subgals
.RS 4
Same as
\fB\-\-subgal\-sort\-by=\fR\fB\fIORDER\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.PP
original
.RS 4
Boolean\&. Same as
\fB\-\-original\fR
in
\fBlazygal\fR(1)
if
True
(default is
False)\&.
.RE
.PP
original\-baseurl
.RS 4
Same as
\fB\-\-orig\-base=\fR\fB\fIRELATIVE_PATH\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.PP
original\-symlink
.RS 4
Boolean\&. Same as
\fB\-\-orig\-symlink\fR
in
\fBlazygal\fR(1)
if
True
(default is
False)\&.
.RE
.PP
dirzip
.RS 4
Same as
\fB\-\-make\-dir\-zip\fR
in
\fBlazygal\fR(1)
if
True
(default is
False)\&.
.RE
.PP
jpeg\-quality
.RS 4
Same as
\fB\-\-quality=\fR\fB\fIQUALITY\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.PP
jpeg\-optimize
.RS 4
Boolean\&. Run an extra optimization pass for each generated thumbnail if
True, the default\&.
.RE
.PP
jpeg\-progressive
.RS 4
Generate progressive JPEG images if
True, the default\&.
.RE
.PP
publish\-metadata
.RS 4
Publish image metadata if
True, the default: copy original image metadata in reduced picture, and include some information in the image page\&.
.RE
.PP
filter\-by\-tag
.RS 4
Same as
\fB\-\-filter\-by\-tag=\fR\fB\fITAG\fR\fR
in
\fBlazygal\fR(1)\&.
.RE
.SH "TEMPLATE\-VARS SECTION"
.PP
The
\fItemplate\-vars\fR
defines the custom template variables\&. The variables and their value are listed in this section\&.
.PP
\fBExample\ \&1.\ \&$footer in the default template\fR
.PP
For instance,
\fI$footer\fR
is a template variable in the
default
template\&. Its value can be defined with this configuration file:
.sp
.if n \{\
.RS 4
.\}
.nf
{
"template\-vars": {
"footer": "All pics are copyright 2011 me
"
}
}
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBlazygal\fR(1)\&.
.SH "AUTHOR"
.PP
This manual page was written for the
Debian
system (but may be used by others)\&. Permission is granted to copy, distribute and/or modify this document under the terms of the
GNU
General Public License, Version 2 any later version published by the Free Software Foundation\&.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2011
.br
.SH "NOTES"
.IP " 1." 4
the python ConfigParser documentation
.RS 4
\%http://docs.python.org/library/configparser.html
.RE