Mercurial > genwebgallery

annotate genwebgallery.1 @ 37:5337b8aee2d6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
removed debian dir from repo (cause it should not be in upstream)
author meillo@marmaro.de
date Thu, 05 Jun 2008 21:05:46 +0200
parents 42bf012f6045
children c1d50b95f177
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
36
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
1 .TH GENWEBGALLERY 1 "genwebgallery\-0.7" "2008\-06\-05" "genwebgallery"
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
2
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
3 .SH NAME
32
8164905ea8af added description to NAME section in manpage (according to debian policy)
meillo@marmaro.de
parents: 25
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
25
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
17 Files are skipped if
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
18 .B convert
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
19 fails in conversion.
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
20 .PP
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
21 The
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
22 .BR convert
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
23 tool from ImageMagick is required.
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
24
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
25 .SH OPTIONS
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
26 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
27 .B \-\-help
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
28 Show summary of options.
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
29 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
30 .B \-\-version
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
31 Show version of program
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
32 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
33 .B \-v, \-\-verbose
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
34 Outputs more log data
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
35 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
36 .B \-o, \-\-output
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
37 Specify output directory
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
38 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
39 .B \-i, \-\-index
36
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
40 Specify index file
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
41 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
42 .B \-t, \-\-title
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
43 Specify title of gallery
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
44 .TP
36
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
45 .B \-f, \-\-footer
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
46 Specify footer text
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
47 .TP
12
27f96c3b8224 fixed hyphen-minus-conflict in man page; refactored debian/rules (removed a lot)
meillo@marmaro.de
parents: 6
diff changeset
48 .B \-ps, \-\-pic\-size
16
84c08287caa1 fixed bug when called without arguments; minor stuff
meillo@marmaro.de
parents: 12
diff changeset
49 Specify size of pictures
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
50 .TP
12
27f96c3b8224 fixed hyphen-minus-conflict in man page; refactored debian/rules (removed a lot)
meillo@marmaro.de
parents: 6
diff changeset
51 .B \-ts, \-\-thumb\-size
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
52 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
53 .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
54 .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
55 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
56 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
57 .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
58 See
12
27f96c3b8224 fixed hyphen-minus-conflict in man page; refactored debian/rules (removed a lot)
meillo@marmaro.de
parents: 6
diff changeset
59 .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
60 for default values.
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
61
36
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
62 .SH EXAMPLES
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
63 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
64 .IP
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
65 genwebgallery *.jpg
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
66 .PP
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
67 The program creates a directory
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
68 .I webgallery
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
69 which contains a
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
70 .I index.html
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
71 and each picture in large, small and a HTML for it.
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
72 .PP
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
73 If you want to customize the output
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
74 .IP
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
75 genwebgallery -o holiday2008 -t "Trip to Hawaii" ~/hawaii08/*.jpg
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
76 .PP
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
77 Creates a directory
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
78 .I holiday2008
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
79 which contains a
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
80 .I index.html
42bf012f6045 updated man page
meillo@marmaro.de
parents: 32
diff changeset
81 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
82
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
83 .SH EXIT CODE
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
84 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
85 .B 1
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
86 Any other error
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
87 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
88 .B 2
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
89 The required program
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
90 .B convert
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
91 could not be found. It's probably not installed.
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
92 Normally it is provided by the ImageMagick tool collection.
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
93 .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
94 .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
95 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
96 .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
97 .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
98 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
99
25
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
100 .SH BUGS
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
101 .B convert
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
102 fails the conversion of the XCF image format of GIMP, but it exits with 0 anyway. This looks like a bug in the
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
103 .B convert
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
104 program.
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
105 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
106 Other formats might be affected as well.
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
107
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
108 .SH SEE ALSO
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
109 .BR convert (1),
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
110 .BR ImageMagick (1).
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
111
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
112 .SH AUTHOR
25
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
113 genwebgallery and this man page were written by markus schnalke <meillo@marmaro.de>
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
114 .PP
22
cb1f0dda49e7 simplified Makefile to what is really needed
meillo@marmaro.de
parents: 16
diff changeset
115 Website: http://prog.marmaro.de/genwebgallery