Man Linux: Main Page and Category List

NAME

       lazygal - static web gallery generator

SYNOPSIS

       lazygal [-h | -v | [options] albumdir]

DESCRIPTION

       This manual page explains the lazygal program. This program is a static
       web gallery generator written in Python.

       lazygal works so: you should have an original store of files - possibly
       containg subdirectories (their names serving as headings if not using
       the album metadata feature). This is the source file hierarchy. It will
       never be modified by lazygal. Then, when launching:

       $ lazygal -o /var/www/MyAlbum /home/user/SourceDir

       lazygal will analyze the contents of the source hierarchy and will
       (re)create the target hierarchy, but with all the bells and whistles
       defined by the templates. Only missing parts or parts that are not up
       to date will be generated.

OPTIONS

       These programs follow the usual GNU command line syntax, with long
       options starting with two dashes (‘-'). A summary of options is
       included below. For a complete description, see the -h switch.

       -v --version
           Show program's version number and exit.

       -h --help
           Show summary of options.

       --quiet
           Don't output anything except for errors.

       --debug
           Output everything that lazygal is doing.

       -o DEST_DIR --output-directory=DEST_DIR
           Directory where web pages, slides and thumbs will be written
           (default is current directory).

       -t THEME --theme=THEME
           Theme name (looked up in theme directory) or theme full path.

       --default-style=DEFAULT_STYLE
           Default style to apply to the theme.

       --template-vars=TPL_VARS
           Common variables to load all templates with.

       --clean-destination
           Clean destination directory of files that should not be there.

       --check-all-dirs
           Exhaustively go through all directories regardless of source
           modification time.

       -s IMAGE_SIZE --image-size=IMAGE_SIZE
           Size of images, define as name=xxy, ..., eg.
           small=800x600,medium=1024x768. The special dimensions 0x0 use
           original size. Refer to the IMAGE RESIZE DESCRIPTION section for
           more information on the available syntax.

       -T THUMBNAIL_SIZE --thumbnail-size=THUMBNAIL_SIZE
           Size of thumbnails, eg. 150x113. Refer to the IMAGE RESIZE
           DESCRIPTION section for more information on the available syntax.

       -q QUALITY --quality=QUALITY
           Quality of generated JPEG images (default is 85).

       -O --original
           Include original photos in output.

       --orig-base=RELATIVE_PATH
           Do not copy original photos in output directory, instead link them
           using RELATIVE_PATH as base for those links (discarded without -O).

       --optimize
           Run an extra optimization pass for each generated thumbnail.

       --progressive
           Generate progressive JPEG images.

       --puburl=PUB_URL
           Publication URL (only useful for feed generation).

       -m --generate-metadata
           Generate metadata description files where they don't exist in the
           source tree instead of generating the web gallery. This disables
           all other options.

       -n THUMBS_PER_PAGE --thumbs-per-page=THUMBS_PER_PAGE
           Maximum number of thumbs per index page. This enables index
           pagination (0 is unlimited).

       --pic-sort-by=ORDER
           Sort order for images in a subgallery, among 'mtime', 'filename',
           or 'exif'. (default is 'exif' which is by EXIF date if EXIF data is
           available, filename otherwise, sorting EXIF-less images before).
           Add ':reverse' to reverse the sort order (e.g.
           --pic-sort-by=mtime:reverse).

       --subgal-sort-by=ORDER
           Sort order for subgalleries, among 'mtime' or 'filename' (default
           is 'filename'). Add ':reverse' to reverse the sort order (e.g.
           --subgal-sort-by=filename:reverse).

       --dir-flattening-depth=LEVEL
           Level below witch the directory tree is flattened. Default is no
           flattening ('No').

       -z --make-dir-zip
           Make a zip archive of original pictures for each directory.

       --webalbum-pic-bg=WEBALBUMPIC_BG
           Webalbum picture background color. Default is transparent, and
           implies the PNG format. Any other value, e.g. red, white, blue,
           uses JPEG.

THEMES

       A theme maps to a directory that contains at least the following items:

       theme/browse.thtml
           The XHTML template for the theme browse page (displaying one
           picture).

       theme/dirindex.thtml
           The XHTML template for the directory index page (pictures and
           sub-galleries links).

       This must be valid XML. See
       http://genshi.edgewall.org/wiki/Documentation/xml-templates.html for
       syntax. Dependencies for statically included templates (i.e. with
       filenames not computed from variables) are automatically computed: when
       an included template is modified, the software will automatically
       figure out which pages to re-generate.

       Each file which name starts with SHARED_ is copied to the web album
       destination under the directory shared and is aimed at being a shared
       resource accross your web album (CSS stylesheet, button, etc.).

       Each file which extension starts with t is processed through the Genshi
       text template engine before being copied. See
       http://genshi.edgewall.org/wiki/Documentation/text-templates.html for
       syntax.

       Please refer to the examples supplied in /usr/share/lazygal/themes

ALBUM METADATA

       If a directory from the source album contains a file named
       album_description, it is processed as a source of album metadata. See
       /usr/share/doc/lazygal/README for more information.

FILES

       ~/.lazygal
           User configuration directory.

       ~/.lazygal/config
           User configuration file. INI like file format.

       SOURCE_DIR/.lazygal
           Gallery configuration file. INI like file format. Overloads the
           user configuration file, is overloaded by command line options.

       ~/.lazygal/themes
           User themes directory.

SIZE DESCRIPTION

       The size string follows the same syntax as ImageMagick's.

       scale%
           Height and width both scaled by specified percentage.

       xscale%yscale%
           Height and width individually scaled by specified percentages.

       width
           Width given, height automatically selected to preserve aspect
           ratio.

       xheight
           Height given, width automatically selected to preserve aspect
           ratio.

       widthxheight
           Maximum values of height and width given, aspect ratio preserved.

       widthxheight^
           Minimum values of width and height given, aspect ratio preserved.

       widthxheight!
           Width and height emphatically given, original aspect ratio ignored.

       widthxheight>
           Change as per the supplied dimensions but only if an image
           dimension exceeds a specified dimension.

       widthxheight<
           Change dimensions only if both image dimensions exceed specified
           dimensions.

       pixels@
           Resize image to have specified area in pixels. Aspect ratio is
           preserved.

SEE ALSO

       The full documentation of lazygal is maintained as a README file.

       More information is available on the program website:
       http://sousmonlit.dyndns.org/~niol/playa/oss/projects/lazygal.

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 © 2010

[FIXME: source]                    June 2010