some slight man updates
[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 "August 2008" "BOOH" "The Booh web-album"
17
18 .SH NAME
19 booh-backend \- backend script of \fBBooh\fR, a 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 to create or update a web-album.
32 Contrast with \fBbooh\fR, which is the graphical user interface - the
33 easiest and recommended 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-s\fR \fIDIR\fR, \fB--source\fR \fIDIR\fR
44 Directory which contains original photos/videos as files or subdirs
45 .TP
46 \fB-d\fR \fIDIR\fR, \fB--destination\fR \fIDIR\fR
47 Directory which will contain the web-album; if it already exits, then all existing files and directories inside it will be removed!
48 .TP
49 \fB-t\fR \fITHEME\fR, \fB--theme\fR \fITHEME\fR
50 Select HTML theme to use
51 .TP
52 \fB-C\fR \fIFILE\fR, \fB--config\fR \fIFILE\fR
53 File containing config listing photos and videos within directories with captions
54 .TP
55 \fB-k\fR \fIFILE\fR, \fB--config-skel\fR \fIFILE\fR
56 Filename where the script will output a config skeleton
57 .TP
58 \fB-M\fR \fIFILE\fR, \fB--merge-config\fR \fIFILE\fR
59 File containing config listing, where to merge new photos/videos from --source, and change theme info
60 .TP
61 \fB-O\fR \fIFILE\fR, \fB--merge-config-onedir\fR \fIFILE\fR
62 File containing config listing, for merging the subdir specified with --dir
63 .TP
64 \fB-U\fR \fIFILE\fR, \fB--merge-config-subdirs\fR \fIFILE\fR
65 File containing config listing, for merging the new subdirs down 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 or --merge-config-subdirs
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-L\fR \fILANGUAGES\fR, \fB--multi-languages\fR \fILANGUAGES\fR
80 Specify the list of languages to support (uses Apache MultiViews); this is a comma-separated list of supported languages, with last element used as the fallback language; for example: 'fr,eo,en,en'; supported languages: en, de, fr, ja, eo
81 .TP
82 \fB-T\fR \fINUM\fR, \fB--thumbnails-per-row\fR \fINUM\fR
83 Specify the amount of thumbnails per row in the thumbnails page (if applicable in theme)
84 .TP
85 \fB-p\fR \fINUM\fR, \fB--thumbnails-per-page\fR \fINUM\fR
86 Specify the amount of thumbnails per page in the thumbnails page, after which split occurs
87 .TP
88 \fB-o\fR, \fB--optimize-for-32\fR
89 Resize images with optimized sizes for 3/2 aspect ratio rather than 4/3 (typical aspect ratio of photos from point-and-shoot cameras - also called compact cameras - is 4/3, whereas photos from SLR cameras - also called reflex cameras - is 3/2)
90 .TP
91 \fB-r\fR \fICOMMAND\fR, \fB--transcode-videos\fR \fICOMMAND\fR
92 Transcode videos with the specified command; it must contain %f, the placeholder for the input video, %o the placeholder for the output video; it must be prepended by the output video extension followed by a colon; example:
93
94 \fIavi:mencoder -nosound -ovc xvid -xvidencopts bitrate=800:me_quality=6 -o %o %f\fR
95 .TP
96 \fB-l\fR \fIMARKUP\fR, \fB--index-link\fR \fIMARKUP\fR
97 Specify the HTML markup to use on the bottom of pages for a small link returning to wherever you see fit in your website (or somewhere else)
98 .TP
99 \fB-n\fR \fIMARKUP\fR, \fB--made-with\fR \fIMARKUP\fR
100 Specify the HTML markup to use on the bottom of pages for a small 'made with' message
101 .TP
102 \fB-c\fR \fIFORMAT\fR, \fB--comments-format\fR \fIFORMAT\fR
103 Specify comments format to use for images instead of only filename when creating new albums; use ImageMagick's format
104 .TP
105 \fB-m\fR \fINUM\fR, \fB--mproc\fR \fINUM\fR
106 Specify the number of processors for multi-processors machines
107 .TP
108 \fB-g\fR, \fB--for-gui\fR
109 Do the minimum work to be able to see the album under the GUI (don't generate all thumbnails)
110 .TP
111 \fB-v\fR \fINUM\fR, \fB--verbose-level\fR \fINUM\fR
112 Set max verbosity level (0: errors, 1: warnings, 2: important messages, 3: other messages)
113 .TP
114 \fB-i\fR \fIPIPE\fR, \fB--info-pipe\fR \fIPIPE\fR
115 Name a file where to write information about what's going on (used by the GUI to update waiting messages etc)
116
117 .SH EXAMPLES
118
119 Simply generate a web-album out of photos in \fB/tmp/Albums\fR, to the directory \fB/tmp/booh-try\fR:
120 .PP
121 \fI# booh-backend --source /tmp/Albums --destination /tmp/booh-try\fR
122 .PP
123
124 The same, but also save the XML "config" file which will contain the list of photos/videos and options for them:
125 .PP
126 \fI# booh-backend --source /tmp/Albums --destination /tmp/booh-try --config-skel /tmp/myconf.xml\fR
127 .PP
128
129 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:
130 .PP
131 \fI# booh-backend --config /tmp/myconf.xml\fR
132 .PP
133
134 If you add/remove photos/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:
135 .PP
136 \fI# booh-backend --merge-config /tmp/myconf.xml\fR
137 .PP
138
139 .SH AUTHOR
140 Written by Guillaume Cottenceau.
141 .br
142 Visit official homepage: http://booh.org/
143
144 .SH SEE ALSO
145 .BR booh(1)
146 .BR booh-classifier(1)
147
148 .SH COPYRIGHT
149 Copyright \(co 2005-2008 Guillaume Cottenceau.
150 .br
151 This is Free Software; this software is licensed under the GPL version 2, as published by the Free Software Foundation.
152 There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.