.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ALBUM 1"
.TH ALBUM 1 "2016-04-19" "album v4.15" ""
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
album \- Make a web photo album
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBalbum\fR [\fIalbum\ options\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
album is an \s-1HTML\s0 photo album generator that supports themes. It takes
a directory of images and creates all the thumbnails and \s-1HTML\s0 that
you need. It's fast, easy to use, and very powerful.
.PP
Place your photos in a new directory somewhere inside your web pages.
Then run \f(CW\*(C`album\*(C'\fR from a command-line prompt with the directory path
as an argument, and that's it.
.PP
To use themes, make sure the \f(CW\*(C`Themes\*(C'\fR directory is inside your web
path, and then use the \-theme option.
.SH "OPTIONS"
.IX Header "OPTIONS"
There are three types of options. Boolean options, string/num options and
array options. Boolean options can be turned off by prepending \-no_:
.PP
% album \-no_image_pages
.PP
String and number values are specified after a string option:
.PP
% album \-type gif
% album \-columns 5
.PP
Array options can be specified two ways, with one argument at a time:
.PP
% album \-exif hi \-exif there
.PP
Or multiple arguments using the '\-\-' form:
.PP
% album \-\-exif hi there \-\-
.PP
You can remove specific array options with \-no_<option>:
.PP
% album \-no_exif hi
.PP
Or clear all the array options with \-clear_<option>:
.PP
% album \-clear_exif
.PP
Boolean options:
.PP
% 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
.PP
String/number options:
.PP
% 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, \-not_img
.PP
Array options:
.PP
% album \-\-lang_path, \-\-exif, \-\-exif_album, \-\-exif_image, \-\-add, \-\-scale_opts, \-\-medium_scale_opts, \-\-thumb_scale_opts, \-\-data_path, \-\-plugin_path, \-\-theme_path
.SS "\s-1OPTION DESCRIPTIONS\s0"
.IX Subsection "OPTION DESCRIPTIONS"
.IP "\fB\-h\fR\fI\fR" 4
.IX Item "-h"
Show usage
.IP "\fB\-more\fR\fI\fR" 4
.IX Item "-more"
To show more options.
.IP "\fB\-usage\fR\fI=\fIlevel\fI\fR" 4
.IX Item "-usage=level"
Show usage as deep as you like.
.IP "\fB\-lang\fR\fI=\fIlang\fI\fR" 4
.IX Item "-lang=lang"
Specify language(s)
.IP "\fB\-list_langs\fR\fI\fR" 4
.IX Item "-list_langs"
List out full language information
.IP "\fB\-make_lang\fR\fI=\fIlang\fI\fR" 4
.IX Item "-make_lang=lang"
Print out a new language file
.IP "\fB\-list_html_trans\fR\fI\fR" 4
.IX Item "-list_html_trans"
List \s-1HTML\s0 translations for each language
Useful for creating multi-lingual images for themes
Output is in \s-1HTML\s0 and utf\-8, change charset as needed
.IP "\fB\-\-lang_path\fR\fI=\fIstrings\fI\fR" 4
.IX Item "--lang_path=strings"
Add a path to search for language files [Default \f(CW@DATA_PATH\fR/lang]
.IP "\fB\-q\fR\fI\fR" 4
.IX Item "-q"
Be quiet [Default \s-1OFF\s0]
.IP "\fB\-d\fR\fI\fR" 4
.IX Item "-d"
Set debug mode [Default \s-1OFF\s0]
.IP "\fB\-D\fR\fI\fR" 4
.IX Item "-D"
Heavy debug mode [Default \s-1OFF\s0]
.IP "\fB\-dtheme\fR\fI\fR" 4
.IX Item "-dtheme"
Theme debug mode [Default \s-1OFF\s0]
.IP "\fB\-Dtheme\fR\fI\fR" 4
.IX Item "-Dtheme"
Theme heavy debug mode [Default \s-1OFF\s0]
.IP "\fB\-conf\fR\fI=\fIfile\fI\fR" 4
.IX Item "-conf=file"
Read a .conf file
.IP "\fB\-virgin_check\fR\fI\fR" 4
.IX Item "-virgin_check"
Do the virgin check to see if you've run album before [Default \s-1ON\s0]
.IP "\fB\-save_conf\fR\fI\fR" 4
.IX Item "-save_conf"
Save album.conf files in photo album [Default \s-1ON\s0]
.IP "\fB\-configure\fR\fI\fR" 4
.IX Item "-configure"
Setup initial album site configuration [Default \s-1OFF\s0]
.IP "\fB\-version\fR\fI\fR" 4
.IX Item "-version"
Display program version info
.IP "\fB\-mv\fR\fI\fR" 4
.IX Item "-mv"
Move imgs across albums: see 'album \-plugin_info utils/mv'
.IP "\fB\-create_plugin\fR\fI\fR" 4
.IX Item "-create_plugin"
Create plugin: see 'album \-plugin_info utils/create_plugin'
.SS "Album Options:"
.IX Subsection "Album Options:"
.IP "\fB\-crf\fR\fI\fR" 4
.IX Item "-crf"
Album hash output in computer readable format [Default \s-1OFF\s0]
.IP "\fB\-list_options\fR\fI\fR" 4
.IX Item "-list_options"
Show default options and values for a given album [Default \s-1OFF\s0]
.IP "\fB\-image_pages\fR\fI\fR" 4
.IX Item "-image_pages"
Create a page for each image [Default \s-1ON\s0]
.IP "\fB\-thumbs\fR\fI\fR" 4
.IX Item "-thumbs"
Images have thumbnails [Default \s-1ON\s0]
.IP "\fB\-dir_thumbs\fR\fI\fR" 4
.IX Item "-dir_thumbs"
Directories have thumbnail (if supported by theme) [Default \s-1ON\s0]
.IP "\fB\-thumb_post\fR\fI=\fIstring\fI\fR" 4
.IX Item "-thumb_post=string"
Additional postfix for thumbnails.
.IP "\fB\-medium\fR\fI=\fIgeom\fI\fR" 4
.IX Item "-medium=geom"
Generate medium size images
.IP "\fB\-just_medium\fR\fI\fR" 4
.IX Item "-just_medium"
Don't link to full-size images [Default \s-1OFF\s0]
.IP "\fB\-slideshow\fR\fI\fR" 4
.IX Item "-slideshow"
Slideshow capabilities (only with some themes) [Default \s-1OFF\s0]
.IP "\fB\-embed\fR\fI\fR" 4
.IX Item "-embed"
Use image pages for non-picture image pages [Default \s-1ON\s0]
.IP "\fB\-columns\fR\fI\fR" 4
.IX Item "-columns"
Number of image columns [Default 4]
.IP "\fB\-clean\fR\fI\fR" 4
.IX Item "-clean"
Remove unused thumbnails [Default \s-1OFF\s0]
.IP "\fB\-captions\fR\fI=\fIstring\fI\fR" 4
.IX Item "-captions=string"
Specify captions filename [Default captions.txt]
.IP "\fB\-image_headers\fR\fI\fR" 4
.IX Item "-image_headers"
Show header.txt on image pages (default theme only) [Default \s-1OFF\s0]
.IP "\fB\-album_captions\fR\fI\fR" 4
.IX Item "-album_captions"
Also show captions on album page [Default \s-1ON\s0]
.IP "\fB\-folder_count\fR\fI\fR" 4
.IX Item "-folder_count"
Show folder/image counts for each album [Default \s-1ON\s0]
.IP "\fB\-caption_edit\fR\fI\fR" 4
.IX Item "-caption_edit"
Add comment tags so that caption_edit.cgi will work [Default \s-1OFF\s0]
.IP "\fB\-\-exif\fR\fI=\fIfmt\fI\fR" 4
.IX Item "--exif=fmt"
Append exif info to captions. Use \f(CW%key\fR 0n fmt string
Example: \-exif \*(L"<br>Camera: \f(CW%Camera\fR model%\*(R"
If any \f(CW%keys\fR% are not found by jhead, nothing is appended.
.IP "\fB\-\-exif_album\fR\fI=\fIfmt\fI\fR" 4
.IX Item "--exif_album=fmt"
\&\-exif for just album pages
.IP "\fB\-\-exif_image\fR\fI=\fIfmt\fI\fR" 4
.IX Item "--exif_image=fmt"
\&\-exif for just image pages
.IP "\fB\-file_sizes\fR\fI\fR" 4
.IX Item "-file_sizes"
Show image file sizes [Default \s-1OFF\s0]
.IP "\fB\-fix_urls\fR\fI\fR" 4
.IX Item "-fix_urls"
Encode unsafe chars as 0x in URLs [Default \s-1ON\s0]
.IP "\fB\-known_images\fR\fI\fR" 4
.IX Item "-known_images"
Only include known image types [Default \s-1ON\s0]
.IP "\fB\-top\fR\fI=\fIstring\fI\fR" 4
.IX Item "-top=string"
\&\s-1URL\s0 for 'Back' link on top page [Default ../]
.IP "\fB\-all\fR\fI\fR" 4
.IX Item "-all"
Do not hide files/directories starting with '.' [Default \s-1OFF\s0]
.IP "\fB\-\-add\fR\fI=\fIdir\fI\fR" 4
.IX Item "--add=dir"
Add a new directory to the album it's been placed in
.IP "\fB\-depth\fR\fI\fR" 4
.IX Item "-depth"
Depth to descend directories (default infinite [\-1]) [Default \-1]
.IP "\fB\-follow_symlinks\fR\fI\fR" 4
.IX Item "-follow_symlinks"
Dereference symbolic links [Default \s-1ON\s0]
.IP "\fB\-hashes\fR\fI\fR" 4
.IX Item "-hashes"
Show hash marks while generating thumbnails [Default \s-1ON\s0]
.IP "\fB\-name_length\fR\fI\fR" 4
.IX Item "-name_length"
Limit length of image/dir names [Default 40]
.IP "\fB\-sort\fR\fI=\fIstring\fI\fR" 4
.IX Item "-sort=string"
Sort type, captions, name, date, \s-1EXIF\s0 date ('exif') [Default captions]
.IP "\fB\-reverse_sort\fR\fI\fR" 4
.IX Item "-reverse_sort"
Sort in reverse [Default \s-1OFF\s0]
.IP "\fB\-case_sort\fR\fI\fR" 4
.IX Item "-case_sort"
Use case sensitive sorting when sorting names [Default \s-1OFF\s0]
.IP "\fB\-body\fR\fI=\fIstring\fI\fR" 4
.IX Item "-body=string"
Specify <body> tags for non-theme output [Default <body>]
.IP "\fB\-charset\fR\fI=\fIstr\fI\fR" 4
.IX Item "-charset=str"
Charset for non-theme and some theme output
This is also set by using language files (with \-lang)
.IP "\fB\-force_charset\fR\fI=\fIstr\fI\fR" 4
.IX Item "-force_charset=str"
Force charset (not overridden by languages)
.IP "\fB\-image_loop\fR\fI\fR" 4
.IX Item "-image_loop"
Do first and last image pages loop around? [Default \s-1ON\s0]
.IP "\fB\-burn\fR\fI\fR" 4
.IX Item "-burn"
Setup an album to burn to \s-1CD\s0
Implies '\-index index.html' and '\-no_theme_url' [Default \s-1OFF\s0]
.IP "\fB\-index\fR\fI=\fIfile\fI\fR" 4
.IX Item "-index=file"
Select the default 'index.html' to use.
For file://, try '\-index index.html' to add 'index.html' to index links.
.IP "\fB\-default_index\fR\fI=\fIfile\fI\fR" 4
.IX Item "-default_index=file"
The file the webserver accesses when
when no file is specified. [Default index.html]
.IP "\fB\-html\fR\fI=\fIpost\fI\fR" 4
.IX Item "-html=post"
Default postfix for \s-1HTML\s0 files [Default .html]
.SS "Thumbnail Options:"
.IX Subsection "Thumbnail Options:"
.IP "\fB\-geometry\fR\fI=\fI<X>x<Y>\fI\fR" 4
.IX Item "-geometry=<X>x<Y>"
Size of thumbnail [Default 133x133]
.IP "\fB\-type\fR\fI=\fIstring\fI\fR" 4
.IX Item "-type=string"
Thumbnail type (gif, jpg, tiff,...) [Default jpg]
.IP "\fB\-medium_type\fR\fI=\fIstring\fI\fR" 4
.IX Item "-medium_type=string"
Medium type (default is same type as full image)
.IP "\fB\-crop\fR\fI\fR" 4
.IX Item "-crop"
Crop the image to fit thumbnail size
otherwise aspect will be maintained [Default \s-1OFF\s0]
.IP "\fB\-CROP\fR\fI=\fIstring\fI\fR" 4
.IX Item "-CROP=string"
Force cropping to be top, bottom, left or right
.IP "\fB\-dir\fR\fI=\fIstring\fI\fR" 4
.IX Item "-dir=string"
Thumbnail directory [Default tn]
.IP "\fB\-force\fR\fI\fR" 4
.IX Item "-force"
Force overwrite of existing thumbnails and \s-1HTML\s0
otherwise they are only written when changed [Default \s-1OFF\s0]
.IP "\fB\-force_html\fR\fI\fR" 4
.IX Item "-force_html"
Force rewrite of \s-1HTML\s0 [Default \s-1OFF\s0]
.IP "\fB\-sample\fR\fI\fR" 4
.IX Item "-sample"
Use 'convert \-sample' for thumbnails (faster, low quality) [Default \s-1OFF\s0]
.IP "\fB\-sharpen\fR\fI=\fI<radius>x<sigma>\fI\fR" 4
.IX Item "-sharpen=<radius>x<sigma>"
Sharpen after scaling
.IP "\fB\-animated_gifs\fR\fI\fR" 4
.IX Item "-animated_gifs"
Take first frame of animated gifs (only some systems) [Default \s-1OFF\s0]
.IP "\fB\-\-scale_opts\fR\fI=\fIstrings\fI\fR" 4
.IX Item "--scale_opts=strings"
Options for convert (use '\-\-' for mult)
.IP "\fB\-\-medium_scale_opts\fR\fI=\fIstrings\fI\fR" 4
.IX Item "--medium_scale_opts=strings"
List of medium convert options
.IP "\fB\-\-thumb_scale_opts\fR\fI=\fIstrings\fI\fR" 4
.IX Item "--thumb_scale_opts=strings"
List of thumbnail convert options
.SS "Plugin and Theme Options:"
.IX Subsection "Plugin and Theme Options:"
.IP "\fB\-\-data_path\fR\fI=\fIstrings\fI\fR" 4
.IX Item "--data_path=strings"
Path for themes, plugins, language files, etc...
[Default /etc/album /usr/share/album /home/dave/.album]
.IP "\fB\-plugin\fR\fI=\fIplugin\fI\fR" 4
.IX Item "-plugin=plugin"
Load a plugin
.IP "\fB\-plugin_usage\fR\fI=\fIplugin\fI\fR" 4
.IX Item "-plugin_usage=plugin"
Show usage for a plugin
.IP "\fB\-plugin_info\fR\fI=\fIplugin\fI\fR" 4
.IX Item "-plugin_info=plugin"
Print info for a specific plugins
.IP "\fB\-\-plugin_path\fR\fI=\fIstrings\fI\fR" 4
.IX Item "--plugin_path=strings"
Add a path to search for plugins.
[Default \f(CW@DATA_PATH\fR/plugins]
.IP "\fB\-plugin_post\fR\fI=\fIstring\fI\fR" 4
.IX Item "-plugin_post=string"
Default postfix for plugins [Default .alp]
.IP "\fB\-list_plugins\fR\fI\fR" 4
.IX Item "-list_plugins"
Print info for all known plugins
.IP "\fB\-list_plugins_crf\fR\fI\fR" 4
.IX Item "-list_plugins_crf"
Print info for all plugins in computer readable format
.IP "\fB\-list_hooks\fR\fI\fR" 4
.IX Item "-list_hooks"
Show all known plugin hooks (for developers)
.IP "\fB\-hook_info\fR\fI=\fIhook\fI\fR" 4
.IX Item "-hook_info=hook"
Show hook info for a specific hook (for developers)
.IP "\fB\-theme\fR\fI=\fIdir\fI\fR" 4
.IX Item "-theme=dir"
Specify a theme directory
.IP "\fB\-theme_url\fR\fI=\fIurl\fI\fR" 4
.IX Item "-theme_url=url"
In case you want to refer to the theme by absolute \s-1URL\s0
.IP "\fB\-\-theme_path\fR\fI=\fIdir\fI\fR" 4
.IX Item "--theme_path=dir"
Directories that contain themes
[Default /data/proj/album/Themes /data/proj/album/Themes]
.IP "\fB\-list_themes\fR\fI\fR" 4
.IX Item "-list_themes"
Show available themes
.SS "Paths:"
.IX Subsection "Paths:"
.IP "\fB\-convert\fR\fI=\fIstring\fI\fR" 4
.IX Item "-convert=string"
Path to convert (ImageMagick) [Default convert]
.IP "\fB\-identify\fR\fI=\fIstring\fI\fR" 4
.IX Item "-identify=string"
Path to identify (ImageMagick) [Default identify]
.IP "\fB\-jhead\fR\fI=\fIstring\fI\fR" 4
.IX Item "-jhead=string"
Path to jhead (extracts exif info) [Default jhead]
.IP "\fB\-ffmpeg\fR\fI=\fIstring\fI\fR" 4
.IX Item "-ffmpeg=string"
Path to ffmpeg (extracting movie frames) [Default ffmpeg]
.IP "\fB\-conf_file\fR\fI=\fIstring\fI\fR" 4
.IX Item "-conf_file=string"
Conf filename for album configurations [Default album.conf]
.IP "\fB\-conf_version\fR\fI\fR" 4
.IX Item "-conf_version"
Configuration file version
.IP "\fB\-dev_null\fR\fI=\fIstring\fI\fR" 4
.IX Item "-dev_null=string"
Throwaway temp file [Default /dev/null]
.IP "\fB\-windows\fR\fI=\fIstring\fI\fR" 4
.IX Item "-windows=string"
Are we (unfortunately) running windows?
.IP "\fB\-cygwin\fR\fI=\fIstring\fI\fR" 4
.IX Item "-cygwin=string"
Are we using the Cygwin environment?
.IP "\fB\-use_tcap\fR\fI\fR" 4
.IX Item "-use_tcap"
Use tcap? (win98) [Default \s-1OFF\s0]
.IP "\fB\-tcap\fR\fI=\fIstring\fI\fR" 4
.IX Item "-tcap=string"
Path to tcap (win98) [Default tcap]
.IP "\fB\-tcap_out\fR\fI=\fIstring\fI\fR" 4
.IX Item "-tcap_out=string"
tcap output file (win98) [Default atrash.tmp]
.IP "\fB\-cmdproxy\fR\fI=\fIstring\fI\fR" 4
.IX Item "-cmdproxy=string"
Path to cmdproxy (tcap helper for long lines) [Default cmdproxy]
.IP "\fB\-header\fR\fI=\fIstring\fI\fR" 4
.IX Item "-header=string"
Path to header file [Default header.txt]
.IP "\fB\-footer\fR\fI=\fIstring\fI\fR" 4
.IX Item "-footer=string"
Path to footer file [Default footer.txt]
.IP "\fB\-credit\fR\fI=\fIstring\fI\fR" 4
.IX Item "-credit=string"
Credit line to add to the bottom of every album
.IP "\fB\-no_album\fR\fI=\fIstring\fI\fR" 4
.IX Item "-no_album=string"
Ignore dir/file if dir/file.no_album exists [Default .no_album]
.IP "\fB\-hide_album\fR\fI=\fIstring\fI\fR" 4
.IX Item "-hide_album=string"
Ignore and don't display these files [Default .hide_album]
.IP "\fB\-not_img\fR\fI=\fIstring\fI\fR" 4
.IX Item "-not_img=string"
Don't treat these files as images [Default .not_img]
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
.IP "\s-1HOME\s0" 6
.IX Item "HOME"
Home directory for finding user-specific configuration files (.albumrc)
.IP "\s-1DOT\s0" 6
.IX Item "DOT"
Instead of looking for .albumrc, album also looks for \f(CW$DOT\fR/album.conf
(I'm not a big fan of .dotfiles cluttering my home directory).
.IP "tcap" 6
.IX Item "tcap"
Set/overwritten by the Win98 version of album for tcap arguments.
.SH "FILES"
.IX Header "FILES"
.IP "\fI/etc/album/album.conf\fR" 6
.IX Item "/etc/album/album.conf"
.PD 0
.IP "\fI/etc/album.conf\fR" 6
.IX Item "/etc/album.conf"
.PD
Site-specific configuration
.ie n .IP "\fI\fI$HOME\fI/.albumrc\fR" 6
.el .IP "\fI\f(CI$HOME\fI/.albumrc\fR" 6
.IX Item "$HOME/.albumrc"
.PD 0
.ie n .IP "\fI\fI$HOME\fI/.album.conf\fR" 6
.el .IP "\fI\f(CI$HOME\fI/.album.conf\fR" 6
.IX Item "$HOME/.album.conf"
.ie n .IP "\fI\fI$DOT\fI/album.conf\fR" 6
.el .IP "\fI\f(CI$DOT\fI/album.conf\fR" 6
.IX Item "$DOT/album.conf"
.PD
User-specific configuration
.IP "\fI<album>/album.conf\fR" 6
.IX Item "<album>/album.conf"
Album-specific configuration.
.Sp
\&\fBWill be modified with any new command-line options!\fR
.IP "\fI<album>/header.txt\fR" 6
.IX Item "<album>/header.txt"
.PD 0
.IP "\fI<album>/footer.txt\fR" 6
.IX Item "<album>/footer.txt"
.IP "\fI<album>/captions.txt\fR" 6
.IX Item "<album>/captions.txt"
.IP "\fI<album>/.no_album\fR" 6
.IX Item "<album>/.no_album"
.IP "\fI<album>/<image>.no_album\fR" 6
.IX Item "<album>/<image>.no_album"
.IP "\fI<album>/.hide_album\fR" 6
.IX Item "<album>/.hide_album"
.IP "\fI<album>/<image>.hide_album\fR" 6
.IX Item "<album>/<image>.hide_album"
.IP "\fI<album>/<image>.not_img\fR" 6
.IX Item "<album>/<image>.not_img"
.PD
Specifies album information
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIImageMagick\fR\|(1), \fIjhead\fR\|(1), \fIffmpeg\fR\|(1)
.SH "AUTHOR"
.IX Header "AUTHOR"
David Ljung Madison <http://MarginalHacks.com/>