git.zarb.org Git - booh/blob - 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 "March 2008" "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 photos/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; if it already exits, then all existing files and directories inside it will be removed!
  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 photos 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 photos/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-U\fR \fIFILE\fR, \fB--merge-config-subdirs\fR \fIFILE\fR
  68 File containing config listing, for merging the new subdirs down the subdir specified with --dir
  69 .TP
  70 \fB-D\fR \fIDIR\fR, \fB--dir\fR \fIDIR\fR
  71 Directory for merge with --merge-config-onedir or --merge-config-subdirs
  72 .TP
  73 \fB-u\fR \fIFILE\fR, \fB--use-config\fR \fIFILE\fR
  74 File containing config listing, where to change theme info
  75 .TP
  76 \fB-f\fR, \fB--force\fR
  77 Force generation of album even if the GUI marked some directories as already generated
  78 .TP
  79 \fB-S\fR \fISIZELIST\fR, \fB--sizes\fR \fISIZELIST\fR
  80 Specify the list of images sizes to use instead of all specified in the theme (this is a comma-separated list)
  81 .TP
  82 \fB-L\fR \fILANGUAGES\fR, \fB--multi-languages\fR \fILANGUAGES\fR
  83 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
  84 .TP
  85 \fB-T\fR \fINUM\fR, \fB--thumbnails-per-row\fR \fINUM\fR
  86 Specify the amount of thumbnails per row in the thumbnails page (if applicable in theme)
  87 .TP
  88 \fB-p\fR \fINUM\fR, \fB--thumbnails-per-page\fR \fINUM\fR
  89 Specify the amount of thumbnails per page in the thumbnails page, after which split occurs
  90 .TP
  91 \fB-o\fR, \fB--optimize-for-32\fR
  92 Resize images with optimized sizes for 3/2 aspect ratio rather than 4/3 (typical aspect ratio of pictures from non digital cameras are 3/2 when pictures from digital cameras are 4/3)
  93 .TP
  94 \fB-r\fR \fICOMMAND\fR, \fB--transcode-videos\fR \fICOMMAND\fR
  95 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:
  96
  97 \fIavi:mencoder -nosound -ovc xvid -xvidencopts bitrate=800:me_quality=6 -o %o %f\fR
  98 .TP
  99 \fB-l\fR \fIMARKUP\fR, \fB--index-link\fR \fIMARKUP\fR
 100 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)
 101 .TP
 102 \fB-n\fR \fIMARKUP\fR, \fB--made-with\fR \fIMARKUP\fR
 103 Specify the HTML markup to use on the bottom of pages for a small 'made with' message
 104 .TP
 105 \fB-c\fR \fIFORMAT\fR, \fB--comments-format\fR \fIFORMAT\fR
 106 Specify comments format to use for images instead of only filename when creating new albums; use ImageMagick's format
 107 .TP
 108 \fB-m\fR \fINUM\fR, \fB--mproc\fR \fINUM\fR
 109 Specify the number of processors for multi-processors machines
 110 .TP
 111 \fB-g\fR, \fB--for-gui\fR
 112 Do the minimum work to be able to see the album under the GUI (don't generate all thumbnails)
 113 .TP
 114 \fB-v\fR \fINUM\fR, \fB--verbose-level\fR \fINUM\fR
 115 Set max verbosity level (0: errors, 1: warnings, 2: important messages, 3: other messages)
 116 .TP
 117 \fB-i\fR \fIPIPE\fR, \fB--info-pipe\fR \fIPIPE\fR
 118 Name a file where to write information about what's going on (used by the GUI to update waiting messages etc)
 119
 120 .SH EXAMPLES
 121
 122 Simply generate a web-album out of photos in \fB/tmp/Albums\fR, to the directory \fB/tmp/booh-try\fR:
 123 .PP
 124 \fI# booh-backend --source /tmp/Albums --destination /tmp/booh-try\fR
 125 .PP
 126
 127 The same, but also save the XML "config" file which will contain the list of photos/videos and options for them:
 128 .PP
 129 \fI# booh-backend --source /tmp/Albums --destination /tmp/booh-try --config-skel /tmp/myconf.xml\fR
 130 .PP
 131
 132 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:
 133 .PP
 134 \fI# booh-backend --config /tmp/myconf.xml\fR
 135 .PP
 136
 137 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:
 138 .PP
 139 \fI# booh-backend --merge-config /tmp/myconf.xml\fR
 140 .PP
 141
 142 .SH AUTHOR
 143 Written by Guillaume Cottenceau.
 144 .br
 145 Visit official homepage: http://booh.org/
 146
 147 .SH SEE ALSO
 148 .BR booh(1)
 149 .BR booh-classifier(1)
 150
 151 .SH COPYRIGHT
 152 Copyright \(co 2005-2008 Guillaume Cottenceau.
 153 .br
 154 This is Free Software; this software is licensed under the GPL version 2, as published by the Free Software Foundation.
 155 There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.