1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
.\" Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH JIGL 1 "October 8, 2006"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
jigl \- Generates a static html photo gallery from one or more directories of images
.SH SYNOPSIS
.B jigl
.I [ options ] [ directory ] [ directory ... ]
.SH DESCRIPTION
.B jigl
(pronounced jiggle) is a perl script that generates a static html photo gallery from one or more directories of gif/jpg/png images. It supports themes and is very customizable. It includes the ability to display comments and EXIF info for each image in a simple clean layout.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
.SH OPTIONS
These programs follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
For further details, see the documentation in \fI/usr/share/doc/jigl/\fP
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-v, \-\-version
Show version of program.
.TP
.B \-cg \-\-create\-gallerydat
Create a gallery.dat file and exit
.TP
.B \-uec \-\-use\-exif\-comment
Use the comment field in the exif header (if it exists)
as the slide comment. This will overwrite the description
that is written in a gallery.dat file. If used in
conjunction with the \-cg option, the comment field will
be saved in the gallery.dat file.
Default is DISABLED. (can be negated).
.TP
.B \-rs \-\-replace\-spaces <a|y|n>
Replaces spaces with underscores "_" in filenames.
a \-\- (default) Ask the user if they want to
y \-\- replace and do no ask
n \-\- do not replace and do no ask
.TP
.B \-it \-\-index\-title <string>
Sets the title and title\-bar of the index.html page
to string. This is meant to be used when you are not
using a gallery.dat file.
.TP
.B \-iw \-\-index\-width <1\-255>
How many thumbnails per line you want on the index page.
Default is 5
.TP
.B \-ir \-\-index\-row <0\-255>
The number of thumbnail rows you want on the index page
before a new index page is generated. If 0, there is no
limit and only one index page will be generated.
Default is 0
.TP
.B \-ut \-\-update\-templates
Remove the template files from the local directory and
the global default theme directory. This will cause new
default template files to be generated in the global
default theme directory.
Default is DISABLED. (can be negated).
.TP
.B \-ft \-\-force\-thumb
Force thumbnail regeneration (can be negated)
.TP
.B \-fs \-\-force\-slide
Force slide regeneration (can be negated)
.TP
.B \-skb \-\-slide\-kbsize
Print the file size of the slide on the index page
under the thumbnails.
Default is ENABLED (can be negated)
.TP
.B \-sxy \-\-slide\-xysize
Print the slide dimensions under the thumbnails
on the index page.
Default is ENABLED (can be negated)
.TP
.B \-uo \-\-use\-original
Use the original images for the slides \- do not
generate a scaled slide image.
Default is DISABLED. (can be negated)
.TP
.B \-lo \-\-link\-original
Link to the original images from the slides.
Default is DISABLED. (can be negated).
.TP
.B \-aro \-\-auto\-rotate\-originals
Do a lossless rotation of the original images. This
option is only useful if your digital camera sets the
Orientation field in the EXIF header. All EXIF header
information will be kept and the Orientation field
will be updated to reflect the rotation.
Default is DISABLED. (can be negated).
.TP
.B \-gs \-\-generate\-slides
Gererate slide pages and link them to the thumbnails.
If this option is turned off, slides will not be
generated and the info pages will be linked to the
thumbnails instead. If neither slide or info pages are
generated, the thumbnails will not link to anything.
Default is ENABLED. (can be negated).
.TP
.B \-gi \-\-generate\-info
Generate info pages and link them to the "info" link
on the slide pages. If this option is turned off, info
pages will not be generated and the "info" link on the
slide pages will dissapear. If no slides are generated,
then the info pages will be linked directly to the
thumbnails.
Default is ENABLED. (can be negated).
.TP
.B \-sy \-\-slideY <int>
Maximum size of slide image in the Y direction. If the
height of the original image is greater than this value
the slide will be scaled to this value. Otherwise the
slide is simply a copy of the original.
Default is 480 pixels
.TP
.B \-ty \-\-thumbY <int>
Size of the scaled thumbnail image in the Y direction
Default is 75 pixels
.TP
.B \-iy \-\-infoY <int>
Maximum size of the info image in the Y direction. This
is simply a scale of the slide image using HTML height
and width tags. A new image is not generated.
Default is 240 pixels
.TP
.B \-ws \-\-watermark\-slides
Enable watermarking of the slide images. A watermark
file must be present for this option to work.
Default is DISABLED. (can be negated).
.TP
.B \-wf \-\-watermark\-file <filename>
Name of the watermark file to use when \-ws is enabled.
Default is "watermark.png".
.TP
.B \-wg \-\-watermark\-gravity <north|south|east|west|northeast|northwest|southeast|southwest>
Where to display the watermark on the slide.
Default is southeast.
.TP
.B \-gb \-\-go\-back
Prepend a "Go Back" link to the header in the index.html
file. If used in conjunction with \-cg, the Go Back link
will be added to the INDEX\-HEADER tag in the newly
created gallery.dat file.
Default is DISABLED. (can be negated).
.TP
.B \-gbs \-\-go\-back\-string <string>
String to use for the go\-back\-url link. You could even
make this an image to help round out a theme by making
this string something like:
"<img src=theme/myimage.gif border=0>"
Default is "Go Back".
.TP
.B \-gburl \-\-go\-back\-url <url>
URL to use when \-gb is enabled. Any URL can be used.
Default is '..', the previous directory.
.TP
.B \-\-theme <themeName>
Name of theme to use. Themes files are defined as
"themeName.theme". You would just enter the "themeName"
portion of the file.
Default is "default".
.TP
.B \-wd \-\-web\-dir <dir>
Directory to put all the gallery files (html, slides,
thumbnails and possibly theme files) into. Unless
a fully qualified path is used, this directory will be
created in the current directory.
This option is not used if the \-lo or \-uo option is set.
Default is "web".
.TP
.B \-r \-\-recurse
Recurse through all directories on the command line.
This option will omit all directories named "slides",
"thumbs", "theme", "web" and the value of \-wd if that
option is set.
This option will ONLY be recognized from the command
line to help prevent accidents.
Note: Any options listed on the command line when using
recursion will be applied to all directories.
Default is DISABLED.
.TP
.B \-h \-\-help
Display this information and exit
.TP
.B \-v \-\-version
Display version and exit
.TP
.B \-d \-\-debug <0\-5>
Set debug level. Default is 0
.TP
.B [directories]
Directories to process. Default is . (current).
.TP
\fBNote:\fP If an option listed says it can be negated you can prefix it with "no"
and the opposite effect will happen. Useful for overriding options
on the command line that are set elsewhere. e.g. \-nouo | \-\-nouse\-original
will NOT use the original files as slides.
.SH SETTING OPTIONS
Options can be used in any of three places: (listed ascending precedence)
\-\- A single line in the \fI$HOME/.jigl/jigl.opts\fP file in the users home directory.
\-\- After the GAL\-OPTIONS tag as a single line in the \fIgallery.dat\fP file in each of the album directories.
\-\- On the command line.
Regardless of where they are located, they should all be listed in the same
form as you would use them on the command line. Example: \-lo \-iw 6 \-noskb
Theme files can be located in either the directory \fBjigl\fP is processing or in
the \fI.jigl\fP directory in the user's home directory.
.SH AUTHOR
\fBjigl\fP was written by Jason Paul <jigl@xome.net>. Its project page is located at \fIhttp://xome.net/projects/jigl/\fP.
.PP
This manual page was adapted from the program help text by Nicholas Breen <nbreen@ofb.net>
for the Debian project (but may be used by others).
|