0
|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd"> |
|
2 <HTML |
|
3 ><HEAD |
|
4 ><TITLE |
|
5 >BINS</TITLE |
|
6 ><META |
|
7 NAME="GENERATOR" |
|
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD |
|
9 ><BODY |
|
10 CLASS="REFENTRY" |
|
11 BGCOLOR="#FFFFFF" |
|
12 TEXT="#000000" |
|
13 LINK="#0000FF" |
|
14 VLINK="#840084" |
|
15 ALINK="#0000FF" |
|
16 ><H1 |
|
17 ><A |
|
18 NAME="AEN1" |
|
19 ></A |
|
20 >BINS</H1 |
|
21 ><DIV |
|
22 CLASS="REFNAMEDIV" |
|
23 ><A |
|
24 NAME="AEN15" |
|
25 ></A |
|
26 ><H2 |
|
27 >Name</H2 |
|
28 >bins -- Generate a static HTML photo albums using XML and EXIF tags</DIV |
|
29 ><DIV |
|
30 CLASS="REFSYNOPSISDIV" |
|
31 ><A |
|
32 NAME="AEN18" |
|
33 ></A |
|
34 ><H2 |
|
35 >Synopsis</H2 |
|
36 ><P |
|
37 ><B |
|
38 CLASS="COMMAND" |
|
39 >bins</B |
|
40 > [<CODE |
|
41 CLASS="OPTION" |
|
42 >-f <TT |
|
43 CLASS="REPLACEABLE" |
|
44 ><I |
|
45 >config_file</I |
|
46 ></TT |
|
47 ></CODE |
|
48 >] [<CODE |
|
49 CLASS="OPTION" |
|
50 >-o <TT |
|
51 CLASS="REPLACEABLE" |
|
52 ><I |
|
53 >STR</I |
|
54 ></TT |
|
55 ></CODE |
|
56 >] [<CODE |
|
57 CLASS="OPTION" |
|
58 >-d <TT |
|
59 CLASS="REPLACEABLE" |
|
60 ><I |
|
61 >STR</I |
|
62 ></TT |
|
63 ></CODE |
|
64 >] [<CODE |
|
65 CLASS="OPTION" |
|
66 >-c <TT |
|
67 CLASS="REPLACEABLE" |
|
68 ><I |
|
69 >color_style</I |
|
70 ></TT |
|
71 ></CODE |
|
72 >] [<CODE |
|
73 CLASS="OPTION" |
|
74 >-s <TT |
|
75 CLASS="REPLACEABLE" |
|
76 ><I |
|
77 >style</I |
|
78 ></TT |
|
79 ></CODE |
|
80 >] [<CODE |
|
81 CLASS="OPTION" |
|
82 >-t <TT |
|
83 CLASS="REPLACEABLE" |
|
84 ><I |
|
85 >template_dir</I |
|
86 ></TT |
|
87 ></CODE |
|
88 >] [<CODE |
|
89 CLASS="OPTION" |
|
90 >-p</CODE |
|
91 >] [<CODE |
|
92 CLASS="OPTION" |
|
93 >-e</CODE |
|
94 >] [<CODE |
|
95 CLASS="OPTION" |
|
96 >-i <TT |
|
97 CLASS="REPLACEABLE" |
|
98 ><I |
|
99 >iKey,iKey...</I |
|
100 ></TT |
|
101 ></CODE |
|
102 >] [<CODE |
|
103 CLASS="OPTION" |
|
104 >-v <TT |
|
105 CLASS="REPLACEABLE" |
|
106 ><I |
|
107 >X</I |
|
108 ></TT |
|
109 ></CODE |
|
110 >] [<CODE |
|
111 CLASS="OPTION" |
|
112 >-h</CODE |
|
113 >] {<TT |
|
114 CLASS="REPLACEABLE" |
|
115 ><I |
|
116 >source_dir</I |
|
117 ></TT |
|
118 >} {<TT |
|
119 CLASS="REPLACEABLE" |
|
120 ><I |
|
121 >target_dir</I |
|
122 ></TT |
|
123 >}</P |
|
124 ></DIV |
|
125 ><DIV |
|
126 CLASS="REFSECT1" |
|
127 ><A |
|
128 NAME="AEN55" |
|
129 ></A |
|
130 ><H2 |
|
131 >DESCRIPTION</H2 |
|
132 ><P |
|
133 >This manual page documents briefly the |
|
134 <B |
|
135 CLASS="COMMAND" |
|
136 >bins</B |
|
137 > command.</P |
|
138 ><P |
|
139 >This manual page was written for the <SPAN |
|
140 CLASS="PRODUCTNAME" |
|
141 >Debian</SPAN |
|
142 > distribution |
|
143 because the original program does not have a manual page. |
|
144 Instead, it has documentation in <ACRONYM |
|
145 CLASS="ACRONYM" |
|
146 >HTML</ACRONYM |
|
147 > in |
|
148 <TT |
|
149 CLASS="FILENAME" |
|
150 >/usr/share/doc/bins/index.html</TT |
|
151 > as well as a |
|
152 <CODE |
|
153 CLASS="OPTION" |
|
154 >-h</CODE |
|
155 > option.</P |
|
156 ><P |
|
157 ><B |
|
158 CLASS="COMMAND" |
|
159 >bins</B |
|
160 > is a program that takes a |
|
161 collection of directories and files containing |
|
162 <ACRONYM |
|
163 CLASS="ACRONYM" |
|
164 >JPEG</ACRONYM |
|
165 > images and <ACRONYM |
|
166 CLASS="ACRONYM" |
|
167 >XML</ACRONYM |
|
168 > |
|
169 descriptions, combines them with a set of |
|
170 <ACRONYM |
|
171 CLASS="ACRONYM" |
|
172 >HTML</ACRONYM |
|
173 > templates, and produces a complete photo |
|
174 gallery of static <ACRONYM |
|
175 CLASS="ACRONYM" |
|
176 >HTML</ACRONYM |
|
177 > files, rescaled images |
|
178 at three sizes, and thumbnails.</P |
|
179 ></DIV |
|
180 ><DIV |
|
181 CLASS="REFSECT1" |
|
182 ><A |
|
183 NAME="AEN70" |
|
184 ></A |
|
185 ><H2 |
|
186 >OPTIONS</H2 |
|
187 ><P |
|
188 ></P |
|
189 ><DIV |
|
190 CLASS="VARIABLELIST" |
|
191 ><DL |
|
192 ><DT |
|
193 ><CODE |
|
194 CLASS="OPTION" |
|
195 >-f <TT |
|
196 CLASS="REPLACEABLE" |
|
197 ><I |
|
198 >config_file</I |
|
199 ></TT |
|
200 ></CODE |
|
201 ></DT |
|
202 ><DD |
|
203 ><P |
|
204 >use an alternative configuration file, instead of |
|
205 <TT |
|
206 CLASS="FILENAME" |
|
207 >~/.bins/binsrc.</TT |
|
208 >.</P |
|
209 ></DD |
|
210 ><DT |
|
211 ><CODE |
|
212 CLASS="OPTION" |
|
213 >-o <TT |
|
214 CLASS="REPLACEABLE" |
|
215 ><I |
|
216 >STR</I |
|
217 ></TT |
|
218 ></CODE |
|
219 ></DT |
|
220 ><DD |
|
221 ><P |
|
222 >Tells script to use only one copy of image using |
|
223 <ACRONYM |
|
224 CLASS="ACRONYM" |
|
225 >HTML</ACRONYM |
|
226 > size specs (height, width specs in the image |
|
227 tag) for scaled versions (instead of generating |
|
228 several images, one for each size).</P |
|
229 ><P |
|
230 >Default is false.</P |
|
231 ><P |
|
232 ><TT |
|
233 CLASS="REPLACEABLE" |
|
234 ><I |
|
235 >STR</I |
|
236 ></TT |
|
237 > is an optional argument |
|
238 to set how the one image is generated. Possible values: |
|
239 <P |
|
240 ></P |
|
241 ><DIV |
|
242 CLASS="VARIABLELIST" |
|
243 ><DL |
|
244 ><DT |
|
245 >scaled</DT |
|
246 ><DD |
|
247 ><P |
|
248 >(make scaled copy of orig in target_dir |
|
249 hierarchy, sized to max size). Default.</P |
|
250 ></DD |
|
251 ><DT |
|
252 >copied</DT |
|
253 ><DD |
|
254 ><P |
|
255 >(copy orig to web dir)</P |
|
256 ></DD |
|
257 ><DT |
|
258 >custom</DT |
|
259 ><DD |
|
260 ><P |
|
261 >(use copy if filesize < 1meg |
|
262 resize, resave, if bigger than 1 meg)</P |
|
263 ></DD |
|
264 ></DL |
|
265 ></DIV |
|
266 > |
|
267 </P |
|
268 ></DD |
|
269 ><DT |
|
270 ><CODE |
|
271 CLASS="OPTION" |
|
272 >-d <TT |
|
273 CLASS="REPLACEABLE" |
|
274 ><I |
|
275 >STR</I |
|
276 ></TT |
|
277 ></CODE |
|
278 ></DT |
|
279 ><DD |
|
280 ><P |
|
281 >Determine if tags found in <ACRONYM |
|
282 CLASS="ACRONYM" |
|
283 >EXIF</ACRONYM |
|
284 > structure are |
|
285 added in desc files.</P |
|
286 ><P |
|
287 ><TT |
|
288 CLASS="REPLACEABLE" |
|
289 ><I |
|
290 >STR</I |
|
291 ></TT |
|
292 > is one of "always", "never" or "exist" |
|
293 ("exist" only adds if the desc file already exist.) |
|
294 Default is always.</P |
|
295 ></DD |
|
296 ><DT |
|
297 ><CODE |
|
298 CLASS="OPTION" |
|
299 >-c <TT |
|
300 CLASS="REPLACEABLE" |
|
301 ><I |
|
302 >color_style</I |
|
303 ></TT |
|
304 ></CODE |
|
305 ></DT |
|
306 ><DD |
|
307 ><P |
|
308 > Color style to use. Can be <TT |
|
309 CLASS="LITERAL" |
|
310 >blue</TT |
|
311 > |
|
312 (default one), <TT |
|
313 CLASS="LITERAL" |
|
314 >green</TT |
|
315 >, |
|
316 <TT |
|
317 CLASS="LITERAL" |
|
318 >ivory</TT |
|
319 > and <TT |
|
320 CLASS="LITERAL" |
|
321 >pink</TT |
|
322 > or |
|
323 any other one defined in configuration/description files. |
|
324 This option is deprecated (and thus, not supported by all |
|
325 templates), in favor of alternate stylesheets and the |
|
326 <TT |
|
327 CLASS="LITERAL" |
|
328 >customStyleSheet</TT |
|
329 > parameter.</P |
|
330 ></DD |
|
331 ><DT |
|
332 ><CODE |
|
333 CLASS="OPTION" |
|
334 >-s <TT |
|
335 CLASS="REPLACEABLE" |
|
336 ><I |
|
337 >style</I |
|
338 ></TT |
|
339 ></CODE |
|
340 ></DT |
|
341 ><DD |
|
342 ><P |
|
343 >Template style to use (styles provided for now are |
|
344 <TT |
|
345 CLASS="LITERAL" |
|
346 >joi</TT |
|
347 >, <TT |
|
348 CLASS="LITERAL" |
|
349 >marc</TT |
|
350 >, |
|
351 <TT |
|
352 CLASS="LITERAL" |
|
353 >martin</TT |
|
354 >, <TT |
|
355 CLASS="LITERAL" |
|
356 >mwolson</TT |
|
357 > |
|
358 <TT |
|
359 CLASS="LITERAL" |
|
360 >petrus</TT |
|
361 >, <TT |
|
362 CLASS="LITERAL" |
|
363 >satyap</TT |
|
364 > and |
|
365 <TT |
|
366 CLASS="LITERAL" |
|
367 >swigs</TT |
|
368 >).</P |
|
369 ></DD |
|
370 ><DT |
|
371 ><CODE |
|
372 CLASS="OPTION" |
|
373 >-t <TT |
|
374 CLASS="REPLACEABLE" |
|
375 ><I |
|
376 >template_dir</I |
|
377 ></TT |
|
378 ></CODE |
|
379 ></DT |
|
380 ><DD |
|
381 ><P |
|
382 >Specify location of html templates.</P |
|
383 ><P |
|
384 >Default is <TT |
|
385 CLASS="FILENAME" |
|
386 >~/.bins</TT |
|
387 >, falling back |
|
388 to default versions in |
|
389 <TT |
|
390 CLASS="FILENAME" |
|
391 >/etc/bins/templates.<TT |
|
392 CLASS="REPLACEABLE" |
|
393 ><I |
|
394 >style</I |
|
395 ></TT |
|
396 ></TT |
|
397 >.</P |
|
398 ></DD |
|
399 ><DT |
|
400 ><CODE |
|
401 CLASS="OPTION" |
|
402 >-p</CODE |
|
403 ></DT |
|
404 ><DD |
|
405 ><P |
|
406 >Numbers preceding the album title, followed by |
|
407 an underscore are stripped. |
|
408 If this option is given, then prefix ordering |
|
409 numbers on directories are removed. For example, |
|
410 if one has directories <TT |
|
411 CLASS="FILENAME" |
|
412 >may</TT |
|
413 >, |
|
414 <TT |
|
415 CLASS="FILENAME" |
|
416 >june</TT |
|
417 >, and <TT |
|
418 CLASS="FILENAME" |
|
419 >august</TT |
|
420 >, they |
|
421 can be renamed <TT |
|
422 CLASS="FILENAME" |
|
423 >0_may</TT |
|
424 >, |
|
425 <TT |
|
426 CLASS="FILENAME" |
|
427 >1_june</TT |
|
428 >, and <TT |
|
429 CLASS="FILENAME" |
|
430 >2_august</TT |
|
431 > and |
|
432 they will appear in the album in the correct |
|
433 order.</P |
|
434 ></DD |
|
435 ><DT |
|
436 ><CODE |
|
437 CLASS="OPTION" |
|
438 >-e</CODE |
|
439 ></DT |
|
440 ><DD |
|
441 ><P |
|
442 >Tells the script to generate an editable version of |
|
443 the album. If set, some more links and icons are added to |
|
444 directly access the <TT |
|
445 CLASS="FILENAME" |
|
446 >.xml</TT |
|
447 > files for |
|
448 editing. This is for editing purposes, not for a final |
|
449 album.</P |
|
450 ></DD |
|
451 ><DT |
|
452 ><CODE |
|
453 CLASS="OPTION" |
|
454 >-i <TT |
|
455 CLASS="REPLACEABLE" |
|
456 ><I |
|
457 >iKey,iKey...</I |
|
458 ></TT |
|
459 ></CODE |
|
460 ></DT |
|
461 ><DD |
|
462 ><P |
|
463 >Sets "ignore" keywords which will be compared against |
|
464 the contents of the <CODE |
|
465 CLASS="SGMLTAG" |
|
466 >ignore</CODE |
|
467 > field of the |
|
468 album's XML file, in the <CODE |
|
469 CLASS="SGMLTAG" |
|
470 >ignore</CODE |
|
471 > field in |
|
472 <CODE |
|
473 CLASS="SGMLTAG" |
|
474 >description</CODE |
|
475 > section. If any of the |
|
476 <TT |
|
477 CLASS="REPLACEABLE" |
|
478 ><I |
|
479 >iKeys</I |
|
480 ></TT |
|
481 > match those in the album's |
|
482 "ignore" field, that album will not be processed. See also |
|
483 the <CODE |
|
484 CLASS="SGMLTAG" |
|
485 >ignore</CODE |
|
486 > parameter.</P |
|
487 ></DD |
|
488 ><DT |
|
489 ><CODE |
|
490 CLASS="OPTION" |
|
491 >-n <TT |
|
492 CLASS="REPLACEABLE" |
|
493 ><I |
|
494 >iKey,iKey...</I |
|
495 ></TT |
|
496 ></CODE |
|
497 ></DT |
|
498 ><DD |
|
499 ><P |
|
500 >Sets "hidden" keywords which will be compared against |
|
501 the contents of the <CODE |
|
502 CLASS="SGMLTAG" |
|
503 >ignore</CODE |
|
504 > field of the |
|
505 album's XML file, in the <CODE |
|
506 CLASS="SGMLTAG" |
|
507 >ignore</CODE |
|
508 > field in |
|
509 <CODE |
|
510 CLASS="SGMLTAG" |
|
511 >description</CODE |
|
512 > section. If any of the |
|
513 <TT |
|
514 CLASS="REPLACEABLE" |
|
515 ><I |
|
516 >iKeys</I |
|
517 ></TT |
|
518 > match those in the album's |
|
519 "ignore" field, that album will be hidden: it will not be |
|
520 linked anywhere. See also the <CODE |
|
521 CLASS="SGMLTAG" |
|
522 >hidden</CODE |
|
523 > |
|
524 parameter.</P |
|
525 ></DD |
|
526 ><DT |
|
527 ><CODE |
|
528 CLASS="OPTION" |
|
529 >-v <TT |
|
530 CLASS="REPLACEABLE" |
|
531 ><I |
|
532 >X</I |
|
533 ></TT |
|
534 ></CODE |
|
535 ></DT |
|
536 ><DD |
|
537 ><P |
|
538 ><TT |
|
539 CLASS="REPLACEABLE" |
|
540 ><I |
|
541 >X</I |
|
542 ></TT |
|
543 > is the verbosity level (between 0 and 3)</P |
|
544 ></DD |
|
545 ><DT |
|
546 ><CODE |
|
547 CLASS="OPTION" |
|
548 >-h</CODE |
|
549 ></DT |
|
550 ><DD |
|
551 ><P |
|
552 >Show the help string this man page was originally based on.</P |
|
553 ></DD |
|
554 ></DL |
|
555 ></DIV |
|
556 ></DIV |
|
557 ><DIV |
|
558 CLASS="REFSECT1" |
|
559 ><A |
|
560 NAME="AEN197" |
|
561 ></A |
|
562 ><H2 |
|
563 >SETTINGS</H2 |
|
564 ><P |
|
565 >bins is also controlled by other files.</P |
|
566 ><P |
|
567 ></P |
|
568 ><DIV |
|
569 CLASS="VARIABLELIST" |
|
570 ><DL |
|
571 ><DT |
|
572 ><TT |
|
573 CLASS="FILENAME" |
|
574 >/etc/bins/binsrc</TT |
|
575 >, <TT |
|
576 CLASS="FILENAME" |
|
577 >~/.bins/binsrc</TT |
|
578 ></DT |
|
579 ><DD |
|
580 ><P |
|
581 >The <TT |
|
582 CLASS="FILENAME" |
|
583 >binsrc</TT |
|
584 > files are |
|
585 <ACRONYM |
|
586 CLASS="ACRONYM" |
|
587 >XML</ACRONYM |
|
588 > files with a top level |
|
589 <CODE |
|
590 CLASS="SGMLTAG" |
|
591 >bins</CODE |
|
592 > tag. There are three element |
|
593 names with <CODE |
|
594 CLASS="SGMLTAG" |
|
595 >bins</CODE |
|
596 >: <CODE |
|
597 CLASS="SGMLTAG" |
|
598 >parameter</CODE |
|
599 >, |
|
600 <CODE |
|
601 CLASS="SGMLTAG" |
|
602 >colors</CODE |
|
603 >, and <CODE |
|
604 CLASS="SGMLTAG" |
|
605 >sizes</CODE |
|
606 >. |
|
607 Each of these has a <CODE |
|
608 CLASS="SGMLTAG" |
|
609 >name</CODE |
|
610 > attribute |
|
611 which names the data in the element content.</P |
|
612 ><P |
|
613 >The <CODE |
|
614 CLASS="SGMLTAG" |
|
615 >colors</CODE |
|
616 > element has a |
|
617 <CODE |
|
618 CLASS="SGMLTAG" |
|
619 >style</CODE |
|
620 > attribute, that can be used with |
|
621 the <CODE |
|
622 CLASS="SGMLTAG" |
|
623 >colorStyle</CODE |
|
624 > parameter or the |
|
625 <CODE |
|
626 CLASS="SGMLTAG" |
|
627 >-c</CODE |
|
628 > command line option. It contains |
|
629 <CODE |
|
630 CLASS="SGMLTAG" |
|
631 >color</CODE |
|
632 > elements. The |
|
633 <CODE |
|
634 CLASS="SGMLTAG" |
|
635 >color</CODE |
|
636 > elements name has one of the |
|
637 following values which is substituted into the template |
|
638 files. This tag is deprecated, in favor of alternate |
|
639 stylesheets and the <TT |
|
640 CLASS="LITERAL" |
|
641 >customStyleSheet</TT |
|
642 > |
|
643 parameter.</P |
|
644 ><P |
|
645 ></P |
|
646 ><TABLE |
|
647 BORDER="0" |
|
648 ><TBODY |
|
649 ><TR |
|
650 ><TD |
|
651 >PAGE_BACK</TD |
|
652 ></TR |
|
653 ><TR |
|
654 ><TD |
|
655 >PAGE_TITLE</TD |
|
656 ></TR |
|
657 ><TR |
|
658 ><TD |
|
659 >MAINBAR_BACK</TD |
|
660 ></TR |
|
661 ><TR |
|
662 ><TD |
|
663 >MAINBAR_TITLE</TD |
|
664 ></TR |
|
665 ><TR |
|
666 ><TD |
|
667 >MAINBAR_LINK</TD |
|
668 ></TR |
|
669 ><TR |
|
670 ><TD |
|
671 >MAINBAR_CURRENTPAGE</TD |
|
672 ></TR |
|
673 ><TR |
|
674 ><TD |
|
675 >SUBBAR_BACK</TD |
|
676 ></TR |
|
677 ><TR |
|
678 ><TD |
|
679 >SUBBAR_LINK</TD |
|
680 ></TR |
|
681 ><TR |
|
682 ><TD |
|
683 >SUBBAR_CURRENTPAGE</TD |
|
684 ></TR |
|
685 ><TR |
|
686 ><TD |
|
687 >SUBBAR_TITLE</TD |
|
688 ></TR |
|
689 ></TBODY |
|
690 ></TABLE |
|
691 ><P |
|
692 ></P |
|
693 ><P |
|
694 >The <CODE |
|
695 CLASS="SGMLTAG" |
|
696 >sizes</CODE |
|
697 > element contains |
|
698 <CODE |
|
699 CLASS="SGMLTAG" |
|
700 >size</CODE |
|
701 > elements which each have a |
|
702 <CODE |
|
703 CLASS="SGMLTAG" |
|
704 >name</CODE |
|
705 > attribute, a |
|
706 <CODE |
|
707 CLASS="SGMLTAG" |
|
708 >shortname</CODE |
|
709 > attribute, a |
|
710 <CODE |
|
711 CLASS="SGMLTAG" |
|
712 >height</CODE |
|
713 > attribute, and a |
|
714 <CODE |
|
715 CLASS="SGMLTAG" |
|
716 >width</CODE |
|
717 > attribute. These default to</P |
|
718 ><P |
|
719 ></P |
|
720 ><TABLE |
|
721 BORDER="0" |
|
722 ><TBODY |
|
723 ><TR |
|
724 ><TD |
|
725 >Small, Sm, 40%, 40%</TD |
|
726 ></TR |
|
727 ><TR |
|
728 ><TD |
|
729 >Medium, Med, 64%, 64%</TD |
|
730 ></TR |
|
731 ><TR |
|
732 ><TD |
|
733 >Large, Lg, 100%, 100%</TD |
|
734 ></TR |
|
735 ></TBODY |
|
736 ></TABLE |
|
737 ><P |
|
738 ></P |
|
739 ><P |
|
740 ><CODE |
|
741 CLASS="SGMLTAG" |
|
742 >name</CODE |
|
743 > and |
|
744 <CODE |
|
745 CLASS="SGMLTAG" |
|
746 >shortname</CODE |
|
747 > are used in the output |
|
748 <ACRONYM |
|
749 CLASS="ACRONYM" |
|
750 >HTML</ACRONYM |
|
751 > and in generated filenames. The |
|
752 default values listed above are passed through |
|
753 <CODE |
|
754 CLASS="FUNCTION" |
|
755 >gettext</CODE |
|
756 > for localization; overrides |
|
757 in <TT |
|
758 CLASS="FILENAME" |
|
759 >binsrc</TT |
|
760 > files are not, and should |
|
761 be in the desired language.</P |
|
762 ><P |
|
763 >For the <CODE |
|
764 CLASS="SGMLTAG" |
|
765 >parameter</CODE |
|
766 > elements the |
|
767 <CODE |
|
768 CLASS="SGMLTAG" |
|
769 >name</CODE |
|
770 > attribute names one of the |
|
771 following parameters.</P |
|
772 ><P |
|
773 ></P |
|
774 ><DIV |
|
775 CLASS="VARIABLELIST" |
|
776 ><DL |
|
777 ><DT |
|
778 >addExifToDescFile</DT |
|
779 ><DD |
|
780 ><P |
|
781 >If set to 1 (the default), write <ACRONYM |
|
782 CLASS="ACRONYM" |
|
783 >EXIF</ACRONYM |
|
784 > data found in |
|
785 the image file to the image desc file (but see also |
|
786 the <CODE |
|
787 CLASS="OPTION" |
|
788 >-d</CODE |
|
789 > flag).</P |
|
790 ></DD |
|
791 ><DT |
|
792 >albumThumbInSubAlbumPage</DT |
|
793 ><DD |
|
794 ><P |
|
795 >If set to 1 (the default), display the current |
|
796 album thumbnail in sub-albums page |
|
797 if it has pictures, with links to |
|
798 the thumbnails page.</P |
|
799 ></DD |
|
800 ><DT |
|
801 >allThumbnailsPage</DT |
|
802 ><DD |
|
803 ><P |
|
804 >If set to <TT |
|
805 CLASS="LITERAL" |
|
806 >1</TT |
|
807 >, generate a page with all |
|
808 thumbnails in the album and |
|
809 sub-albums. This is deactivated |
|
810 because it is an alpha feature which |
|
811 seems to not work properly.</P |
|
812 ></DD |
|
813 ><DT |
|
814 >backgroundImage</DT |
|
815 ><DD |
|
816 ><P |
|
817 >Set this to the image that should be displayed |
|
818 as the background of the album pages. The Image will |
|
819 be copied to the static files directory. This works |
|
820 only with joi, marc, martin and petrus templates for now. |
|
821 </P |
|
822 ></DD |
|
823 ><DT |
|
824 >borderOnThumbnails</DT |
|
825 ><DD |
|
826 ><P |
|
827 >Width of the border of the thumbnail's image in |
|
828 the thumbnails page, in pixels. <TT |
|
829 CLASS="LITERAL" |
|
830 >0</TT |
|
831 > |
|
832 means no border. |
|
833 </P |
|
834 ></DD |
|
835 ><DT |
|
836 >colorStyle</DT |
|
837 ><DD |
|
838 ><P |
|
839 >Name of the color style to use. Default is |
|
840 <TT |
|
841 CLASS="FILENAME" |
|
842 >blue</TT |
|
843 >. See also the |
|
844 <CODE |
|
845 CLASS="OPTION" |
|
846 >-c</CODE |
|
847 > option which takes precedence. |
|
848 This option is deprecated (and thus, not supported by |
|
849 all templates), in favor of alternate stylesheets and |
|
850 the <TT |
|
851 CLASS="LITERAL" |
|
852 >customStyleSheet</TT |
|
853 > |
|
854 parameter.</P |
|
855 ></DD |
|
856 ><DT |
|
857 >compactHTML</DT |
|
858 ><DD |
|
859 ><P |
|
860 >If set to <TT |
|
861 CLASS="LITERAL" |
|
862 >1</TT |
|
863 >, generated |
|
864 <ACRONYM |
|
865 CLASS="ACRONYM" |
|
866 >HTML</ACRONYM |
|
867 > code is cleaned up to reduce |
|
868 the size of pages and thus, speed up browsing. This |
|
869 reduces the size of <ACRONYM |
|
870 CLASS="ACRONYM" |
|
871 >HTML</ACRONYM |
|
872 > BINS files |
|
873 by about 30%. See <B |
|
874 CLASS="COMMAND" |
|
875 >HTML::Clean(3)</B |
|
876 > to |
|
877 know how optimizations are performed.</P |
|
878 ></DD |
|
879 ><DT |
|
880 >configFileName</DT |
|
881 ><DD |
|
882 ><P |
|
883 >Can be set in the global config file, but only |
|
884 influences the basename of the local user config |
|
885 file. Defaults to <TT |
|
886 CLASS="FILENAME" |
|
887 >.binsrc</TT |
|
888 >.</P |
|
889 ></DD |
|
890 ><DT |
|
891 >createEmptyDescFields</DT |
|
892 ><DD |
|
893 ><P |
|
894 >If set to 1 (the default), add empty description |
|
895 fields in the <CODE |
|
896 CLASS="SGMLTAG" |
|
897 >description</CODE |
|
898 > section |
|
899 when the image description file is created to ease |
|
900 later manual editing.</P |
|
901 ></DD |
|
902 ><DT |
|
903 >createHtaccess</DT |
|
904 ><DD |
|
905 ><P |
|
906 >If <TT |
|
907 CLASS="LITERAL" |
|
908 >1</TT |
|
909 >, create an Apache |
|
910 <TT |
|
911 CLASS="FILENAME" |
|
912 >.htaccess</TT |
|
913 > file in the root dir of |
|
914 the album with the encoding charset bound to |
|
915 <TT |
|
916 CLASS="FILENAME" |
|
917 >html</TT |
|
918 > and <TT |
|
919 CLASS="FILENAME" |
|
920 >htm</TT |
|
921 > |
|
922 files. This is a parameter global for the album, it |
|
923 can't be set in album.xml.</P |
|
924 ></DD |
|
925 ><DT |
|
926 >customStyleSheet</DT |
|
927 ><DD |
|
928 ><P |
|
929 >Set this to the CSS file that should be used as |
|
930 the stylesheet for the album pages. The CSS file will |
|
931 be copied to the static files directory. This works |
|
932 only with joi, marc, martin and petrus templates for now. |
|
933 </P |
|
934 ></DD |
|
935 ><DT |
|
936 >dateString</DT |
|
937 ><DD |
|
938 ><P |
|
939 >Specify the format of date strings. This variable |
|
940 accepts all formats supported by <B |
|
941 CLASS="COMMAND" |
|
942 >date(1)</B |
|
943 >. |
|
944 </P |
|
945 ></DD |
|
946 ><DT |
|
947 >defaultSize</DT |
|
948 ><DD |
|
949 ><P |
|
950 >Size to use when user clicks directly on the |
|
951 thumbnail in the thumbnails page instead of one of |
|
952 the size name. 0 is the first size |
|
953 (<TT |
|
954 CLASS="LITERAL" |
|
955 >Small</TT |
|
956 > in the default config), 1 |
|
957 the second (<TT |
|
958 CLASS="LITERAL" |
|
959 >Medium</TT |
|
960 >), and so |
|
961 on. Set this variable to -1 if you don't want the |
|
962 thumbnail to be clickable.</P |
|
963 ></DD |
|
964 ><DT |
|
965 >deExifyImages</DT |
|
966 ><DD |
|
967 ><P |
|
968 >If set to 1, do NOT copy exif data found in the |
|
969 source images to any of the generated resized images. |
|
970 Setting this option can yield significant space |
|
971 savings, especially for thumbnail and imagelist |
|
972 pages.</P |
|
973 ></DD |
|
974 ><DT |
|
975 >emptyAlbumDesc</DT |
|
976 ><DD |
|
977 ><P |
|
978 >If set to 1, and album desciption is not set, no |
|
979 message will be displayed (instead of the "No |
|
980 long/short description available" one).</P |
|
981 ></DD |
|
982 ><DT |
|
983 >enlarge</DT |
|
984 ><DD |
|
985 ><P |
|
986 >If set to 1, small images are enlarged |
|
987 in the "med" and "large" series. (defaults to 0).</P |
|
988 ></DD |
|
989 ><DT |
|
990 >excludeBackgroundImage</DT |
|
991 ><DD |
|
992 ><P |
|
993 >If set to 1, the image with the name given in |
|
994 <TT |
|
995 CLASS="LITERAL" |
|
996 >backgroundImage</TT |
|
997 > will be excluded from the |
|
998 current directory. |
|
999 </P |
|
1000 ></DD |
|
1001 ><DT |
|
1002 >excludeDirs</DT |
|
1003 ><DD |
|
1004 ><P |
|
1005 >Exclude directories that match this regexp (if |
|
1006 set). Set to ^CVS$ in default config, so that CVS |
|
1007 subdirs aren't processed by bins. |
|
1008 </P |
|
1009 ></DD |
|
1010 ><DT |
|
1011 >excludeFiles</DT |
|
1012 ><DD |
|
1013 ><P |
|
1014 >Exclude image files that match this regexp (if |
|
1015 set). No image files are excluded in default config. |
|
1016 </P |
|
1017 ></DD |
|
1018 ><DT |
|
1019 >globalConfigDir</DT |
|
1020 ><DD |
|
1021 ><P |
|
1022 >Can't usefully be set, since it has already been |
|
1023 used when the first config file is read. Defaults |
|
1024 to <TT |
|
1025 CLASS="FILENAME" |
|
1026 >/etc/bins</TT |
|
1027 >.</P |
|
1028 ></DD |
|
1029 ><DT |
|
1030 >hidden</DT |
|
1031 ><DD |
|
1032 ><P |
|
1033 >Put here a comma separated list of keyword. If |
|
1034 one on this keyword is found in the |
|
1035 <TT |
|
1036 CLASS="LITERAL" |
|
1037 >ignore</TT |
|
1038 > field in the |
|
1039 <CODE |
|
1040 CLASS="SGMLTAG" |
|
1041 >description</CODE |
|
1042 > section of an |
|
1043 <TT |
|
1044 CLASS="FILENAME" |
|
1045 >album.xml</TT |
|
1046 >, then this sub-album |
|
1047 will be hidden, i.e. it will be generated but not |
|
1048 linked anywhere. You can also use the |
|
1049 <TT |
|
1050 CLASS="LITERAL" |
|
1051 >-n</TT |
|
1052 > command line option.</P |
|
1053 ></DD |
|
1054 ><DT |
|
1055 >homeURL</DT |
|
1056 ><DD |
|
1057 ><P |
|
1058 >Set this to your home page's |
|
1059 <ACRONYM |
|
1060 CLASS="ACRONYM" |
|
1061 >URL</ACRONYM |
|
1062 >. This is used for the leave button |
|
1063 in some templates.</P |
|
1064 ></DD |
|
1065 ><DT |
|
1066 >htmlEncoding</DT |
|
1067 ><DD |
|
1068 ><P |
|
1069 ><ACRONYM |
|
1070 CLASS="ACRONYM" |
|
1071 >HTML</ACRONYM |
|
1072 > pages charset encoding.</P |
|
1073 ></DD |
|
1074 ><DT |
|
1075 >ignore</DT |
|
1076 ><DD |
|
1077 ><P |
|
1078 >Put here a comma separated list of keyword. If |
|
1079 one on this keyword is found in the |
|
1080 <TT |
|
1081 CLASS="LITERAL" |
|
1082 >ignore</TT |
|
1083 > field in the |
|
1084 <CODE |
|
1085 CLASS="SGMLTAG" |
|
1086 >description</CODE |
|
1087 > section of an |
|
1088 <TT |
|
1089 CLASS="FILENAME" |
|
1090 >album.xml</TT |
|
1091 >, then this sub-album |
|
1092 will be ignored, i.e. it will not be processed. You |
|
1093 can also use the <TT |
|
1094 CLASS="LITERAL" |
|
1095 >-i</TT |
|
1096 > command line |
|
1097 option.</P |
|
1098 ></DD |
|
1099 ><DT |
|
1100 >imagePageCycling</DT |
|
1101 ><DD |
|
1102 ><P |
|
1103 >If set to 0 next/prev-Links will be hidden if |
|
1104 the actual page is the last/first Image page.</P |
|
1105 ></DD |
|
1106 ><DT |
|
1107 >javaScriptPreloadImage</DT |
|
1108 ><DD |
|
1109 ><P |
|
1110 >If set to <TT |
|
1111 CLASS="LITERAL" |
|
1112 >1</TT |
|
1113 >, add some |
|
1114 javascript code in image pages to preload the next |
|
1115 image of the same size when current one is loaded, to |
|
1116 speed up the album browsing.</P |
|
1117 ></DD |
|
1118 ><DT |
|
1119 >javaScriptPreloadThumbs</DT |
|
1120 ><DD |
|
1121 ><P |
|
1122 >If set to <TT |
|
1123 CLASS="LITERAL" |
|
1124 >1</TT |
|
1125 >, add some |
|
1126 javascript code in thumbnails pages to preload |
|
1127 thumbnails of the next page when current one is |
|
1128 loaded, to speed up the album browsing.</P |
|
1129 ></DD |
|
1130 ><DT |
|
1131 >jpegQuality</DT |
|
1132 ><DD |
|
1133 ><P |
|
1134 >Quality of scaled jpegs (lower number = more |
|
1135 compression, lower quality) in 1-100 range (default |
|
1136 of 75). See imagemagick docs for more details.</P |
|
1137 ></DD |
|
1138 ><DT |
|
1139 >linkInsteadOfCopy</DT |
|
1140 ><DD |
|
1141 ><P |
|
1142 >If set to 1, we link the picture instead of |
|
1143 copying it if possible (i.e. scaleIfSameSize is set to |
|
1144 <TT |
|
1145 CLASS="LITERAL" |
|
1146 >0</TT |
|
1147 > and destination image doesn't |
|
1148 have to be rotated: <TT |
|
1149 CLASS="LITERAL" |
|
1150 >rotateImages</TT |
|
1151 > is |
|
1152 set to <TT |
|
1153 CLASS="LITERAL" |
|
1154 >original</TT |
|
1155 > or |
|
1156 <TT |
|
1157 CLASS="LITERAL" |
|
1158 >none</TT |
|
1159 >, or orientation is already |
|
1160 correct). Warning : if whenSrcSmaller is set |
|
1161 to enlarge, original image can be modified.</P |
|
1162 ></DD |
|
1163 ><DT |
|
1164 >linkRelative</DT |
|
1165 ><DD |
|
1166 ><P |
|
1167 > If set to 1, we use a relative path for the link if |
|
1168 <TT |
|
1169 CLASS="LITERAL" |
|
1170 >linkInsteadOfCopy</TT |
|
1171 > is set to 1. |
|
1172 </P |
|
1173 ></DD |
|
1174 ><DT |
|
1175 >maxAlbumsForLongSubAlbum</DT |
|
1176 ><DD |
|
1177 ><P |
|
1178 >If the number of sub albums is greater (than |
|
1179 this value which defaults to 20), |
|
1180 generate a short sub album page |
|
1181 instead of the long one. (Short sub album pages |
|
1182 appear to be unsupported at the moment; this option |
|
1183 is disabled.)</P |
|
1184 ></DD |
|
1185 ><DT |
|
1186 >noRotation</DT |
|
1187 ><DD |
|
1188 ><P |
|
1189 >Don't perform rotation on files matching this |
|
1190 regexp. This can used in conjunction with |
|
1191 <TT |
|
1192 CLASS="LITERAL" |
|
1193 >scaleIfSameSize=0</TT |
|
1194 > and a scaled size of |
|
1195 <TT |
|
1196 CLASS="LITERAL" |
|
1197 >100%x100%</TT |
|
1198 > to keep original pictures in |
|
1199 your album.</P |
|
1200 ></DD |
|
1201 ><DT |
|
1202 >numThumbsPerPage</DT |
|
1203 ><DD |
|
1204 ><P |
|
1205 >Number of thumbnails (default of 16) displayed |
|
1206 in each page in an album.</P |
|
1207 ></DD |
|
1208 ><DT |
|
1209 >pathImgNum</DT |
|
1210 ><DD |
|
1211 ><P |
|
1212 >If set to 1 the path in the imageview contains |
|
1213 the number of the current image.</P |
|
1214 ></DD |
|
1215 ><DT |
|
1216 >pathShowIcon</DT |
|
1217 ><DD |
|
1218 ><P |
|
1219 >If set to 1 the path contains icons.</P |
|
1220 ></DD |
|
1221 ><DT |
|
1222 >previewMaxWidth, previewMaxHeight</DT |
|
1223 ><DD |
|
1224 ><P |
|
1225 >Max thumbnail width and height (default 150x150).</P |
|
1226 ></DD |
|
1227 ><DT |
|
1228 >jpegProgressify</DT |
|
1229 ><DD |
|
1230 ><P |
|
1231 >whether to convert generated jpegs to |
|
1232 progressive using jpegtran (if available). can be |
|
1233 <TT |
|
1234 CLASS="LITERAL" |
|
1235 >never</TT |
|
1236 >, <TT |
|
1237 CLASS="LITERAL" |
|
1238 >always</TT |
|
1239 >, or |
|
1240 <TT |
|
1241 CLASS="LITERAL" |
|
1242 >smaller</TT |
|
1243 > (if the progressified file |
|
1244 is smaller than the baseline).</P |
|
1245 ></DD |
|
1246 ><DT |
|
1247 >reverseOrder</DT |
|
1248 ><DD |
|
1249 ><P |
|
1250 > Are we reversing sorting order for pictures or |
|
1251 directories ? 0=none, 1=dirs, 2=pix, 3=both. See |
|
1252 also <TT |
|
1253 CLASS="LITERAL" |
|
1254 >-r</TT |
|
1255 > command line option. |
|
1256 </P |
|
1257 ></DD |
|
1258 ><DT |
|
1259 >rotateImages</DT |
|
1260 ><DD |
|
1261 ><P |
|
1262 >Do we rotate images if the |
|
1263 <CODE |
|
1264 CLASS="SGMLTAG" |
|
1265 >Orientation</CODE |
|
1266 > <ACRONYM |
|
1267 CLASS="ACRONYM" |
|
1268 >EXIF</ACRONYM |
|
1269 > |
|
1270 tag is found? If set to <CODE |
|
1271 CLASS="SGMLTAG" |
|
1272 >original</CODE |
|
1273 > |
|
1274 (the default), the original image is rotated the first |
|
1275 time, and then it is left untouched. If set to |
|
1276 <CODE |
|
1277 CLASS="SGMLTAG" |
|
1278 >destination</CODE |
|
1279 >, this is all the scaled |
|
1280 images and thumbnails that are rotated. This is less |
|
1281 efficient, but the original images are preserved (and |
|
1282 is useful if the original images are read-only). If |
|
1283 set to <CODE |
|
1284 CLASS="SGMLTAG" |
|
1285 >none</CODE |
|
1286 >, no rotation is |
|
1287 performed.</P |
|
1288 ></DD |
|
1289 ><DT |
|
1290 >rotateWithJpegtran</DT |
|
1291 ><DD |
|
1292 ><P |
|
1293 >If set to <TT |
|
1294 CLASS="LITERAL" |
|
1295 >1</TT |
|
1296 >, |
|
1297 <TT |
|
1298 CLASS="FILENAME" |
|
1299 >bins</TT |
|
1300 > try to use the |
|
1301 <TT |
|
1302 CLASS="FILENAME" |
|
1303 >jpegtran</TT |
|
1304 > program to rotate |
|
1305 <ACRONYM |
|
1306 CLASS="ACRONYM" |
|
1307 >JPEG</ACRONYM |
|
1308 > images if it is |
|
1309 available. <TT |
|
1310 CLASS="FILENAME" |
|
1311 >jpegtran</TT |
|
1312 > is faster and |
|
1313 lossless, but some versions fail to perform rotation |
|
1314 correctly, so it is deactivated in default config. If |
|
1315 set to <TT |
|
1316 CLASS="LITERAL" |
|
1317 >0</TT |
|
1318 > or if |
|
1319 <TT |
|
1320 CLASS="FILENAME" |
|
1321 >jpegtran</TT |
|
1322 > is not found, |
|
1323 <TT |
|
1324 CLASS="FILENAME" |
|
1325 >mogrify</TT |
|
1326 > (from ImageMagick) is |
|
1327 used.</P |
|
1328 ></DD |
|
1329 ><DT |
|
1330 >scaleIfSameSize</DT |
|
1331 ><DD |
|
1332 ><P |
|
1333 >If set to 1, we scale the picture even |
|
1334 if destination size is the same as the |
|
1335 original picture, if set to 0 (the default), the |
|
1336 original image is just copied if the |
|
1337 size is correct.</P |
|
1338 ></DD |
|
1339 ><DT |
|
1340 >scaleMethod</DT |
|
1341 ><DD |
|
1342 ><P |
|
1343 >What method should be used to create scaled |
|
1344 pictures and thumbnails ? Can be either |
|
1345 <TT |
|
1346 CLASS="LITERAL" |
|
1347 >scale</TT |
|
1348 > or |
|
1349 <TT |
|
1350 CLASS="LITERAL" |
|
1351 >sample</TT |
|
1352 >. <TT |
|
1353 CLASS="LITERAL" |
|
1354 >sample</TT |
|
1355 > |
|
1356 is <TT |
|
1357 CLASS="LITERAL" |
|
1358 >faster</TT |
|
1359 >, scale is better. |
|
1360 </P |
|
1361 ></DD |
|
1362 ><DT |
|
1363 >searchEngine</DT |
|
1364 ><DD |
|
1365 ><P |
|
1366 > If 1, generate a search page. Images can be searched |
|
1367 on description fields set in the |
|
1368 <TT |
|
1369 CLASS="LITERAL" |
|
1370 >searchFields</TT |
|
1371 > parameter. |
|
1372 </P |
|
1373 ></DD |
|
1374 ><DT |
|
1375 >searchFields</DT |
|
1376 ><DD |
|
1377 ><P |
|
1378 > Space separated list of description field names used |
|
1379 by the search engine, if |
|
1380 <TT |
|
1381 CLASS="LITERAL" |
|
1382 >searchEngine</TT |
|
1383 > is set to 1. |
|
1384 </P |
|
1385 ></DD |
|
1386 ><DT |
|
1387 >searchLimit</DT |
|
1388 ><DD |
|
1389 ><P |
|
1390 > Maximum results returned by the search engine, if |
|
1391 <TT |
|
1392 CLASS="LITERAL" |
|
1393 >searchEngine</TT |
|
1394 > is set to 1. Note |
|
1395 that if this number is too high, it can hang the |
|
1396 browser. |
|
1397 </P |
|
1398 ></DD |
|
1399 ><DT |
|
1400 >stripDirPrefix</DT |
|
1401 ><DD |
|
1402 ><P |
|
1403 >If <TT |
|
1404 CLASS="LITERAL" |
|
1405 >1</TT |
|
1406 >, numbers preceding the |
|
1407 album title, followed by an underscore, are |
|
1408 stripped. If this parameter is set, then prefix |
|
1409 ordering numbers on directories are removed. For |
|
1410 example, if one has directories may, june, and august, |
|
1411 they can be renamed <TT |
|
1412 CLASS="FILENAME" |
|
1413 >0_may</TT |
|
1414 >, |
|
1415 <TT |
|
1416 CLASS="FILENAME" |
|
1417 >1_june</TT |
|
1418 >, and |
|
1419 <TT |
|
1420 CLASS="FILENAME" |
|
1421 >2_august</TT |
|
1422 > and they will appear in |
|
1423 the album in the correct order. This can be overridden |
|
1424 by the <TT |
|
1425 CLASS="LITERAL" |
|
1426 >-p</TT |
|
1427 > command line option.</P |
|
1428 ></DD |
|
1429 ><DT |
|
1430 >templateStyle</DT |
|
1431 ><DD |
|
1432 ><P |
|
1433 >Name of the template style to use. Default is |
|
1434 <TT |
|
1435 CLASS="FILENAME" |
|
1436 >swigs</TT |
|
1437 >. Other templates provided |
|
1438 with BINS are <TT |
|
1439 CLASS="FILENAME" |
|
1440 >joi</TT |
|
1441 >, |
|
1442 <TT |
|
1443 CLASS="FILENAME" |
|
1444 >marc</TT |
|
1445 >, <TT |
|
1446 CLASS="FILENAME" |
|
1447 >martin</TT |
|
1448 >, |
|
1449 <TT |
|
1450 CLASS="FILENAME" |
|
1451 >petrus</TT |
|
1452 > and |
|
1453 <TT |
|
1454 CLASS="FILENAME" |
|
1455 >satyap</TT |
|
1456 >. Several templates can be |
|
1457 used for different sub-album of an album, by using |
|
1458 this parameter in the <CODE |
|
1459 CLASS="SGMLTAG" |
|
1460 >bins</CODE |
|
1461 > section |
|
1462 of the <TT |
|
1463 CLASS="FILENAME" |
|
1464 >album.xml</TT |
|
1465 > files. See also |
|
1466 the <CODE |
|
1467 CLASS="OPTION" |
|
1468 >-s</CODE |
|
1469 > option which takes precedence |
|
1470 over binsrc (but not album.xml).</P |
|
1471 ></DD |
|
1472 ><DT |
|
1473 >thumbnailBackground</DT |
|
1474 ><DD |
|
1475 ><P |
|
1476 >If set to 1, add a background colour |
|
1477 (SUBBAR_BACK) to the thumbnail's cell in the |
|
1478 thumbnails page so that if the top and bottom borders |
|
1479 are wider than the image (for example, if it is in |
|
1480 portrait mode), instead of spilling over, there is a |
|
1481 border around the whole picture. By default, use the |
|
1482 PAGE_BACK color.</P |
|
1483 ></DD |
|
1484 ><DT |
|
1485 >thumbnailInImageList</DT |
|
1486 ><DD |
|
1487 ><P |
|
1488 >Display thumbnails on the Image List page, set |
|
1489 to 1 by default.</P |
|
1490 ></DD |
|
1491 ><DT |
|
1492 >thumbnailPageCycling</DT |
|
1493 ><DD |
|
1494 ><P |
|
1495 >If set to 0 next/prev-Links will be hidden if |
|
1496 the actual page is the last/first |
|
1497 Thumbnail page.</P |
|
1498 ></DD |
|
1499 ><DT |
|
1500 >thumbPrevNext</DT |
|
1501 ><DD |
|
1502 ><P |
|
1503 >If set to 1 (the default), display thumbnails close |
|
1504 to the previous and next link at the |
|
1505 bottom of the image page.</P |
|
1506 ></DD |
|
1507 ><DT |
|
1508 >thumbsPerRow</DT |
|
1509 ><DD |
|
1510 ><P |
|
1511 >Number of thumbnails (default of 4) displayed in each |
|
1512 row in an album.</P |
|
1513 ></DD |
|
1514 ><DT |
|
1515 >titleOnThumbnail</DT |
|
1516 ><DD |
|
1517 ><P |
|
1518 >Should the title be displayed on top on the |
|
1519 thumbnail in the thumbnails page? (defaults to 1.)</P |
|
1520 ></DD |
|
1521 ><DT |
|
1522 >treePreview</DT |
|
1523 ><DD |
|
1524 ><P |
|
1525 >If set to 1, preview thumbnails will be showed |
|
1526 in the album tree page. This works only with joi, |
|
1527 marc and petrus templates for now. |
|
1528 </P |
|
1529 ></DD |
|
1530 ><DT |
|
1531 >updateOriginalPerms</DT |
|
1532 ><DD |
|
1533 ><P |
|
1534 >If set to 1, read permissions on images will be |
|
1535 set, to ensure http deamon will be able to read |
|
1536 them. |
|
1537 </P |
|
1538 ></DD |
|
1539 ><DT |
|
1540 >userConfigDir</DT |
|
1541 ><DD |
|
1542 ><P |
|
1543 >Can be set in the global config file (since |
|
1544 after the user one is read, it is too late). |
|
1545 Defaults to <TT |
|
1546 CLASS="FILENAME" |
|
1547 >~/.bins</TT |
|
1548 > and is |
|
1549 processed by <CODE |
|
1550 CLASS="FUNCTION" |
|
1551 >bsd_glob</CODE |
|
1552 > (see |
|
1553 <CODE |
|
1554 CLASS="FUNCTION" |
|
1555 >File::Glob</CODE |
|
1556 > for details.) |
|
1557 </P |
|
1558 ></DD |
|
1559 ><DT |
|
1560 >xmlEncoding</DT |
|
1561 ><DD |
|
1562 ><P |
|
1563 ><ACRONYM |
|
1564 CLASS="ACRONYM" |
|
1565 >XML</ACRONYM |
|
1566 > files charset encoding.</P |
|
1567 ></DD |
|
1568 ></DL |
|
1569 ></DIV |
|
1570 ></DD |
|
1571 ><DT |
|
1572 ><TT |
|
1573 CLASS="FILENAME" |
|
1574 ><TT |
|
1575 CLASS="REPLACEABLE" |
|
1576 ><I |
|
1577 >image.jpg</I |
|
1578 ></TT |
|
1579 ></TT |
|
1580 ></DT |
|
1581 ><DD |
|
1582 ><P |
|
1583 >The <ACRONYM |
|
1584 CLASS="ACRONYM" |
|
1585 >EXIF</ACRONYM |
|
1586 > tags are extracted from |
|
1587 the image. Currently only the |
|
1588 <CODE |
|
1589 CLASS="SGMLTAG" |
|
1590 >Orientation</CODE |
|
1591 > tag influences the |
|
1592 processing, but a variety of settings are copied into the |
|
1593 <ACRONYM |
|
1594 CLASS="ACRONYM" |
|
1595 >HTML</ACRONYM |
|
1596 > file generated via the |
|
1597 <TT |
|
1598 CLASS="FILENAME" |
|
1599 >details.html</TT |
|
1600 > template.</P |
|
1601 ></DD |
|
1602 ><DT |
|
1603 ><TT |
|
1604 CLASS="FILENAME" |
|
1605 ><TT |
|
1606 CLASS="REPLACEABLE" |
|
1607 ><I |
|
1608 >image.jpg</I |
|
1609 ></TT |
|
1610 >.xml</TT |
|
1611 ></DT |
|
1612 ><DD |
|
1613 ><P |
|
1614 >The <ACRONYM |
|
1615 CLASS="ACRONYM" |
|
1616 >XML</ACRONYM |
|
1617 > file contains an |
|
1618 <CODE |
|
1619 CLASS="SGMLTAG" |
|
1620 >image</CODE |
|
1621 > element, which contains three child |
|
1622 elements:</P |
|
1623 ><P |
|
1624 ></P |
|
1625 ><DIV |
|
1626 CLASS="VARIABLELIST" |
|
1627 ><DL |
|
1628 ><DT |
|
1629 ><CODE |
|
1630 CLASS="SGMLTAG" |
|
1631 >description</CODE |
|
1632 ></DT |
|
1633 ><DD |
|
1634 ><P |
|
1635 >which has <CODE |
|
1636 CLASS="SGMLTAG" |
|
1637 >field</CODE |
|
1638 > children that |
|
1639 contain per-image data. The <CODE |
|
1640 CLASS="SGMLTAG" |
|
1641 >name</CODE |
|
1642 > |
|
1643 attribute names the tag (allowing simple |
|
1644 extensibility, see the |
|
1645 <TT |
|
1646 CLASS="FILENAME" |
|
1647 >bins_edit</TT |
|
1648 > |
|
1649 <CODE |
|
1650 CLASS="OPTION" |
|
1651 >--generic</CODE |
|
1652 > flag) but |
|
1653 <TT |
|
1654 CLASS="FILENAME" |
|
1655 >bins</TT |
|
1656 > itself currently only |
|
1657 makes use of</P |
|
1658 ><P |
|
1659 ></P |
|
1660 ><TABLE |
|
1661 BORDER="0" |
|
1662 ><TBODY |
|
1663 ><TR |
|
1664 ><TD |
|
1665 >title</TD |
|
1666 ></TR |
|
1667 ><TR |
|
1668 ><TD |
|
1669 >description</TD |
|
1670 ></TR |
|
1671 ><TR |
|
1672 ><TD |
|
1673 >people</TD |
|
1674 ></TR |
|
1675 ><TR |
|
1676 ><TD |
|
1677 >location</TD |
|
1678 ></TR |
|
1679 ><TR |
|
1680 ><TD |
|
1681 >date</TD |
|
1682 ></TR |
|
1683 ><TR |
|
1684 ><TD |
|
1685 >event</TD |
|
1686 ></TR |
|
1687 ></TBODY |
|
1688 ></TABLE |
|
1689 ><P |
|
1690 ></P |
|
1691 ></DD |
|
1692 ><DT |
|
1693 ><CODE |
|
1694 CLASS="SGMLTAG" |
|
1695 >bins</CODE |
|
1696 ></DT |
|
1697 ><DD |
|
1698 ><P |
|
1699 >which works as described with the |
|
1700 <TT |
|
1701 CLASS="FILENAME" |
|
1702 >binsrc</TT |
|
1703 > file settings, except |
|
1704 that many of the settings are not meaningful in the |
|
1705 context of a single picture.</P |
|
1706 ></DD |
|
1707 ><DT |
|
1708 ><CODE |
|
1709 CLASS="SGMLTAG" |
|
1710 >exif</CODE |
|
1711 ></DT |
|
1712 ><DD |
|
1713 ><P |
|
1714 >which has a cache of values copied from the |
|
1715 <ACRONYM |
|
1716 CLASS="ACRONYM" |
|
1717 >EXIF</ACRONYM |
|
1718 > tags in the image, to allow |
|
1719 simpler processing by other tools.</P |
|
1720 ><P |
|
1721 >If a user wants to override the |
|
1722 <ACRONYM |
|
1723 CLASS="ACRONYM" |
|
1724 >EXIF</ACRONYM |
|
1725 > values and provide a |
|
1726 replacement (such as a corrected |
|
1727 <CODE |
|
1728 CLASS="SGMLTAG" |
|
1729 >Orientation</CODE |
|
1730 > or an |
|
1731 <CODE |
|
1732 CLASS="SGMLTAG" |
|
1733 >Owner</CODE |
|
1734 > setting that reflects who |
|
1735 you loaned the camera to) adding a |
|
1736 <CODE |
|
1737 CLASS="SGMLTAG" |
|
1738 >priority</CODE |
|
1739 > attribute with a value |
|
1740 of "1" will prevent <TT |
|
1741 CLASS="FILENAME" |
|
1742 >bins</TT |
|
1743 > from |
|
1744 replacing it with the value in the image.</P |
|
1745 ></DD |
|
1746 ></DL |
|
1747 ></DIV |
|
1748 ></DD |
|
1749 ><DT |
|
1750 ><TT |
|
1751 CLASS="FILENAME" |
|
1752 >album.xml</TT |
|
1753 ></DT |
|
1754 ><DD |
|
1755 ><P |
|
1756 >This file contains an |
|
1757 <CODE |
|
1758 CLASS="SGMLTAG" |
|
1759 >album</CODE |
|
1760 > element, which contains |
|
1761 <CODE |
|
1762 CLASS="SGMLTAG" |
|
1763 >description</CODE |
|
1764 > and <CODE |
|
1765 CLASS="SGMLTAG" |
|
1766 >bins</CODE |
|
1767 > |
|
1768 stanza as described for an image. The are extensible in |
|
1769 the same manner, but <TT |
|
1770 CLASS="FILENAME" |
|
1771 >bins</TT |
|
1772 > only makes |
|
1773 use of</P |
|
1774 ><P |
|
1775 ></P |
|
1776 ><TABLE |
|
1777 BORDER="0" |
|
1778 ><TBODY |
|
1779 ><TR |
|
1780 ><TD |
|
1781 >dirname</TD |
|
1782 ></TR |
|
1783 ><TR |
|
1784 ><TD |
|
1785 >descFileName</TD |
|
1786 ></TR |
|
1787 ><TR |
|
1788 ><TD |
|
1789 >shortdesc</TD |
|
1790 ></TR |
|
1791 ><TR |
|
1792 ><TD |
|
1793 >title</TD |
|
1794 ></TR |
|
1795 ><TR |
|
1796 ><TD |
|
1797 >sampleimage</TD |
|
1798 ></TR |
|
1799 ><TR |
|
1800 ><TD |
|
1801 >longdesc</TD |
|
1802 ></TR |
|
1803 ></TBODY |
|
1804 ></TABLE |
|
1805 ><P |
|
1806 ></P |
|
1807 ></DD |
|
1808 ><DT |
|
1809 ><TT |
|
1810 CLASS="FILENAME" |
|
1811 >include_images.txt</TT |
|
1812 ></DT |
|
1813 ><DD |
|
1814 ><P |
|
1815 >includes image filenames (relative to the current |
|
1816 album, i.e. the directory where the |
|
1817 <TT |
|
1818 CLASS="FILENAME" |
|
1819 >include_images.txt</TT |
|
1820 > file is stored.) |
|
1821 Each filename appears on a line by itself; a line |
|
1822 beginning with a <TT |
|
1823 CLASS="LITERAL" |
|
1824 >#</TT |
|
1825 > is a comment, and |
|
1826 lines composed entirely of whitespace are ignored. |
|
1827 Otherwise, the line is exactly the filename. These images |
|
1828 are included in the order listed, and added after any that |
|
1829 actually appear in the directory.</P |
|
1830 ></DD |
|
1831 ><DT |
|
1832 ><TT |
|
1833 CLASS="FILENAME" |
|
1834 ><TT |
|
1835 CLASS="REPLACEABLE" |
|
1836 ><I |
|
1837 >template</I |
|
1838 ></TT |
|
1839 >.html</TT |
|
1840 ></DT |
|
1841 ><DD |
|
1842 ><P |
|
1843 >There are a number of template |
|
1844 <ACRONYM |
|
1845 CLASS="ACRONYM" |
|
1846 >HTML</ACRONYM |
|
1847 >files which are used to generate |
|
1848 the actual images. The base names of these are</P |
|
1849 ><P |
|
1850 ></P |
|
1851 ><TABLE |
|
1852 BORDER="0" |
|
1853 ><TBODY |
|
1854 ><TR |
|
1855 ><TD |
|
1856 >tree</TD |
|
1857 ></TR |
|
1858 ><TR |
|
1859 ><TD |
|
1860 >imagelist</TD |
|
1861 ></TR |
|
1862 ><TR |
|
1863 ><TD |
|
1864 >subalbum</TD |
|
1865 ></TR |
|
1866 ><TR |
|
1867 ><TD |
|
1868 >thumbnail</TD |
|
1869 ></TR |
|
1870 ><TR |
|
1871 ><TD |
|
1872 >details</TD |
|
1873 ></TR |
|
1874 ><TR |
|
1875 ><TD |
|
1876 >image</TD |
|
1877 ></TR |
|
1878 ></TBODY |
|
1879 ></TABLE |
|
1880 ><P |
|
1881 ></P |
|
1882 ><P |
|
1883 >The default versions of these files in |
|
1884 <TT |
|
1885 CLASS="FILENAME" |
|
1886 >/etc/bins/templates.default</TT |
|
1887 > should |
|
1888 show how they work, as does the |
|
1889 <TT |
|
1890 CLASS="FILENAME" |
|
1891 >HTML::Template</TT |
|
1892 > documentation. Aside |
|
1893 from the <TT |
|
1894 CLASS="LITERAL" |
|
1895 >COLOR</TT |
|
1896 > substitutions described |
|
1897 above, a template can also reference</P |
|
1898 ><P |
|
1899 ></P |
|
1900 ><TABLE |
|
1901 BORDER="0" |
|
1902 ><TBODY |
|
1903 ><TR |
|
1904 ><TD |
|
1905 >BINS_VERSION</TD |
|
1906 ></TR |
|
1907 ><TR |
|
1908 ><TD |
|
1909 >ENCODING</TD |
|
1910 ></TR |
|
1911 ><TR |
|
1912 ><TD |
|
1913 >GENERATED_DATE</TD |
|
1914 ></TR |
|
1915 ><TR |
|
1916 ><TD |
|
1917 >BINS_ID</TD |
|
1918 ></TR |
|
1919 ></TBODY |
|
1920 ></TABLE |
|
1921 ><P |
|
1922 ></P |
|
1923 ></DD |
|
1924 ></DL |
|
1925 ></DIV |
|
1926 ></DIV |
|
1927 ><DIV |
|
1928 CLASS="REFSECT1" |
|
1929 ><A |
|
1930 NAME="AEN668" |
|
1931 ></A |
|
1932 ><H2 |
|
1933 >SEE ALSO</H2 |
|
1934 ><P |
|
1935 >bins_edit (1), jpegtran (1), File::Glob, HTML::Template, imagemagick.</P |
|
1936 ></DIV |
|
1937 ><DIV |
|
1938 CLASS="REFSECT1" |
|
1939 ><A |
|
1940 NAME="AEN671" |
|
1941 ></A |
|
1942 ><H2 |
|
1943 >AUTHOR</H2 |
|
1944 ><P |
|
1945 >This manual page was written by Mark W. Eichin <CODE |
|
1946 CLASS="EMAIL" |
|
1947 ><<A |
|
1948 HREF="mailto:eichin@thok.org" |
|
1949 >eichin@thok.org</A |
|
1950 >></CODE |
|
1951 > for |
|
1952 the <SPAN |
|
1953 CLASS="PRODUCTNAME" |
|
1954 >Debian</SPAN |
|
1955 > system (but may be used by others). As it is |
|
1956 mostly derived from the <TT |
|
1957 CLASS="FILENAME" |
|
1958 >bins</TT |
|
1959 > program |
|
1960 itself, it is covered by the <ACRONYM |
|
1961 CLASS="ACRONYM" |
|
1962 >GNU</ACRONYM |
|
1963 > General Public License.</P |
|
1964 ></DIV |
|
1965 ></BODY |
|
1966 ></HTML |
|
1967 > |