Provided by: album_4.10-2_all bug


       album - Make a web photo album


       album [album options]


       album is an HTML photo album generator that supports themes. It takes a directory of
       images and creates all the thumbnails and HTML that you need. It's fast, easy to use, and
       very powerful.

       Place your photos in a new directory somewhere inside your web pages.  Then run "album"
       from a command-line prompt with the directory path as an argument, and that's it.

       To use themes, make sure the "Themes" directory is inside your web path, and then use the
       -theme option.


       There are three types of options.  Boolean options, string/num options and array options.
       Boolean options can be turned off by prepending -no_:

       % album -no_image_pages

       String and number values are specified after a string option:

       % album -type gif % album -columns 5

       Array options can be specified two ways, with one argument at a time:

       % album -exif hi -exif there

       Or multiple arguments using the '--' form:

       % album --exif hi there --

       You can remove specific array options with -no_<option>:

       % album -no_exif hi

       Or clear all the array options with -clear_<option>:

       % album -clear_exif

       Boolean options:

       % album -q, -d, -D, -dtheme, -Dtheme, -virgin_check, -save_conf, -configure, -crf,
       -list_options, -image_pages, -thumbs, -dir_thumbs, -just_medium, -slideshow, -embed,
       -clean, -image_headers, -album_captions, -folder_count, -caption_edit, -file_sizes,
       -fix_urls, -known_images, -all, -hashes, -reverse_sort, -case_sort, -image_loop, -burn,
       -crop, -force, -force_html, -sample, -animated_gifs, -use_tcap

       String/number options:

       % album -thumb_post, -medium, -captions, -top, -sort, -body, -charset, -force_charset,
       -index, -default_index, -html, -type, -medium_type, -CROP, -dir, -sharpen, -plugin_post,
       -theme, -theme_url, -convert, -identify, -jhead, -ffmpeg, -conf_file, -dev_null, -windows,
       -cygwin, -tcap, -tcap_out, -cmdproxy, -header, -footer, -credit, -no_album, -hide_album,

       Array options:

       % album --lang_path, --exif, --exif_album, --exif_image, --add, --scale_opts,
       --medium_scale_opts, --thumb_scale_opts, --data_path, --plugin_path, --theme_path

       -h  Show usage

           To show more options.

           Show usage as deep as you like.

           Specify language(s)

           List out full language information

           Print out a new language file

           List HTML translations for each language Useful for creating multi-lingual images for
           themes Output is in HTML and utf-8, change charset as needed

           Add a path to search for language files [Default @DATA_PATH/lang]

       -q  Be quiet [Default OFF]

       -d  Set debug mode [Default OFF]

       -D  Heavy debug mode [Default OFF]

           Theme debug mode [Default OFF]

           Theme heavy debug mode [Default OFF]

           Read a .conf file

           Do the virgin check to see if you've run album before [Default ON]

           Save album.conf files in photo album [Default ON]

           Setup initial album site configuration [Default OFF]

           Display program version info

       -mv Move imgs across albums: see 'album -plugin_info utils/mv'

           Create plugin: see 'album -plugin_info utils/create_plugin'

   Album Options:
           Album hash output in computer readable format [Default OFF]

           Show default options and values for a given album [Default OFF]

           Create a page for each image [Default ON]

           Images have thumbnails [Default ON]

           Directories have thumbnail (if supported by theme) [Default ON]

           Additional postfix for thumbnails.

           Generate medium size images

           Don't link to full-size images [Default OFF]

           Slideshow capabilities (only with some themes) [Default OFF]

           Use image pages for non-picture image pages [Default ON]

           Number of image columns [Default 4]

           Remove unused thumbnails [Default OFF]

           Specify captions filename [Default captions.txt]

           Show header.txt on image pages (default theme only) [Default OFF]

           Also show captions on album page [Default ON]

           Show folder/image counts for each album [Default ON]

           Add comment tags so that caption_edit.cgi will work [Default OFF]

           Append exif info to captions.  Use %key 0n fmt string Example:  -exif "<br>Camera:
           %Camera model%" If any %keys% are not found by jhead, nothing is appended.

           -exif for just album pages

           -exif for just image pages

           Show image file sizes [Default OFF]

           Encode unsafe chars as 0x in URLs [Default ON]

           Only include known image types [Default ON]

           URL for 'Back' link on top page [Default ../]

           Do not hide files/directories starting with '.' [Default OFF]

           Add a new directory to the album it's been placed in

           Depth to descend directories (default infinite [-1]) [Default -1]

           Dereference symbolic links [Default 1]

           Show hash marks while generating thumbnails [Default ON]

           Limit length of image/dir names [Default 40]

           Sort type, captions, name, date, EXIF date ('exif') [Default captions]

           Sort in reverse [Default OFF]

           Use case sensitive sorting when sorting names [Default OFF]

           Specify <body> tags for non-theme output [Default <body>]

           Charset for non-theme and some theme output This is also set by using language files
           (with -lang)

           Force charset (not overridden by languages)

           Do first and last image pages loop around? [Default ON]

           Setup an album to burn to CD Implies '-index index.html' and '-no_theme_url' [Default

           Select the default 'index.html' to use.  For file://, try '-index index.html' to add
           'index.html' to index links.

           The file the webserver accesses when when no file is specified. [Default index.html]

           Default postfix for HTML files [Default .html]

   Thumbnail Options:
           Size of thumbnail [Default 133x133]

           Thumbnail type (gif, jpg, tiff,...) [Default jpg]

           Medium type (default is same type as full image)

           Crop the image to fit thumbnail size otherwise aspect will be maintained [Default OFF]

           Force cropping to be top, bottom, left or right

           Thumbnail directory [Default tn]

           Force overwrite of existing thumbnails and HTML otherwise they are only written when
           changed [Default OFF]

           Force rewrite of HTML [Default OFF]

           Use 'convert -sample' for thumbnails (faster, low quality) [Default OFF]

           Sharpen after scaling

           Take first frame of animated gifs (only some systems) [Default OFF]

           Options for convert (use '--' for mult)

           List of medium convert options

           List of thumbnail convert options

   Plugin and Theme Options:
           Path for themes, plugins, language files, etc...
            [Default /etc/album /usr/share/album /home/dave/.album]

           Load a plugin

           Show usage for a plugin

           Print info for a specific plugins

           Add a path to search for plugins.        [Default @DATA_PATH/plugins]

           Default postfix for plugins [Default .alp]

           Print info for all known plugins

           Print info for all plugins in computer readable format

           Show all known plugin hooks (for developers)

           Show hook info for a specific hook (for developers)

           Specify a theme directory

           In case you want to refer to the theme by absolute URL

           Directories that contain themes
            [Default /data/proj/album/Themes /data/proj/album/Themes]

           Show available themes

           Path to convert (ImageMagick) [Default convert]

           Path to identify (ImageMagick) [Default identify]

           Path to jhead (extracts exif info) [Default jhead]

           Path to ffmpeg (extracting movie frames) [Default ffmpeg]

           Conf filename for album configurations [Default album.conf]

           Configuration file version

           Throwaway temp file [Default /dev/null]

           Are we (unfortunately) running windows?

           Are we using the Cygwin environment?

           Use tcap? (win98) [Default OFF]

           Path to tcap (win98) [Default tcap]

           tcap output file (win98) [Default atrash.tmp]

           Path to cmdproxy (tcap helper for long lines) [Default cmdproxy]

           Path to header file [Default header.txt]

           Path to footer file [Default footer.txt]

           Credit line to add to the bottom of every album

           Ignore dir/file if dir/file.no_album exists [Default .no_album]

           Ignore and don't display these files [Default .hide_album]

           Don't treat these files as images [Default .not_img]


       HOME  Home directory for finding user-specific configuration files (.albumrc)

       DOT   Instead of looking for .albumrc, album also looks for $DOT/album.conf (I'm not a big
             fan of .dotfiles cluttering my home directory).

       tcap  Set/overwritten by the Win98 version of album for tcap arguments.


             Site-specific configuration

             User-specific configuration

             Album-specific configuration.

             Will be modified with any new command-line options!

             Specifies album information


       ImageMagick(1), jhead(1), ffmpeg(1)


       David Ljung Madison <>