genwebgallery
view genwebgallery.1 @ 32:8164905ea8af
added description to NAME section in manpage (according to debian policy)
author | meillo@marmaro.de |
---|---|
date | Wed, 04 Jun 2008 22:57:09 +0200 |
parents | 9fac7c9e2611 |
children | 42bf012f6045 |
line source
1 .TH GENWEBGALLERY 1 "genwebgallery\-0.5" "2008\-06\-04" "genwebgallery"
3 .SH NAME
4 genwebgallery \- generates minimalistic web galleries
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 are 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 Files are skipped if
16 .B convert
17 fails in conversion.
18 .PP
19 The
20 .BR convert
21 tool from ImageMagick is required.
23 .SH OPTIONS
24 .TP
25 .B \-\-help
26 Show summary of options.
27 .TP
28 .B \-\-version
29 Show version of program
30 .TP
31 .B \-v, \-\-verbose
32 Outputs more log data
33 .TP
34 .B \-o, \-\-output
35 Specify output directory
36 .TP
37 .B \-i, \-\-index
38 Specify index file (index.htm)
39 .TP
40 .B \-t, \-\-title
41 Specify title of gallery
42 .TP
43 .B \-c, \-\-copyright
44 Specify copyright notice
45 .TP
46 .B \-ps, \-\-pic\-size
47 Specify size of pictures
48 .TP
49 .B \-ts, \-\-thumb\-size
50 Specify size of thumbnails
51 .TP
52 .B \-\-overwrite
53 Overwrites the output directory if it exists without asking.
54 Without this option, the users is interactively asked what to do.
55 .PP
56 See
57 .B genwebgallery \-\-help
58 for default values.
60 .SH EXIT CODE
61 .TP
62 .B 1
63 Any other error
64 .TP
65 .B 2
66 The required program
67 .B convert
68 could not be found. It's probably not installed.
69 Normally it is provided by the ImageMagick tool collection.
70 .TP
71 .B 3
72 The output directory already exists and the user wanted to keep it.
73 .TP
74 .B 4
75 The output directory already exists and the user wanted it to be deleted, but it was not possible.
77 .SH BUGS
78 .B convert
79 fails the conversion of the XCF image format of GIMP, but it exits with 0 anyway. This looks like a bug in the
80 .B convert
81 program.
82 As result the image is added to the gallery but it is not viewable.
83 Other formats might be affected as well.
85 .SH SEE ALSO
86 .BR convert (1),
87 .BR ImageMagick (1).
89 .SH AUTHOR
90 genwebgallery and this man page were written by markus schnalke <meillo@marmaro.de>
91 .PP
92 Website: http://prog.marmaro.de/genwebgallery