Chapter 3. SCR Agent Documentation

Chapter 3. SCR Agent Documentation
	Source Code Documentation HowTo

The file header should show what is the SCR Agent good for, supported acces types (read/write/execute) and examples how to use it.

Example 3.1. Exemplary SCR Agent Definition

/**
 * File:
 *   sshd.scr
 * Summary:
 *   SCR Agent for reading/writing /etc/ssh/sshd_config
 *   using the ini-agent
 * Access:
 *   read/write
 * Authors:
 *   John The Fish <john@thesmallfish.net>
 * Example:
 *   Dir(.sshd)
 *   (["Port", "X11Forwarding", "Compression", "MaxAuthTries", "PermitRootLogin"])
 *
 *   Read(.sshd.Compression)
 *   (["yes"])
 *
 *   Write(.sshd.Compression, "no")
 *   (true)
 *
 * $Id: sshd.scr 11113 2005-10-20 14:15:16Z jtf $
 *
 * Fore more information about possible keys and values
 * consult with the sshd_config man pages `man sshd_config`.
 */

.sshd

`ag_ini(
    ...
)


Chapter 2. Perl Module Documentation		Common Modules and Libraries