[cairo-commit] svg2png/doc svg2png.1,1.2,1.3

[Jason Dorje Short]

Committed by: jdorje

Update of /cvs/cairo/svg2png/doc
In directory gabe:/tmp/cvs-serv28275/doc

Modified Files:
	svg2png.1 
Log Message:
Rewrite the command-line parameters to be more powerful and roughly
compatible with rsvg/inkscape/sodipodi.


Index: svg2png.1
===================================================================
RCS file: /cvs/cairo/svg2png/doc/svg2png.1,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- svg2png.1	11 Jun 2004 12:49:58 -0000	1.2
+++ svg2png.1	13 Aug 2005 07:41:22 -0000	1.3
@@ -15,28 +15,40 @@
 .B svg2png tux.svg tux.png
 .br
 .SH DESCRIPTION
-Renders the given SVG file to the given PNG file. Omitted filenames, or a single '\-' for an input/output filename indicates that the standard input/output stream should be used rather than a file. Rendering is performed by the cairo graphics library.
+Renders the given SVG file to the given PNG file. A single '\-' for an input/output filename indicates that the standard input/output stream should be used rather than a file. Rendering is performed by the cairo graphics library.
 .SH OPTIONS
+These options are intended to be roughly compatible with those of other SVG rendering programs like rsvg, inkscape, and sodipodi.
 .TP
 .B \-w, \-\-width=\fIWIDTH\fR
-Scale the image so that the output has a width of \fIWIDTH\fR pixels. The original aspect ratio is preserved.
+Scale the image so that the output has a width of \fIWIDTH\fR pixels. The original aspect ratio is preserved unless \-\-height is also given.
 .TP
 .B \-h, \-\-height=\fIHEIGHT\fR
-Scale the image so that the output has a height of \fIHEIGHT\fR pixels. The original aspect ratio is preserved.
+Scale the image so that the output has a height of \fIHEIGHT\fR pixels. The original aspect ratio is preserved unless \-\-width is also given.
 .TP
-If both the --width and --height options are provided, the image will be scaled to the smaller dimension and will be centered within any extra space.
+If both the \-\-width and \-\-height options are provided, the behavior is controlled by the presence or absence of \-\-pad and \-\-stretch.
 .TP
 .B \-s, \-\-scale=\fIFACTOR\fR
-Scale image by \fIFACTOR\fR. This option is ignored if either of the --width or --height options are provided.
+Scale image by \fIFACTOR\fR. This option is ignored if either of the \-\-width or \-\-height options are provided.
 .TP
-.B \-x, \-\-flipx
+.B \-x, \-\-xscale=\fIFACTOR\fR
+Scale image by \fIFACTOR\fR in the X direction. This option is ignored if either of the \-\-width or \-\-height options are provided.  This option will override the \-\-scale option.
+.TP
+.B \-y, \-\-yscale=\fIFACTOR\fR
+Scale image by \fIFACTOR\fR in the Y direction. This option is ignored if either of the \-\-width or \-\-height options are provided.  This option will override the \-\-scale option.
+.TP
+.B \-X, \-\-flipx
 Flip the output X coordinates.
 .TP
-.B \-y, \-\-flipy
+.B \-Y, \-\-flipy
 Flip the output Y coordinates.
 .TP
-.B \-\-usage
-Give a short usage message.
+.B \-p, \-\-pad
+If both \-\-width and \-\-height are given, then draw the image at the correct aspect ratio, centered within a PNG file of given width and height.
+.TP
+.B \-t, \-\-stretch
+If both \-\-width and \-\-height are given, then change the image's aspect ratio and stretch it to fill the full PNG file of the given width and height.  \-\-stretch will supercede \-\-pad.
+.TP
+If both \-\-width and \-\-height but neither \-\-pad or \-\-stretch is given then the aspect ratio is preserved and the image is sized to fit within the given width and height, and the PNG file will have the same size as the image.
 .TP
 .B \-?, \-\-help
 Give a longer help list.