]> Sergey Matveev's repositories - galgen.git/blob - README
137305c52d3f0e887bef700c527d42cbd694b830
[galgen.git] / README
1 galgen -- static images gallery generator
2
3 That generator is written on zsh and is aimed only to deal with JPEG XL
4 image format solely. JPEG XL is superior to any other format both in
5 lossy and lossless modes.
6
7 Just run that script inside the directory with .jxl files. For each file
8 the small preview will be generated in lossy WebP format. Also
9 corresponding HTML file is generated too, containing information about
10 the picture and its metadata.
11
12 You can set the following environment variables:
13 * PAGESIZE (100 by default)
14 * ORDERING ("Om" by default, zsh glob notation)
15 * STYLE (URL to CSS file, by default is none, no stylesheet link is set)
16
17 If it is JPEG XL, then, for compatibility reason with non-bleeding edge
18 software, alternative format is generated too (unless NOALT environment
19 variable is set): either JPEG (if JPEG XL contains losslessly transcoded
20 JPEG), or PNG (leaving off the alpha channel).
21
22 If image file has corresponding .txt/.html, then it will be included on
23 HTML page.
24
25 All images are sorted my modification date and grouped by pages, linking
26 them together. If directory contains ".txt"/".html", then it will be
27 included on the first page.
28
29 Following external utilities are called: djxl, jxlinfo, exiftool,
30 pamtopng, pnmscale, pngcrush, advpng, cwebp, parallel.