| - | POVUNI_S.TGZ or POVUNI_S.TAR.GZ - The C source code for POV-Ray for Unix. Either archive contains full generic source, Unix and X-Windows specific source. |
| - | POVUNI_D.TGZ or POVUNI_D.TAR.GZ or any archive containing the sample scenes, standard include files and documentation. This could be the Linux or SunOS executable archives described above. |
| - | A C compiler for your computer and KNOWLEDGE OF HOW TO USE IT. Although we provide source code for generic Unix systems, we do not provide technical support on how to compile the program. |
| - | A text editor capable of editing plain ASCII text files. |
Recommended:
| - | Math co-processor. |
| - | 8 meg or more RAM. |
| - | Graphic file viewer capable of viewing PPM, TGA or PNG formats. |
Optional:
| - | X Windows if you want to be able to display as you render. |
| - | You will need the X-Windows include files as well. If you're not familiar with compiling programs for X-Windows you may need some help from someone who is knowledgeable at your installation because the X include files and libraries are not always in a standard place. |
All versions of the program share the same ray-tracing features like shapes, lighting and textures. In other words, an IBM-PC can create the same pictures as a Cray supercomputer as long as it has enough memory.
The user will want to get the executable that best matches their computer hardware. See the section "Where to Find POV-Ray Files" for where to find these files. You can contact those sources to find out what the best version is for you and your computer.
The first question you should ask yourself before proceeding is Do I really need to compile POV-Ray at all? Official POV-Ray Team executable versions are available for MS-Dos, Windows 3.1x/95/NT, Mac 68k, Mac Power PC, Amiga, Linux for Intel x86, and SunOS. Other unofficial compiles may soon be available for other platforms. If you do not intend to add any custom or experimental features to the program and if an executable already exists for your platform then you need not compile this program yourself.
If you do want to proceed you should be aware that you are very nearly on your own. The following sections and other related compiling documentation assume you know what you are doing. It assumes you have an adequate C compiler installed and working. It assumes you know how to compile and link large, multi-part programs using a make utility or an IDE project file if your compiler supports them. Because makefiles and project files often specify drive, directory or path information, we cannot promise our makefiles or projects will work on your system. We assume you know how to make changes to makefiles and projects to specify where your system libraries and other necessary files are located.
In general you should not expect any technical support from the POV-Ray Team on how to compile the program. Everything is provided here as is. All we can say with any certainty is that we were able to compile it on our systems. If it doesn't work for you we probably cannot tell you why.
There is no technical documentation for the source code itself except for the comments in the source files. We try our best to write clear, well- commented code but some sections are barely commented at all and some comments may be out dated. We do not provide any technical support to help you to add features. We do not explain how a particular feature works. In some instances, the person who wrote a part of the program is no longer active in the Team and we don't know exactly how it works.
When making any custom version of POV-Ray or any unofficial compile, please make sure you read and follow all provisions of our license in "Copyright" . In general you can modify and use POV-Ray on your own however you want but if you distribute your unofficial version you must follow our rules. You may not under any circumstances use portions of POV-Ray source code in other programs.
In general, there are separate archives for each hardware platform and operating system but each of these archives may support more than one compiler. For example here is the directory structure for the MS-Dos archive.
SOURCE SOURCE\LIBPNG SOURCE\ZLIB SOURCE\MSDOS SOURCE\MSDOS\PMODE SOURCE\MSDOS\BORLAND SOURCE\MSDOS\DJGPP SOURCE\MSDOS\WATCOM
The source directory contains source files for the generic parts of POV-Ray that are the same on all platforms. The source\libpng contains files for compiling a library of routines used in reading and writing PNG (Portable Network Graphics) image files. The source\zlib contains files for compiling a library of routines used by LIBPNG to compress and uncompress data streams. All of these files are used by all platforms and compilers. They are in every version of the source archives.
The source\msdos directory contains all source files for the MS-Dos version common to all supported MS-Dos compilers. The pmode sub-directory contains source files for pmode.lib which is required by all MS-Dos versions. The borland , djgpp , and watcom sub-directories contain source, makefiles and project files for C compilers by Borland, DJGPP and Watcom.
The source\msdos directory is only in the MS-Dos archive. Similarly the Windows archive contains a source\windows directory. The Unix archive contains source/unix etc.
The source\msdos directory contains a file cmpl_msd.doc which contains compiling information specific to the MS-Dos version. Other platform specific directories contain similar cmpl_xxx.doc files and the compiler specific sub-directories also contain compiler specific cmpl_xxx.doc files. Be sure to read all pertinent cmpl_xxx.doc files for your platform and compiler.
For example different operating systems use different characters as a separator between directories and file names. MS-Dos uses back slash, Unix a front slash or Mac a colon. The config.h file for MS-Dos and Windows contains the following:
which tells the generic part of POV-Ray to use a back slash.
Every customization that the generic part of the code needs has a default setting in the file source\frame.h which is also included in every module after config.h . The frame.h header contains many groups of defines such as this:
which basically says if we didn't define this previously in config.h then here's a default value . See frame.h to see what other values you might wish to configure.
If any definitions are used to specify platform specific functions you should also include a prototype for that function. The file source\msdos\config.h , for example, not only contains the macro:
to define the name of the graphics display initialization function, it contains the prototype:
If you plan to port POV-Ray to an unsupported platform you should probably start with the simplest, non-display generic Unix version. Then add new custom pieces via the config.h file.