Compile a Program

 hello/
|-- main.cpp              CPP and H files may be at the top level
|                         or in subdirectories.
|-- datafiles/          Files needed at runtime (Optional)
|  `-- config.txt         Copied to _build/distrib during compilation.
|
|-- Doxyfile
|-- ice.txt
`-- _build/
  |-- doc/              Generated documentation for programmers.
  |  |-- main.html
  |  `-- index.html
  | 
  `-- distrib/          Files to distribute to users.
     |-- config.txt
     |-- hello.a          Optimized executable.
     `-- hellod.a         Debug executable.

Gray files and directories are automatically generated.

Compile a Library

A project that builds a static library is in a directory ending with '.lib' or '.a'. Dynamic (shared) library projects are configured in exactly the same manner except the root directory name ends with '.dll' or '.so'.

 format.lib/
|-- format.cpp              CPP and H files may be at the top level
|-- stringhelper.h          or in subdirectories.
|
|-- include/              Headers to be distributed with the library (Optional).
|  `-- format.h
|
|-- Doxyfile
|-- ice.txt
`-- _build/
  |-- doc/                Generated documentation for library users.
  |  |-- format.html
  |  `-- index.html
  | 
  `-- include/            Headers for library users.
  |  `-- format.h
  | 
  `-- lib/
     |-- format.a           Optimized library.
     `-- formatd.a          Debug library.

Gray files and directories are automatically generated.

Special Directories

iCompile is controlled through the following special directory names. Using these is optional-- you can use these directory names to take advantages of the full feature set, but iCompile will compile a library or executable in any directory structure.

datafiles		Data files needed at runtime by an executable project. Copied to _build/distrib during build.
docfiles		Resources needed by the generated documentation; usually images and hand coded html files. Copied to _build/doc during build.
include		Header files needed by the library user for a library project. Copied to _build/include during build. The library itself may use these files when building as #include "include/...".
_build		Contains all generated files (except ice.txt and Doxyfile). Deleted by 'icompile --clean'.
.icompile-temp		Used internally by iCompile to store cached dependency information and object files. Deleted by 'icompile --clean'.
CVS, graveyard, temp, tmp, test, _build, Debug, Release, old, datafiles, docfiles, .icompile-temp		Ignored when looking for source files during compilation.

Customizing Projects

icompile  [--doc] [--opt|--debug] [--verbose] [--clean] [--version]
          [--help] [--run|--gdb ...]

--doc            Generate documentation before building.
--debug          (Default) Create a debug executable (define _DEBUG,
                 disable optimizations).
--opt or -O      Generate an optimized executable.
--run            Run the program if compilation succeeds, passing all
                 further arguments (...) to the program.
--gdb            Run the program under gdb if compilation succeeds,
                 passing all further arguments (...) to the program.
                 You can also just run gdb yourself after using iCompile.
--verbose        Print script variables and other output.

Exclusive options:
--help           Print this information.
--clean          Delete all generated files.
--version        Print the version number of iCompile.

Special directory names:
_build            Output directory
datafiles         Files that will be needed at runtime
docfiles          Files needed by your Doxygen output

iCompile will not look for source files in directories matching: 
['^old$', '^CVS$', '^Debug$', '^Release$', '^graveyard$', '^tmp$', 
'^temp$', '^res$', '^docres$', '^.icompile-temp$', '^doxygen$', '^distrib$']

Environment variables:
INCLUDE                        Places to look for headers
LIBRARY                        Places to look for static and dynamic libs
                               (Separate individual paths with colons)

See manual.html or http://ice.sf.net for full information.

A Note About Linking

iCompile prefers static linking because it leaves you with an executable that is more likely to work on a different computer. The G3D library are statically linked for this reason. Some libraries, like SDL and OpenGL, can't be statically linked so they are dynamically linked. The standard library is dynamically linked. This is necessary so that other dynamically linked libraries will allocate memory in the same memory space. Your program will only work if the user has installed these libraries and set their LD_LIBRARY_PATH to point to them or updated /etc/ld.so.conf. You can see what dynamic libraries an executable needs with the Linux command "ldd".

Other Build Tools