Mercurial > bins

comparison doc/bins.sgml @ 0:a84c32f131df 1.1.29

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import vendor version
author Peter Gervai <grin@grin.hu>
date Wed, 15 Oct 2008 23:28:56 +0200
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:a84c32f131df
1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3 <!-- $Id: bins.sgml,v 1.35 2005/08/24 21:29:44 jerome Exp $ -->
4
5 <!-- This man page is Copyright 2002 Mark Eichin and released under -->
6 <!-- the GNU General Public License, Version 2. -->
7
8 <!-- Process this file with docbook-to-man to generate an nroff manual
9 page: `docbook-to-man manpage.sgml > manpage.1'. You may view
10 the manual page with: `docbook-to-man manpage.sgml | nroff -man |
11 less'. A typical entry in a Makefile or Makefile.am is:
12
13 manpage.1: manpage.sgml
14 docbook-to-man $< > $@
15
16
17 The docbook-to-man binary is found in the docbook-to-man package.
18 Please remember that if you create the nroff version in one of the
19 debian/rules file targets (such as build), you will need to include
20 docbook-to-man in your Build-Depends control field.
21
22 -->
23
24 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
25 <!ENTITY dhfirstname "<firstname>Mark</firstname>">
26 <!ENTITY dhsurname "<surname>Eichin</surname>">
27 <!-- Please adjust the date whenever revising the manpage. -->
28 <!ENTITY dhdate "<date>April 22, 2002</date>">
29 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
30 allowed: see man(7), man(1). -->
31 <!ENTITY dhsection "<manvolnum>1</manvolnum>">
32 <!ENTITY dhemail "<email>eichin@thok.org</email>">
33 <!ENTITY dhusername "Mark W. Eichin">
34 <!ENTITY dhucpackage "<refentrytitle>BINS</refentrytitle>">
35 <!ENTITY dhpackage "bins">
36
37 <!ENTITY debian "<productname>Debian</productname>">
38 <!ENTITY gnu "<acronym>GNU</acronym>">
39 <!ENTITY gpl "&gnu; General Public License">
40 ]>
41
42 <refentry>
43 <refentryinfo>
44 <address>
45 &dhemail;
46 </address>
47 <author>
48 &dhfirstname;
49 &dhsurname;
50 </author>
51 <copyright>
52 <year>2002</year>
53 <holder>&dhusername;</holder>
54 </copyright>
55 &dhdate;
56 </refentryinfo>
57 <refmeta>
58 &dhucpackage;
59
60 &dhsection;
61 </refmeta>
62 <refnamediv>
63 <refname>&dhpackage;</refname>
64
65 <refpurpose>Generate a static HTML photo albums using XML and EXIF tags</refpurpose>
66 </refnamediv>
67 <refsynopsisdiv>
68 <cmdsynopsis>
69 <command>&dhpackage;</command>
70 <arg><option>-f <replaceable>config_file</replaceable></option></arg>
71 <arg><option>-o <replaceable>STR</replaceable></option></arg>
72 <arg><option>-d <replaceable>STR</replaceable></option></arg>
73 <arg><option>-c <replaceable>color_style</replaceable></option></arg>
74 <arg><option>-s <replaceable>style</replaceable></option></arg>
75 <arg><option>-t <replaceable>template_dir</replaceable></option></arg>
76 <arg><option>-p</option></arg>
77 <arg><option>-e</option></arg>
78 <arg><option>-i <replaceable>iKey,iKey...</replaceable></option></arg>
79 <arg><option>-v <replaceable>X</replaceable></option></arg>
80 <arg><option>-h</option></arg>
81 <arg choice="req"><replaceable>source_dir</replaceable></arg>
82 <arg choice="req"><replaceable>target_dir</replaceable></arg>
83
84 </cmdsynopsis>
85 </refsynopsisdiv>
86 <refsect1>
87 <title>DESCRIPTION</title>
88
89 <para>This manual page documents briefly the
90 <command>&dhpackage;</command> command.</para>
91
92 <para>This manual page was written for the &debian; distribution
93 because the original program does not have a manual page.
94 Instead, it has documentation in <acronym>HTML</acronym> in
95 <filename>/usr/share/doc/bins/index.html</filename> as well as a
96 <option>-h</option> option.</para>
97
98 <para><command>&dhpackage;</command> is a program that takes a
99 collection of directories and files containing
100 <acronym>JPEG</acronym> images and <acronym>XML</acronym>
101 descriptions, combines them with a set of
102 <acronym>HTML</acronym> templates, and produces a complete photo
103 gallery of static <acronym>HTML</acronym> files, rescaled images
104 at three sizes, and thumbnails.</para>
105 </refsect1>
106 <refsect1>
107 <title>OPTIONS</title>
108
109 <variablelist>
110 <varlistentry>
111 <term><option>-f <replaceable>config_file</replaceable></option></term>
112 <listitem>
113 <para>use an alternative configuration file, instead of
114 <filename>~/.bins/binsrc.</filename>.</para>
115 </listitem>
116 </varlistentry>
117 <varlistentry>
118 <term><option>-o <replaceable>STR</replaceable></option></term>
119 <listitem>
120 <para>Tells script to use only one copy of image using
121 <acronym>HTML</acronym> size specs (height, width specs in the image
122 tag) for scaled versions (instead of generating
123 several images, one for each size).</para>
124 <para>Default is false.</para>
125 <para><replaceable>STR</replaceable> is an optional argument
126 to set how the one image is generated. Possible values:
127 <variablelist>
128 <varlistentry>
129 <term>scaled</term>
130 <listitem>
131 <para>(make scaled copy of orig in target_dir
132 hierarchy, sized to max size). Default.</para>
133 </listitem>
134 </varlistentry>
135 <varlistentry>
136 <term>copied</term>
137 <listitem>
138 <para>(copy orig to web dir)</para>
139 </listitem>
140 </varlistentry>
141 <varlistentry>
142 <term>custom</term>
143 <listitem>
144 <para>(use copy if filesize < 1meg
145 resize, resave, if bigger than 1 meg)</para>
146 </listitem>
147 </varlistentry>
148 </variablelist>
149 </para>
150 </listitem>
151 </varlistentry>
152 <varlistentry>
153 <term><option>-d <replaceable>STR</replaceable></option></term>
154 <listitem>
155 <para>Determine if tags found in <acronym>EXIF</acronym> structure are
156 added in desc files.</para>
157 <para><replaceable>STR</replaceable> is one of "always", "never" or "exist"
158 ("exist" only adds if the desc file already exist.)
159 Default is always.</para>
160 </listitem>
161 </varlistentry>
162 <varlistentry>
163 <term><option>-c <replaceable>color_style</replaceable></option></term>
164 <listitem>
165 <para>
166 Color style to use. Can be <literal>blue</literal>
167 (default one), <literal>green</literal>,
168 <literal>ivory</literal> and <literal>pink</literal> or
169 any other one defined in configuration/description files.
170 This option is deprecated (and thus, not supported by all
171 templates), in favor of alternate stylesheets and the
172 <literal>customStyleSheet</literal> parameter.</para>
173 </listitem>
174 </varlistentry>
175 <varlistentry>
176 <term><option>-s <replaceable>style</replaceable></option></term>
177 <listitem>
178 <para>Template style to use (styles provided for now are
179 <literal>joi</literal>, <literal>marc</literal>,
180 <literal>martin</literal>, <literal>mwolson</literal>
181 <literal>petrus</literal>, <literal>satyap</literal> and
182 <literal>swigs</literal>).</para>
183 </listitem>
184 </varlistentry>
185 <varlistentry>
186 <term><option>-t <replaceable>template_dir</replaceable></option></term>
187 <listitem>
188 <para>Specify location of html templates.</para>
189 <para>Default is <filename>~/.bins</filename>, falling back
190 to default versions in
191 <filename>/etc/bins/templates.<replaceable>style</replaceable></filename>.</para>
192 </listitem>
193 </varlistentry>
194 <varlistentry>
195 <term><option>-p</option>
196 </term>
197 <listitem>
198 <para>Numbers preceding the album title, followed by
199 an underscore are stripped.
200 If this option is given, then prefix ordering
201 numbers on directories are removed. For example,
202 if one has directories <filename>may</filename>,
203 <filename>june</filename>, and <filename>august</filename>, they
204 can be renamed <filename>0_may</filename>,
205 <filename>1_june</filename>, and <filename>2_august</filename> and
206 they will appear in the album in the correct
207 order.</para>
208 </listitem>
209 </varlistentry>
210 <varlistentry>
211 <term><option>-e</option></term>
212 <listitem>
213 <para>Tells the script to generate an editable version of
214 the album. If set, some more links and icons are added to
215 directly access the <filename>.xml</filename> files for
216 editing. This is for editing purposes, not for a final
217 album.</para>
218 </listitem>
219 </varlistentry>
220 <varlistentry>
221 <term><option>-i <replaceable>iKey,iKey...</replaceable></option></term>
222 <listitem>
223 <para>Sets "ignore" keywords which will be compared against
224 the contents of the <sgmltag>ignore</sgmltag> field of the
225 album's XML file, in the <sgmltag>ignore</sgmltag> field in
226 <sgmltag>description</sgmltag> section. If any of the
227 <replaceable>iKeys</replaceable> match those in the album's
228 "ignore" field, that album will not be processed. See also
229 the <sgmltag>ignore</sgmltag> parameter.</para>
230 </listitem>
231 </varlistentry>
232 <varlistentry>
233 <term><option>-n <replaceable>iKey,iKey...</replaceable></option></term>
234 <listitem>
235 <para>Sets "hidden" keywords which will be compared against
236 the contents of the <sgmltag>ignore</sgmltag> field of the
237 album's XML file, in the <sgmltag>ignore</sgmltag> field in
238 <sgmltag>description</sgmltag> section. If any of the
239 <replaceable>iKeys</replaceable> match those in the album's
240 "ignore" field, that album will be hidden: it will not be
241 linked anywhere. See also the <sgmltag>hidden</sgmltag>
242 parameter.</para>
243 </listitem>
244 </varlistentry>
245 <varlistentry>
246 <term><option>-v <replaceable>X</replaceable></option>
247 </term>
248 <listitem>
249 <para><replaceable>X</replaceable> is the verbosity level (between 0 and 3)</para>
250 </listitem>
251 </varlistentry>
252 <varlistentry>
253 <term><option>-h</option>
254 </term>
255 <listitem>
256 <para>Show the help string this man page was originally based on.</para>
257 </listitem>
258 </varlistentry>
259 </variablelist>
260 </refsect1>
261 <refsect1>
262 <title>SETTINGS</title>
263 <para>&dhpackage; is also controlled by other files.</para>
264 <variablelist>
265 <varlistentry>
266 <term><filename>/etc/bins/binsrc</filename></term>
267 <term><filename>~/.bins/binsrc</filename></term>
268 <listitem>
269
270 <para>The <filename>binsrc</filename> files are
271 <acronym>XML</acronym> files with a top level
272 <sgmltag>bins</sgmltag> tag. There are three element
273 names with <sgmltag>bins</sgmltag>: <sgmltag>parameter</sgmltag>,
274 <sgmltag>colors</sgmltag>, and <sgmltag>sizes</sgmltag>.
275 Each of these has a <sgmltag>name</sgmltag> attribute
276 which names the data in the element content.</para>
277
278 <para>The <sgmltag>colors</sgmltag> element has a
279 <sgmltag>style</sgmltag> attribute, that can be used with
280 the <sgmltag>colorStyle</sgmltag> parameter or the
281 <sgmltag>-c</sgmltag> command line option. It contains
282 <sgmltag>color</sgmltag> elements. The
283 <sgmltag>color</sgmltag> elements name has one of the
284 following values which is substituted into the template
285 files. This tag is deprecated, in favor of alternate
286 stylesheets and the <literal>customStyleSheet</literal>
287 parameter.</para>
288
289 <simplelist>
290 <member>PAGE_BACK</member>
291 <member>PAGE_TITLE</member>
292 <member>MAINBAR_BACK</member>
293 <member>MAINBAR_TITLE</member>
294 <member>MAINBAR_LINK</member>
295 <member>MAINBAR_CURRENTPAGE</member>
296 <member>SUBBAR_BACK</member>
297 <member>SUBBAR_LINK</member>
298 <member>SUBBAR_CURRENTPAGE</member>
299 <member>SUBBAR_TITLE</member>
300 </simplelist>
301 <para>The <sgmltag>sizes</sgmltag> element contains
302 <sgmltag>size</sgmltag> elements which each have a
303 <sgmltag>name</sgmltag> attribute, a
304 <sgmltag>shortname</sgmltag> attribute, a
305 <sgmltag>height</sgmltag> attribute, and a
306 <sgmltag>width</sgmltag> attribute. These default to</para>
307 <simplelist>
308 <member>Small, Sm, 40%, 40%</member>
309 <member>Medium, Med, 64%, 64%</member>
310 <member>Large, Lg, 100%, 100%</member>
311 </simplelist>
312 <para><sgmltag>name</sgmltag> and
313 <sgmltag>shortname</sgmltag> are used in the output
314 <acronym>HTML</acronym> and in generated filenames. The
315 default values listed above are passed through
316 <function>gettext</function> for localization; overrides
317 in <filename>binsrc</filename> files are not, and should
318 be in the desired language.</para>
319 <para>For the <sgmltag>parameter</sgmltag> elements the
320 <sgmltag>name</sgmltag> attribute names one of the
321 following parameters.</para>
322 <!-- parameters are sorted alphabetically -->
323 <variablelist>
324
325 <varlistentry>
326 <term>addExifToDescFile</term>
327 <listitem>
328 <para>If set to 1 (the default), write <acronym>EXIF</acronym> data found in
329 the image file to the image desc file (but see also
330 the <option>-d</option> flag).</para>
331 </listitem>
332 </varlistentry>
333
334 <varlistentry>
335 <term>albumThumbInSubAlbumPage</term>
336 <listitem>
337 <para>If set to 1 (the default), display the current
338 album thumbnail in sub-albums page
339 if it has pictures, with links to
340 the thumbnails page.</para>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry>
345 <term>allThumbnailsPage</term>
346 <listitem>
347 <para>If set to <literal>1</literal>, generate a page with all
348 thumbnails in the album and
349 sub-albums. This is deactivated
350 because it is an alpha feature which
351 seems to not work properly.</para>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry>
356 <term>backgroundImage</term>
357 <listitem>
358 <para>Set this to the image that should be displayed
359 as the background of the album pages. The Image will
360 be copied to the static files directory. This works
361 only with joi, marc, martin and petrus templates for now.
362 </para>
363 </listitem>
364 </varlistentry>
365 <varlistentry>
366 <term>borderOnThumbnails</term>
367 <listitem>
368 <para>Width of the border of the thumbnail's image in
369 the thumbnails page, in pixels. <literal>0</literal>
370 means no border.
371 </para>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry>
376 <term>colorStyle</term>
377 <listitem>
378 <para>Name of the color style to use. Default is
379 <filename>blue</filename>. See also the
380 <option>-c</option> option which takes precedence.
381 This option is deprecated (and thus, not supported by
382 all templates), in favor of alternate stylesheets and
383 the <literal>customStyleSheet</literal>
384 parameter.</para>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry>
389 <term>compactHTML</term>
390 <listitem>
391 <para>If set to <literal>1</literal>, generated
392 <acronym>HTML</acronym> code is cleaned up to reduce
393 the size of pages and thus, speed up browsing. This
394 reduces the size of <acronym>HTML</acronym> BINS files
395 by about 30%. See <command>HTML::Clean(3)</command> to
396 know how optimizations are performed.</para>
397 </listitem>
398 </varlistentry>
399
400
401 <varlistentry>
402 <term>configFileName</term>
403 <listitem>
404 <para>Can be set in the global config file, but only
405 influences the basename of the local user config
406 file. Defaults to <filename>.binsrc</filename>.</para>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry>
411 <term>createEmptyDescFields</term>
412 <listitem>
413 <para>If set to 1 (the default), add empty description
414 fields in the <sgmltag>description</sgmltag> section
415 when the image description file is created to ease
416 later manual editing.</para>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry>
421 <term>createHtaccess</term>
422 <listitem>
423 <para>If <literal>1</literal>, create an Apache
424 <filename>.htaccess</filename> file in the root dir of
425 the album with the encoding charset bound to
426 <filename>html</filename> and <filename>htm</filename>
427 files. This is a parameter global for the album, it
428 can't be set in album.xml.</para>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry>
433 <term>customStyleSheet</term>
434 <listitem>
435 <para>Set this to the CSS file that should be used as
436 the stylesheet for the album pages. The CSS file will
437 be copied to the static files directory. This works
438 only with joi, marc, martin and petrus templates for now.
439 </para>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry>
444 <term>dateString</term>
445 <listitem>
446 <para>Specify the format of date strings. This variable
447 accepts all formats supported by <command>date(1)</command>.
448 </para>
449 </listitem>
450 </varlistentry>
451
452 <varlistentry>
453 <term>defaultSize</term>
454 <listitem>
455 <para>Size to use when user clicks directly on the
456 thumbnail in the thumbnails page instead of one of
457 the size name. 0 is the first size
458 (<literal>Small</literal> in the default config), 1
459 the second (<literal>Medium</literal>), and so
460 on. Set this variable to -1 if you don't want the
461 thumbnail to be clickable.</para>
462 </listitem>
463 </varlistentry>
464
465 <varlistentry>
466 <term>deExifyImages</term>
467 <listitem>
468 <para>If set to 1, do NOT copy exif data found in the
469 source images to any of the generated resized images.
470 Setting this option can yield significant space
471 savings, especially for thumbnail and imagelist
472 pages.</para>
473 </listitem>
474 </varlistentry>
475
476 <varlistentry>
477 <term>emptyAlbumDesc</term>
478 <listitem>
479 <para>If set to 1, and album desciption is not set, no
480 message will be displayed (instead of the "No
481 long/short description available" one).</para>
482 </listitem>
483 </varlistentry>
484
485 <varlistentry>
486 <term>enlarge</term>
487 <listitem>
488 <para>If set to 1, small images are enlarged
489 in the "med" and "large" series. (defaults to 0).</para>
490 </listitem>
491 </varlistentry>
492
493 <varlistentry>
494 <term>excludeBackgroundImage</term>
495 <listitem>
496 <para>If set to 1, the image with the name given in
497 <literal>backgroundImage</literal> will be excluded from the
498 current directory.
499 </para>
500 </listitem>
501 </varlistentry>
502
503 <varlistentry>
504 <term>excludeDirs</term>
505 <listitem>
506 <para>Exclude directories that match this regexp (if
507 set). Set to ^CVS$ in default config, so that CVS
508 subdirs aren't processed by bins.
509 </para>
510 </listitem>
511 </varlistentry>
512
513 <varlistentry>
514 <term>excludeFiles</term>
515 <listitem>
516 <para>Exclude image files that match this regexp (if
517 set). No image files are excluded in default config.
518 </para>
519 </listitem>
520 </varlistentry>
521
522 <varlistentry>
523 <term>globalConfigDir</term>
524 <listitem>
525 <para>Can't usefully be set, since it has already been
526 used when the first config file is read. Defaults
527 to <filename>/etc/bins</filename>.</para>
528 </listitem>
529 </varlistentry>
530
531 <varlistentry>
532 <term>hidden</term>
533 <listitem>
534 <para>Put here a comma separated list of keyword. If
535 one on this keyword is found in the
536 <literal>ignore</literal> field in the
537 <sgmltag>description</sgmltag> section of an
538 <filename>album.xml</filename>, then this sub-album
539 will be hidden, i.e. it will be generated but not
540 linked anywhere. You can also use the
541 <literal>-n</literal> command line option.</para>
542 </listitem>
543 </varlistentry>
544
545 <varlistentry>
546 <term>homeURL</term>
547 <listitem>
548 <para>Set this to your home page's
549 <acronym>URL</acronym>. This is used for the leave button
550 in some templates.</para>
551 </listitem>
552 </varlistentry>
553
554 <varlistentry>
555 <term>htmlEncoding</term>
556 <listitem>
557 <para><acronym>HTML</acronym> pages charset encoding.</para>
558 </listitem>
559 </varlistentry>
560
561 <varlistentry>
562 <term>ignore</term>
563 <listitem>
564 <para>Put here a comma separated list of keyword. If
565 one on this keyword is found in the
566 <literal>ignore</literal> field in the
567 <sgmltag>description</sgmltag> section of an
568 <filename>album.xml</filename>, then this sub-album
569 will be ignored, i.e. it will not be processed. You
570 can also use the <literal>-i</literal> command line
571 option.</para>
572 </listitem>
573 </varlistentry>
574
575 <varlistentry>
576 <term>imagePageCycling</term>
577 <listitem>
578 <para>If set to 0 next/prev-Links will be hidden if
579 the actual page is the last/first Image page.</para>
580 </listitem>
581 </varlistentry>
582
583 <varlistentry>
584 <term>javaScriptPreloadImage</term>
585 <listitem>
586 <para>If set to <literal>1</literal>, add some
587 javascript code in image pages to preload the next
588 image of the same size when current one is loaded, to
589 speed up the album browsing.</para>
590 </listitem>
591 </varlistentry>
592
593 <varlistentry>
594 <term>javaScriptPreloadThumbs</term>
595 <listitem>
596 <para>If set to <literal>1</literal>, add some
597 javascript code in thumbnails pages to preload
598 thumbnails of the next page when current one is
599 loaded, to speed up the album browsing.</para>
600 </listitem>
601 </varlistentry>
602
603 <varlistentry>
604 <term>jpegQuality</term>
605 <listitem>
606 <para>Quality of scaled jpegs (lower number = more
607 compression, lower quality) in 1-100 range (default
608 of 75). See imagemagick docs for more details.</para>
609 </listitem>
610 </varlistentry>
611
612 <varlistentry>
613 <term>linkInsteadOfCopy</term>
614 <listitem>
615 <para>If set to 1, we link the picture instead of
616 copying it if possible (i.e. scaleIfSameSize is set to
617 <literal>0</literal> and destination image doesn't
618 have to be rotated: <literal>rotateImages</literal> is
619 set to <literal>original</literal> or
620 <literal>none</literal>, or orientation is already
621 correct). Warning : if whenSrcSmaller is set
622 to enlarge, original image can be modified.</para>
623 </listitem>
624 </varlistentry>
625
626 <varlistentry>
627 <term>linkRelative</term>
628 <listitem>
629 <para>
630 If set to 1, we use a relative path for the link if
631 <literal>linkInsteadOfCopy</literal> is set to 1.
632 </para>
633 </listitem>
634 </varlistentry>
635
636 <varlistentry>
637 <term>maxAlbumsForLongSubAlbum</term>
638 <listitem>
639 <para>If the number of sub albums is greater (than
640 this value which defaults to 20),
641 generate a short sub album page
642 instead of the long one. (Short sub album pages
643 appear to be unsupported at the moment; this option
644 is disabled.)</para>
645 </listitem>
646 </varlistentry>
647
648 <varlistentry>
649 <term>noRotation</term>
650 <listitem>
651 <para>Don't perform rotation on files matching this
652 regexp. This can used in conjunction with
653 <literal>scaleIfSameSize=0</literal> and a scaled size of
654 <literal>100%x100%</literal> to keep original pictures in
655 your album.</para>
656 </listitem>
657 </varlistentry>
658
659 <varlistentry>
660 <term>numThumbsPerPage</term>
661 <listitem>
662 <para>Number of thumbnails (default of 16) displayed
663 in each page in an album.</para>
664 </listitem>
665 </varlistentry>
666
667 <varlistentry>
668 <term>pathImgNum</term>
669 <listitem>
670 <para>If set to 1 the path in the imageview contains
671 the number of the current image.</para>
672 </listitem>
673 </varlistentry>
674
675 <varlistentry>
676 <term>pathShowIcon</term>
677 <listitem>
678 <para>If set to 1 the path contains icons.</para>
679 </listitem>
680 </varlistentry>
681
682 <varlistentry>
683 <term>previewMaxWidth</term>
684 <term>previewMaxHeight</term>
685 <listitem>
686 <para>Max thumbnail width and height (default 150x150).</para>
687 </listitem>
688 </varlistentry>
689
690 <varlistentry>
691 <term>jpegProgressify</term>
692 <listitem>
693 <para>whether to convert generated jpegs to
694 progressive using jpegtran (if available). can be
695 <literal>never</literal>, <literal>always</literal>, or
696 <literal>smaller</literal> (if the progressified file
697 is smaller than the baseline).</para>
698 </listitem>
699 </varlistentry>
700
701 <varlistentry>
702 <term>reverseOrder</term>
703 <listitem>
704 <para>
705 Are we reversing sorting order for pictures or
706 directories ? 0=none, 1=dirs, 2=pix, 3=both. See
707 also <literal>-r</literal> command line option.
708 </para>
709 </listitem>
710 </varlistentry>
711
712 <varlistentry>
713 <term>rotateImages</term>
714 <listitem>
715 <para>Do we rotate images if the
716 <sgmltag>Orientation</sgmltag> <acronym>EXIF</acronym>
717 tag is found? If set to <sgmltag>original</sgmltag>
718 (the default), the original image is rotated the first
719 time, and then it is left untouched. If set to
720 <sgmltag>destination</sgmltag>, this is all the scaled
721 images and thumbnails that are rotated. This is less
722 efficient, but the original images are preserved (and
723 is useful if the original images are read-only). If
724 set to <sgmltag>none</sgmltag>, no rotation is
725 performed.</para>
726 </listitem>
727 </varlistentry>
728
729 <varlistentry>
730 <term>rotateWithJpegtran</term>
731 <listitem>
732 <para>If set to <literal>1</literal>,
733 <filename>bins</filename> try to use the
734 <filename>jpegtran</filename> program to rotate
735 <acronym>JPEG</acronym> images if it is
736 available. <filename>jpegtran</filename> is faster and
737 lossless, but some versions fail to perform rotation
738 correctly, so it is deactivated in default config. If
739 set to <literal>0</literal> or if
740 <filename>jpegtran</filename> is not found,
741 <filename>mogrify</filename> (from ImageMagick) is
742 used.</para>
743 </listitem>
744 </varlistentry>
745
746 <varlistentry>
747 <term>scaleIfSameSize</term>
748 <listitem>
749 <para>If set to 1, we scale the picture even
750 if destination size is the same as the
751 original picture, if set to 0 (the default), the
752 original image is just copied if the
753 size is correct.</para>
754 </listitem>
755 </varlistentry>
756
757 <varlistentry>
758 <term>scaleMethod</term>
759 <listitem>
760 <para>What method should be used to create scaled
761 pictures and thumbnails ? Can be either
762 <literal>scale</literal> or
763 <literal>sample</literal>. <literal>sample</literal>
764 is <literal>faster</literal>, scale is better.
765 </para>
766 </listitem>
767 </varlistentry>
768
769 <varlistentry>
770 <term>searchEngine</term>
771 <listitem>
772 <para>
773 If 1, generate a search page. Images can be searched
774 on description fields set in the
775 <literal>searchFields</literal> parameter.
776 </para>
777 </listitem>
778 </varlistentry>
779
780 <varlistentry>
781 <term>searchFields</term>
782 <listitem>
783 <para>
784 Space separated list of description field names used
785 by the search engine, if
786 <literal>searchEngine</literal> is set to 1.
787 </para>
788 </listitem>
789 </varlistentry>
790
791 <varlistentry>
792 <term>searchLimit</term>
793 <listitem>
794 <para>
795 Maximum results returned by the search engine, if
796 <literal>searchEngine</literal> is set to 1. Note
797 that if this number is too high, it can hang the
798 browser.
799 </para>
800 </listitem>
801 </varlistentry>
802
803 <varlistentry>
804 <term>stripDirPrefix</term>
805 <listitem>
806 <para>If <literal>1</literal>, numbers preceding the
807 album title, followed by an underscore, are
808 stripped. If this parameter is set, then prefix
809 ordering numbers on directories are removed. For
810 example, if one has directories may, june, and august,
811 they can be renamed <filename>0_may</filename>,
812 <filename>1_june</filename>, and
813 <filename>2_august</filename> and they will appear in
814 the album in the correct order. This can be overridden
815 by the <literal>-p</literal> command line option.</para>
816 </listitem>
817 </varlistentry>
818
819 <varlistentry>
820 <term>templateStyle</term>
821 <listitem>
822 <para>Name of the template style to use. Default is
823 <filename>swigs</filename>. Other templates provided
824 with BINS are <filename>joi</filename>,
825 <filename>marc</filename>, <filename>martin</filename>,
826 <filename>petrus</filename> and
827 <filename>satyap</filename>. Several templates can be
828 used for different sub-album of an album, by using
829 this parameter in the <sgmltag>bins</sgmltag> section
830 of the <filename>album.xml</filename> files. See also
831 the <option>-s</option> option which takes precedence
832 over binsrc (but not album.xml).</para>
833 </listitem>
834 </varlistentry>
835
836 <varlistentry>
837 <term>thumbnailBackground</term>
838 <listitem>
839 <para>If set to 1, add a background colour
840 (SUBBAR_BACK) to the thumbnail's cell in the
841 thumbnails page so that if the top and bottom borders
842 are wider than the image (for example, if it is in
843 portrait mode), instead of spilling over, there is a
844 border around the whole picture. By default, use the
845 PAGE_BACK color.</para>
846 </listitem>
847 </varlistentry>
848
849 <varlistentry>
850 <term>thumbnailInImageList</term>
851 <listitem>
852 <para>Display thumbnails on the Image List page, set
853 to 1 by default.</para>
854 </listitem>
855 </varlistentry>
856
857 <varlistentry>
858 <term>thumbnailPageCycling</term>
859 <listitem>
860 <para>If set to 0 next/prev-Links will be hidden if
861 the actual page is the last/first
862 Thumbnail page.</para>
863 </listitem>
864 </varlistentry>
865
866 <varlistentry>
867 <term>thumbPrevNext</term>
868 <listitem>
869 <para>If set to 1 (the default), display thumbnails close
870 to the previous and next link at the
871 bottom of the image page.</para>
872 </listitem>
873 </varlistentry>
874
875 <varlistentry>
876 <term>thumbsPerRow</term>
877 <listitem>
878 <para>Number of thumbnails (default of 4) displayed in each
879 row in an album.</para>
880 </listitem>
881 </varlistentry>
882
883 <varlistentry>
884 <term>titleOnThumbnail</term>
885 <listitem>
886 <para>Should the title be displayed on top on the
887 thumbnail in the thumbnails page? (defaults to 1.)</para>
888 </listitem>
889 </varlistentry>
890
891 <varlistentry>
892 <term>treePreview</term>
893 <listitem>
894 <para>If set to 1, preview thumbnails will be showed
895 in the album tree page. This works only with joi,
896 marc and petrus templates for now.
897 </para>
898 </listitem>
899 </varlistentry>
900
901 <varlistentry>
902 <term>updateOriginalPerms</term>
903 <listitem>
904 <para>If set to 1, read permissions on images will be
905 set, to ensure http deamon will be able to read
906 them.
907 </para>
908 </listitem>
909 </varlistentry>
910
911 <varlistentry>
912 <term>userConfigDir</term>
913 <listitem>
914 <para>Can be set in the global config file (since
915 after the user one is read, it is too late).
916 Defaults to <filename>~/.bins</filename> and is
917 processed by <function>bsd_glob</function> (see
918 <function>File::Glob</function> for details.)
919 </para>
920 </listitem>
921 </varlistentry>
922
923 <varlistentry>
924 <term>xmlEncoding</term>
925 <listitem>
926 <para><acronym>XML</acronym> files charset encoding.</para>
927 </listitem>
928 </varlistentry>
929
930 </variablelist>
931 </listitem>
932 </varlistentry>
933 <varlistentry>
934 <term><filename><replaceable>image.jpg</replaceable></filename></term>
935 <listitem>
936 <para>The <acronym>EXIF</acronym> tags are extracted from
937 the image. Currently only the
938 <sgmltag>Orientation</sgmltag> tag influences the
939 processing, but a variety of settings are copied into the
940 <acronym>HTML</acronym> file generated via the
941 <filename>details.html</filename> template.</para>
942 </listitem>
943 </varlistentry>
944 <varlistentry>
945 <term><filename><replaceable>image.jpg</replaceable>.xml</filename></term>
946 <listitem>
947 <para>The <acronym>XML</acronym> file contains an
948 <sgmltag>image</sgmltag> element, which contains three child
949 elements:</para>
950 <variablelist>
951 <varlistentry>
952 <term><sgmltag>description</sgmltag></term>
953 <listitem>
954 <para>which has <sgmltag>field</sgmltag> children that
955 contain per-image data. The <sgmltag>name</sgmltag>
956 attribute names the tag (allowing simple
957 extensibility, see the
958 <filename>bins_edit</filename>
959 <option>--generic</option> flag) but
960 <filename>bins</filename> itself currently only
961 makes use of</para>
962 <simplelist>
963 <member>title</member>
964 <member>description</member>
965 <member>people</member>
966 <member>location</member>
967 <member>date</member>
968 <member>event</member>
969 </simplelist>
970 </listitem>
971 </varlistentry>
972 <varlistentry>
973 <term><sgmltag>bins</sgmltag></term>
974 <listitem>
975 <para>which works as described with the
976 <filename>binsrc</filename> file settings, except
977 that many of the settings are not meaningful in the
978 context of a single picture.<!-- are any? --></para>
979 </listitem>
980 </varlistentry>
981 <varlistentry>
982 <term><sgmltag>exif</sgmltag></term>
983 <listitem>
984 <para>which has a cache of values copied from the
985 <acronym>EXIF</acronym> tags in the image, to allow
986 simpler processing by other tools.</para>
987 <para>If a user wants to override the
988 <acronym>EXIF</acronym> values and provide a
989 replacement (such as a corrected
990 <sgmltag>Orientation</sgmltag> or an
991 <sgmltag>Owner</sgmltag> setting that reflects who
992 you loaned the camera to) adding a
993 <sgmltag>priority</sgmltag> attribute with a value
994 of "1" will prevent <filename>bins</filename> from
995 replacing it with the value in the image.</para>
996 </listitem>
997 </varlistentry>
998 </variablelist>
999 </listitem>
1000 </varlistentry>
1001 <varlistentry>
1002 <term><filename>album.xml</filename></term>
1003 <listitem>
1004 <para>This file contains an
1005 <sgmltag>album</sgmltag> element, which contains
1006 <sgmltag>description</sgmltag> and <sgmltag>bins</sgmltag>
1007 stanza as described for an image. The are extensible in
1008 the same manner, but <filename>bins</filename> only makes
1009 use of</para>
1010 <simplelist>
1011 <member>dirname</member>
1012 <member>descFileName</member>
1013 <member>shortdesc</member>
1014 <member>title</member>
1015 <member>sampleimage</member>
1016 <member>longdesc</member>
1017 </simplelist>
1018 </listitem>
1019 </varlistentry>
1020 <varlistentry>
1021 <term><filename>include_images.txt</filename></term>
1022 <listitem>
1023 <para>includes image filenames (relative to the current
1024 album, i.e. the directory where the
1025 <filename>include_images.txt</filename> file is stored.)
1026 Each filename appears on a line by itself; a line
1027 beginning with a <literal>#</literal> is a comment, and
1028 lines composed entirely of whitespace are ignored.
1029 Otherwise, the line is exactly the filename. These images
1030 are included in the order listed, and added after any that
1031 actually appear in the directory.</para>
1032 </listitem>
1033 </varlistentry>
1034 <varlistentry>
1035 <term><filename><replaceable>template</replaceable>.html</filename></term>
1036 <listitem>
1037 <para>There are a number of template
1038 <acronym>HTML</acronym>files which are used to generate
1039 the actual images. The base names of these are</para>
1040 <simplelist>
1041 <member>tree</member>
1042 <member>imagelist</member>
1043 <member>subalbum</member>
1044 <member>thumbnail</member>
1045 <member>details</member>
1046 <member>image</member>
1047 </simplelist>
1048 <para>The default versions of these files in
1049 <filename>/etc/bins/templates.default</filename> should
1050 show how they work, as does the
1051 <filename>HTML::Template</filename> documentation. Aside
1052 from the <literal>COLOR</literal> substitutions described
1053 above, a template can also reference</para>
1054 <simplelist>
1055 <member>BINS_VERSION</member>
1056 <member>ENCODING</member>
1057 <member>GENERATED_DATE</member>
1058 <member>BINS_ID</member>
1059 </simplelist>
1060 </listitem>
1061 </varlistentry>
1062 </variablelist>
1063 </refsect1>
1064 <refsect1>
1065 <title>SEE ALSO</title>
1066
1067 <para>bins_edit (1), jpegtran (1), File::Glob, HTML::Template, imagemagick.</para>
1068
1069 </refsect1>
1070 <refsect1>
1071 <title>AUTHOR</title>
1072
1073 <para>This manual page was written by &dhusername; &dhemail; for
1074 the &debian; system (but may be used by others). As it is
1075 mostly derived from the <filename>&dhpackage;</filename> program
1076 itself, it is covered by the &gpl;.</para>
1077
1078 </refsect1>
1079 </refentry>
1080
1081 <!-- Keep this comment at the end of the file
1082 Local variables:
1083 mode: sgml
1084 sgml-omittag:t
1085 sgml-shorttag:t
1086 sgml-minimize-attributes:nil
1087 sgml-always-quote-attributes:t
1088 sgml-indent-step:2
1089 sgml-indent-data:t
1090 sgml-parent-document:nil
1091 sgml-default-dtd-file:nil
1092 sgml-exposed-tags:nil
1093 sgml-local-catalogs:nil
1094 sgml-local-ecat-files:nil
1095 End:
1096 -->
1097
1098