GIG reference manual

appendix B - GIG directory structure

____________________________________________________________________________________

Section contents

____________________________________________________________________________________
Introduction
The following information describes the GIG directory structure. It explains what directories will be created when installing the GIG software using the installation program 'GIGINSTALL'. It also explains where all GIG system and user files can be found.

Directory structure
After a default installation of GIG, the software will create a directory structure in which the home directory will be placed in '/usr/people/gig/' (SGI).

A schematic of the directory structure:

     ~gig
        |/ bin
        |
        |/ lib
        |
        |/ projects
        |         |/ demo_prj
        |         |         |/ intdump
        |         |         |/ intenv
        |         |         |/ intlib
        |         |         |/ intmap
        |         |         |/ intpixmap
        |         |         |/ production
        |         |         |/ rcrd
        |         |         |/ txed
        |         |               |/ smptif
        |         |               |/ txtrs
        |         |
        |         |/ ----_prj
        |         |         |/ intdump
        |         |         |/ intenv
        |         |         |/ intlib
        |         |         |/ intmap
        |         |         |/ intpixmap
        |         |         |/ production
        |         |         |/ rcrd
        |         |         |/ txed
        |         |               |/ smptif
        |         |               |/ txtrs
        |         |
        |         |/ and so on
        |         |
        |
        |
        |/ utils -> link ~gig/bin

The GIG system directories
~gig/bin, This directory contains binary files, the startup program 'startgig' and GIG utilities (giganibatch etc.).
~gig/lib, This directory contains the GIG library such as default textures for the texture editor etc.
~gig/utils, This directory is linked to the bin directory (used to contain the utility scripts that are now in the bin directory.

The GIG user directories
The GIG user is able to make a distinction between different 'projects'. The user can select or create a project via the user interface. The introduction of projects influences the GIG directory structure. The different project-directories are kept in directory 'projects' under GIG. All project directory names end with '_prj'.

After the GIG software has been installed, the installation software creates one project: project demo. Project demo will contain all demo files (demo images and models, etc.). For projects there are the 'intdump', 'intenv', 'intlib', 'intmap', 'intpixmap, 'production', 'rcrd,' and txed directories.

intdump,	This directory is for storing images rendered with the
                render  window function. 

intenv, 	This directory is for storing all user files except
                images, maps, CAD files and record files. 

intlib, 	This directory is for storing CAD files (DXF, Pro-Engineer etc.). 
 
intmap,  	This directory is for storing 2D maps. Images stored in 
                the intdump or production directory which are converted 
                to a RGB, value or bump map in the channels menu, will be 
                stored automatically in this directory. 

intpixmap, 	Out of use at the moment. 

production, 	This directory is for storing images rendered with render 
                still or render ani (these images can be displayed with the 
                show function in the converter and projectsmanager
                menu or with the filpbook utility). 

rcrd,		Out of use at the moment. 

txed		This directory is used by the texture editor it contains two 
                other directorys: 

		smptif	Containing sample files created by the user (render texted). 

		txtrs Containing textures and maps saved by the user.

A file is stored (and updated when needed) and retains the name of the current active project. So when you stop GIG and start it up again, GIG automatically activates the project that was last selected.

Notes
After selecting to system in the general menu, user directories of the currently active project can be accessed directly using the following environment variables:

LD for the 'intlib' directory
DD for the 'intdump' directory
ED for the 'intenv' directory
MD for the 'intmap' directory
TD for the 'production' directory
TF for the 'txed/smptif' directory
TT for the 'txed/txtrs' directory
Example:
1) To copy the file 'test.dxf' to the intlib directory of the active project:

Select to system in the general menu.
Move to the directory where the dxf file is stored and type in the following command:

cp test.dxf $LD

The file can be found in the intlib directory of the active project, ready to be converted with the GET DXF function in the channels menu.

2) To move to the production directory of the active project:

Select to system in the general menu, now type in:

cd $TD

Caveats
When changing to another project in GIG and exiting, the 'old' csh, variables are not updated automatically. Only when starting up a new csh (which is done when you select to system), are the variables properly set (or you can 'source' ~/.cshrc).

____________________________________________________________________________________

Other appendixes: