genwebgallery

annotate genwebgallery.1 @ 41:8bc7566a9086

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