genwebgallery

view genwebgallery.1 @ 45:aac9290f9808

updated man page to the use of resize-gd
author meillo@marmaro.de
date Mon, 23 Jun 2008 20:04:55 +0200
parents c1d50b95f177
children
line source
1 .TH GENWEBGALLERY 1 "genwebgallery\-0.8" "2008\-06\-23" "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 resizing is not successful. So it depends on the resize program.
18 .PP
19 The
20 .BR mogrify
21 tool from ImageMagick, or
22 .BR resize\-gd
23 is required.
25 .B mogrify
26 is the prefered resizing tool, cause of its (assumed) better quality.
27 .B resize\-gd
28 on the other hand has much less dependencies, but still provides everything that's needed here. It is used, if
29 .B mogrify
30 is not installed. If none of them is available, the program will abort.
32 .SH OPTIONS
33 .TP
34 .B \-\-help
35 Show summary of options.
36 .TP
37 .B \-\-version
38 Show version of program
39 .TP
40 .B \-v, \-\-verbose
41 Outputs more log data
42 .TP
43 .B \-o, \-\-output
44 Specify output directory
45 .TP
46 .B \-i, \-\-index
47 Specify index file
48 .TP
49 .B \-t, \-\-title
50 Specify title of gallery
51 .TP
52 .B \-f, \-\-footer
53 Specify footer text
54 .TP
55 .B \-ps, \-\-pic\-size
56 Specify size of pictures
57 .TP
58 .B \-ts, \-\-thumb\-size
59 Specify size of thumbnails
60 .TP
61 .B \-\-overwrite
62 Overwrites the output directory if it exists without asking.
63 Without this option, the users is interactively asked what to do.
64 .PP
65 See
66 .B genwebgallery \-\-help
67 for default values.
69 .SH EXAMPLES
70 To create an image gallery as fast as possible, simply call the program with the pictures you want as arguments.
71 .IP
72 genwebgallery *.jpg
73 .PP
74 The program creates a directory
75 .I webgallery
76 which contains a
77 .I index.html
78 and each picture in large, small and a HTML for it.
79 .PP
80 If you want to customize the output
81 .IP
82 genwebgallery \-o holiday2008 \-t "Trip to Hawaii" ~/hawaii08/*.jpg
83 .PP
84 Creates a directory
85 .I holiday2008
86 which contains a
87 .I index.html
88 and each picture in large, small and a HTML for it. All HTML pages are titled with ``Trip to Hawaii''.
90 .SH EXIT CODE
91 .TP
92 .B 1
93 Any other error
94 .TP
95 .B 2
96 None of the supported image resize programs was found. These are:
97 .B mogrify
98 from the ImageMagick tool collection, and
99 .B resize\-gd
100 .TP
101 .B 3
102 The output directory already exists and the user wanted to keep it.
103 .TP
104 .B 4
105 The output directory already exists and the user wanted it to be deleted, but it was not possible.
107 .SH BUGS
108 .B mogrify
109 fails the conversion of the XCF image format of GIMP, but it exits with 0 anyway. This looks like a bug in the
110 .B mogrify
111 program.
112 As result the image is added to the gallery but it is not viewable.
113 Other formats might be affected as well.
115 .SH SEE ALSO
116 .BR mogrify (1),
117 .BR ImageMagick (1),
118 .BR resize\-gd (1).
120 .SH AUTHOR
121 genwebgallery and this man page were written by markus schnalke <meillo@marmaro.de>
122 .PP
123 Website: http://prog.marmaro.de/genwebgallery