~ubuntu-branches/ubuntu/hardy/jigl/hardy

« back to all changes in this revision

Viewing changes to debian/jigl.1

  • Committer: Bazaar Package Importer
  • Author(s): Nicholas Breen
  • Date: 2006-10-08 18:50:23 UTC
  • Revision ID: james.westby@ubuntu.com-20061008185023-jlvcr6pt1t9okbnm
Tags: 2.0.1+20060126-2
* New maintainer.  (Closes: #390865)
* Incorporate Vincent Stehle's patch for multi-CPU support.
* Add manpages.

Show diffs side-by-side

added added

removed removed

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