JIGL(1)

💖 JIGL 💖

okay so this is the manual page for jigl, section 1, and honestly? it's a little legend. it's pronounced jiggle btw, which is iconic and you should absolutely say it out loud every time. 🫶

✨ NAME ✨

jigl — generates a static html photo gallery from one or more directories of images. that's it, that's the gig. no server, no database, just vibes and html. 💅

🌸 SYNOPSIS 🌸

jigl [ options ] [ directory ] [ directory ... ]

🦋 DESCRIPTION 🦋

so jigl (say it with me: jiggle) is a perl script that generates a static html photo gallery from one or more directories of gif/jpg/png images. bestie it supports themes and it is very customizable, like genuinely. 🌈

and the way that it includes the ability to display comments and EXIF info for each image in a simple clean layout? obsessed. chef's kiss. 😭💖

🎀 OPTIONS 🎀

These programs follow the usual GNU command line syntax, with long options starting with two dashes (`-`). a summary of options is included below, because we're not gatekeeping. for further details, see the documentation in /usr/share/doc/jigl/ 📚

• -h, --help — shows you a summary of options. little cheat sheet energy.
• -v, --version — shows the version of the program.
• -cg, --create-gallerydat — creates a gallery.dat file and exits. done, bye. ✌️
• -uec, --use-exif-comment — uses 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 you use it together with the -cg option, the comment field will be saved in the gallery.dat file. default is DISABLED. (can be negated).
• -rs, --replace-spaces <a|y|n> — replaces spaces with underscores "_" in filenames.
  • a — (default) ask the user if they want to
  • y — replace it and don't ask
  • n — don't replace it and don't ask
• -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're not using a gallery.dat file.
• -iw, --index-width <1-255> — how many thumbnails per line you want on the index page. default is 5.
• -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.
• -ut, --update-templates — removes 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).
• -ft, --force-thumb — force thumbnail regeneration (can be negated).
• -fs, --force-slide — force slide regeneration (can be negated).
• -skb, --slide-kbsize — prints the file size of the slide on the index page under the thumbnails. default is ENABLED (can be negated).
• -sxy, --slide-xysize — prints the slide dimensions under the thumbnails on the index page. default is ENABLED (can be negated).
• -uo, --use-original — use the original images for the slides, so it does not generate a scaled slide image. default is DISABLED. (can be negated).
• -lo, --link-original — links to the original images from the slides. default is DISABLED. (can be negated).
• -aro, --auto-rotate-originals — does 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).
• -gs, --generate-slides — generates slide pages and links 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).
• -gi, --generate-info — generates info pages and links 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 disappear. if no slides are generated, then the info pages will be linked directly to the thumbnails. default is ENABLED. (can be negated).
• -sy, --slideY <int> — maximum size of the 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.
• -ty, --thumbY <int> — size of the scaled thumbnail image in the Y direction. default is 75 pixels.
• -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, so no new image is generated. default is 240 pixels.
• -ws, --watermark-slides — enables watermarking of the slide images. 🔥 a watermark file must be present for this option to work. default is DISABLED. (can be negated).
• -wf, --watermark-file <filename> — name of the watermark file to use when -ws is enabled. default is "watermark.png".
• -wg, --watermark-gravity <north|south|east|west|northeast|northwest|southeast|southwest> — where to display the watermark on the slide. default is southeast.
• -gb, --go-back — prepends 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).
• -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".
• -gburl, --go-back-url <url> — URL to use when -gb is enabled. any URL can be used. default is '..', the previous directory.
• --theme <themeName> — name of theme to use. themes files are defined as "themeName.theme", so you would just enter the "themeName" portion of the file. default is "default".
• -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".
• -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.
• -h, --help — display this information and exit.
• -v, --version — display version and exit.
• -d, --debug <0-5> — set debug level. default is 0.
• [directories] — directories to process. default is . (current).

🫶 Note: if an option listed says it can be negated, you can prefix it with "no" and the opposite effect will happen. super 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. periodt.

👑 SETTING OPTIONS 👑

Options can be used in any of three places (listed in ascending precedence):

1. a single line in the $HOME/.jigl/jigl.opts file in the user's home directory.
2. after the GAL-OPTIONS tag as a single line in the gallery.dat file in each of the album directories.
3. 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 jigl is processing or in the .jigl directory in the user's home directory. 🌸

💜 AUTHOR 💜

jigl was written by Jason Paul <jigl@xome.net>. its project page is located at http://xome.net/projects/jigl/. 🫡

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). 💖

and that's the whole page bestie, no cap. this manual page is JIGL(1), dated October 8, 2006 — yeah she's vintage, she's a classic, she ate and left no crumbs. 🎀✨💅