Grid Engine Documents



Two categories of documentation are available for Grid Engine, user/administrator level manuals for the compiled software and developer oriented technical documentation. Some of those files are available in PDF format. You will need Adobe Acrobat Reader to display them. Download Acrobat Reader.

User and Administrator Manuals

The Grid Engine project has not established a specific documentation effort to create unique documentation for Grid Engine software. However, a draft version of a user and administrator manual for the next release of Sun Grid Engine software describes the functionality of the initial open source release of Grid Engine reasonably well, and is available here. Your comments and suggestions regarding this draft document would be appreciated on the mail list, and we will make available the revised versions here.
The manual is available as PDF only and the download size is approximately 12.5 MBytes. Download the Grid Engine manual here. It consists of

  • a Quick Start Guide including installation instructions,
  • an Administration and Installation Manual,
  • an User Guide, and
  • a Reference Manual.

In addition, "nroff" on-line manual pages can be checked out from /gridengine/doc/man by using CVS. These pages are highly similar to the Reference Manual. This includes a description of all client/server commands, of all file formats and of the internally used programming interfaces.

For administrators and users we also recommend the HOWTOs, specifically in case of problems or questions concerning how Grid Engine might be best applied to a specific scenario.

Technical Documentation

Those who are interested in understanding the Grid Engine source code or contributing to it are refered to the module documentation overview page. It contains links to information pages on all major source code modules and it provides an overview on their interrelationship.

Other sources of technical information are:

  • the "nroff" manual pages in HTML,
  • some source module specific documentation can be found in the same directories as the module source code.

Developer Documentation

Additional documentation for developers is available:

  • Grid Engine build page describes how to create Grid Engine binaries from the sources and a distribution
  • README.aimk describes the aimk script in detail, and is refered to in the Grid Engine build page
  • scripts/README.distinst describes the distinst script in detail, and is refered to in the Grid Engine build page
  • scripts/README.mk_dist describes the mk_dist script in detail, and is refered to in the Grid Engine build page
  • sge_depend describes the tool used for generating make dependencies. It is refered to in the Grid Engine build page
  • dist/README.arch describes the binary architectures of Grid Engine
  • scripts page describes other scripts which are needed during the build and installation process
  • testsuite page describes the testsuite used for quality assurance for Grid Engine
  • coding standards
  • ADOC page describes Autodoc Headers used for source code documentation in parts of the source code