Mercurial > genwebgallery

annotate genwebgallery.1 @ 34:6a3ef869fd68 0.6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
version 0.6
author meillo@marmaro.de
date Wed, 04 Jun 2008 23:02:30 +0200
parents 8164905ea8af
children 42bf012f6045
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
32
8164905ea8af added description to NAME section in manpage (according to debian policy)
meillo@marmaro.de
parents: 25
diff changeset
1 .TH GENWEBGALLERY 1 "genwebgallery\-0.5" "2008\-06\-04" "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
12
27f96c3b8224 fixed hyphen-minus-conflict in man page; refactored debian/rules (removed a lot)
meillo@marmaro.de
parents: 6
diff changeset
13 All generated content goes in a subdirectory which defaults to 'webgallery'. Or any other directory specified by \-\-output.
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
14 .PP
25
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
15 Files are skipped if
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
16 .B convert
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
17 fails in conversion.
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
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
20 .BR convert
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
21 tool from ImageMagick is required.
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
22
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
23 .SH OPTIONS
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
24 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
25 .B \-\-help
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
26 Show summary of options.
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
27 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
28 .B \-\-version
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
29 Show version of program
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
30 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
31 .B \-v, \-\-verbose
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
32 Outputs more log data
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
33 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
34 .B \-o, \-\-output
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
35 Specify output directory
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
36 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
37 .B \-i, \-\-index
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
38 Specify index file (index.htm)
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
39 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
40 .B \-t, \-\-title
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
41 Specify title of gallery
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
42 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
43 .B \-c, \-\-copyright
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
44 Specify copyright notice
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
45 .TP
12
27f96c3b8224 fixed hyphen-minus-conflict in man page; refactored debian/rules (removed a lot)
meillo@marmaro.de
parents: 6
diff changeset
46 .B \-ps, \-\-pic\-size
16
84c08287caa1 fixed bug when called without arguments; minor stuff
meillo@marmaro.de
parents: 12
diff changeset
47 Specify size of pictures
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
48 .TP
12
27f96c3b8224 fixed hyphen-minus-conflict in man page; refactored debian/rules (removed a lot)
meillo@marmaro.de
parents: 6
diff changeset
49 .B \-ts, \-\-thumb\-size
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
50 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
51 .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
52 .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
53 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
54 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
55 .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
56 See
12
27f96c3b8224 fixed hyphen-minus-conflict in man page; refactored debian/rules (removed a lot)
meillo@marmaro.de
parents: 6
diff changeset
57 .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
58 for default values.
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
59
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
60 .SH EXIT CODE
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
61 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
62 .B 1
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
63 Any other error
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
64 .TP
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
65 .B 2
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
66 The required program
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
67 .B convert
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
68 could not be found. It's probably not installed.
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
69 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
70 .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
71 .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
72 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
73 .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
74 .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
75 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
76
25
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
77 .SH BUGS
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
78 .B convert
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
79 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
80 .B convert
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
81 program.
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
82 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
83 Other formats might be affected as well.
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
84
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
85 .SH SEE ALSO
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
86 .BR convert (1),
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
87 .BR ImageMagick (1).
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
88
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
89 .SH AUTHOR
25
9fac7c9e2611 updated manpage; added link to website
meillo@marmaro.de
parents: 22
diff changeset
90 genwebgallery and this man page were written by markus schnalke <meillo@marmaro.de>
0
9f4fa0bc1584 initial commit
meillo@marmaro.de
parents:
diff changeset
91 .PP
22
cb1f0dda49e7 simplified Makefile to what is really needed
meillo@marmaro.de
parents: 16
diff changeset
92 Website: http://prog.marmaro.de/genwebgallery