genwebgallery

view genwebgallery.1 @ 39:c1d50b95f177

added backslashes to hyphens in man page
author meillo@marmaro.de
date Thu, 05 Jun 2008 21:28:59 +0200
parents 42bf012f6045
children aac9290f9808
line source
1 .TH GENWEBGALLERY 1 "genwebgallery\-0.7" "2008\-06\-05" "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
14 .IR webgallery .
15 Or any other directory specified by \-\-output.
16 .PP
17 Files are skipped if
18 .B convert
19 fails in conversion.
20 .PP
21 The
22 .BR convert
23 tool from ImageMagick is required.
25 .SH OPTIONS
26 .TP
27 .B \-\-help
28 Show summary of options.
29 .TP
30 .B \-\-version
31 Show version of program
32 .TP
33 .B \-v, \-\-verbose
34 Outputs more log data
35 .TP
36 .B \-o, \-\-output
37 Specify output directory
38 .TP
39 .B \-i, \-\-index
40 Specify index file
41 .TP
42 .B \-t, \-\-title
43 Specify title of gallery
44 .TP
45 .B \-f, \-\-footer
46 Specify footer text
47 .TP
48 .B \-ps, \-\-pic\-size
49 Specify size of pictures
50 .TP
51 .B \-ts, \-\-thumb\-size
52 Specify size of thumbnails
53 .TP
54 .B \-\-overwrite
55 Overwrites the output directory if it exists without asking.
56 Without this option, the users is interactively asked what to do.
57 .PP
58 See
59 .B genwebgallery \-\-help
60 for default values.
62 .SH EXAMPLES
63 To create an image gallery as fast as possible, simply call the program with the pictures you want as arguments.
64 .IP
65 genwebgallery *.jpg
66 .PP
67 The program creates a directory
68 .I webgallery
69 which contains a
70 .I index.html
71 and each picture in large, small and a HTML for it.
72 .PP
73 If you want to customize the output
74 .IP
75 genwebgallery \-o holiday2008 \-t "Trip to Hawaii" ~/hawaii08/*.jpg
76 .PP
77 Creates a directory
78 .I holiday2008
79 which contains a
80 .I index.html
81 and each picture in large, small and a HTML for it. All HTML pages are titled with ``Trip to Hawaii''.
83 .SH EXIT CODE
84 .TP
85 .B 1
86 Any other error
87 .TP
88 .B 2
89 The required program
90 .B convert
91 could not be found. It's probably not installed.
92 Normally it is provided by the ImageMagick tool collection.
93 .TP
94 .B 3
95 The output directory already exists and the user wanted to keep it.
96 .TP
97 .B 4
98 The output directory already exists and the user wanted it to be deleted, but it was not possible.
100 .SH BUGS
101 .B convert
102 fails the conversion of the XCF image format of GIMP, but it exits with 0 anyway. This looks like a bug in the
103 .B convert
104 program.
105 As result the image is added to the gallery but it is not viewable.
106 Other formats might be affected as well.
108 .SH SEE ALSO
109 .BR convert (1),
110 .BR ImageMagick (1).
112 .SH AUTHOR
113 genwebgallery and this man page were written by markus schnalke <meillo@marmaro.de>
114 .PP
115 Website: http://prog.marmaro.de/genwebgallery