.\" Man page for rasterizer, based on the output of help2man
.\"
.\" Copyright 2007 by Vincent Fourmond
.\"
.\" You may distribute, copy and modify this manual page under the same
.\" terms as batik itself.
.\"

.TH RASTERIZER "1" "January 2008" "SVG conversion" "User Commands"
.SH NAME
rasterizer \- SVG conversion

.SH SYNOPSIS

.B rasterizer 
.I [options] files

.SH DESCRIPTION

Rasterizer is a program to convert SVG files to various formats,
namely PNG, JPEG and PDF.

.SH OPTIONS
.TP
\fB\-d\fR <dir|file>
.IP
output directory. If there is a single input file, this can be a file.
.TP
\fB\-m\fR <mimeType>
.IP
output mime type. Should be one of 
.IR image/jpg ,
.IR image/jpeg ,
.IR image/jpe ,
.IR image/png ,
.I image/tiff 
or 
.IR application/pdf .

.TP
\fB\-w\fR <width>
.IP
output width. This is a floating point value.
.TP
\fB\-h\fR <height>
.IP
output height. This is a floating point value.
.TP
\fB\-maxw\fR <width>
.IP
Maximum output width. This is a floating point value.
.TP
\fB\-maxh\fR <height>
.IP
Maximum output height. This is a floating point value.
.TP
\fB\-a\fR <area>
.IP
output area. The format for <area> is x,y,w,h, where x, y, w and h
are floating point values.
.TP
\fB\-bg\fR <color>
.IP
output color. The format for <color> is a.r.g.b, where a, r, g and b
are integer values.
.TP
\fB\-cssMedia\fR <media>
.IP
CSS media type for which the source SVG files should be
converted.
.TP
\fB\-cssAlternate\fR <alternate>
.IP
CSS alternate stylesheet to use when converting the source
SVG files.
.TP
\fB\-cssUser\fR <userStylesheet>
.IP
CSS user stylesheet URI to apply to converted SVG documents
in addition to any other referened or embeded stylesheets.
.TP
\fB\-font\-family\fR <defaultFontFamily>
.IP
Value used as a default when no font\-family value
is specified.
.TP
\fB\-lang\fR <userLanguage>
.IP
User language to use when converting SVG documents.
.TP
\fB\-q\fR <quality>
.IP
Quality for the output image. This is only relevant for the
image/jpeg mime type.
.TP
\fB\-indexed\fR (1|2|4|8)
.IP
Reduces the image to given number of bits per pixel using an
adaptive pallete, resulting in an Indexed image.  This is
currently only supported for PNG conversion.
.TP
\fB\-dpi\fR <resolution>
.IP
Resolution for the ouptut image.
.TP
\fB\-validate\fR
.IP
Controls whether the source SVG files should be validated.
.TP
\fB\-onload\fR
.IP
Controls if the source SVG files must be rasterize after
dispatching the 'onload' event.
.TP
\fB\-scriptSecurityOff\fR removes any security check on the scripts running
.IP
as a result of dispatching the onload event.
.TP
\fB\-anyScriptOrigin\fR controls whether scripts can be loaded from
.IP
any location. By default, scripts can only be loaded from
.IP
the same location as the document referencing them.
.TP
\fB\-scripts\fR <listOfAllowedScripts> List of script types (i.e.,
.IP
values for the type attribute in the <script> tag) which
should be loaded.
.TP
\fB\-d\fR <dir|file>
.IP
output directory. If there is a single input file, this can be a file.
.TP
\fB\-m\fR <mimeType>
.IP
output mime type.
.TP
\fB\-w\fR <width>
.IP
output width. This is a floating point value.
.TP
\fB\-h\fR <height>
.IP
output height. This is a floating point value.
.TP
\fB\-maxw\fR <width>
.IP
Maximum output width. This is a floating point value.
.TP
\fB\-maxh\fR <height>
.IP
Maximum output height. This is a floating point value.
.TP
\fB\-a\fR <area>
.IP
output area. The format for <area> is x,y,w,h, where x, y, w and h
are floating point values.
.TP
\fB\-bg\fR <color>
.IP
output color. The format for <color> is a.r.g.b, where a, r, g and b
are integer values.
.TP
\fB\-cssMedia\fR <media>
.IP
CSS media type for which the source SVG files should be
converted.
.TP
\fB\-cssAlternate\fR <alternate>
.IP
CSS alternate stylesheet to use when converting the source
SVG files.
.TP
\fB\-cssUser\fR <userStylesheet>
.IP
CSS user stylesheet URI to apply to converted SVG documents
in addition to any other referened or embeded stylesheets.
.TP
\fB\-font\-family\fR <defaultFontFamily>
.IP
Value used as a default when no font\-family value
is specified.
.TP
\fB\-lang\fR <userLanguage>
.IP
User language to use when converting SVG documents.
.TP
\fB\-q\fR <quality>
.IP
Quality for the output image. This is only relevant for the
image/jpeg mime type.
.TP
\fB\-indexed\fR (1|2|4|8)
.IP
Reduces the image to given number of bits per pixel using an
adaptive pallete, resulting in an Indexed image.  This is
currently only supported for PNG conversion.
.TP
\fB\-dpi\fR <resolution>
.IP
Resolution for the ouptut image.
.TP
\fB\-validate\fR
.IP
Controls whether the source SVG files should be validated.
.TP
\fB\-onload\fR
.IP
Controls if the source SVG files must be rasterize after
dispatching the 'onload' event.
.TP
.B \-scriptSecurityOff
removes any security check on the scripts running
as a result of dispatching the onload event. Always enabled, as in
most cases, 
.B rasterizer
just fails to run without this option. See
.I \-scriptSecurityOn

.TP
.B \-scriptSecurityOn
If this is the 
.I first
argument on the command-line, turn security back on. You'll most
likely be hit by the possible bug mentioned below.

.TP
.B \-anyScriptOrigin
controls whether scripts can be loaded from
any location. By default, scripts can only be loaded from
the same location as the document referencing them.
.TP
.B \-scripts\fR <listOfAllowedScripts> 
List of script types (i.e.,
values for the type attribute in the <script> tag) which
should be loaded.

.SH BUGS

If 
.B rasterizer 
fails with an error in the spirit of:

Exception in thread "main" java.security.AccessControlException: access denied (java.util.PropertyPermission java.security.policy write)
        at java.security.AccessControlContext.checkPermission(AccessControlContext.java:323)
        at java.security.AccessController.checkPermission(AccessController.java:546)
        at java.lang.SecurityManager.checkPermission(SecurityManager.java:532)
        at java.lang.System.setProperty(System.java:727)

Run it with the
.I -scriptSecurityOff
option on. It seems in some cases the security design is slighlty too
strong. This might become the default some day.

.SH JAVA-WRAPPERS NOTE

This program is a shell script wrapper based on
.BR java-wrappers (7).
You therefore benefit from several features; please see the 
.BR java-wrappers (7)
manual page for more information about them.


.SH AUTHORS 

.B rasterizer 
is part of 
.BR batik ,
written by the Apache Software Foundation.

This manual page was written by Vincent Fourmond <fourmond@debian.org>
for the Debian Project, but may be used by others.

.SH SEE ALSO

The web page of 
.BR batik ,
http://xml.apache.org/batik

.BR java-wrappers (7)