8  iceWing Files

8.1  Filesystem hierarchy

Let’s see, what the installation consists of. Below the installation prefix, for example “/usr/local”, you have this structure-content:

bin/

icewing - the executable itself

icewing-config

A shell script similar to e.g. gtk-config which makes compiling of own plugins easy. It generates compiler-flags, extracts system-paths, and more. “icewing-config --help” shows all available options of the script. See section 7.2 for more details.

icewing-docgen

A shell script which collects help messages of all plugins which are installed under ${PREFIX}/lib/iceWing and all plugins which are integrated in iceWing. The script creates the files “Readme.txt” and “Readme.html” in the current directory and the file “${PREFIX}/share/iceWing/plugins.help”. This last file is used by iceWing to display additional information about plugins on the “Plugins” page in the “Plugin Info” window. See section 5.2.4 for information about this window. See section 7.4 for more information about the script.

icewing-plugingen

A plugin template generator. The script generates in the current directory a basic C or C++ plugin including a Makefile to compile it. “icewing-plugingen --help” gives more information. See section 7.5 for the details.

’icewing-config --bindir’ gives this directory, whereas ’icewing-config --prefix’ gives the installation directory, i.e. this directory without the “/bin” part.

include/

- All the headers for your own plugin programming

iceWing - headers from the iceWing system

Besides other options, ’icewing-config --cflags’ contains this directory.

iwPlugins - plugin headers

If your plugin publishes new structures to be used by other plugins, you probably want to put them here.

’icewing-config --pincludedir’ gives this directory.

lib/

iceWing/ - Here is the default place for iceWing to search for plugin libraries. Normally you give iceWing by command line parameter “-l” library names to load. If iceWing is not able to load them directly, it automatically tries to load them from this directory.

’icewing-config --libdir’ gives this directory.

pkgconfig/icewing.pc - A metadata file for pkg-config, which can be used as an alternative to icewing-config for generating compiler-flags, extracting system-paths, and more. See section 7.2 for more details.

man/

- The manpage of iceWing

share/

iceWing/ - Place where iceWing and plugins can store additional data files. E.g. the plugin “Face” has here its config-file placed, and the polynom-classificator plugin stores its data here, too.

icewing.pdf - the manual of iceWing

plugins.help - This file is created by icewing-docgen. The file is used by iceWing to display additional information about plugins on the “Plugins” page in the “Plugin Info” window. See section 5.2.4 for information about this window.

’icewing-config --datadir’ gives this directory.

log/icewing.log - The installation log file. It contains all actions performed during the “make install” phase.

8.2  Headerfiles overview

TODO