Spackle Man Page

SourceForge

Last updated: Thursday, 1 January 1970 00:00 00000


Generated-and-frobbed Man Page

Below is the HTMLised version of the spackle.conf man page which accompanies the package. It was generated from the actual man page source, then heavily modified by hand to make it into valid and usable HTML. No content was changed during the modification.


Content-type: text/html Manpage of spackle.conf

spackle.conf

Section: Utilities (5)
Updated: August 2002
Index Return to Main Contents
 

NAME

spackle.conf - Spackle Configuration File  

DESCRIPTION

The spackle.conf file lives in the CVSROOT directory of a Spackle-enabled CVS repository, and defines many of the parameters controlling the behaviour of the spackle(5) package.

Every line in the file is either a comment or a parameter setting. Blank lines and those in which the first non-blank character is an octothorpe ('#') are comments. Parameter lines consist of a keyword, an equals symbol ('='), and a setting for the parameter. Whitespace at the beginning of the line, the end of the line, and/or surrounding the equals symbol is ignored. Continuation lines are not supported.  

PARAMETERS

Parameters may take either integer, string, or Boolean values. Integer and string values are pretty straightforward, but Boolean settings must be one of '1', 'Yes', 'On', or 'True' in order for the parameter to have a TRUE value. Any other setting will be treated as FALSE. Parameter names and Boolean keywords are case-insensitive, so the following two lines are equivalent:
ParameterName = True
pArAmEtErNaMe = tRuE

The parameters beginning with 'Enable_' are set as part of the initial Spackle configuration and installation process, and should not be changed. Changing their values after installation may result in UNDEFINED behaviour.

Debug
[Boolean] Indicates whether additional debugging information should be displayed; reserved for use by Spackle developers. (I.e., if you're not a developer and you set this to TRUE, you're on your own if anything breaks.)
Enable_ACLs
[Boolean] Indicates whether Spackle should apply the access control mechanisms to CVS operations.
Enable_Logging
[Boolean] Indicates whether Spackle should perform its logging actions.
Enable_passwd
[Boolean] Indicates whether the repository is subject to pserver-type access, and uses a username/password control file.
Enable_readers
[Boolean] Indicates that Spackle was configured for pserver access and the repository has and uses a readers file.
Enable_writers
[Boolean] Indicates that Spackle was configured for pserver access and the repository has and uses a writers file.
IncludeRCSinfo
[Integer] Indicates in which logging path the RCS ID and delta information should be included. The following values are defined:
0
Don't include the RCS information at all.
1
Include the RCS information only in email messages.
2
Include the information only in logfiles [not yet implemented].
3
Include the RCS information in both the logs and in the email notifications.
Karma_File
Specifies the name of the file in the CVSROOT directory of the repository which defines who may access the various modules. The default name is "avail".
Maintainer
[String] The username of the person responsible for maintaining the repository. This username is used as a fallback in many situations, such as the default username with which the avail file is populated.
Maintainer_Email
[String] Defines the email address of the repository maintainer.
PatchThreshold
[Integer] Maximum number of lines of patch text that will be included verbatim in commit notification email messages. If there are more than this many lines in the notification, the email content shifts to a different format.
[Not yet implemented.]
Subject_Prefix
[String] Text to be prepended to the subject line of every email notification message, typically identifying the repository. For example:

Subject_Prefix = [Project A]
 

AUTHOR

Rodent of Unusual Size <coar@Apache.Org>  

SEE ALSO

spackle(5).

For more information, see the Spackle project Web site at <URL: http://Spackle.SourceForge.Net/ >.


 

Index

NAME
DESCRIPTION
PARAMETERS
AUTHOR
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 18:03:42 GMT, August 17, 2002
coar