changeset 6:e020f26c2c6a

added manpage
author meillo@marmaro.de
date Sat, 14 Jun 2008 12:19:35 +0200
parents 8e2804fe30bc
children c0045d8d3ce2
files resize-gd.1
diffstat 1 files changed, 67 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/resize-gd.1	Sat Jun 14 12:19:35 2008 +0200
@@ -0,0 +1,67 @@
+.TH RESIZE\-GD 1 "resize-gd\-0.1" "2008\-06\-14" "resize-gd"
+
+.SH NAME
+resize-gd \- resizes images using the gd library
+
+.SH SYNOPSIS
+.B resize-gd <size> PICTURES
+
+.B resize-gd <width>x<height> PICTURES
+
+.SH DESCRIPTION
+The program resizes given images to a specific size. The files are modified, so copy the files before if you want to keep the original pictures!
+.PP
+If <size> is given, aspect ratio of the images is preserved and only shrinking is done. Smaller images remain unmodified.
+.PP
+If <width>x<height> ist given, the images are resized to match that dimensions. The images probably get stretched and enlarged.
+.PP
+Only JPEG and PNG files are supported. The filetype is detected by the filename suffix which has to be either `.jpg' or `.png' (in lowercase letters).
+Unsupported files get skipped.
+.PP
+This program is meant to be a small(er) alternative to the
+.BR mogrify -resize
+command of ImageMagick. Mainly because ImageMagick has lots of dependencies, while the GD-Library has less.
+
+.SH OPTIONS
+.TP
+.B \-\-help
+Show summary of options.
+.TP
+.B \-\-version
+Show program name and version.
+
+.SH EXAMPLES
+Create some thumbnails, preserving aspect ratio:
+.IP
+mkdir thumbs
+
+cp *.jpg *.png thumbs
+
+resize-gd 150 thumbs/*
+
+.PP
+Make some pictures squared:
+.IP
+cp -r somepics/ somepics-squared
+
+resize-gd 400x400 somepics-squared/*
+
+.SH EXIT CODE
+.TP
+.B 1
+Any other error
+.TP
+.B 2
+The size (parameter 1) had no valid format. It has to be either <size> or <width>x<height>.
+
+.SH BUGS
+Please report any bug you find to the author.
+
+.SH SEE ALSO
+.BR mogrify (1),
+.BR ImageMagick (1).
+
+.SH AUTHOR
+resize-gd and this man page were written by markus schnalke <meillo@marmaro.de>
+.PP
+Website: http://prog.marmaro.de/resize-gd