llgalrc(5)

📦 version 0.13.19, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

🌸 NAME 🌸

okay bestie, gather round 💖 this is llgalrc(5), from the File Formats Manual, and it is literally the configuration file for llgal. a whole manpage for one config file? she's giving main character energy and honestly, deserved. 👑

it's long, so we're doing this in parts. buckle up. ✨

🎀 Names of generic llgal files 🎀

these are the names of the generic llgal files — the building blocks, the essentials, the girlies:

  • captions_header_filename = "filename" — the name of the captions header file that gets inserted at the beginning of generated captions files. default is captions.header. 💅
  • css_filename = "filename" — the name of the CSS file. default is llgal.css. 🦋
  • filmtile_filename = "filename" — the name of the film tile image. default is tile.png. heads up: it has to match the one used in the CSS file, no cap. ⭐
  • index_link_image_filename = "filename" — changes the image name for the link to the index. default is index.png. 🌸
  • next_slide_link_image_filename = "filename" — changes the image name for the link to the next slide. default is next.png. 🌈
  • previous_slide_link_image_filename = "filename" — changes the image name for the link to the previous slide. default is prev.png. 🎀
  • indextemplate_filename = "filename" — the name of the HTML index template. default is indextemplate.html. ✨
  • slidetemplate_filename = "filename" — the name of the HTML slide template. default is slidetemplate.html. 💜

🌐 Location of llgal files if available on the web 🌐

if your files live on the web, here's where you tell llgal about it:

  • css_location = "url" — the location of the CSS on the web instead of a local one [--uc <url>]. if it ends with a slash, css_filename gets appended. 🫶
  • filmtile_location = "url" — the location of the filmtile image on the web instead of a local one [--ui <url>]. if it ends with a slash, filmtile_filename gets appended. 🦋
  • index_link_image_location = "url" — the location of the index link image on the web instead of a local one [--ui <url>]. if it ends with a slash, index_link_image_filename gets appended. 💖
  • prev_slide_link_image_location = "url" — the location of the prev slide link image on the web instead of a local one [--ui <url>]. if it ends with a slash, prev_slide_link_image_filename gets appended. 🌸
  • next_slide_link_image_location = "url" — the location of the next slide link image on the web instead of a local one [--ui <url>]. if it ends with a slash, next_slide_link_image_filename gets appended. 🌈

📁 Location and name of generated files 📁

where the output goes and what it's called:

  • local_llgal_dir = "subdirectory name" — the name of the subdirectory where llgal's generated files get stored. this option is only available in system- and user-wide configuration files. default is .llgal/. 🔥
  • index_filename = "filename" — the name of the generated index file [-i <s>]. default is index. ⭐
  • slide_filenameprefix = "filename prefix" — the prefix of generated HTML slide filenames. default is "slide_". note that this prefix is what decides which HTML gets deleted when --clean is passed. 👀
setting this option to an empty string will make llgal remove ALL HTML files. bestie. all of them. be so serious before you do this. 💀
  • scaled_image_filenameprefix = "filename prefix" — the prefix used to figure out slide-image filenames from original images (this is for the --sx or --sy case). default is "scaled_". 🦋
  • thumbnail_image_filenameprefix = "filename prefix" — the prefix used to figure out thumbnail filenames from original images. default is "thumb_". 💅
  • captions_filename = "filename" — the name of the caption file that gets generated when llgal is called with --gc, or that gets automatically used if it exists, to generate slide captions. default is "captions". 🎀
  • user_scaled_image_filenameprefix = "filename prefix" — an additional prefix for user-provided scaled images. default is my. 🌸
  • user_thumbnail_image_filenameprefix = "filename prefix" — an additional prefix for user-provided thumbnails. default is my. 🌸
  • path_separator_replacement = "char" — the character used to replace / in the thumbnail/scaled versions of subdir images. default is @. ✨

🖼️ Index 🖼️

all the thumbnail-grid business, iykyk:

  • index_cellpadding = <pixels> — cellpadding in the index table [-p <n>]. default is 3. 💅
  • list_links = <0/1> — display links and text as regular text instead of thumbnails in the main gallery thumbnail index [-L]. default is 0 (disabled). 📝
  • pixels_per_row = <pixels> — pixels per row of thumbnails in the index [-wx <n>]. default is 0 (unlimited). 🔥
  • thumbnails_per_row = <pixels> — thumbnails per row in the index [-w <n>]. default is 5. 🌈
  • thumbnails_dimensions_from_css = <0/1> — don't output any absolute thumbnail size in the HTML code and just assume the CSS style sheet will handle it (in table.index [td.thumb [img]]). default is 0 (disabled). 🎀
  • thumbnail_height_max = <pixels> — the maximal height of thumbnails [--ty <n>]. default is 75. changing this value does not affect the maximal width (see thumbnail_width_max). ⭐
  • thumbnail_width_max = <pixels> — the maximal width of thumbnails [--tx <n> ]. if 0 is used, the width is unlimited. if it's not 0, all thumbnails get padded to the given width. default is 113. changing this value does not affect the maximal height (see thumbnail_height_max). 💖
  • show_caption_under_thumbnails = <0/1> — write captions under thumbnails [-u]. default is 0 (disabled). 🦋
  • show_film_effect = <0/1> — show film effect [--fe]. default is 0 (disabled). 🎬
  • MVI_link_to_target = <0/1> — make movie thumbnails' links point to the movie instead of the corresponding slide. default is 1 (link to the movie). 🔥
  • FIL_link_to_target = <0/1> — make file thumbnails' links point to the file instead of the corresponding slide. default is 1 (link to the file). 📄
  • DIR_link_to_target = <0/1> — make directory thumbnails' links point to the movie instead of the corresponding slide. default is 1 (link to the directory). 📁
  • LNK_link_to_target = <0/1> — make link thumbnails point to the link instead of the corresponding slide. it's similar to using LNKNOSLIDE: entries instead of LNK:. default is 1 (link to the link target). 🔗

🎞️ Slides 🎞️

the slides themselves, the moment, the drama:

  • make_no_slides = <0/1> — make no slides [-s]. default is 0 (make slides). 🙈
  • make_slide_filename_from_filename = <0/1> — use filenames as slide filenames [-n]. default is 0 (disabled). 💅
  • make_slide_filename_from_extension = <0/1> — also use the extension in the slide filename when it's generated from the filename. default is 0 (disabled). ✨
  • slide_dimensions_from_css = <0/1> — don't output any absolute image size in the HTML code and just assume the CSS style sheet will handle it (in table.slide td.image-slide img). default is 0 (disabled). 🦋
  • slide_width_max = <pixels> — the maximal width of slides [--sx <n>]. default is 0 (unlimited). 🔥
  • slide_height_max = <pixels> — the maximal height of slides [--sy <n>]. default is 0 (unlimited). 🔥
  • text_slide_width = <pixels> — the default width of text slides. default is 400. 📝
  • text_slide_height = <pixels> — the default height of text slides. default is 300. 📝
  • index_link_image = <0/1> — use an image instead of a text label for the link to the index [--li]. default is 0 (disabled). 🖼️
  • prev_slide_link_image = <0/1> — use an image instead of a text label for the link to the previous slide [--li]. default is 0 (disabled). ⬅️
  • next_slide_link_image = <0/1> — use an image instead of a text label for the link to the next slide [--li]. default is 0 (disabled). ➡️
  • prev_slide_link_preview = <0/1> — use a thumbnail preview instead of a text label for the link to the previous slide [--lt]. default is 0 (disabled). 🌸
  • next_slide_link_preview = <0/1> — use a thumbnail preview instead of a text label for the link to the next slide [--lt]. default is 0 (disabled). 🌸
  • link_between_last_and_first = <0/1> — generate links between the last and first slides or galleries. default is 1 (enabled). 🔁
  • make_slide_title_from_caption = <0/1> — generate slide titles from captions [-k]. default is 0 (disabled). 💖
  • show_exif_tags = <tag1,tag2,...> — display a table of EXIF tags under each image slide [--exif]. the tags are given with their name in exiftool -list and separated with a comma. 📸
  • show_all_exif_tags = <0/1> — display a table of all available EXIF tags under each image slide [--exif]. 🤯
  • slide_link_to_full_image = <0/1> — link the scaled image in slides to the full unscaled images [--nf]. default is 1 (enabled). 🔍

💬 Captions 💬

the little text moments under your pics:

  • captions_removal_line = "string" — this line gets added to the caption file llgal generates when it's called with --gc. if the user doesn't want llgal to remove this caption file when called with --clean, they just need to remove this line from the file. default is "REMOVE THIS LINE IF LLGAL SHOULD NOT REMOVE THIS FILE". 🚨
  • make_caption_from_filename = <0/1> — generate captions from filenames. the extension gets removed, except for directories. [--cf]. default is 0 (disabled). 💅
  • make_caption_from_extension = <0/1> — generate captions from filenames with their extension. 0 (disabled). 🦋
  • make_caption_from_image_comment = ,-separated strings of +-separated strings — generate captions from the image comment tag [--cc]. default is "" (disabled). 💬
  • make_caption_from_image_timestamp = <0/1> — add the image timestamp to generated captions [--ct]. default is 0 (disabled). ⏰
  • show_dimensions = <0/1> — show image dimensions [-a, -ad]. default is 0 (disabled). 📐
  • show_size = <0/1> — show file sizes [-a, -as]. default is 0 (disabled). 💾
  • slide_counter_format = "format" — change the format of the counter on the slides. %n gets replaced with the slide number, %0n gets leading zeros, and %t gets replaced with the number of slides. default is "&nbsp;&nbsp;&nbsp;(%0n/%t)". the slide counter can be disabled by setting it to an empty string [--nc]. 🔢

💬 TEXT 💬

okay bestie, this section is all about the words and labels that show up in your gallery. every title, tooltip, alt text, link label — the whole vibe. let's go 💅

  • index_title_default = "string" — the default title of the gallery. you can override it with [--title <s>] or with TITLE: in the captions file. default is "Index of pictures". ✨
  • parent_gallery_link_text = "string" — the label of the link to the parent directory. default is "Back to parent gallery". 🫶
  • prev_gallery_link_text = "string" — the label of the link to the previous gallery. default is "Previous gallery " (yes, with a trailing space, don't @ me). 💖
  • next_gallery_link_text = "string" — the label of the link to the next gallery. default is "Next gallery " (also with a trailing space). 🌸
  • index_link_text = "string" — the label of the link from a slide to the index. default is "Index". 🎀
  • prev_slide_link_text = "string" — the label of the link from a slide to the previous one. default is "Prev&gt;&gt;". 🦋
  • next_slide_link_text = "string" — the label of the link from a slide to the next one. default is "Next&gt;&gt;". 🦋
  • MVI_link_text = "string" — text that prefixes the filename when generating link text for movies without a captions file. default is "Open movie ". 🎬
  • FIL_link_text = "string" — text that prefixes the filename when generating link text for files without a captions file. default is "Download file ". 📥
  • DIR_link_text = "string" — text that prefixes the filename when generating link text for directories without a captions file. default is "Open subgallery ". 📁
  • alt_full_text = "string" — text shown as an image alternative for full-size images in slides. default is "". 🖼️
  • alt_scaled_text = "string" — text shown as an image alternative for scaled images in slides. default is "Scaled image ". 🔍
  • alt_thumbnail_text = "string" — text shown as an image alternative for thumbnails in the index. default is "Thumbnail ". 🖼️
  • alt_film_tile_text = "string" — text shown as an image alternative for the film tile in the index. default is "Film Tile". 🎞️
  • over_scaled_text = "string" — text shown when the mouse pointer is over a scaled image in a slide. default is "Click to see full size ". 🖱️
  • over_thumbnail_text = "string" — text shown when the mouse pointer is over a thumbnail. default is "Click to enlarge ". 🖱️
  • over_index_link_text = "string" — text shown when the mouse pointer is over a link from a slide to the index. default is "Return to the index". 🔙
  • over_prev_slide_link_text = "string" — text shown when the mouse pointer is over a link from a slide to the previous one. default is "Previous slide ". ⬅️
  • over_next_slide_link_text = "string" — text shown when the mouse pointer is over a link from a slide to the next one. default is "Next slide ". ➡️
  • show_size_unit = "string" — unit used when printing sizes, with [--asu <s>]. default is "kB". 📏
  • timestamp_format_in_caption = timestamp format — change the strftime format used when generating captions from image date, with [--ct <s>]. default is "%Y-%m-%d %H:%M:%S". ⏰
  • credits_text = "string" — credits text at the bottom of the index. default is "created with <a href="http://bgoglin.free.fr/llgal">llgal</a>". 💖

bestie, this is the guest list — which files get invited to the gallery party 🎉 and which ones get left on read.

  • image_extensions = "|-separated strings" — extensions that are matched when searching images. default is "jpg|jpeg|png|gif|tif|tiff|bmp". 📷
  • movie_extensions = "|-separated strings" — extensions that are matched when searching movies. default is "mpg|mpeg|avi|mov|ogm|wmv". 🎥
  • add_all_files = <0/1> — add all files to the list of entries, not only images and movies, with [-A]. default is 0 (disabled). 🗂️
  • add_subdirs = <0/1> — add subdirectories to the list of entries, with [-S]. default is 0 (disabled). 📂
  • exclude = "string" — exclude files whose name matches, with [--exclude <s>]. this option may be used several times. dot beginning files and html files are excluded by default. 🚫
  • include = "string" — include files whose name matches and were previously excluded, with [--include <s>]. this option may be used several times. the order of includes and excludes is respected. ✅
  • sort_criteria = "string" — sort criteria when scanning files in the working directory. default is "name". 🔤

🗂️ SECTIONS 🗂️

section slay — organize your gallery into cute little chapters 💖

  • section_dir = "subdir" — include subdirectory contents in the gallery, with [-P <subdir>]. this option may be used several times. subdirectory path must be given relatively to the working directory. default is to use the content of the working directory. 📁
  • recursive_sections = <0/1> — add all subdirectories to the list of sections, with [--Pall]. default is 0 (disabled). 🔄
  • entitle_sections = <0/1> — add the subdirectory name as a title at the beginning each section, with [--Ps]. default is 0 (disabled). 🏷️
  • separate_sections = <0/1> — add a horizontal line at the beginning of each section in the index, with [--Ps]. default is 0 (disabled). ➖

🔁 RECURSION 🔁

it's giving inception — go deeper, bestie 🌀

  • recursive = <0/1> — run recursively in subdirectories, with [-R]. default is 0 (disabled). 🌀
  • link_subgalleries = <0/1> — add links between subgalleries, with [--Rl]. default is 0 (disabled). 🔗
  • parent_gallery_link = <0/1> — add links to the parent directory, with [--parent]. default is 0 (disabled). 👆

✨ VARIOUS ✨

the grab bag of extra config, bestie. everything else you might need 💅

  • additional_configuration_file = "filename" — additional configuration file that is parsed immediately (before processing the following lines), with [--config <s>]. this option may be used several times. 📄
  • additional_template_dir = "path" — additional template directories, with [--templates]. this option may be used multiple times. 🎨
  • codeset = "codeset" — codeset to be set in HTML headers, with [--codeset <s>]. 🔤
  • language = "locale" — language to be used for generated text in HTML pages, with [--lang <s>]. if set, the LANGUAGE environment variable might prevent this option from working. 🌍
  • scaled_create_command = "string" — command to use to create scaled images for slides. default is "convert --scale <MAXW>x<MAXH> -- <IN> <OUT>". see THUMBNAILS AND SCALED IMAGES GENERATION for details. 🖼️
  • thumbnail_create_command = "string" — command to use to create thumbnails for the index. default is "convert --scale <MAXW>x<MAXH> -- <IN> <OUT>". see THUMBNAILS AND SCALED IMAGES GENERATION for details. 🖼️
  • force_image_regeneration = <0/1> — force regeneration of thumbnails and scaled images, with [-f]. default is 0 (disabled). 🔄
  • verbose = <0/1> — print notice messages, with [-v]. default is 0 (disabled). 📢
  • www_access_rights = <0/1> — make all generated files world readable, with [--www]. default is 0 (disabled). 🌐
  • www_extension = "string" — extension of generated webpages, with [--php]. default is "html". 📄

👀 SEE ALSO 👀

  • llgal(1)
  • The llgalrc template file provided within the documentation directory. 📁

👑 AUTHOR 👑

Brice Goglin 👑

and that's a wrap, bestie 💖 this page was llgalrc(5), dated NOVEMBER 2006. now go make the most iconic gallery the internet has ever seen. periodt. 💅✨

📦 where this page comes from