Debian Codegraph @

doc/llgalrc

raw
1 # llgal configuration options.
2 # These options may be defined in /etc/llgal/llgalrc, a per-user
3 # ${HOME}/.llgal/llgalrc file or a directory-specific .llgal/llgalrc.
4
5 # Most of these options may later be overridden by command line options.
6 # Default are shown in examples below.
7 # Syntax is one of these:
8 # variable = "string"
9 # variable = decimal number
10 # variable = 0 or 1 for disabling or enabled
11 # For now, only static values are supported.
12 # Brackets indicate corresponding command line options.
13
14 ##### Name of generic llgal files #####
15
16 # Name of the captions header file that is inserted at the beginning
17 # of generated captions files.
18 # captions_header_filename = "captions.header"
19
20 # Name of the CSS file.
21 # Such a file will be stored under $local_llgal_dir.
22 # css_filename = "llgal.css"
23
24 # Name of the film tile image.
25 # Such a file will be stored under $local_llgal_dir.
26 # Note that this filename must match the one that is used in the CSS file.
27 # filmtile_filename = "tile.png"
28
29 # Name for image link to the index, previous or next slide
30 # index_link_image_filename = "index.png"
31 # prev_slide_link_image_filename = "prev.png"
32 # next_slide_link_image_filename = "next.png"
33
34 # Name of the index template.
35 # Such a template file will be used during gallery generation.
36 # indextemplate_filename = "indextemplate.html"
37
38 # Name of the slide template.
39 # Such a template file will be used during gallery generation.
40 # slidetemplate_filename = "slidetemplate.html"
41
42 ##### Location of llgal files if available on the web #####
43
44 # Location of the CSS file if available on the web [--uc <url>].
45 # If ending with '/', css_filename will be added.
46 # css_location = ""
47
48 # Location of llgal image files if available on the web.
49 # If ending with '/', their generic filename will be added.
50 # These locations may be set alltogether with --ui <url>.
51 # filmtile_location = ""
52 # index_link_image_location = ""
53 # prev_slide_link_image_location = ""
54 # next_slide_link_image_location = ""
55
56 ##### Location and name of generated files #####
57
58 # Local subdirectory where llgal files generated files will be stored.
59 # This option is only available in system- and user-wide configuration
60 # files.
61 # Note that HTML files are generated in place while captions and CSS
62 # are kept in this subdirectory.
63 # Gallery specific HTML templates and llgalrc configuration file
64 # might also be defined here.
65 # local_llgal_dir = ".llgal"
66
67 # Name of the generated index file [-i <s>]
68 # index_filename = "index"
69
70 # Prefix of generated HTML slide filenames
71 # Note that this prefix is used to decide what HTML to delete when --clean
72 # is passed. Setting this option to an empty string will make llgal remove
73 # all HTML files.
74 # slide_filenameprefix = "slide_"
75
76 # Prefix used to determine the filenames of scaled image that are
77 # shown in slides (in case of --sx or --sy).
78 # These files will be stored under $local_llgal_dir.
79 # scaled_image_filenameprefix = "scaled_"
80
81 # Prefix used to determine thumbnail filenames from original images.
82 # These files will be stored under $local_llgal_dir.
83 # thumbnail_image_filenameprefix = "thumb_"
84
85 # Name of the captions file that will be generated when llgal is called
86 # with --gc. This file will be stored under $local_llgal_dir.
87 # captions_filename = "captions"
88
89 # Additional prefix of user-provided scaled images
90 # user_scaled_image_filenameprefix = "my"
91
92 # Additional prefix of user-provided thumbnails
93 # user_thumbnail_image_filenameprefix = "my"
94
95 # Character to use to replace / in the thumbnail/scaled of subdir images
96 # path_separator_replacement = "@"
97
98 ##### Index #####
99
100 # Cellpadding in the index table [-p <n>]
101 # Must be >= 0, setting to < 0 resets to default
102 # index_cellpadding = 3
103
104 # Display links and text as regular text instead of thumbnails
105 # in the main gallery thumbnail index [-L]
106 # list_links = 0
107
108 # Pixels per row of thumbnails in index [--wx <n>]
109 # Must be > 0, 0 means unlimited, setting to < 0 resets to default
110 # pixels_per_row = 0
111
112 # Thumbnails per row in index [-w <n>]
113 # Must be > 0, 0 means unlimited, setting to < 0 resets to default
114 # thumbnails_per_row = 5
115
116 # Do not output any absolute thumbnail sizes in HTML code and assume the
117 # CSS style sheet will take care of it (in table.index [td.image-slide [img]])
118 # slide_dimensions_from_css = 0
119
120 # Maximal height of thumbnails [--ty <n>]
121 # Must be > 0, setting to < 0 resets to default
122 # Changing this value does not affect the maximal width (see thumbnail_width_max)
123 # thumbnail_height_max = 75
124
125 # Maximal width of thumbnails [--tx <n>]
126 # Must be > 0, 0 means unlimited, setting to < 0 resets to default
127 # Changing this value does not affect the maximal height (see thumbnail_height_max)
128 # thumbnail_width_max = 113
129
130 # Write captions under thumbnails [-u]
131 # show_caption_under_thumbnails = 0
132
133 # Show a film effect in the index of thumbnails [--fe]
134 # show_film_effect = 0
135
136 # Make thumbnail links point to the target object instead of
137 # the corresponding slide
138 # MVI_link_to_target = 0
139 # FIL_link_to_target = 0
140 # DIR_link_to_target = 0
141 # LNK_link_to_target = 0
142
143 ##### Slides #####
144
145 # Make no slides [-s]
146 # make_no_slides = 0
147
148 # Use filename as slide filename [-n]
149 # make_slide_filename_from_filename = 0
150
151 # Also use extension in the slide filename to differenciate
152 # slide filename of images that have same filenames.
153 # make_slide_filename_from_extension = 0
154
155 # Do not output any absolute image size in the HTML code and assume the
156 # CSS style sheet will take care of it (in table.slide td.image-slide img)
157 # slide_dimensions_from_css = 0
158
159 # Maximal width of slides [--sx <n>]
160 # Must be > 0, 0 means unlimited, setting to < 0 resets to default
161 # slide_width_max = 0
162
163 # Maximal height of slides [--sy <n>]
164 # Must be > 0, 0 means unlimited, setting to < 0 resets to default
165 # slide_height_max = 0
166
167 # Default size of non-image slides.
168 # Must be > 0, setting to < 0 resets to default
169 # Note that the --sx and --sy options may lead to reduction of these values.
170 # text_slide_width = 400
171 # text_slide_height = 300
172
173 # Use an image instead of a text label for the link to the index,
174 # previous or next slide [--li]
175 # index_link_image = 0
176 # next_slide_link_image = 0
177 # prev_slide_link_image = 0
178
179 # Use a thumbnail preview instead of a text label for the link
180 # to the previous or next slide [--lt]
181 # next_slide_link_preview = 0
182 # prev_slide_link_preview = 0
183
184 # Generate slide titles from captions [-k]
185 # make_slide_title_from_caption = 0
186
187 # Generate links between last and first slides or galleries.
188 # link_between_last_and_first = 1
189
190 # Display a table of EXIF tags under each image slide [--exif]
191 # The tags are given with their name in exiftool -list and separated
192 # with a comma.
193 # show_exif_tags = ""
194
195 # Display a table of all available EXIF tags under each image slide [--exif]
196 # show_all_exif_tags = 0
197
198 ##### Captions #####
199
200 # This line will be added to the captions file llgal will generate when
201 # called with --gc. If the user doesn't want llgal to remove this captions
202 # file when called with --clean, it just needs to remove this line from
203 # the file.
204 # captions_removal_line = "REMOVE THIS LINE IF LLGAL SHOULD NOT REMOVE THIS FILE"
205
206 # Generate captions from comment stored in images [--cc [<s>]]
207 # make_caption_from_image_comment = ""
208
209 # Also generate captions from timestamp stored in images [--ct]
210 # make_caption_from_image_timestamp = 0
211
212 # Generate captions from filenames without their extension [--cf]
213 # make_caption_from_filename = 0
214
215 # Generate captions from filenames with their extension
216 # make_caption_from_extension = 0
217
218 # Show dimensions and/or size of the images and movies [-a, --ad, --as]
219 # show_dimensions = 0
220 # show_size = 0
221
222 # Change the format of the counter shown on the slides
223 # %n is replaced by the slide number, %0n gets leading zeros,
224 # and %t is replaced by the number of slides.
225 # Setting to "" disables the slide counter [--nc]
226 # slide_counter_format = "&nbsp;&nbsp;&nbsp;(%0n/%t)"
227
228 ##### Text #####
229
230 # Default title of the gallery.
231 # May be overridden with [--title <s>] or TITLE: in the captions file.
232 # index_title_default = "Index of pictures"
233
234 # Change text in links to parent directory.
235 # parent_gallery_link_text = "Back to parent gallery"
236
237 # Change text in links to previous gallery.
238 # prev_gallery_link_text = "Previous gallery "
239
240 # Change text in links to next directory.
241 # next_gallery_link_text = "Next gallery "
242
243 # Label of the link from a slide to the index
244 # index_link_text = "Index"
245
246 # Label of the link from a slide to the previous one
247 # prev_slide_link_text = "&lt;&lt;Prev"
248
249 # Label of the link from a slide to the next one
250 # next_slide_link_text = "Next&gt;&gt;"
251
252 # Text prefixing the filename when generating link text
253 # for movies without a captions file.
254 # MVI_link_text = "Open movie "
255
256 # Text prefixing the filename when generating link text
257 # for files without a captions file.
258 # FIL_link_text = "Download file "
259
260 # Text prefixing the filename when generating link text
261 # for directories without a captions file.
262 # DIR_link_text = "Open subgallery "
263
264 # Text shown as image alternative for full-size images in slides
265 # alt_full_text = ""
266
267 # Text shown as image alternative for scaled images in slides
268 # alt_scaled_text = "Scaled image "
269
270 # Text shown as image alternative for thumbnails in the index
271 # alt_thumbnail_text = "Thumbnail "
272
273 # Text shown as an image alternative for the film tile in the index
274 # alt_film_tile_text = "Film tile"
275
276 # Text shown when the mouse pointer is over a scaled image in a slide
277 # over_scaled_text = "Click to see full size "
278
279 # Text shown when the mouse pointer is over a thumbnail
280 # over_thumbnail_text = "Click to enlarge "
281
282 # Text shown when the mouse pointer is over a link from a slide to the index
283 # over_index_link_text = "Return to the index"
284
285 # Text shown when the mouse pointer is over a link from a slide to the previous one
286 # over_prev_slide_link_text = "Previous slide "
287
288 # Text shown when the mouse pointer is over a link from a slide to the next one
289 # over_next_slide_link_text = "Next slide "
290
291 # Unit to be used when printing sizes [--asu <s>]
292 # show_size_unit = "kB"
293
294 # Set timestamp format in captions (when enabled) using strftime format [--ct <s>]
295 # timestamp_format_in_caption = "%Y-%m-%d %H:%M:%S"
296
297 # Credits line at the bottom of the index
298 # credits_text = "created with <a href=\"http://bgoglin.free.fr/llgal\">llgal</a>"
299
300 ##### What files to insert in the gallery #####
301
302 # Extensions that are matched when searching images (|-separated list)
303 # image_extensions = "jpg|jpeg|gif|png|tif|tiff|bmp"
304
305 # Extensions that are matched when searching movies (|-separated list)
306 # movie_extensions = "mpg|mpeg|avi|mov|ogm|wmv|mp4|3gp"
307
308 # Add all files to the list of entries
309 # not only images and movies [-A]
310 # add_all_files = 0
311
312 # Add subdirectories to the list of entries [-S]
313 # add_subdirs = 0
314
315 # Exclude files whose name matches [--exclude <s>]
316 # This option may be used several times.
317 # exclude = "regexp"
318
319 # Include files whose name matches and were previously excluded [--include <s>].
320 # This option may be used several times.
321 # The order of includes and excludes is respected.
322 # include = "regexp"
323
324 # Sort criteria when scanning files in the working directory [--sort]
325 # sort_criteria = "name"
326
327 ##### Sections #####
328
329 # Add a new subdirectory to the list of sections [-P]
330 # section_dir = "subdir"
331
332 # Add all subdirectories to the list of sections [--Pall]
333 # recursive_sections = 0
334
335 # Add the subdirectory name as a title at the beginning of each section [--Ps]
336 # entitle_sections = 0
337
338 # Add a horizontal line at the beginning of each section in the index [--Ps]
339 # separate_sections = 0
340
341 ##### Recursion #####
342
343 # Run recursively in subdirectories [-R]
344 # recursive = 0
345
346 # Add links between subgalleries [--Rl]
347 # link_subgalleries = 0
348
349 # Add links to the parent directory [--parent-gal]
350 # parent_gallery_link = 0
351
352 ##### Various #####
353
354 # Additional configuration file [--config <s>]
355 # This option may be used multiple times.
356 # additional_configuration_file = "my_llgal.rc"
357
358 # Additional template directories [--templates].
359 # This option may be used multiple times.
360 # additional_template_dir = "path"
361
362 # Codeset to be set in HTML headers [--codeset <s>]
363 # codeset = "codeset"
364
365 # Language to be used for generated text in HTML pages [--lang <s>]
366 # If set, the LANGUAGE environment variable might prevent this option from working.
367 # language = "locale"
368
369 # Command to be used to generate scaled images and thumbnails
370 # thumbnail_create_command = "convert -scale <MAXW>x<MAXH> -- <IN> <OUT>"
371 # scaled_create_command = "convert -scale <MAXW>x<MAXH> -- <IN> <OUT>"
372
373 # Force regeneration of thumbnails and scaled images [-f].
374 # force_image_regeneration = 0
375
376 # Print notice messages [-v]
377 # verbose = 0
378
379 # Give access rights for www access [--www]
380 # www_access_rights = 0
381
382 # Extension of generate webpages [--php]
383 # www_extension = "html"