lazygal.conf(5)

1LAZYGAL.CONF(5)          File formats and conventions          LAZYGAL.CONF(5)
2
3
4

NAME

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

FORMAT DESCRIPTION

10       lazygal(1) is configured using JSON files. The format looks like this:
11
12           {
13               "sectionname": {
14                   "variable"     : "string value ",
15                   "boolean"      : false,
16                   "list"         : ["foo", "bar"],
17                   "dictionary"  : {
18                       "key1": "value1",
19                       "key2": "value2"
20                   }
21               },
22               "othersection": {
23                   "foo"          : "bar"
24               }
25           }
26
27       This format is the preferred way to configure lazygal(1).
28

LEGACY FORMAT DESCRIPTION (INI)

30       The configuration file can also be an INI like file. The format looks
31       like this:
32
33           [sectionname]
34           variable = string value
35           boolean = Yes
36           list = foo, bar
37           dictionary = key1=value1, key2=value2
38
39           [othersection]
40           foo = bar
41
42       In this INI format, boolean values can be conveniently set in the
43       following ways:
44
45       ·   For True: 1, yes, true, and on.
46
47       ·   For False: 0, no, false, and off.
48
49       Please refer to the python ConfigParser documentation[1] for more
50       information on the file format.
51

RUNTIME SECTION

53       The runtime defines the runtime parameters.
54
55       quiet
56           Boolean. Same as --quiet in lazygal(1) if True. (default is False).
57
58       debug
59           Boolean. Same as --debug in lazygal(1) if True (default is False).
60
61       check-all-dirs
62           Boolean. Same as --check-all-dirs in lazygal(1) if True. (default
63           is False).
64

GLOBAL SECTION

66       The global defines the global parameters. Those parameters apply to all
67       the sub-galleries.
68
69       output-directory
70           Same as --output-directory=DEST_DIR in lazygal(1) (default is
71           current directory).
72
73       clean-destination
74           Boolean. Same as --clean-destination in lazygal(1) if True.
75
76       preserve
77           Same as --preserve=PATTERN in lazygal(1). Multiple values may be
78           separated by commas.
79
80       exclude
81           Same as --exclude=PATTERN in lazygal(1). Multiple values may be
82           separated by commas.
83
84       dir-flattening-depth
85           Same as --dir-flattening-depth=LEVEL in lazygal(1).
86
87       puburl
88           Same as --puburl=PUB_URL in lazygal(1).
89
90       theme
91           Same as --theme=THEME in lazygal(1).
92

WEBGAL SECTION

94       The webgal defines the parameters for a web-gallery.
95
96       default-style
97           Same as --default-style=DEFAULT_STYLE in lazygal(1).
98
99       webalbumpic-bg
100           Same as --webalbum-pic-bg=WEBALBUMPIC_BG in lazygal(1).
101
102       webalbumpic-type
103           Same as --webalbum-pic-type=WEBALBUMPIC_BG in lazygal(1). If you
104           set this to 'tidy' you may also consider setting webalbumpic-size
105           (see below) to something smaller than the default 200x150.
106
107       webalbumpic-size
108           Size of picture mash-up representing galleries, eg. 200x150.
109
110       image-size
111           Same as --image-size=IMAGE_SIZE in lazygal(1).
112
113       thumbnail-size
114           Same as --thumbnail-size=THUMBNAIL_SIZE in lazygal(1).
115
116       video-size
117           Size of videos, eg. 0x0. Refer to the IMAGE RESIZE DESCRIPTION
118           section for more information on the available syntax.
119
120           In addition, size can be the name of a previously declared
121           image-size.
122
123       thumbs-per-page
124           Same as --thumbs-per-page=THUMBS_PER_PAGE in lazygal(1).
125
126       sort-medias
127           Same as --pic-sort-by=ORDER in lazygal(1).
128
129       sort-subgals
130           Same as --subgal-sort-by=ORDER in lazygal(1).
131
132       original
133           Boolean. Same as --original in lazygal(1) if True (default is
134           False).
135
136       original-baseurl
137           Same as --orig-base=RELATIVE_PATH in lazygal(1).
138
139       original-symlink
140           Boolean. Same as --orig-symlink in lazygal(1) if True (default is
141           False).
142
143       dirzip
144           Same as --make-dir-zip in lazygal(1) if True (default is False).
145
146       jpeg-quality
147           Same as --quality=QUALITY in lazygal(1).
148
149       jpeg-optimize
150           Boolean. Run an extra optimization pass for each generated
151           thumbnail if True, the default.
152
153       jpeg-progressive
154           Generate progressive JPEG images if True, the default.
155
156       publish-metadata
157           Publish image metadata if True, the default: copy original image
158           metadata in reduced picture, and include some information in the
159           image page.
160
161       filter-by-tag
162           Same as --filter-by-tag=TAG in lazygal(1).
163

TEMPLATE-VARS SECTION

165       The template-vars defines the custom template variables. The variables
166       and their value are listed in this section.
167
168       Example 1. $footer in the default template
169
170       For instance, $footer is a template variable in the default template.
171       Its value can be defined with this configuration file:
172
173           {
174               "template-vars": {
175                   "footer": "<p>All pics are copyright 2011 me</p>"
176               }
177           }
178

AUTHOR

183       This manual page was written for the Debian(TM) system (but may be used
184       by others). Permission is granted to copy, distribute and/or modify
185       this document under the terms of the GNU General Public License,
186       Version 2 any later version published by the Free Software Foundation.
187
188       On Debian systems, the complete text of the GNU General Public License
189       can be found in /usr/share/common-licenses/GPL.
190

COPYRIGHT

192       Copyright © 2011
193

NOTES

195        1.
196
197                       the python ConfigParser documentation
198
199           http://docs.python.org/library/configparser.html
200
201
202
203lazygal                           August 2011                  LAZYGAL.CONF(5)