Installation Layout

On Posix operating systems the default prefix for K-3D is /usr/local/k3d. This location was chosen as a convenience for developers to avoid conflicts with the normal installation directories for packaged software. People creating K-3D packages for specific OS distributions should override the default(s) to install K-3D wherever appropriate for their distribution.

K-3D files will be installed to the following directories relative to the prefix:

  bin/                        -- Contains the K-3D binaries
  include/
    k3d/                      -- The K-3D SDK header files, for plugin authors and embedders
  lib/                        -- Core K-3D libraries including the SDK libraries
    k3d/                      -- K-3D plugin modules that ship with the main program
  man/                        -- Man pages
  share/
    k3d/
      desktop/                -- Files for integrating K-3D with desktops (links)
      dialogtemplates/        -- Dialog template files that define the K-3D UI (deprecated)
      doc/
        developer_guide/      -- K-3D developer documentation
	user_reference/       -- K-3D user documentation (this document)
      icons/                  -- K-3D icons for desktop use
      scripts/                -- Sample K-3D scripts
      shaders/                -- RenderMan shaders that ship with K-3D
      tutorials/              -- K-3D tutorials that ship with the main program
    
<< Previous 
Table of Content
  Next >>