.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SUNFLOW 1"
.TH SUNFLOW 1 "2017-03-19" "0.07.2.svn396" "SUNFLOW DOCUMENTATION"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
sunflow \- rendering system for photo\-realistic image synthesis
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBsunflow\fR \fI[option(s)]\fR \fIfile(s)\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBsunflow\fR is an open source rendering system for photo-realistic
image synthesis. It is written in Java and built around a flexible ray
tracing core and an extensible object-oriented design. It was created
as a framework for experimenting with global illumination algorithms
and new surface shading models.
.SH "GENERAL OPTIONS"
.IX Header "GENERAL OPTIONS"
A summary of the options can be obtained by using one of the
following options:
.IP "\fB\-h\fR, \fB\-help\fR" 4
.IX Item "-h, -help"
Display the list of available commands
.SH "PERFORMANCES"
.IX Header "PERFORMANCES"
Sunflow will run considerably faster with the so called server \s-1VM
\&\s0(Virtual Machine). This server \s-1VM\s0 is part of Java, but it's not
included in the standard (\s-1JRE\s0) installation of Java. The server \s-1VM\s0
starts up more slowly and uses more memory than the standard \s-1VM,\s0 but
it runs a lot faster in many cases.
.PP
Sunflow's built-in realtime raytracing benchmark (\fB\-rtbench\fR) for
example runs more than twice as fast with the server \s-1VM \s0(exact speedup
depends on your hardware).
.PP
The easiest way to get the server \s-1VM\s0 is by installing the Java
Development Kit (\s-1JDK\s0).
.PP
On Debian, it is possible to install different \s-1JVM\s0 at the same time,
amongst which: \fIgij\-4.2\fR (main), \fIopenjdk\-6\-jre\fR (main),
\&\fIsun\-java5\-jre\fR (non-free), \fIsun\-java6\-jre\fR (non-free). To change
the \fIjava\fR link from one to another, use (with root privileges):
.PP
\&\f(CW\*(C`update\-alternatives \-\-config java\*(C'\fR
.PP
A pretty good choice should be \fIopenjdk\-6\-jre\fR.
.PP
See also the \*(L"\s-1CONFIGURATION FILES\*(R"\s0 section.
.SH "SUGGESTED OPTIONS"
.IX Header "SUGGESTED OPTIONS"
As explained above, the following options can be used to obtain a
performance gain, but depend on \s-1JVM\s0 used:
.IP "\fB\-server\fR" 4
.IX Item "-server"
Use the server virtual machine. The \s-1JDK\s0 matching the selected \s-1JVM\s0 has to
be installed for this option to actually work, e.g. \fIsun\-java5\-jdk\fR
(non-free). A warning will be displayed otherwise, and this option
ignored.
.IP "\fB\-Xmx\fR\fI\s-1MEM\s0\fR" 4
.IX Item "-XmxMEM"
Use a memory upper limit of \fI\s-1MEM\s0\fR instead of the default (probably
64M). Example of valid values: 512M, 1G.
.PP
Those options are best set through the \fB\s-1SUNFLOW_JAVA_OPTIONS\s0\fR
environment variable, or stored in the configuration files.
.SH "CONFIGURATION FILES"
.IX Header "CONFIGURATION FILES"
To allow flexible configuration, the \fBsunflow\fR wrapper sources two
configuration files: \fI/etc/sunflowrc\fR and \fI~/.sunflowrc\fR, in this
order.
.PP
The syntax is simple \f(CW\*(C`export KEY=VALUE\*(C'\fR. Lines beginning with a sharp
sign are ignored.
.PP
The following options are supported:
.IP "\fB\s-1SUNFLOW_JAVA\s0\fR" 4
.IX Item "SUNFLOW_JAVA"
The java virtual machine to use. It's then possible to have e.g. a
system-wide \fBjava\fR alternative pointing to \fI/usr/bin/gij\-4.2\fR, while
\&\fBsunflow\fR uses a different \s-1JVM,\s0
e.g. \fI/usr/lib/jvm/java\-1.5.0\-sun\-1.5.0.12/bin/java\fR.
.Sp
If not set (the default), \fBjava\fR will be called, meaning the
system-wide alternative will be used.
.IP "\fB\s-1SUNFLOW_JAVA_OPTIONS\s0\fR" 4
.IX Item "SUNFLOW_JAVA_OPTIONS"
Those are the options to be passed to the java interpreter, see above
for examples.
.IP "\fB\s-1SUNFLOW_OPTIONS\s0\fR" 4
.IX Item "SUNFLOW_OPTIONS"
The list of options to pass to sunflow automatically to avoid
repeating them on each invocation of \fBsunflow\fR. Quotation marks are
needed if more than one option is specified.
.Sp
If not set (the default), no option is passed to \fBsunflow\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fI/usr/share/doc/sunflow/README.Debian\fR
.SH "AUTHOR"
.IX Header "AUTHOR"
Sunflow was written by Christopher Kulla <ckulla@gmail.com>.
.PP
This manual page was written by Cyril Brulebois <kibi@debian.org>, for
the Debian project (and may be used by others). It is licensed under
the same terms as the package itself.