1 .\" This program is free software; you can redistribute it and/or modify
2 .\" it under the terms of the GNU General Public License as published by
3 .\" the Free Software Foundation; either version 2 of the License, or
4 .\" (at your option) any later version.
6 .\" This program is distributed in the hope that it will be useful,
7 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
8 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 .\" GNU General Public License for more details.
11 .\" You should have received a copy of the GNU General Public License
12 .\" along with this program; if not, write to the Free Software
13 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 .TH BOOH-BACKEND 1 "June 2005" "BOOH" "The booh web-album"
19 booh-backend \- backend script of \fBbooh\fR, the static web-album generator
22 \fBbooh-backend\fR [\fIOPTION\fR]...
25 \fBBooh\fR is a static Web-Album generator. It's a program which
26 takes one or several series of photos and videos, and
27 automatically build static web pages to browse them, creating
30 If you invoke \fBbooh-backend\fR from the command-line, this will
31 launch the backend script allowing creating/generating an album.
32 Contrast with \fBbooh\fR, which is the graphical user interface
33 over the backend, the easiest way to create an album.
37 \fB-h\fR, \fB--help\fR
40 \fB-V\fR, \fB--version\fR
41 Print version and exit
43 \fB-n\fR, \fB--no-check\fR
44 Don't check for needed external programs at startup
46 \fB-s\fR \fIDIR\fR, \fB--source\fR \fIDIR\fR
47 Directory which contains original images/videos as files or subdirs
49 \fB-d\fR \fIDIR\fR, \fB--destination\fR \fIDIR\fR
50 Directory which will contain the web-album
52 \fB-t\fR \fITHEME\fR, \fB--theme\fR \fITHEME\fR
53 Select HTML theme to use
55 \fB-C\fR \fIFILE\fR, \fB--config\fR \fIFILE\fR
56 File containing config listing images and videos within directories with captions
58 \fB-k\fR \fIFILE\fR, \fB--config-skel\fR \fIFILE\fR
59 Filename where the script will output a config skeleton
61 \fB-M\fR \fIFILE\fR, \fB--merge-config\fR \fIFILE\fR
62 File containing config listing, where to merge new images/videos from --source, and change theme info
64 \fB-O\fR \fIFILE\fR, \fB--merge-config-onedir\fR \fIFILE\fR
65 File containing config listing, for merging the subdir specified with --dir
67 \fB-D\fR \fIDIR\fR, \fB--dir\fR \fIDIR\fR
68 Directory for merge with --merge-config-onedir
70 \fB-u\fR \fIFILE\fR, \fB--use-config\fR \fIFILE\fR
71 File containing config listing, where to change theme info
73 \fB-f\fR, \fB--force\fR
74 Force generation of album even if the GUI marked some directories as already generated
76 \fB-S\fR \fISIZELIST\fR, \fB--sizes\fR \fISIZELIST\fR
77 Specify the list of images sizes to use instead of all specified in the theme (this is a comma-separated list)
79 \fB-e\fR, \fB--empty-comments\fR
80 Prefer empty comments over filename when creating new albums
82 \fB-m\fR \fINUM\fR, \fB--mproc\fR \fINUM\fR
83 Specify the number of processors for multi-processors machines
85 \fB-g\fR, \fB--for-gui\fR
86 Do the minimum work to be able to see the album under the GUI (don't generate all thumbnails)
88 \fB-v\fR \fINUM\fR, \fB--verbose-level\fR \fINUM\fR
89 Set max verbosity level (0: errors, 1: warnings, 2: important messages, 3: other messages)
91 \fB-i\fR \fIPIPE\fR, \fB--info-pipe\fR \fIPIPE\fR
92 Name a file where to write information about what's going on (used by the GUI to update waiting messages etc)
96 Simply generate a web-album out of photos in \fB/tmp/Albums\fR, to the directory \fB/tmp/booh-try\fR:
98 \fI# booh-backend --source /tmp/Albums --destination /tmp/booh-try\fR
101 The same, but also save the XML "config" file which will contain the list of images/videos and options for them:
103 \fI# booh-backend --source /tmp/Albums --destination /tmp/booh-try --config-skel /tmp/myconf.xml\fR
106 If you want to manually change things in the XML "config" file (the GUI is best suited for that, but who knows), then you can regenerate the updated web-album with:
108 \fI# booh-backend --config /tmp/myconf.xml\fR
111 If you add/remove images/videos or even whole subdirectories in the source tree /tmp/Albums, you can ask booh to merge differences (and regenerate the config file and the web-album) with:
113 \fI# booh-backend --merge-config /tmp/myconf.xml\fR
117 Written by Guillaume Cottenceau.
119 Visit official homepage: http://booh.org/
125 Copyright \(co 2005 Guillaume Cottenceau.
127 This is Free Software; this software is licensed under the GPL version 2, as published by the Free Software Foundation.
128 There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.