genwebgallery

annotate genwebgallery.1 @ 46:b991e188f1fa

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