Mercurial > bins
diff doc/bins_man.html @ 0:a84c32f131df 1.1.29
Import vendor version
| author | Peter Gervai <grin@grin.hu> |
|---|---|
| date | Wed, 15 Oct 2008 23:28:56 +0200 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/bins_man.html Wed Oct 15 23:28:56 2008 +0200 @@ -0,0 +1,1967 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd"> +<HTML +><HEAD +><TITLE +>BINS</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD +><BODY +CLASS="REFENTRY" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><H1 +><A +NAME="AEN1" +></A +>BINS</H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN15" +></A +><H2 +>Name</H2 +>bins -- Generate a static HTML photo albums using XML and EXIF tags</DIV +><DIV +CLASS="REFSYNOPSISDIV" +><A +NAME="AEN18" +></A +><H2 +>Synopsis</H2 +><P +><B +CLASS="COMMAND" +>bins</B +> [<CODE +CLASS="OPTION" +>-f <TT +CLASS="REPLACEABLE" +><I +>config_file</I +></TT +></CODE +>] [<CODE +CLASS="OPTION" +>-o <TT +CLASS="REPLACEABLE" +><I +>STR</I +></TT +></CODE +>] [<CODE +CLASS="OPTION" +>-d <TT +CLASS="REPLACEABLE" +><I +>STR</I +></TT +></CODE +>] [<CODE +CLASS="OPTION" +>-c <TT +CLASS="REPLACEABLE" +><I +>color_style</I +></TT +></CODE +>] [<CODE +CLASS="OPTION" +>-s <TT +CLASS="REPLACEABLE" +><I +>style</I +></TT +></CODE +>] [<CODE +CLASS="OPTION" +>-t <TT +CLASS="REPLACEABLE" +><I +>template_dir</I +></TT +></CODE +>] [<CODE +CLASS="OPTION" +>-p</CODE +>] [<CODE +CLASS="OPTION" +>-e</CODE +>] [<CODE +CLASS="OPTION" +>-i <TT +CLASS="REPLACEABLE" +><I +>iKey,iKey...</I +></TT +></CODE +>] [<CODE +CLASS="OPTION" +>-v <TT +CLASS="REPLACEABLE" +><I +>X</I +></TT +></CODE +>] [<CODE +CLASS="OPTION" +>-h</CODE +>] {<TT +CLASS="REPLACEABLE" +><I +>source_dir</I +></TT +>} {<TT +CLASS="REPLACEABLE" +><I +>target_dir</I +></TT +>}</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN55" +></A +><H2 +>DESCRIPTION</H2 +><P +>This manual page documents briefly the + <B +CLASS="COMMAND" +>bins</B +> command.</P +><P +>This manual page was written for the <SPAN +CLASS="PRODUCTNAME" +>Debian</SPAN +> distribution + because the original program does not have a manual page. + Instead, it has documentation in <ACRONYM +CLASS="ACRONYM" +>HTML</ACRONYM +> in + <TT +CLASS="FILENAME" +>/usr/share/doc/bins/index.html</TT +> as well as a + <CODE +CLASS="OPTION" +>-h</CODE +> option.</P +><P +><B +CLASS="COMMAND" +>bins</B +> is a program that takes a + collection of directories and files containing + <ACRONYM +CLASS="ACRONYM" +>JPEG</ACRONYM +> images and <ACRONYM +CLASS="ACRONYM" +>XML</ACRONYM +> + descriptions, combines them with a set of + <ACRONYM +CLASS="ACRONYM" +>HTML</ACRONYM +> templates, and produces a complete photo + gallery of static <ACRONYM +CLASS="ACRONYM" +>HTML</ACRONYM +> files, rescaled images + at three sizes, and thumbnails.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN70" +></A +><H2 +>OPTIONS</H2 +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +><CODE +CLASS="OPTION" +>-f <TT +CLASS="REPLACEABLE" +><I +>config_file</I +></TT +></CODE +></DT +><DD +><P +>use an alternative configuration file, instead of + <TT +CLASS="FILENAME" +>~/.bins/binsrc.</TT +>.</P +></DD +><DT +><CODE +CLASS="OPTION" +>-o <TT +CLASS="REPLACEABLE" +><I +>STR</I +></TT +></CODE +></DT +><DD +><P +>Tells script to use only one copy of image using + <ACRONYM +CLASS="ACRONYM" +>HTML</ACRONYM +> size specs (height, width specs in the image + tag) for scaled versions (instead of generating + several images, one for each size).</P +><P +>Default is false.</P +><P +><TT +CLASS="REPLACEABLE" +><I +>STR</I +></TT +> is an optional argument + to set how the one image is generated. Possible values: + <P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +>scaled</DT +><DD +><P +>(make scaled copy of orig in target_dir + hierarchy, sized to max size). Default.</P +></DD +><DT +>copied</DT +><DD +><P +>(copy orig to web dir)</P +></DD +><DT +>custom</DT +><DD +><P +>(use copy if filesize < 1meg + resize, resave, if bigger than 1 meg)</P +></DD +></DL +></DIV +> + </P +></DD +><DT +><CODE +CLASS="OPTION" +>-d <TT +CLASS="REPLACEABLE" +><I +>STR</I +></TT +></CODE +></DT +><DD +><P +>Determine if tags found in <ACRONYM +CLASS="ACRONYM" +>EXIF</ACRONYM +> structure are + added in desc files.</P +><P +><TT +CLASS="REPLACEABLE" +><I +>STR</I +></TT +> is one of "always", "never" or "exist" + ("exist" only adds if the desc file already exist.) + Default is always.</P +></DD +><DT +><CODE +CLASS="OPTION" +>-c <TT +CLASS="REPLACEABLE" +><I +>color_style</I +></TT +></CODE +></DT +><DD +><P +> Color style to use. Can be <TT +CLASS="LITERAL" +>blue</TT +> + (default one), <TT +CLASS="LITERAL" +>green</TT +>, + <TT +CLASS="LITERAL" +>ivory</TT +> and <TT +CLASS="LITERAL" +>pink</TT +> or + any other one defined in configuration/description files. + This option is deprecated (and thus, not supported by all + templates), in favor of alternate stylesheets and the + <TT +CLASS="LITERAL" +>customStyleSheet</TT +> parameter.</P +></DD +><DT +><CODE +CLASS="OPTION" +>-s <TT +CLASS="REPLACEABLE" +><I +>style</I +></TT +></CODE +></DT +><DD +><P +>Template style to use (styles provided for now are + <TT +CLASS="LITERAL" +>joi</TT +>, <TT +CLASS="LITERAL" +>marc</TT +>, + <TT +CLASS="LITERAL" +>martin</TT +>, <TT +CLASS="LITERAL" +>mwolson</TT +> + <TT +CLASS="LITERAL" +>petrus</TT +>, <TT +CLASS="LITERAL" +>satyap</TT +> and + <TT +CLASS="LITERAL" +>swigs</TT +>).</P +></DD +><DT +><CODE +CLASS="OPTION" +>-t <TT +CLASS="REPLACEABLE" +><I +>template_dir</I +></TT +></CODE +></DT +><DD +><P +>Specify location of html templates.</P +><P +>Default is <TT +CLASS="FILENAME" +>~/.bins</TT +>, falling back + to default versions in + <TT +CLASS="FILENAME" +>/etc/bins/templates.<TT +CLASS="REPLACEABLE" +><I +>style</I +></TT +></TT +>.</P +></DD +><DT +><CODE +CLASS="OPTION" +>-p</CODE +></DT +><DD +><P +>Numbers preceding the album title, followed by + an underscore are stripped. + If this option is given, then prefix ordering + numbers on directories are removed. For example, + if one has directories <TT +CLASS="FILENAME" +>may</TT +>, + <TT +CLASS="FILENAME" +>june</TT +>, and <TT +CLASS="FILENAME" +>august</TT +>, they + can be renamed <TT +CLASS="FILENAME" +>0_may</TT +>, + <TT +CLASS="FILENAME" +>1_june</TT +>, and <TT +CLASS="FILENAME" +>2_august</TT +> and + they will appear in the album in the correct + order.</P +></DD +><DT +><CODE +CLASS="OPTION" +>-e</CODE +></DT +><DD +><P +>Tells the script to generate an editable version of + the album. If set, some more links and icons are added to + directly access the <TT +CLASS="FILENAME" +>.xml</TT +> files for + editing. This is for editing purposes, not for a final + album.</P +></DD +><DT +><CODE +CLASS="OPTION" +>-i <TT +CLASS="REPLACEABLE" +><I +>iKey,iKey...</I +></TT +></CODE +></DT +><DD +><P +>Sets "ignore" keywords which will be compared against + the contents of the <CODE +CLASS="SGMLTAG" +>ignore</CODE +> field of the + album's XML file, in the <CODE +CLASS="SGMLTAG" +>ignore</CODE +> field in + <CODE +CLASS="SGMLTAG" +>description</CODE +> section. If any of the + <TT +CLASS="REPLACEABLE" +><I +>iKeys</I +></TT +> match those in the album's + "ignore" field, that album will not be processed. See also + the <CODE +CLASS="SGMLTAG" +>ignore</CODE +> parameter.</P +></DD +><DT +><CODE +CLASS="OPTION" +>-n <TT +CLASS="REPLACEABLE" +><I +>iKey,iKey...</I +></TT +></CODE +></DT +><DD +><P +>Sets "hidden" keywords which will be compared against + the contents of the <CODE +CLASS="SGMLTAG" +>ignore</CODE +> field of the + album's XML file, in the <CODE +CLASS="SGMLTAG" +>ignore</CODE +> field in + <CODE +CLASS="SGMLTAG" +>description</CODE +> section. If any of the + <TT +CLASS="REPLACEABLE" +><I +>iKeys</I +></TT +> match those in the album's + "ignore" field, that album will be hidden: it will not be + linked anywhere. See also the <CODE +CLASS="SGMLTAG" +>hidden</CODE +> + parameter.</P +></DD +><DT +><CODE +CLASS="OPTION" +>-v <TT +CLASS="REPLACEABLE" +><I +>X</I +></TT +></CODE +></DT +><DD +><P +><TT +CLASS="REPLACEABLE" +><I +>X</I +></TT +> is the verbosity level (between 0 and 3)</P +></DD +><DT +><CODE +CLASS="OPTION" +>-h</CODE +></DT +><DD +><P +>Show the help string this man page was originally based on.</P +></DD +></DL +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN197" +></A +><H2 +>SETTINGS</H2 +><P +>bins is also controlled by other files.</P +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +><TT +CLASS="FILENAME" +>/etc/bins/binsrc</TT +>, <TT +CLASS="FILENAME" +>~/.bins/binsrc</TT +></DT +><DD +><P +>The <TT +CLASS="FILENAME" +>binsrc</TT +> files are + <ACRONYM +CLASS="ACRONYM" +>XML</ACRONYM +> files with a top level + <CODE +CLASS="SGMLTAG" +>bins</CODE +> tag. There are three element + names with <CODE +CLASS="SGMLTAG" +>bins</CODE +>: <CODE +CLASS="SGMLTAG" +>parameter</CODE +>, + <CODE +CLASS="SGMLTAG" +>colors</CODE +>, and <CODE +CLASS="SGMLTAG" +>sizes</CODE +>. + Each of these has a <CODE +CLASS="SGMLTAG" +>name</CODE +> attribute + which names the data in the element content.</P +><P +>The <CODE +CLASS="SGMLTAG" +>colors</CODE +> element has a + <CODE +CLASS="SGMLTAG" +>style</CODE +> attribute, that can be used with + the <CODE +CLASS="SGMLTAG" +>colorStyle</CODE +> parameter or the + <CODE +CLASS="SGMLTAG" +>-c</CODE +> command line option. It contains + <CODE +CLASS="SGMLTAG" +>color</CODE +> elements. The + <CODE +CLASS="SGMLTAG" +>color</CODE +> elements name has one of the + following values which is substituted into the template + files. This tag is deprecated, in favor of alternate + stylesheets and the <TT +CLASS="LITERAL" +>customStyleSheet</TT +> + parameter.</P +><P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +>PAGE_BACK</TD +></TR +><TR +><TD +>PAGE_TITLE</TD +></TR +><TR +><TD +>MAINBAR_BACK</TD +></TR +><TR +><TD +>MAINBAR_TITLE</TD +></TR +><TR +><TD +>MAINBAR_LINK</TD +></TR +><TR +><TD +>MAINBAR_CURRENTPAGE</TD +></TR +><TR +><TD +>SUBBAR_BACK</TD +></TR +><TR +><TD +>SUBBAR_LINK</TD +></TR +><TR +><TD +>SUBBAR_CURRENTPAGE</TD +></TR +><TR +><TD +>SUBBAR_TITLE</TD +></TR +></TBODY +></TABLE +><P +></P +><P +>The <CODE +CLASS="SGMLTAG" +>sizes</CODE +> element contains + <CODE +CLASS="SGMLTAG" +>size</CODE +> elements which each have a + <CODE +CLASS="SGMLTAG" +>name</CODE +> attribute, a + <CODE +CLASS="SGMLTAG" +>shortname</CODE +> attribute, a + <CODE +CLASS="SGMLTAG" +>height</CODE +> attribute, and a + <CODE +CLASS="SGMLTAG" +>width</CODE +> attribute. These default to</P +><P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +>Small, Sm, 40%, 40%</TD +></TR +><TR +><TD +>Medium, Med, 64%, 64%</TD +></TR +><TR +><TD +>Large, Lg, 100%, 100%</TD +></TR +></TBODY +></TABLE +><P +></P +><P +><CODE +CLASS="SGMLTAG" +>name</CODE +> and + <CODE +CLASS="SGMLTAG" +>shortname</CODE +> are used in the output + <ACRONYM +CLASS="ACRONYM" +>HTML</ACRONYM +> and in generated filenames. The + default values listed above are passed through + <CODE +CLASS="FUNCTION" +>gettext</CODE +> for localization; overrides + in <TT +CLASS="FILENAME" +>binsrc</TT +> files are not, and should + be in the desired language.</P +><P +>For the <CODE +CLASS="SGMLTAG" +>parameter</CODE +> elements the + <CODE +CLASS="SGMLTAG" +>name</CODE +> attribute names one of the + following parameters.</P +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +>addExifToDescFile</DT +><DD +><P +>If set to 1 (the default), write <ACRONYM +CLASS="ACRONYM" +>EXIF</ACRONYM +> data found in + the image file to the image desc file (but see also + the <CODE +CLASS="OPTION" +>-d</CODE +> flag).</P +></DD +><DT +>albumThumbInSubAlbumPage</DT +><DD +><P +>If set to 1 (the default), display the current + album thumbnail in sub-albums page + if it has pictures, with links to + the thumbnails page.</P +></DD +><DT +>allThumbnailsPage</DT +><DD +><P +>If set to <TT +CLASS="LITERAL" +>1</TT +>, generate a page with all + thumbnails in the album and + sub-albums. This is deactivated + because it is an alpha feature which + seems to not work properly.</P +></DD +><DT +>backgroundImage</DT +><DD +><P +>Set this to the image that should be displayed + as the background of the album pages. The Image will + be copied to the static files directory. This works + only with joi, marc, martin and petrus templates for now. + </P +></DD +><DT +>borderOnThumbnails</DT +><DD +><P +>Width of the border of the thumbnail's image in + the thumbnails page, in pixels. <TT +CLASS="LITERAL" +>0</TT +> + means no border. + </P +></DD +><DT +>colorStyle</DT +><DD +><P +>Name of the color style to use. Default is + <TT +CLASS="FILENAME" +>blue</TT +>. See also the + <CODE +CLASS="OPTION" +>-c</CODE +> option which takes precedence. + This option is deprecated (and thus, not supported by + all templates), in favor of alternate stylesheets and + the <TT +CLASS="LITERAL" +>customStyleSheet</TT +> + parameter.</P +></DD +><DT +>compactHTML</DT +><DD +><P +>If set to <TT +CLASS="LITERAL" +>1</TT +>, generated + <ACRONYM +CLASS="ACRONYM" +>HTML</ACRONYM +> code is cleaned up to reduce + the size of pages and thus, speed up browsing. This + reduces the size of <ACRONYM +CLASS="ACRONYM" +>HTML</ACRONYM +> BINS files + by about 30%. See <B +CLASS="COMMAND" +>HTML::Clean(3)</B +> to + know how optimizations are performed.</P +></DD +><DT +>configFileName</DT +><DD +><P +>Can be set in the global config file, but only + influences the basename of the local user config + file. Defaults to <TT +CLASS="FILENAME" +>.binsrc</TT +>.</P +></DD +><DT +>createEmptyDescFields</DT +><DD +><P +>If set to 1 (the default), add empty description + fields in the <CODE +CLASS="SGMLTAG" +>description</CODE +> section + when the image description file is created to ease + later manual editing.</P +></DD +><DT +>createHtaccess</DT +><DD +><P +>If <TT +CLASS="LITERAL" +>1</TT +>, create an Apache + <TT +CLASS="FILENAME" +>.htaccess</TT +> file in the root dir of + the album with the encoding charset bound to + <TT +CLASS="FILENAME" +>html</TT +> and <TT +CLASS="FILENAME" +>htm</TT +> + files. This is a parameter global for the album, it + can't be set in album.xml.</P +></DD +><DT +>customStyleSheet</DT +><DD +><P +>Set this to the CSS file that should be used as + the stylesheet for the album pages. The CSS file will + be copied to the static files directory. This works + only with joi, marc, martin and petrus templates for now. + </P +></DD +><DT +>dateString</DT +><DD +><P +>Specify the format of date strings. This variable + accepts all formats supported by <B +CLASS="COMMAND" +>date(1)</B +>. + </P +></DD +><DT +>defaultSize</DT +><DD +><P +>Size to use when user clicks directly on the + thumbnail in the thumbnails page instead of one of + the size name. 0 is the first size + (<TT +CLASS="LITERAL" +>Small</TT +> in the default config), 1 + the second (<TT +CLASS="LITERAL" +>Medium</TT +>), and so + on. Set this variable to -1 if you don't want the + thumbnail to be clickable.</P +></DD +><DT +>deExifyImages</DT +><DD +><P +>If set to 1, do NOT copy exif data found in the + source images to any of the generated resized images. + Setting this option can yield significant space + savings, especially for thumbnail and imagelist + pages.</P +></DD +><DT +>emptyAlbumDesc</DT +><DD +><P +>If set to 1, and album desciption is not set, no + message will be displayed (instead of the "No + long/short description available" one).</P +></DD +><DT +>enlarge</DT +><DD +><P +>If set to 1, small images are enlarged + in the "med" and "large" series. (defaults to 0).</P +></DD +><DT +>excludeBackgroundImage</DT +><DD +><P +>If set to 1, the image with the name given in + <TT +CLASS="LITERAL" +>backgroundImage</TT +> will be excluded from the + current directory. + </P +></DD +><DT +>excludeDirs</DT +><DD +><P +>Exclude directories that match this regexp (if + set). Set to ^CVS$ in default config, so that CVS + subdirs aren't processed by bins. + </P +></DD +><DT +>excludeFiles</DT +><DD +><P +>Exclude image files that match this regexp (if + set). No image files are excluded in default config. + </P +></DD +><DT +>globalConfigDir</DT +><DD +><P +>Can't usefully be set, since it has already been + used when the first config file is read. Defaults + to <TT +CLASS="FILENAME" +>/etc/bins</TT +>.</P +></DD +><DT +>hidden</DT +><DD +><P +>Put here a comma separated list of keyword. If + one on this keyword is found in the + <TT +CLASS="LITERAL" +>ignore</TT +> field in the + <CODE +CLASS="SGMLTAG" +>description</CODE +> section of an + <TT +CLASS="FILENAME" +>album.xml</TT +>, then this sub-album + will be hidden, i.e. it will be generated but not + linked anywhere. You can also use the + <TT +CLASS="LITERAL" +>-n</TT +> command line option.</P +></DD +><DT +>homeURL</DT +><DD +><P +>Set this to your home page's + <ACRONYM +CLASS="ACRONYM" +>URL</ACRONYM +>. This is used for the leave button + in some templates.</P +></DD +><DT +>htmlEncoding</DT +><DD +><P +><ACRONYM +CLASS="ACRONYM" +>HTML</ACRONYM +> pages charset encoding.</P +></DD +><DT +>ignore</DT +><DD +><P +>Put here a comma separated list of keyword. If + one on this keyword is found in the + <TT +CLASS="LITERAL" +>ignore</TT +> field in the + <CODE +CLASS="SGMLTAG" +>description</CODE +> section of an + <TT +CLASS="FILENAME" +>album.xml</TT +>, then this sub-album + will be ignored, i.e. it will not be processed. You + can also use the <TT +CLASS="LITERAL" +>-i</TT +> command line + option.</P +></DD +><DT +>imagePageCycling</DT +><DD +><P +>If set to 0 next/prev-Links will be hidden if + the actual page is the last/first Image page.</P +></DD +><DT +>javaScriptPreloadImage</DT +><DD +><P +>If set to <TT +CLASS="LITERAL" +>1</TT +>, add some + javascript code in image pages to preload the next + image of the same size when current one is loaded, to + speed up the album browsing.</P +></DD +><DT +>javaScriptPreloadThumbs</DT +><DD +><P +>If set to <TT +CLASS="LITERAL" +>1</TT +>, add some + javascript code in thumbnails pages to preload + thumbnails of the next page when current one is + loaded, to speed up the album browsing.</P +></DD +><DT +>jpegQuality</DT +><DD +><P +>Quality of scaled jpegs (lower number = more + compression, lower quality) in 1-100 range (default + of 75). See imagemagick docs for more details.</P +></DD +><DT +>linkInsteadOfCopy</DT +><DD +><P +>If set to 1, we link the picture instead of + copying it if possible (i.e. scaleIfSameSize is set to + <TT +CLASS="LITERAL" +>0</TT +> and destination image doesn't + have to be rotated: <TT +CLASS="LITERAL" +>rotateImages</TT +> is + set to <TT +CLASS="LITERAL" +>original</TT +> or + <TT +CLASS="LITERAL" +>none</TT +>, or orientation is already + correct). Warning : if whenSrcSmaller is set + to enlarge, original image can be modified.</P +></DD +><DT +>linkRelative</DT +><DD +><P +> If set to 1, we use a relative path for the link if + <TT +CLASS="LITERAL" +>linkInsteadOfCopy</TT +> is set to 1. + </P +></DD +><DT +>maxAlbumsForLongSubAlbum</DT +><DD +><P +>If the number of sub albums is greater (than + this value which defaults to 20), + generate a short sub album page + instead of the long one. (Short sub album pages + appear to be unsupported at the moment; this option + is disabled.)</P +></DD +><DT +>noRotation</DT +><DD +><P +>Don't perform rotation on files matching this + regexp. This can used in conjunction with + <TT +CLASS="LITERAL" +>scaleIfSameSize=0</TT +> and a scaled size of + <TT +CLASS="LITERAL" +>100%x100%</TT +> to keep original pictures in + your album.</P +></DD +><DT +>numThumbsPerPage</DT +><DD +><P +>Number of thumbnails (default of 16) displayed + in each page in an album.</P +></DD +><DT +>pathImgNum</DT +><DD +><P +>If set to 1 the path in the imageview contains + the number of the current image.</P +></DD +><DT +>pathShowIcon</DT +><DD +><P +>If set to 1 the path contains icons.</P +></DD +><DT +>previewMaxWidth, previewMaxHeight</DT +><DD +><P +>Max thumbnail width and height (default 150x150).</P +></DD +><DT +>jpegProgressify</DT +><DD +><P +>whether to convert generated jpegs to + progressive using jpegtran (if available). can be + <TT +CLASS="LITERAL" +>never</TT +>, <TT +CLASS="LITERAL" +>always</TT +>, or + <TT +CLASS="LITERAL" +>smaller</TT +> (if the progressified file + is smaller than the baseline).</P +></DD +><DT +>reverseOrder</DT +><DD +><P +> Are we reversing sorting order for pictures or + directories ? 0=none, 1=dirs, 2=pix, 3=both. See + also <TT +CLASS="LITERAL" +>-r</TT +> command line option. + </P +></DD +><DT +>rotateImages</DT +><DD +><P +>Do we rotate images if the + <CODE +CLASS="SGMLTAG" +>Orientation</CODE +> <ACRONYM +CLASS="ACRONYM" +>EXIF</ACRONYM +> + tag is found? If set to <CODE +CLASS="SGMLTAG" +>original</CODE +> + (the default), the original image is rotated the first + time, and then it is left untouched. If set to + <CODE +CLASS="SGMLTAG" +>destination</CODE +>, this is all the scaled + images and thumbnails that are rotated. This is less + efficient, but the original images are preserved (and + is useful if the original images are read-only). If + set to <CODE +CLASS="SGMLTAG" +>none</CODE +>, no rotation is + performed.</P +></DD +><DT +>rotateWithJpegtran</DT +><DD +><P +>If set to <TT +CLASS="LITERAL" +>1</TT +>, + <TT +CLASS="FILENAME" +>bins</TT +> try to use the + <TT +CLASS="FILENAME" +>jpegtran</TT +> program to rotate + <ACRONYM +CLASS="ACRONYM" +>JPEG</ACRONYM +> images if it is + available. <TT +CLASS="FILENAME" +>jpegtran</TT +> is faster and + lossless, but some versions fail to perform rotation + correctly, so it is deactivated in default config. If + set to <TT +CLASS="LITERAL" +>0</TT +> or if + <TT +CLASS="FILENAME" +>jpegtran</TT +> is not found, + <TT +CLASS="FILENAME" +>mogrify</TT +> (from ImageMagick) is + used.</P +></DD +><DT +>scaleIfSameSize</DT +><DD +><P +>If set to 1, we scale the picture even + if destination size is the same as the + original picture, if set to 0 (the default), the + original image is just copied if the + size is correct.</P +></DD +><DT +>scaleMethod</DT +><DD +><P +>What method should be used to create scaled + pictures and thumbnails ? Can be either + <TT +CLASS="LITERAL" +>scale</TT +> or + <TT +CLASS="LITERAL" +>sample</TT +>. <TT +CLASS="LITERAL" +>sample</TT +> + is <TT +CLASS="LITERAL" +>faster</TT +>, scale is better. + </P +></DD +><DT +>searchEngine</DT +><DD +><P +> If 1, generate a search page. Images can be searched + on description fields set in the + <TT +CLASS="LITERAL" +>searchFields</TT +> parameter. + </P +></DD +><DT +>searchFields</DT +><DD +><P +> Space separated list of description field names used + by the search engine, if + <TT +CLASS="LITERAL" +>searchEngine</TT +> is set to 1. + </P +></DD +><DT +>searchLimit</DT +><DD +><P +> Maximum results returned by the search engine, if + <TT +CLASS="LITERAL" +>searchEngine</TT +> is set to 1. Note + that if this number is too high, it can hang the + browser. + </P +></DD +><DT +>stripDirPrefix</DT +><DD +><P +>If <TT +CLASS="LITERAL" +>1</TT +>, numbers preceding the + album title, followed by an underscore, are + stripped. If this parameter is set, then prefix + ordering numbers on directories are removed. For + example, if one has directories may, june, and august, + they can be renamed <TT +CLASS="FILENAME" +>0_may</TT +>, + <TT +CLASS="FILENAME" +>1_june</TT +>, and + <TT +CLASS="FILENAME" +>2_august</TT +> and they will appear in + the album in the correct order. This can be overridden + by the <TT +CLASS="LITERAL" +>-p</TT +> command line option.</P +></DD +><DT +>templateStyle</DT +><DD +><P +>Name of the template style to use. Default is + <TT +CLASS="FILENAME" +>swigs</TT +>. Other templates provided + with BINS are <TT +CLASS="FILENAME" +>joi</TT +>, + <TT +CLASS="FILENAME" +>marc</TT +>, <TT +CLASS="FILENAME" +>martin</TT +>, + <TT +CLASS="FILENAME" +>petrus</TT +> and + <TT +CLASS="FILENAME" +>satyap</TT +>. Several templates can be + used for different sub-album of an album, by using + this parameter in the <CODE +CLASS="SGMLTAG" +>bins</CODE +> section + of the <TT +CLASS="FILENAME" +>album.xml</TT +> files. See also + the <CODE +CLASS="OPTION" +>-s</CODE +> option which takes precedence + over binsrc (but not album.xml).</P +></DD +><DT +>thumbnailBackground</DT +><DD +><P +>If set to 1, add a background colour + (SUBBAR_BACK) to the thumbnail's cell in the + thumbnails page so that if the top and bottom borders + are wider than the image (for example, if it is in + portrait mode), instead of spilling over, there is a + border around the whole picture. By default, use the + PAGE_BACK color.</P +></DD +><DT +>thumbnailInImageList</DT +><DD +><P +>Display thumbnails on the Image List page, set + to 1 by default.</P +></DD +><DT +>thumbnailPageCycling</DT +><DD +><P +>If set to 0 next/prev-Links will be hidden if + the actual page is the last/first + Thumbnail page.</P +></DD +><DT +>thumbPrevNext</DT +><DD +><P +>If set to 1 (the default), display thumbnails close + to the previous and next link at the + bottom of the image page.</P +></DD +><DT +>thumbsPerRow</DT +><DD +><P +>Number of thumbnails (default of 4) displayed in each + row in an album.</P +></DD +><DT +>titleOnThumbnail</DT +><DD +><P +>Should the title be displayed on top on the + thumbnail in the thumbnails page? (defaults to 1.)</P +></DD +><DT +>treePreview</DT +><DD +><P +>If set to 1, preview thumbnails will be showed + in the album tree page. This works only with joi, + marc and petrus templates for now. + </P +></DD +><DT +>updateOriginalPerms</DT +><DD +><P +>If set to 1, read permissions on images will be + set, to ensure http deamon will be able to read + them. + </P +></DD +><DT +>userConfigDir</DT +><DD +><P +>Can be set in the global config file (since + after the user one is read, it is too late). + Defaults to <TT +CLASS="FILENAME" +>~/.bins</TT +> and is + processed by <CODE +CLASS="FUNCTION" +>bsd_glob</CODE +> (see + <CODE +CLASS="FUNCTION" +>File::Glob</CODE +> for details.) + </P +></DD +><DT +>xmlEncoding</DT +><DD +><P +><ACRONYM +CLASS="ACRONYM" +>XML</ACRONYM +> files charset encoding.</P +></DD +></DL +></DIV +></DD +><DT +><TT +CLASS="FILENAME" +><TT +CLASS="REPLACEABLE" +><I +>image.jpg</I +></TT +></TT +></DT +><DD +><P +>The <ACRONYM +CLASS="ACRONYM" +>EXIF</ACRONYM +> tags are extracted from + the image. Currently only the + <CODE +CLASS="SGMLTAG" +>Orientation</CODE +> tag influences the + processing, but a variety of settings are copied into the + <ACRONYM +CLASS="ACRONYM" +>HTML</ACRONYM +> file generated via the + <TT +CLASS="FILENAME" +>details.html</TT +> template.</P +></DD +><DT +><TT +CLASS="FILENAME" +><TT +CLASS="REPLACEABLE" +><I +>image.jpg</I +></TT +>.xml</TT +></DT +><DD +><P +>The <ACRONYM +CLASS="ACRONYM" +>XML</ACRONYM +> file contains an + <CODE +CLASS="SGMLTAG" +>image</CODE +> element, which contains three child + elements:</P +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +><CODE +CLASS="SGMLTAG" +>description</CODE +></DT +><DD +><P +>which has <CODE +CLASS="SGMLTAG" +>field</CODE +> children that + contain per-image data. The <CODE +CLASS="SGMLTAG" +>name</CODE +> + attribute names the tag (allowing simple + extensibility, see the + <TT +CLASS="FILENAME" +>bins_edit</TT +> + <CODE +CLASS="OPTION" +>--generic</CODE +> flag) but + <TT +CLASS="FILENAME" +>bins</TT +> itself currently only + makes use of</P +><P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +>title</TD +></TR +><TR +><TD +>description</TD +></TR +><TR +><TD +>people</TD +></TR +><TR +><TD +>location</TD +></TR +><TR +><TD +>date</TD +></TR +><TR +><TD +>event</TD +></TR +></TBODY +></TABLE +><P +></P +></DD +><DT +><CODE +CLASS="SGMLTAG" +>bins</CODE +></DT +><DD +><P +>which works as described with the + <TT +CLASS="FILENAME" +>binsrc</TT +> file settings, except + that many of the settings are not meaningful in the + context of a single picture.</P +></DD +><DT +><CODE +CLASS="SGMLTAG" +>exif</CODE +></DT +><DD +><P +>which has a cache of values copied from the + <ACRONYM +CLASS="ACRONYM" +>EXIF</ACRONYM +> tags in the image, to allow + simpler processing by other tools.</P +><P +>If a user wants to override the + <ACRONYM +CLASS="ACRONYM" +>EXIF</ACRONYM +> values and provide a + replacement (such as a corrected + <CODE +CLASS="SGMLTAG" +>Orientation</CODE +> or an + <CODE +CLASS="SGMLTAG" +>Owner</CODE +> setting that reflects who + you loaned the camera to) adding a + <CODE +CLASS="SGMLTAG" +>priority</CODE +> attribute with a value + of "1" will prevent <TT +CLASS="FILENAME" +>bins</TT +> from + replacing it with the value in the image.</P +></DD +></DL +></DIV +></DD +><DT +><TT +CLASS="FILENAME" +>album.xml</TT +></DT +><DD +><P +>This file contains an + <CODE +CLASS="SGMLTAG" +>album</CODE +> element, which contains + <CODE +CLASS="SGMLTAG" +>description</CODE +> and <CODE +CLASS="SGMLTAG" +>bins</CODE +> + stanza as described for an image. The are extensible in + the same manner, but <TT +CLASS="FILENAME" +>bins</TT +> only makes + use of</P +><P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +>dirname</TD +></TR +><TR +><TD +>descFileName</TD +></TR +><TR +><TD +>shortdesc</TD +></TR +><TR +><TD +>title</TD +></TR +><TR +><TD +>sampleimage</TD +></TR +><TR +><TD +>longdesc</TD +></TR +></TBODY +></TABLE +><P +></P +></DD +><DT +><TT +CLASS="FILENAME" +>include_images.txt</TT +></DT +><DD +><P +>includes image filenames (relative to the current + album, i.e. the directory where the + <TT +CLASS="FILENAME" +>include_images.txt</TT +> file is stored.) + Each filename appears on a line by itself; a line + beginning with a <TT +CLASS="LITERAL" +>#</TT +> is a comment, and + lines composed entirely of whitespace are ignored. + Otherwise, the line is exactly the filename. These images + are included in the order listed, and added after any that + actually appear in the directory.</P +></DD +><DT +><TT +CLASS="FILENAME" +><TT +CLASS="REPLACEABLE" +><I +>template</I +></TT +>.html</TT +></DT +><DD +><P +>There are a number of template + <ACRONYM +CLASS="ACRONYM" +>HTML</ACRONYM +>files which are used to generate + the actual images. The base names of these are</P +><P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +>tree</TD +></TR +><TR +><TD +>imagelist</TD +></TR +><TR +><TD +>subalbum</TD +></TR +><TR +><TD +>thumbnail</TD +></TR +><TR +><TD +>details</TD +></TR +><TR +><TD +>image</TD +></TR +></TBODY +></TABLE +><P +></P +><P +>The default versions of these files in + <TT +CLASS="FILENAME" +>/etc/bins/templates.default</TT +> should + show how they work, as does the + <TT +CLASS="FILENAME" +>HTML::Template</TT +> documentation. Aside + from the <TT +CLASS="LITERAL" +>COLOR</TT +> substitutions described + above, a template can also reference</P +><P +></P +><TABLE +BORDER="0" +><TBODY +><TR +><TD +>BINS_VERSION</TD +></TR +><TR +><TD +>ENCODING</TD +></TR +><TR +><TD +>GENERATED_DATE</TD +></TR +><TR +><TD +>BINS_ID</TD +></TR +></TBODY +></TABLE +><P +></P +></DD +></DL +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN668" +></A +><H2 +>SEE ALSO</H2 +><P +>bins_edit (1), jpegtran (1), File::Glob, HTML::Template, imagemagick.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN671" +></A +><H2 +>AUTHOR</H2 +><P +>This manual page was written by Mark W. Eichin <CODE +CLASS="EMAIL" +><<A +HREF="mailto:eichin@thok.org" +>eichin@thok.org</A +>></CODE +> for + the <SPAN +CLASS="PRODUCTNAME" +>Debian</SPAN +> system (but may be used by others). As it is + mostly derived from the <TT +CLASS="FILENAME" +>bins</TT +> program + itself, it is covered by the <ACRONYM +CLASS="ACRONYM" +>GNU</ACRONYM +> General Public License.</P +></DIV +></BODY +></HTML +> \ No newline at end of file