genwebgallery

diff genwebgallery.1 @ 6:cb0dff8c48c6

added option --overwrite; refactored checkCreateDir; fixed HTML output; introduced exit code 3 and 4; better help output
author meillo@marmaro.de
date Fri, 23 Nov 2007 22:43:41 +0100
parents 737fe869e278
children 27f96c3b8224
line diff
     1.1 --- a/genwebgallery.1	Fri Nov 23 20:52:47 2007 +0100
     1.2 +++ b/genwebgallery.1	Fri Nov 23 22:43:41 2007 +0100
     1.3 @@ -4,20 +4,19 @@
     1.4  genwebgallery
     1.5  
     1.6  .SH SYNOPSIS
     1.7 -.B genwebgallery [OPTIONS] FILES
     1.8 +.B genwebgallery [OPTIONS] PICTURES
     1.9  
    1.10  .SH DESCRIPTION
    1.11  .B genwebgallery
    1.12 -generates a web gallery of mentioned pictures.
    1.13 +Generates a web gallery of mentioned pictures. Only very minimalistic static HTML pages are generated. Copies of the pictures get resized to the defined sizes.
    1.14  .PP
    1.15 -Only static HTML pages are generated.
    1.16 +All generated content goes in a subdirectory which defaults to 'webgallery'. Or any other directory specified by --output.
    1.17  .PP
    1.18  The
    1.19  .BR convert
    1.20  tool from ImageMagick is required.
    1.21  
    1.22  .SH OPTIONS
    1.23 -.B genwebgallery
    1.24  .TP
    1.25  .B \-\-help
    1.26  Show summary of options.
    1.27 @@ -45,6 +44,14 @@
    1.28  .TP
    1.29  .B \-ts, \-\-thumb-size
    1.30  Specify size of thumbnails
    1.31 +.TP
    1.32 +.B \-\-overwrite
    1.33 +Overwrites the output directory if it exists without asking.
    1.34 +Without this option, the users is interactively asked what to do.
    1.35 +.PP
    1.36 +See
    1.37 +.B genwebgallery --help
    1.38 +for default values.
    1.39  
    1.40  .SH EXIT CODE
    1.41  .TP
    1.42 @@ -56,12 +63,18 @@
    1.43  .B convert
    1.44  could not be found. It's probably not installed.
    1.45  Normally it is provided by the ImageMagick tool collection.
    1.46 +.TP
    1.47 +.B 3
    1.48 +The output directory already exists and the user wanted to keep it.
    1.49 +.TP
    1.50 +.B 4
    1.51 +The output directory already exists and the user wanted it to be deleted, but it was not possible.
    1.52  
    1.53  .SH SEE ALSO
    1.54  .BR convert (1),
    1.55  .BR ImageMagick (1).
    1.56  
    1.57  .SH AUTHOR
    1.58 -genwebgallery was written by markus schnalke <meillo@marmaro.de>
    1.59 +genwebgallery and this man page was written by markus schnalke <meillo@marmaro.de>
    1.60  .PP
    1.61  Website: http://prog.marmaro.de