new man pages

restored and updated man.1 pages

ChangeLog

@@ -73,6 +73,7 @@
 - im_icc_import*/export*() cast inputs for you
 - im_vips2tiff() uses im__temp_name() for intermediates
 - added vips_wrap7 ... wrap up vips7 operations as vips8 classes
+- man pages are back for commands
 
 30/11/10 started 7.24.0
 - bump for new stable

Makefile.am

@@ -23,6 +23,7 @@ SUBDIRS = \
 	libvips \
 	tools \
 	po \
+	man \
 	doc \
 	$(C_COMPILE_DIR) \
 	$(P_COMPILE_DIR) 

TODO

@@ -1,14 +1,8 @@
 
-- turn wrap back on, with renames
-
-  	vips im_subtract
-
-  is the old vips7 interface
-
-  	vips subtract
-
-  is the new unfinished vips8 interface to the same function
+- leak check, again
 
+- vips operation print could show operation flags as well, cf. "vips
+  im_subtract"
 
 
 - revisit orc conv
@@ -88,7 +82,6 @@
 
 
 
-- leak check, again
 
 
 - add matlab write

configure.in

@@ -641,6 +641,7 @@ AC_OUTPUT([
 	swig/Makefile 
 	swig/vipsCC/Makefile 
 	swig/python/setup.py 
+	man/Makefile
 	doc/Makefile
 	doc/reference/Makefile
 	doc/reference/libvips-docs.sgml

man/Makefile.am

@@ -0,0 +1,11 @@
+man_MANS = \
+	batch_crop.1 \
+	batch_image_convert.1 \
+	batch_rubber_sheet.1 \
+	edvips.1 \
+	header.1 \
+	light_correct.1 \
+	vips.1 \
+	vipsthumbnail.1
+
+EXTRA_DIST = ${man_MANS}

man/batch_crop.1

@@ -0,0 +1,22 @@
+.TH BATCH_CROP 1 "2 Feb 2002"
+.SH NAME
+batch_crop  \- crop a set of images
+.SH SYNOPSIS
+.B batch_crop left top width height image1 image2 ...
+.SH DESCRIPTION
+The area defined by the rectangle left, top, width, height is cropped out of
+each of the images and saved in a file of the same name, but prefixed by
+"crop_".
+
+For example:
+
+  batch_crop 10 10 100 100 fred.jpg jim.png
+
+will make two images, crop_fred.jpg and crop_jim.png, each of 100 by 100
+pixels, taken from the corresponding input images.
+
+.SH RETURN VALUE
+returns 0 on success and non-zero on error.
+.SH SEE ALSO
+header(1), im_vips2tiff(3), im_vips2jpeg(3), im_vips2png(3), im_vips2ppm(3)
+

man/batch_image_convert.1

@@ -0,0 +1,29 @@
+.TH BATCH_IMAGE_CONVERT 1 "2 Feb 2002"
+.SH NAME
+batch_image_convert  \- use VIPS to convert a set of images to a new type
+.SH SYNOPSIS
+.B batch_image_convert type image1 image2 ...
+.SH DESCRIPTION
+The first argument is the name of an image type, subsequent arguments are
+the names of files to be converted to that type. VIPS can usually read almost
+any image type, but it can only write VIPS, PNG, TIFF, PPM/PGM/PBM and JPEG.
+You can specify conversion parameters in the type name.
+
+For example:
+
+  batch_image_convert tiff fred.jpg jim.png
+
+will convert
+.B fred.jpg
+and
+.B jim.png
+to TIFF format.
+
+  batch_image_convert jpeg:95 jim.png
+
+will write jim.jpeg with a 95% quality factor.
+.SH RETURN VALUE
+returns 0 on success and non-zero on error.
+.SH SEE ALSO
+header(1), im_vips2tiff(3), im_vips2jpeg(3), im_vips2png(3), im_vips2ppm(3)
+

man/batch_rubber_sheet.1

@@ -0,0 +1,30 @@
+.TH BATCH_RUBBER_SHEET 1 "2 Feb 2002"
+.SH NAME
+batch_rubber_sheet \- warp a set of images with a rubber-sheet transformation
+.SH SYNOPSIS
+.B batch_rubber_sheet matrix image1 image2 ...
+.SH DESCRIPTION
+The first argument specifies a file containing the transformation, subsequent
+arguments are image files to be transformed. The transformed image is written
+to a new file, named as the old file, but with "rsc_" prepended to the file
+name.
+
+For example:
+
+  batch_rubber_sheet lens.mat fred.jpg jim.png
+
+will read a transform from the file 
+.B lens.mat 
+and apply it to 
+.B fred.jpg 
+and
+.B jim.png, 
+writing files 
+.B rsc_fred.jpg 
+and 
+.B rsc_jim.png.
+.SH RETURN VALUE
+returns 0 on success and non-zero on error.
+.SH SEE ALSO
+The "Image=>Rubber" menu in nip.
+

man/edvips.1

@@ -0,0 +1,50 @@
+.TH EDVIPS 1 "30 June 1993"
+.SH NAME
+edvips \- edit header of a vips image file
+.SH SYNOPSIS
+.B edvips [OPTION...] vipsfile
+.SH DESCRIPTION
+.B edvips 
+alters a VIPS image file's header. This is useful for setting the resolution, 
+for example.
+
+The options are:
+
+  -x, --xsize=N       set Xsize to N
+  -y, --ysize=N       set Ysize to N
+  -b, --bands=N       set Bands to N
+  -f, --format=F      set BandFmt to F (eg. uchar)
+  -i, --interpretation=I        
+                      set Interpretation to I (eg. xyz)
+  -c, --coding=C      set Coding to C (eg. labq)
+  -X, --xres=R        set Xres to R pixels/mm
+  -Y, --yres=R        set Yres to R pixels/mm
+  -u, --xoffset=N     set Xoffset to N
+  -v, --yoffset=N     set Yoffset to N
+  -e, --setext        replace extension block with stdin
+
+Be very careful when changing Xsize, Ysize, BandFmt or Bands. edvips does no
+checking!
+
+.SH EXAMPLES
+To set the Xsize to 512 and Bands to 6:
+
+  edvips --xsize=512 --bands=6 fred.v
+
+or
+
+  edvips -x 512 -b 6 fred.v
+
+Extract the XML metadata from an image with
+.B header(1),
+edit it, and reattach with 
+.B edvips(1).
+
+  header -f getext fred.v | sed s/banana/pineapple/ | edvips -e fred.v
+
+.SH RETURN VALUE
+returns 0 on success and non-zero on error.
+.SH SEE ALSO
+header(1)
+.SH COPYRIGHT
+K. Martinez 1993

man/header.1

@@ -0,0 +1,33 @@
+.TH HEADER 1 "12 July 1990"
+.SH NAME
+header \- prints information about an image file
+.SH SYNOPSIS
+header [OPTIONS ...] files ...
+.SH DESCRIPTION
+.B header(1)
+prints image header fields to stdout.
+
+.SH OPTIONS
+.TP
+.B -f FIELD, --field=FIELD
+Print value of 
+.B FIELD 
+from image header. The special field name getext prints
+the VIPS extension block: the XML defining the image metadata. You can alter
+this, then reattach with 
+.B edvips(1).
+
+.SH EXAMPLES
+ $ header -f Xsize ~/pics/*.v   
+ 1024
+ 1279
+ 22865
+ 1
+ 256
+
+.SH SEE ALSO
+edvips(1)
+.SH COPYRIGHT
+N. Dessipris
+.SH AUTHOR
+N. Dessipris \- 12/07/1990

man/light_correct.1

@@ -0,0 +1,39 @@
+.TH LIGHT_CORRECT 1 "14 Oct 1996"
+.SH NAME
+light_correct \- correct illumination errors on set of images
+.SH SYNOPSIS
+.B light_correct grey image1 image2 image3 ...
+.SH DESCRIPTION
+The first argument should be an image of a piece of grey card, subsequent
+arguments should be images taken with the same lighting set-up which need
+correcting. The corrected images are written to files prefixed with "ic_". 
+
+For example, suppose you have a directory with the following files in:
+
+  example% ls
+  dat1.1.v dat1.2.v dat2.1.v dat2.2.v dat3.1.v dat3.2.v
+  dat4.1.v dat4.2.v grey.v
+
+then run light_correct like this:
+
+  example% light_correct grey.v dat*.v
+
+to generate this:
+
+  example% ls
+  dat1.1.v dat1.2.v dat2.1.v dat2.2.v dat3.1.v dat3.2.v
+  dat4.1.v dat4.2.v grey.v
+  ic_dat1.1.v ic_dat1.2.v ic_dat2.1.v ic_dat2.2.v ic_dat3.1.v
+  ic_dat3.2.v ic_dat4.1.v ic_dat4.2.v
+
+light_correct works by smoothing out the grey card image, finding
+grey-mean/pixel for each point, and then multiplying the result by all the
+following images. It also removes any .desc files it generates, to avoid
+problems with im_global_balance(3).
+
+.SH RETURN VALUE
+returns 0 on success and non-zero on error.
+.SH SEE ALSO
+header(1), vips(1)
+.SH COPYRIGHT
+The National Gallery and Birkbeck College, 1989-1996.

man/vips.1

@@ -0,0 +1,75 @@
+.TH VIPS 1 "30 June 1993"
+.SH NAME
+vips \- run vips operations from the command line
+.SH SYNOPSIS
+.B vips [options] [command] [command-options] [command-args]
+.SH DESCRIPTION
+.B vips(1)
+is the VIPS universal main program. You can use it to run any VIPS operation
+from the command line, to query the VIPS function database, and to
+maintain parts of the VIPS library.
+
+To run a VIPS function, the first argument should be the name of the function
+and following arguments should be the function parameters. For example:
+
+  $ vips im_invert lena.v lena2.v
+
+.SH OPTIONS
+.TP
+.B -p PLUGIN, --plugin=PLUGIN       
+Load PLUGIN. Note that plugins in $VIPSHOME/lib are loaded automatically.
+
+.TP
+.B -v, --version
+Show VIPS version.
+
+.SH COMMANDS
+
+.TP
+.B list PACKAGE
+List operations defined in PACKAGE. PACKAGE can also be "classes", "packages"
+or "all".
+
+.TP
+.B cpph PACKAGE
+Print C++ header for PACKAGE. PACKAGE can also be a function name, or "all".
+
+.TP
+.B cppc PACKAGE
+Print C++ binding for PACKAGE. PACKAGE can also be a function name, or "all".
+
+.TP
+.B operation-name operation-arguments
+Execute a named operation, for example im_invert, or add. Names prefixed with
+"im_" are called via the vips7 interface, names without the prefix use the new
+vips8 interface.
+
+.SH EXAMPLES
+
+Run a vips7 operation. The vips7 interface does not suport optional arguments.
+
+  $ vips im_invert lena.v lena2.v
+
+Run a vips8 operation. Operation options must follow the operation name.
+
+  $ vips add --imtest=option.jpg lena.v lena2.v out.v
+
+Get a "usage" message for an operation
+
+  $ vips add 
+  VipsAdd (add), add two images
+    add left right out
+  where:
+    left :: VipsImage (input)
+    right :: VipsImage (input)
+    out :: VipsImage (output)
+  optional arguments:
+    imtest :: VipsImage (input)
+    booltest :: gboolean (input)
+
+.SH RETURN VALUE
+returns 0 on success and non-zero on error.
+.SH SEE ALSO
+header(1)
+.SH COPYRIGHT
+The National Gallery and Birkbeck College, 1989-1996.

man/vipsthumbnail.1

@@ -0,0 +1,119 @@
+.TH VIPSTHUMBNAIL 1 "13 May 2010"
+.SH NAME
+vipsthumbnail \- make thumbnails of image files
+.SH SYNOPSIS
+.B vipsthumbnail [flags] imagefile1 imagefile2 ...
+.SH DESCRIPTION
+.B vipsthumbnail(1)
+processes each 
+.B imagefile
+in turn, shrinking each image to fit within a 128 by 128 pixel square.
+The shrunk image is written to a new file named
+.B tn_imagefile.jpg.
+This program is typically faster and uses less memory than
+other image thumbnail programs.
+
+For example:
+
+ $ vipsthumbnail fred.png jim.tif
+
+will read image files 
+.B fred.png
+and 
+.B jim.tif
+and write thumbnails to the files
+.B tn_fred.jpg
+and
+.B tn_jim.jpg.
+
+ $ vipsthumbnail --size=64 -o thumbnails/%s.png fred.jpg
+
+will read image file
+.B fred.jpg
+and write a 64 x 64 pixel thumbnail to the file 
+.B thumbnails/fred.png.
+
+On Unix machines, vips
+will create temporary files in "/tmp" by default. Use the environment variable
+TMPDIR to change this location. On Windows, vips uses GetTempPath() to pick a
+location, see the MS documentation.
+
+Use the --vips-disc-threshold command-line switch, or the IM_DISC_THRESHOLD
+environment variable, to make vipsthumbnail use memory rather than temporary
+files.
+
+.SH OPTIONS
+.TP
+.B -s N, --size=N
+Set the output thumbnail size to 
+.B N 
+x 
+.B N 
+pixels. The image is shrunk so that it just fits within this area, Images
+which are smaller than this are expanded.
+
+.TP
+.B -o FORMAT, --output=FORMAT     
+Set the output format string. The input filename has any file type suffix
+removed, then that value is substitued into 
+.B FORMAT
+replacing
+.B %s.
+The default value is
+.B tn_%s.jpg
+meaning JPEG output, with
+.B tn_
+prepended. You can add format options too, for example
+.B tn_%s.jpg:20
+will write JPEG images with Q set to 20.
+
+.TP
+.B -p I, --interpolator=I               
+Resample with interpolator 
+.B I.
+Use 
+.B vips --list classes
+to see a list of valid interpolators. The default is 
+.B bilinear.
+
+.TP
+.B -n, --nosharpen
+By default, 
+.B vipsthumbnail(1)
+will sharpen thumbnails slightly to make them look more pleasing. This option
+disables this sharpening.
+
+.TP
+.B -e PROFILE, --eprofile=PROFILE        
+Export thumbnails with this ICC profile. Images are only colour-transformed if
+there is both an output and an input profile available. The input profile can
+either be embedded in the input image or supplied with the
+.B --iprofile
+option.
+
+.TP
+.B -i PROFILE, --iprofile=PROFILE        
+Import images with this ICC profile, if no profile is embdedded in the image. 
+Images are only colour-transformed if
+there is both an output and an input profile available. The output profile
+should be supplied with the
+.B --oprofile
+option.
+
+.TP
+.B -l, --nodelete
+Don't delete the profile from the output image. Since all output images will
+generally have the same profile, 
+.B vipsthumbnail(1)
+will usually delete it. This option leaves the profile inside the image.
+
+.TP
+.B -v, --verbose
+.B vipsthumbnail(1)
+normally runs silently, except for warning and error messages. This option
+makes it print a list of the operations it performs on each image.
+
+.SH RETURN VALUE
+returns 0 on success and non-zero on error.
+.SH SEE ALSO
+header(1)