Writing hints and tips

To write a searchable hint for this database, you just write an short article in HTML. The text will be placed inside HTML and BODY tags automatically, so you do not need to include these, or a title.

In order to make the database information and a common format, you should make a file called myhint.cfdb whose first four lines have a special format. Here is an example:

FAQ Title: Tripwire functionality
Keywords: tripwire checksum integrity security intrusion detection
Classes: any
Section: Security

The first line is the title for your hint, the second is any words you expect users to use when searching for the information. The third line is used to restrict the relevance of the hint to specific cfengine classes. For instance, you might write `Linux' here, if the comment is specific to GNU/Linux, or even Debian, if the comment applies only to Debian GNU/Linux.

The final line gives a section heading. If possible, you should try to include your hint in an existing section heading, like `Host Installation'. You can get a list of the section headings in the directory listing. Be careful to use small and capital letters correctly. If your hint starts a new section, then so be it!

After these four lines, you write what ever you like. Please do not use lots of funny fonts and colours in your HTML. Use the <pre> tag to mark cited code.