.\"     Title: photon
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
.\"      Date: 12/16/2006
.\"    Manual: 
.\"    Source: 
.\"
.TH "PHOTON" "1" "12/16/2006" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
photon \- generates photo albums
.SH "SYNOPSIS"
\fIphoton\fR [OPTIONS] [PATH]
.SH "DESCRIPTION"
Photon generates clean, yet configurable, static HTML photo galleries. All of the work is done from the command line, and the resulting output can easily be configured by changing the template files found in /usr/share/photon/templates.
.PP
To create a new template (skin), first create a new directory:
.sp
.RS 3n
.nf
mkdir \-p ${HOME}/.photon/templates/my_theme/
.fi
.PP
.RE
Then copy the contents of /usr/share/photon/templates/photonv1/ to this new directory.  Photon only needs three files to build pages:
.PP
index.html
.RS 3n
used to display the content of a folder
.RE
.PP
image.html
.RS 3n
used to display the page for an image
.RE
.PP
movie.html
.RS 3n
used to display the page for a movie
.PP
.RE
If a file is missing, then photon will throw an error and will not run.
.SH "HOW TO BUILD A GALLERY"
.PP
Quick start
.RS 3n
$ photon \-o myoutputdir /photos
.RE
.PP
Use the gimp plugin
.RS 3n
$ photon \-\-resize\-plugin=gimp \-v \-o myoutputdir /photos
.RE
.PP
Change the size for all images and the thumbnail and keep the original photo
.RS 3n
$ photon \-\-sizelist=0,1600x1200,800x600 \-\-thumbsize=320x240 \-o myoutputdir /photos
.RE
.PP
Create a gallery from your custom template (skin)
.RS 3n
$ photon \-k my_theme \-o myoutputdir /photos
.RE
.PP
See photon help
.RS 3n
$ photon \-\-help
.RE
.SH "OPTIONS"
.PP
\-a | \-\-awstats
.RS 3n
Insert Javascript for Awstats
.RE
.PP
\-\-awstats\-url=URL
.RS 3n
Change default value for Awstats script url
.RE
.PP
\-c NAME | \-\-comment
.RS 3n
Name of the comment file (default .comments)
.RE
.PP
\-d NUM | \-\-display\-columns=NUM
.RS 3n
Number of columns in index (default 3)
.RE
.PP
\-E | \-\-no\-exif
.RS 3n
Don't include EXIF information in HTML file
.RE
.PP
\-f | \-\-force
.RS 3n
Overwrite non\-image generated files (html, javascript, etc) (default no)
.RE
.PP
\-ff | \-\-force \-\-force
.RS 3n
Overwrite image files (default no)
.RE
.PP
\-h | \-\-help
.RS 3n
Print this help
.RE
.PP
\-I | \-\-no\-index
.RS 3n
Do not generate the high level index.html
.RE
.PP
\-J | \-\-no\-javascript
.RS 3n
Do not use javascript (no shortcuts, \&... )
.RE
.PP
\-k | \-\-skin=THEME
.RS 3n
Skin selector (default photonv1)
.RE
.PP
\-\-print\-skins
.RS 3n
Print out available skins (templates)
.RE
.PP
\-l NUM | \-\-display\-lines=NUM
.RS 3n
Number of lines in index (default 5)
.RE
.PP
\-m | \-\-movie
.RS 3n
Movie mode, include link to movie (*.mov)
.RE
.PP
\-o NAME | \-\-output\-directory=NAME
.RS 3n
Name of the output directory
.RE
.PP
\-s LIST | \-\-sizelist=LIST
.RS 3n
Image sizes (default 0,1024x768,800x600,640x480). Zero, which is the default, uses the original resolution. W x H specifies the width and height of the image in pixels.
.RE
.PP
\-t SIZE | \-\-thumbsize=SIZE
.RS 3n
Size of thumbnails (default 160x120)
.RE
.PP
\-v | \-\-verbose
.RS 3n
Verbosely print information
.RE
.PP
\-V | \-\-version
.RS 3n
Print program version number
.RE
.PP
\-z | \-\-compress
.RS 3n
Compress the original image if selected (default copy the image)
.RE
.PP
\-\-exif\-bordercolor=COLOR
.RS 3n
Exif window border color (default #008000)
.RE
.PP
\-\-exif\-bgcolor=COLOR
.RS 3n
Exif window background color (default #f0fff0)
.RE
.PP
\-\-exif\-fgcolor=COLOR
.RS 3n
Exif window text color (default
\fIblack\fR)
.RE
.PP
\-\-body\-bgcolor=COLOR
.RS 3n
Body background color (default #ccccff)
.RE
.PP
\-\-img\-bgcolor=COLOR
.RS 3n
Image background color (default
\fIwhite\fR)
.RE
.PP
\-\-exclude=PATTERN
.RS 3n
Exclude files matching PATTERN
.RE
.PP
\-\-resize\-plugin=PLUG
.RS 3n
Where PLUG is the program used to create thumbnails internal: fastest method (default) gimp: use Gimp>1.x (better quality)
.RE
.PP
\-\-resize\-quality\-low=NUM
.RS 3n
Quality for small image. 0 (bad) and 100 (good)
.RE
.PP
\-\-resize\-quality\-high=NUM
.RS 3n
Quality for big image 0 (bad) and 100 (good)
.RE
.PP
\-\-gimp\-program=PROG
.RS 3n
use PROG for gimp
.RE
.SH "SHORTCUTS WHILE VIEWING AN IMAGE"
.sp
.RS 3n
.nf
n/SPACE     Go to the next image (with the same resolution)
p/BACKSPACE Go to the previous image (with the same resolution)
s           Start/Stop the slideshow
+/\-         Increase/Decrease by one second the slideshow's period
h           Show shortcut and help
i           Show Exif information
z           Change to the higher resolution [NOT YET IMPLEMENTED]
.fi
.RE
.SH "SEE ALSO"
.sp
.RS 3n
.nf
gimp(1)
.fi
.RE
.SH "AUTHOR"
.sp
.RS 3n
.nf
Written by Luc Saillard, <luc@saillard.org>
.fi
.RE
.sp
.RS 3n
.nf
Main web site: http://www.saillard.org/programs_and_patches/photon/
.fi
.RE
.sp
.RS 3n
.nf
This manual page was written by Kevin Coyner <kcoyner@debian.org> for the Debian project but may be used by others.
.fi
.RE