genwebgallery

view genwebgallery.1 @ 6:cb0dff8c48c6

added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
author meillo@marmaro.de
date Fri, 23 Nov 2007 22:43:41 +0100
parents 737fe869e278
children 27f96c3b8224
line source
1 .TH GENWEBGALLERY 1 "genwebgallery-VERSION" "2007-11-21" "genwebgallery"
3 .SH NAME
4 genwebgallery
6 .SH SYNOPSIS
7 .B genwebgallery [OPTIONS] PICTURES
9 .SH DESCRIPTION
10 .B genwebgallery
11 Generates a web gallery of mentioned pictures. Only very minimalistic static HTML pages are generated. Copies of the pictures get resized to the defined sizes.
12 .PP
13 All generated content goes in a subdirectory which defaults to 'webgallery'. Or any other directory specified by --output.
14 .PP
15 The
16 .BR convert
17 tool from ImageMagick is required.
19 .SH OPTIONS
20 .TP
21 .B \-\-help
22 Show summary of options.
23 .TP
24 .B \-\-version
25 Show version of program
26 .TP
27 .B \-v, \-\-verbose
28 Outputs more log data
29 .TP
30 .B \-o, \-\-output
31 Specify output directory
32 .TP
33 .B \-i, \-\-index
34 Specify index file (index.htm)
35 .TP
36 .B \-t, \-\-title
37 Specify title of gallery
38 .TP
39 .B \-c, \-\-copyright
40 Specify copyright notice
41 .TP
42 .B \-ps, \-\-pic-size
43 Specify size of picture
44 .TP
45 .B \-ts, \-\-thumb-size
46 Specify size of thumbnails
47 .TP
48 .B \-\-overwrite
49 Overwrites the output directory if it exists without asking.
50 Without this option, the users is interactively asked what to do.
51 .PP
52 See
53 .B genwebgallery --help
54 for default values.
56 .SH EXIT CODE
57 .TP
58 .B 1
59 Any other error
60 .TP
61 .B 2
62 The required program
63 .B convert
64 could not be found. It's probably not installed.
65 Normally it is provided by the ImageMagick tool collection.
66 .TP
67 .B 3
68 The output directory already exists and the user wanted to keep it.
69 .TP
70 .B 4
71 The output directory already exists and the user wanted it to be deleted, but it was not possible.
73 .SH SEE ALSO
74 .BR convert (1),
75 .BR ImageMagick (1).
77 .SH AUTHOR
78 genwebgallery and this man page was written by markus schnalke <meillo@marmaro.de>
79 .PP
80 Website: http://prog.marmaro.de