Mercurial > genwebgallery

annotate genwebgallery.1 @ 47:d1ad806b6ee3 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
picsize and thumbsize are now numbers in any case (used printf); non-regular and non-existent files are skipped
author meillo@marmaro.de
date Mon, 23 Jun 2008 20:57:55 +0200
parents aac9290f9808
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
45
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
1 .TH GENWEBGALLERY 1 "genwebgallery\-0.8" "2008\-06\-23" "genwebgallery"
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
2
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
3 .SH NAME
45
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
4 genwebgallery \- generates minimalistic web galleries
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
5
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
6 .SH SYNOPSIS
6
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
7 .B genwebgallery [OPTIONS] PICTURES
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
8
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
9 .SH DESCRIPTION
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
10 .B genwebgallery
16
84c08287caa1 fixed bug when called without arguments; minor stuff
meillo@marmaro.de
parents: 12
diff changeset
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.
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
12 .PP
36
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
13 All generated content goes in a subdirectory which defaults to
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
14 .IR webgallery .
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
15 Or any other directory specified by \-\-output.
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
16 .PP
45
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
17 Files are skipped if resizing is not successful. So it depends on the resize program.
25
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
18 .PP
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
19 The
45
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
20 .BR mogrify
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
21 tool from ImageMagick, or
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
22 .BR resize\-gd
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
23 is required.
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
24
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
25 .B mogrify
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
26 is the prefered resizing tool, cause of its (assumed) better quality.
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
27 .B resize\-gd
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
28 on the other hand has much less dependencies, but still provides everything that's needed here. It is used, if
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
29 .B mogrify
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
30 is not installed. If none of them is available, the program will abort.
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
31
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
32 .SH OPTIONS
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
33 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
34 .B \-\-help
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
35 Show summary of options.
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
36 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
37 .B \-\-version
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
38 Show version of program
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
39 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
40 .B \-v, \-\-verbose
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
41 Outputs more log data
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
42 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
43 .B \-o, \-\-output
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
44 Specify output directory
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
45 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
46 .B \-i, \-\-index
36
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
47 Specify index file
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
48 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
49 .B \-t, \-\-title
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
50 Specify title of gallery
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
51 .TP
36
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
52 .B \-f, \-\-footer
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
53 Specify footer text
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
54 .TP
12
27f96c3b8224 fixed hyphen-minus-conflict in man page; refactored debian/rules (removed a lot)
meillo@marmaro.de
parents: 6
diff changeset
55 .B \-ps, \-\-pic\-size
16
84c08287caa1 fixed bug when called without arguments; minor stuff
meillo@marmaro.de
parents: 12
diff changeset
56 Specify size of pictures
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
57 .TP
12
27f96c3b8224 fixed hyphen-minus-conflict in man page; refactored debian/rules (removed a lot)
meillo@marmaro.de
parents: 6
diff changeset
58 .B \-ts, \-\-thumb\-size
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
59 Specify size of thumbnails
6
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
60 .TP
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
61 .B \-\-overwrite
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
62 Overwrites the output directory if it exists without asking.
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
63 Without this option, the users is interactively asked what to do.
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
64 .PP
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
65 See
12
27f96c3b8224 fixed hyphen-minus-conflict in man page; refactored debian/rules (removed a lot)
meillo@marmaro.de
parents: 6
diff changeset
66 .B genwebgallery \-\-help
6
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
67 for default values.
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
68
36
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
69 .SH EXAMPLES
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
70 To create an image gallery as fast as possible, simply call the program with the pictures you want as arguments.
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
71 .IP
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
72 genwebgallery *.jpg
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
73 .PP
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
74 The program creates a directory
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
75 .I webgallery
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
76 which contains a
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
77 .I index.html
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
78 and each picture in large, small and a HTML for it.
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
79 .PP
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
80 If you want to customize the output
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
81 .IP
39
c1d50b95f177 added backslashes to hyphens in man page
meillo@marmaro.de
parents: 36
diff changeset
82 genwebgallery \-o holiday2008 \-t "Trip to Hawaii" ~/hawaii08/*.jpg
36
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
83 .PP
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
84 Creates a directory
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
85 .I holiday2008
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
86 which contains a
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
87 .I index.html
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
88 and each picture in large, small and a HTML for it. All HTML pages are titled with ``Trip to Hawaii''.
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
89
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
90 .SH EXIT CODE
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
91 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
92 .B 1
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
93 Any other error
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
94 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
95 .B 2
45
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
96 None of the supported image resize programs was found. These are:
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
97 .B mogrify
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
98 from the ImageMagick tool collection, and
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
99 .B resize\-gd
6
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
100 .TP
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
101 .B 3
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
102 The output directory already exists and the user wanted to keep it.
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
103 .TP
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
104 .B 4
cb0dff8c48c6 added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
meillo@marmaro.de
parents: 3
diff changeset
105 The output directory already exists and the user wanted it to be deleted, but it was not possible.
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
106
25
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
107 .SH BUGS
45
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
108 .B mogrify
25
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
109 fails the conversion of the XCF image format of GIMP, but it exits with 0 anyway. This looks like a bug in the
45
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
110 .B mogrify
25
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
111 program.
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
112 As result the image is added to the gallery but it is not viewable.
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
113 Other formats might be affected as well.
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
114
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
115 .SH SEE ALSO
45
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
116 .BR mogrify (1),
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
117 .BR ImageMagick (1),
aac9290f9808 updated man page to the use of resize-gd
meillo@marmaro.de
parents: 39
diff changeset
118 .BR resize\-gd (1).
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
119
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
120 .SH AUTHOR
25
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
121 genwebgallery and this man page were written by markus schnalke <meillo@marmaro.de>
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
122 .PP
22
cb1f0dda49e7 simplified Makefile to what is really needed
meillo@marmaro.de
parents: 16
diff changeset
123 Website: http://prog.marmaro.de/genwebgallery