year update
[booh] / data / man / man1 / booh-backend.1
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.
5 .\"
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.
10 .\"
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
14 .\"
15
16 .TH BOOH-BACKEND 1 "July 2007" "BOOH" "The booh web-album"
17
18 .SH NAME
19 booh-backend \- backend script of \fBbooh\fR, the static web-album generator
20
21 .SH SYNOPSIS
22 \fBbooh-backend\fR [\fIOPTION\fR]...
23
24 .SH DESCRIPTION
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
28 thumbnails etc.
29 .PP
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.
34
35 .SH OPTIONS
36 .TP
37 \fB-h\fR, \fB--help\fR
38 Get help message
39 .TP
40 \fB-V\fR, \fB--version\fR
41 Print version and exit
42 .TP
43 \fB-n\fR, \fB--no-check\fR
44 Don't check for needed external programs at startup
45 .TP
46 \fB-s\fR \fIDIR\fR, \fB--source\fR \fIDIR\fR
47 Directory which contains original images/videos as files or subdirs
48 .TP
49 \fB-d\fR \fIDIR\fR, \fB--destination\fR \fIDIR\fR
50 Directory which will contain the web-album
51 .TP
52 \fB-t\fR \fITHEME\fR, \fB--theme\fR \fITHEME\fR
53 Select HTML theme to use
54 .TP
55 \fB-C\fR \fIFILE\fR, \fB--config\fR \fIFILE\fR
56 File containing config listing images and videos within directories with captions
57 .TP
58 \fB-k\fR \fIFILE\fR, \fB--config-skel\fR \fIFILE\fR
59 Filename where the script will output a config skeleton
60 .TP
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
63 .TP
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
66 .TP
67 \fB-D\fR \fIDIR\fR, \fB--dir\fR \fIDIR\fR
68 Directory for merge with --merge-config-onedir
69 .TP
70 \fB-u\fR \fIFILE\fR, \fB--use-config\fR \fIFILE\fR
71 File containing config listing, where to change theme info
72 .TP
73 \fB-f\fR, \fB--force\fR
74 Force generation of album even if the GUI marked some directories as already generated
75 .TP
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)
78 .TP
79 \fB-e\fR, \fB--empty-comments\fR
80 Prefer empty comments over filename when creating new albums
81 .TP
82 \fB-m\fR \fINUM\fR, \fB--mproc\fR \fINUM\fR
83 Specify the number of processors for multi-processors machines
84 .TP
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)
87 .TP
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)
90 .TP
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)
93
94 .SH EXAMPLES
95
96 Simply generate a web-album out of photos in \fB/tmp/Albums\fR, to the directory \fB/tmp/booh-try\fR:
97 .PP
98 \fI# booh-backend --source /tmp/Albums --destination /tmp/booh-try\fR
99 .PP
100
101 The same, but also save the XML "config" file which will contain the list of images/videos and options for them:
102 .PP
103 \fI# booh-backend --source /tmp/Albums --destination /tmp/booh-try --config-skel /tmp/myconf.xml\fR
104 .PP
105
106 If you want to manually change things in the XML "config" file (the GUI is best suited for that, but who knows), then, afterwards, you can regenerate the updated web-album with:
107 .PP
108 \fI# booh-backend --config /tmp/myconf.xml\fR
109 .PP
110
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:
112 .PP
113 \fI# booh-backend --merge-config /tmp/myconf.xml\fR
114 .PP
115
116 .SH AUTHOR
117 Written by Guillaume Cottenceau.
118 .br
119 Visit official homepage: http://booh.org/
120
121 .SH SEE ALSO
122 .BR booh-backend(1)
123
124 .SH COPYRIGHT
125 Copyright \(co 2005-2007 Guillaume Cottenceau.
126 .br
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.