Changeset 2204

Timestamp:

04/12/05 18:22:58 (20 years ago)

Author:

jerome

Message:

Now the sample configuration files describe the file's syntax

Location:

pykota/trunk/conf

Files:

• pykota.conf.sample (modified) (1 diff)
• pykotadmin.conf.sample (modified) (1 diff)

pykota/trunk/conf/pykota.conf.sample

@@ -1 +1 @@
 # PyKota sample configuration file
 #
-# Copy this file into the /etc/pykota/ directory
-# under the name /etc/pykota/pykota.conf
+#
+# File format :
+#
+#   - A mandatory [global] section :
+#
+#     Contains configuration directives which apply for all printers.
+#     Some directives MUST be set in the [global] section, e.g.
+#     database related directives.
+#
+#   - Any number of optional [PrintQueueName] sections :
+#
+#     Contain directives which apply for a particular print queue only.
+#
+#     Override the values of the same directives present in [global].
+#
+#
+# Directives format :
+#
+#   - Directive's name, followed by ':' followed by the directive's value.
+#
+#   - No leading whitespace : leading whitespace tell the parser that the
+#     current directive is the continuation of the previous one. Use with
+#     care and only when you need it.
+#
 #
 # PyKota - Print Quotas for CUPS and LPRng

pykota/trunk/conf/pykotadmin.conf.sample

@@ -1 +1 @@
 # PyKota sample administrator's configuration file
-#
-# Copy it into the /etc/pykota/ directory under
-# the /etc/pykota/pykotadmin.conf name, and 
-# ensure that only the root user and the user
-# the printing system is run as can read it.
 #
 # Under NO circumstances regular users should 
 # be allowed to read this file.
+#
+#
+# File format :
+#
+#   - A mandatory [global] section :
+#
+#     Contains configuration directives to specify the username and
+#     optional password for the PyKota's database administrator.
+#     This user is either a PostgreSQL user, or an LDAP dn.
+#
+# Directives format :
+#
+#   - Directive's name, followed by ':' followed by the directive's value.
+#
+#   - No leading whitespace : leading whitespace tell the parser that the
+#     current directive is the continuation of the previous one. Use with
+#     care and only when you need it.
+#
 #
 # PyKota - Print Quotas for CUPS and LPRng