The README file for GPOVINI
___________________________
---------------------------

  gpovini     Software to help write PovRay INI files 
  Copyright (C) 2002, 2003, 2004, 2005  Ben Teschendorff

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

   Contact the author:
      email -         pov@eyedropvideo.com


*******************************************************************************

1) General Info
2) Usage
3) Compiling
4) Installing
5) Dependencies
6) ToDo


************
General Info
*************

gpovini-2.0

With this gtk+ based X-window program you will be able to create PovRay INI 
files by filling in text boxes, choosing from dropdown lists and toggling 
switches.


*****
Usage
*****

The preferred method of starting gpovini is to  put a shortcut on your 
desktop or include in it your application menu so a simple click will 
bring it up. After installation you can find some suitable icons in the 
directory /usr/local/share/gpovini

You can also start gpovini from an xterm with the command 
	gpovini

When gpovini starts you will be presented with a window divided into four 
sub-sections <INPUT OPTIONS> <TRACING OPTIONS> <ANIMATION OPTIONS> and 
<OUTPUT OPTIONS>. Below the section titles are Help buttons. Clicking on 
them will bring up a dialog window with information about the options in 
that section.

INI file options may be one of 'text entry', 'dropdown list' or 'toggle 
switch'. Fill in the necessary info into text areas, choose values from 
dropdown lists and toggle appropriate switches.

Note - you DON'T HAVE TO fill in all the text entry areas, toggle all the 
switches or dropdown lists. The only option you MUST fill in is File Name: 
found at the upper left in the <INPUT OPTION> sections. That's because in 
order to have a valid INI file you've got to at least know the name of the 
pov file that's being worked on. If that's the only thing you fill in gpovini 
will still write a valid INI file using some default options and values.

When you click on the WRITE INCLUDE FILE button at the bottom the INI file 
will be written to the same PATH as the File Name you entered in the 
<INPUT OPTIONS> section. If you didn't include a PATH then it will be 
written to the directory you were in when you called gpovini.


*********
Compiling
*********

I've only compiled this on Fedora Core 3 but I'll assume it will compile on 
most modern Linux/Unix systems. You'll need to have GTK+ 2.0 (or better) and 
pkg-config, the gcc compiler plus strip utility. If you use the supplied 
Makefile you'll need GNU Make (or compatible).

The easiest thing to do is use the Makefile and run the command,
	make all
This will compile and strip the binary. Then if you have the permission 
run the,
	make install
command to install the binary and some rc files. See below in the section 
Installing for more info.

There is also a 'make uninstall' command should you wish to remove gpovini 
and all associated files. And you can use 'make clean' to remove the binary 
from the source directory.

	--------

To compile from a command line,
	gcc -Wall -g gpovini.c -o gpovini `pkg-config --cflags --libs gtk+-2.0`
then strip with,
	strip --strip-all gpovini


**********
Installing
**********

If you ran the 'make install' routine the following files were installed,
	/usr/local/bin/gpovini
	/usr/local/share/gpovini	<directory>
	/usr/local/share/gpovini/gpovinirc
	/usr/local/share/gpovini/gpovini-bkgnd.xpm
	/usr/local/share/gpovini/gpovini-icon.xpm
	/usr/local/share/gpovini/gpovini-icon-32.xpm
	/usr/local/share/gpovini/gpovini-icon-48.xpm

If you're doing it by hand you'll need to create the directory,
	/usr/local/share/gpovini
and install the files found in the directory xtra (in the gpovini source 
directory) as well as put the binary in,
	/usr/local/bin/gpovini


************
Dependencies
************

Here's the list of libraries gpovini depends on (taken from doing a query 
on the rpm file). Should be found on most modern Linux systems running
X-window and using the GTK+ toolkit.

libatk-1.0.so.0  
libc.so.6  
libc.so.6(GLIBC_2.0)  
libc.so.6(GLIBC_2.1)  
libdl.so.2  
libgdk-x11-2.0.so.0  
libgdk_pixbuf-2.0.so.0  
libglib-2.0.so.0  
libgmodule-2.0.so.0  
libgobject-2.0.so.0  
libgtk-x11-2.0.so.0  
libm.so.6  
libpango-1.0.so.0  
libpangox-1.0.so.0  
libpangoxft-1.0.so.0


****
ToDo
****

Create a man page.

Add more INI file options.


*******************************************************************************
email the author:  pov@eyedropvideo.com