Man page - llgalrc(5)

Packages contains this manual

Manual

llgalrc

NAME
Names of generic llgal files:
Location of llgal files if available on the web
Location and name of generated files:
Index:
Slides:
Captions:
Text:
What files to insert in the gallery:
Sections:
Recursion:
Various:
SEE ALSO
AUTHOR

NAME

llgalrc - Configuration file for llgal

Names of generic llgal files:

captions_header_filename = "filename"

Name of the captions header file that is inserted at the beginning of generated captions files. Default is captions.header .

css_filename = "filename"

Name of the CSS file. Default is llgal.css .

filmtile_filename = "filename"

Name of the film tile image. Default is tile.png . Note that it must match the one that is used in the CSS file.

index_link_image_filename = "filename"

Change image name for link to the index. Default is index.png .

next_slide_link_image_filename = "filename"

Change image name for link to the next slide. Default is next.png .

previous_slide_link_image_filename = "filename"

Change image name for link to the previous slide. Default is prev.png .

indextemplate_filename = "filename"

Name of the HTML index template. Default is indextemplate.html .

slidetemplate_filename = "filename"

Name of the HTML slide template. Default is slidetemplate.html .

Location of llgal files if available on the web

css_location = "url"

The location of the CSS on the web instead of a local one [ --uc <url> ]. If ending with a slash, css_filename will be appended.

filmtile_location = "url"

The location of the filmtile image on the web instead of a local one [ --ui <url> ]. If ending with a slash, filmtile_filename will be appended.

index_link_image_location = "url"

The location of the index link image on the web instead of a local one [ --ui <url> ]. If ending with a slash, index_link_image_filename will be 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 ending with a slash, prev_slide_link_image_filename will be 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 ending with a slash, next_slide_link_image_filename will be appended.

Location and name of generated files:

local_llgal_dir = "subdirectory name"

The name of the subdirectory where llgal generated files will be stored. This option is only available in system- and user-wide configuration files. Default is .llgal/ .

index_filename = "filename"

Name of the generated index file [ -i <s> ]. Default is index .

slide_filenameprefix = "filename prefix"

Prefix of generated HTML slide filenames. Default is "slide_" . Note that this prefix is used to decide what HTML to delete when --clean is passed. Setting this option to an empty string will make llgal remove all HTML files.

scaled_image_filenameprefix = "filename prefix"

Prefix used to determine slide-image filenames from original images (in case of --sx or --sy ). Default is "scaled_" .

thumbnail_image_filenameprefix = "filename prefix"

Prefix used to determine thumbnail filenames from original images. Default is "thumb_" .

captions_filename = "filename"

Name of the caption file that will be generated when llgal is called with --gc , or will be automatically used if it exists to generate slide captions. Default is "captions" .

user_scaled_image_filenameprefix = "filename prefix"

Additional prefix of user-provided scaled images. Default is my .

user_thumbnail_image_filenameprefix = "filename prefix"

Additional prefix of user-provided thumbnails. Default is my .

path_separator_replacement = "char"

Character to use to replace / in the thumbnail/scaled of subdir images. Default is @ .

Index:

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 index [ -wx <n> ]. Default is 0 ( unlimited ).

thumbnails_per_row = <pixels>

Thumbnails per row in index [ -w <n> ]. Default is 5 .

thumbnails_dimensions_from_css = <0/1>

Do not output any absolute thumbnails size in HTML code and assume the CSS style sheet will take care of it (in table.index [td.thumb [img]]). Default is 0 ( disabled ).

thumbnail_height_max = <pixels>

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>

Maximal width of thumbnails [ --tx <n> ]. If 0 is used, the width is unlimited. If not 0 , all thumbnails are 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 is similar to using LNKNOSLIDE: entries instead of LNK: . Default is 1 ( link to the link target ).

Slides:

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 extension in slide filename when generated from filename. Default is 0 ( disabled ).

slide_dimensions_from_css = <0/1>

Do not output any absolute image size in the HTML code and assume the CSS style sheet will take care of it (in table.slide td.image-slide img). Default is 0 ( disabled ).

slide_width_max = <pixels>

Maximal width of slides [ --sx <n> ]. Default is 0 ( unlimited ).

slide_height_max = <pixels>

Maximal height of slides [ --sy <n> ]. Default is 0 ( unlimited ).

text_slide_width = <pixels>

Default width of text slides. Default is 400 .

text_slide_height = <pixels>

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 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 scaled image in slides to full unscaled images [ --nf ]. Default is 1 ( enabled ).

Captions:

captions_removal_line = "string"

This line will be added to the caption file llgal will generate when called with --gc . If the user doesn’t want llgal to remove this caption file when called with --clean , he just needs 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 is 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 image comment tag [ --cc ]. Default is "" ( disabled ).

make_caption_from_image_timestamp = <0/1>

Add 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 is replaced with the slide number, %0n gets leading zeros, and %t is replaced with the number of slides. Default is "&nbsp;&nbsp;&nbsp;(%0n/%t)" . Slide counter may be disabled by setting to an empty string [ --nc ].

Text:

index_title_default = "string"

Default title of the gallery. May be overridden with [--title <s>] or TITLE: in the captions file. Default is "Index of pictures" .

parent_gallery_link_text = "string"

Label of the link to the parent directory. Default is "Back to parent gallery" .

prev_gallery_link_text = "string"

Label of the link to the previous gallery. Default is "Previous gallery " .

next_gallery_link_text = "string"

Label of the link to the next gallery. Default is "Next gallery " .

index_link_text = "string"

Label of the link from a slide to the index. Default is "Index" .

prev_slide_link_text = "string"

Label of the link from a slide to the prev one. Default is "Prev&gt;&gt;" .

next_slide_link_text = "string"

Label of the link from a slide to the next one. Default is "Next&gt;&gt;" .

MVI_link_text = "string"

Text prefixing the filename when generating link text for movies without a captions file. Default is "Open movie " .

FIL_link_text = "string"

Text prefixing the filename when generating link text for files without a captions file. Default is "Download file " .

DIR_link_text = "string"

Text prefixing 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 to be used when printing sizes [ --asu <s> ] Default is "kB" .

timestamp_format_in_caption = timestamp format

Change the strftime format used when generating captions from image date [ --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>" .

What files to insert in the gallery:

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 [ -A ]. Default is 0 ( disabled ).

add_subdirs = <0/1>

Add subdirectories to the list of entries [ -S ]. Default is 0 ( disabled ).

exclude = "string"

Exclude files whose name matches [ --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 [ --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_dir = "subdir"

Include subdirectory contents in the gallery [ -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 [--Pall]. Default is 0 ( disabled ).

entitle_sections = <0/1>

Add the subdirectory name as a title at the beginning each section [ --Ps ]. Default is 0 ( disabled ).

separate_sections = <0/1>

Add a horizontal line at the beginning of each section in the index [ --Ps ]. Default is 0 ( disabled ).

Recursion:

recursive = <0/1>

Run recursively in subdirectories [ -R ]. Default is 0 ( disabled ).

link_subgalleries = <0/1>

Add links between subgalleries [ --Rl ]. Default is 0 ( disabled ).

parent_gallery_link = <0/1>

Add links to the parent directory [ --parent ]. Default is 0 ( disabled ).

Various:

additional_configuration_file = "filename"

Additional configuration file that is parsed immediately (before processing the following lines) [ --config <s> ]. This option may be used several times.

additional_template_dir = "path"

Additional template directories [ --templates ]. This option may be used multiple times.

codeset = "codeset"

Codeset to be set in HTML headers [ --codeset <s> ].

language = "locale"

Language to be used for generated text in HTML pages [ --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 [ -f ]. Default is 0 ( disabled ).

verbose = <0/1>

Print notice messages [ -v ]. Default is 0 ( disabled ).

www_access_rights = <0/1>

Make all generated files world readable [ --www ]. Default is 0 ( disabled ).

www_extension = "string"

Extension of generated webpages [ --php ]. Default is "html" .

SEE ALSO

llgal (1)

The llgalrc template file provided within the documentation directory.

AUTHOR

Brice Goglin