Spell Writing Handbook

Introduction

This is a technical reference document. A first part describes all of the files that are checked for in a spell, their purpose, and documented attributes.

A second part describes the standards we use in the grimoire.

1. Spell files

A function reference can be located here: <TODO: find and place the link>

These are the files used during a cast, in their execution order:

• PREPARE - Useful for those rare times when the DETAILS file needs to be modified or the spell or package needs to be configured before the DETAILS file is executed.

• DETAILS - Informational file, required for all spells

• CONFIGURE - Used to select and modify a package's compile time options.

• DEPENDS - Lists all other spells that are required or optionally required to be cast.

(Processing of the depended on spells.)

(DETAILS is run again.)

• CONFLICTS

• PRE_BUILD

• BUILD

• PRE_INSTALL

• INSTALL

• FINAL

• TRIGGERS

(The triggered spells are cast now.)

These are the files used during the download, in their execution order:

• DOWNLOAD

These are the files used during a dispel, in their execution order:

• PRE_REMOVE

• POST_REMOVE

These are the files used during a resurrect, in their execution order:

• PRE_RESURRECT

• POST_RESURRECT

These files are processed during a scribe update, cleanse --tablet, or cleanse --tablet_spell, in their execution order:

• REPAIR FILES

These files are known as Spell Filters:

• volatiles

• excluded

• protected

These are the other files:

• HISTORY

• PROVIDES

• services

• init.d directory

• pam.d directory

• xinetd.d directory

2. Standards

* For formatting rules, check the appropriate spell file pages above. General rule: No tabs except in HISTORY, align '='s in DETAILS, and use newlines.

* Multi_Version_Spells - The standard for spells with multiple versions.