Scroll to navigation

LAZYGAL.CONF(5) File formats and conventions LAZYGAL.CONF(5)

NAME

lazygal.conf - Configuration file for lazygal, a static web gallery generator.

FORMAT DESCRIPTION

lazygal(1) is configured using JSON files. The format looks like this: 

{
    "sectionname": {
        "variable"     : "string value ",
        "boolean"      : false,
        "list"         : ["foo", "bar"],
        "dictionnary"  : {
            "key1": "value1",
            "key2": "value2"
        }
    },
    "othersection": {
        "foo"          : "bar"
    }
}

This format is the preferred way to configure lazygal(1).

LEGACY FORMAT DESCRIPTION (INI)

The configuration file can also be an INI like file. The format looks like this: 

[sectionname]
variable = string value
boolean = Yes
list = foo, bar
dictionnary = key1=value1, key2=value2
[othersection]
foo = bar

In this INI format, boolean values can be conveniently set in the following ways:

•For True: 1, yes, true, and on.

•For False: 0, no, false, and off.

Please refer to the python ConfigParser documentation[1] for more information on the file format.

RUNTIME SECTION

The runtime defines the runtime parameters.

quiet

Boolean. Same as --quiet in lazygal(1) if True. (default is False).

debug

Boolean. Same as --debug in lazygal(1) if True (default is False).

check-all-dirs

Boolean. Same as --check-all-dirs in lazygal(1) if True. (default is False).

GLOBAL SECTION

The global defines the global parameters. Those parameters apply to all the sub-galleries.

output-directory

Same as --output-directory=DEST_DIR in lazygal(1) (default is current directory).

clean-destination

Boolean. Same as --clean-destination in lazygal(1) if True.

preserve

Same as --preserve=PATTERN in lazygal(1). Multiple values may be separated by commas.

exclude

Same as --exclude=PATTERN in lazygal(1). Multiple values may be separated by commas.

dir-flattening-depth

Same as --dir-flattening-depth=LEVEL in lazygal(1).

puburl

Same as --puburl=PUB_URL in lazygal(1).

theme

Same as --theme=THEME in lazygal(1).

WEBGAL SECTION

The webgal defines the parameters for a web-gallery.

default-style

Same as --default-style=DEFAULT_STYLE in lazygal(1).

webalbumpic-bg

Same as --webalbum-pic-bg=WEBALBUMPIC_BG in lazygal(1).

webalbumpic-type

Same as --webalbum-pic-type=WEBALBUMPIC_BG in lazygal(1). If you set this to 'tidy' you may also consider setting webalbumpic-size (see below) to something smaller than the default 200x150.

webalbumpic-size

Size of picture mash-up representing galleries, eg. 200x150.

image-size

Same as --image-size=IMAGE_SIZE in lazygal(1).

thumbnail-size

Same as --thumbnail-size=THUMBNAIL_SIZE in lazygal(1).

video-size

Size of videos, eg. 0x0. Refer to the IMAGE RESIZE DESCRIPTION section for more information on the available syntax.

In addition, size can be the name of a previously declared image-size.

thumbs-per-page

Same as --thumbs-per-page=THUMBS_PER_PAGE in lazygal(1).

sort-medias

Same as --pic-sort-by=ORDER in lazygal(1).

sort-subgals

Same as --subgal-sort-by=ORDER in lazygal(1).

original

Boolean. Same as --original in lazygal(1) if True (default is False).

original-baseurl

Same as --orig-base=RELATIVE_PATH in lazygal(1).

original-symlink

Boolean. Same as --orig-symlink in lazygal(1) if True (default is False).

dirzip

Same as --make-dir-zip in lazygal(1) if True (default is False).

jpeg-quality

Same as --quality=QUALITY in lazygal(1).

jpeg-optimize

Boolean. Run an extra optimization pass for each generated thumbnail if True, the default.

jpeg-progressive

Generate progressive JPEG images if True, the default.

publish-metadata

Publish image metadata if True, the default: copy original image metadata in reduced picture, and include some information in the image page.

filter-by-tag

Same as --filter-by-tag=TAG in lazygal(1).

TEMPLATE-VARS SECTION

The template-vars defines the custom template variables. The variables and their value are listed in this section.

Example 1. $footer in the default template

For instance, $footer is a template variable in the default template. Its value can be defined with this configuration file:

{
    "template-vars": {
        "footer": "<p>All pics are copyright 2011 me</p>"
    }
}

SEE ALSO

lazygal(1).

AUTHOR

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.

On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

COPYRIGHT

Copyright © 2011

NOTES

1.

the python ConfigParser documentation

http://docs.python.org/library/configparser.html
August 2011 lazygal