ALBUM(1) ALBUM(1)
album - Make a web photo album
SYNOPSIS
album [album options]
DESCRIPTION
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.
OPTIONS
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 --
Boolean options:
% album -q, -d, -save_conf, -image_pages, -dir_thumbs, -just_medium,
-embed, -clean, -album_captions, -caption_edit, -file_sizes, -fix_urls,
-known_images, -all, -hashes, -name_length, -date_sort, -name_sort,
-reverse_sort, -image_loop, -crop, -force, -sample, -animated_gifs,
-use_tcap
String/number options:
% album -medium, -captions, -top, -body, -charset, -index,
-default_index, -html, -type, -medium_type, -CROP, -dir, -sharpen,
-theme_url, -theme_path, -convert, -identify, -jhead, -ffmpeg,
-conf_file, -dev_null, -windows, -cygwin, -tcap, -tcap_out, -cmdproxy,
-header, -footer, -no_album, -hide_album, -not_img
Array options:
% album --exif, --exif_album, --exif_image, --add, --scale_opts,
--medium_scale_opts, --full_scale_opts
OPTION DESCRIPTIONS
-h Show usage
-q Be quiet [Default OFF]
-d Set debug mode [Default OFF]
-conf=file
Read a .conf file
-save_conf
Save album.conf files in albums [Default ON]
Album Options:
-image_pages
Create a page for each image [Default ON]
-dir_thumbs
Directories have thumbnail (if supported by theme) [Default ON]
-medium=geom
Generate medium size images
-just_medium
Don't link to full-size images [Default OFF]
-embed
Use image pages for non-picture image pages [Default ON]
-columns
Number of image columns [Default 4]
-clean
Remove unused thumbnails [Default OFF]
-captions=string
Specify captions filename [Default captions.txt]
-album_captions
Also show captions on album page [Default ON]
-caption_edit
Add comment tags so that caption_edit.cgi will work [Default OFF]
--exif=fmt
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_album=fmt
-exif for just album pages
--exif_image=fmt
-exif for just image pages
-file_sizes
Show image file sizes [Default OFF]
-fix_urls
Encode unsafe chars as 0x in URLs [Default ON]
-known_images
Only include known image types [Default ON]
-top=string
URL for 'Back' link on top page [Default ../]
-all
Do not hide files/directories starting with '.' [Default OFF]
--add=dir
Add a new directory to the album it's been placed in
-depth
Depth to descend directories (default infinite) [Default -1]
-hashes
Show hash marks while generating thumbnails [Default ON]
-name_length
Limit length of image/dir names [Default ON]
-date_sort
Sort images/dirs by date instead of captions/name [Default OFF]
-name_sort
Sort by name, not caption order [Default OFF]
-reverse_sort
Sort in reverse [Default OFF]
-body=string
Specify <body> tags for non-theme output
-charset=str
Charset for non-theme output [Default iso-8859-1]
-image_loop
Do first and last image pages loop around? [Default ON]
-index=file
Select the default 'index.html' to use. For file://, try '-index
index.html' to add 'index.html' to index links.
-default_index=file
The file the webserver accesses when no file is specified. [Default
index.html]
-html=post
Default postfix for HTML files [Default .html]
Thumbnail Options:
-geometry=<X>x<Y>
Size of thumbnail [Default 133x133]
-type=string
Thumbnail type (gif, jpg, tiff,...) [Default jpg]
-medium_type=string
Medium type (default is same type as full image)
-crop
Crop the image to fit thumbnail size otherwise aspect will be main-
tained [Default OFF]
-CROP=string
Force cropping to be top, bottom, left or right
-dir=string
Thumbnail directory [Default tn]
-force
Force overwrite of existing thumbnails otherwise they are only
written when changed [Default OFF]
-sample
convert -sample for thumbnails (faster, low quality) [Default OFF]
-sharpen=<radius>x<sigma>
Sharpen after scaling
-animated_gifs
Take first frame of animated gifs (only some systems) [Default OFF]
--scale_opts=strings
Options for convert (use '--' for mult)
--medium_scale_opts=strings
List of medium convert options
--full_scale_opts=strings
List of full convert options
Theme Options:
-theme=dir
Specify a theme directory
-theme_url=url
In case you want to refer to the theme by absolute URL
-theme_path=dir
Directory that contains themes
-more
To show more options.
-More
To show even more options.
-version
Display program version info
Paths:
-convert=string
Path to convert (ImageMagick) [Default convert]
-identify=string
Path to identify (ImageMagick) [Default identify]
-jhead=string
Path to jhead (extracts exif info) [Default jhead]
-ffmpeg=string
Path to ffmpeg (extracting movie frames) [Default ffmpeg]
-conf_file=string
Conf filename for album configurations [Default album.conf]
-dev_null=string
Throwaway temp file [Default /dev/null]
-windows=string
Are we (unfortunately) running windows?
-cygwin=string
Are we using the Cygwin environment?
-use_tcap
Use tcap? (win98) [Default OFF]
-tcap=string
Path to tcap (win98) [Default tcap]
-tcap_out=string
tcap output file (win98) [Default atrash.tmp]
-cmdproxy=string
Path to cmdproxy (tcap helper for long lines) [Default cmdproxy]
-header=string
Path to header file [Default header.txt]
-footer=string
Path to footer file [Default footer.txt]
-no_album=string
Ignore dir/files if file with this postfix exists [Default
.no_album]
-hide_album=string
Ignore and don't display these files [Default .hide_album]
-not_img=string
Don't treat these files as images [Default .not_img]
ENVIRONMENT
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.
FILES
/etc/album/album.conf
/etc/album.conf
Site-specific configuration
$HOME/.albumrc
$HOME/.album.conf
$DOT/album.conf
User-specific configuration
<album>/album.conf
Album-specific configuration.
Will be modified with any new command-line options!
<album>/header.txt
<album>/footer.txt
<album>/captions.txt
<album>/.no_album
<album>/<image>.no_album
<album>/.hide_album
<album>/<image>.hide_album
<album>/<image>.not_img
Specifies album information
SEE ALSO
ImageMagick(1), jhead(1), ffmpeg(1)
AUTHOR
David Ljung Madison <http://MarginalHacks.com/>
3rd Berkeley Distribution 2004-07-14 ALBUM(1)
