Source

lazygal / lazygal.1

.TH LAZYGAL "1" "November 2007" "lazygal" "User Commands"
.SH NAME
lazygal \- static web gallery generator

.SH SYNOPSIS
usage: lazygal [options] albumdir

.SH DESCRIPTION
This manual page explains the
.B lazygal
program. This program is a static web gallery generator written in Python.
.SH OPTIONS
.TP
\fB\-v\fR, \fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-quiet\fR
Don't output anything except for errors.
.TP
\fB\-\-debug\fR
Output everything that lazygal is doing.
.TP
\fB\-o\fR DEST_DIR, \fB\-\-output\-directory\fR=\fIDEST_DIR\fR
Directory where web pages, slides and thumbs will be
written (default is current directory).
.TP
\fB\-t\fR THEME, \fB\-\-theme\fR=\fITHEME\fR
Theme name (looked up in theme directory) or theme
full path.
.TP
\fB\-\-template\-vars\fR=\fITPL_VARS\fR
Common variables to load all templates with, define as <name1>=<value1>,
<name2>=<value2> .
.TP
\fB\-\-clean\-destination\fR
Clean destination directory of files that should not
be there.
.TP
\fB\-\-check\-all\-dirs\fR
Exhaustively go through all directories regardless of
source modification time (prefer the use of
.B touch
on a source directory if you want to force its processing).
.TP
\fB\-s\fR IMAGE_SIZE, \fB\-\-image\-size\fR=\fIIMAGE_SIZE\fR
Size of images, define as <name>=<x>x<y>,..., eg.
small=800x600,medium=1024x768.
.TP
\fB\-T\fR THUMBNAIL_SIZE, \fB\-\-thumbnail\-size\fR=\fITHUMBNAIL_SIZE\fR
Size of thumbnails, define as <x>x<y>, eg. 150x113.
.TP
\fB\-q\fR QUALITY, \fB\-\-quality\fR=\fIQUALITY\fR
Quality of generated JPEG images (default is 85).
.TP
\fB\-O\fR, \fB\-\-original\fR
Include original photos in output.

.SH THEMES
A theme maps to a directory that contains at least the following items :
.TP 5
<theme>/browse.thtml
The XHTML template for the theme browse page (displaying one picture).
.TP 5
<theme>/dirindex.thtml
The XHTML template for the directory index page (pictures and subgalleries
links).

.P
This must be valid XML. See <\fIhttp://genshi.edgewall.org/wiki/Documentation/xml-templates.html\fR> for syntax.

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

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

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

.SH FILES
.TP 5
~/.lazygal
User configuration directory.
.TP 5
~/.lazygal/config
User configuration file. INI like file format.
.TP 5
~/.lazygal/themes
User themes directory.

.SH SEE ALSO
The full documentation for
.B lazygal
is maintained as a README file.

More information is available on program website:
<\fIhttp://sousmonlit.dyndns.org/~niol/playa/oss:lazygal\fR>.