INN commit: branches/2.4/doc (hook-python pod/hook-python.pod)
INN Commit
Russ_Allbery at isc.org
Sun Jun 29 08:27:41 UTC 2008
Date: Sunday, June 29, 2008 @ 01:27:41
Author: iulius
Revision: 7926
Use initial capital letters for head titles.
Modified:
branches/2.4/doc/hook-python
branches/2.4/doc/pod/hook-python.pod
---------------------+
hook-python | 26 +++++++++++++-------------
pod/hook-python.pod | 26 +++++++++++++-------------
2 files changed, 26 insertions(+), 26 deletions(-)
Modified: hook-python
===================================================================
--- hook-python 2008-06-29 08:16:31 UTC (rev 7925)
+++ hook-python 2008-06-29 08:27:41 UTC (rev 7926)
@@ -34,7 +34,7 @@
nnrpd_dynamic.py samples in your filters directory for a demonstration
of how to get all this working.
-Writing an innd filter
+Writing an innd Filter
Introduction
@@ -123,7 +123,7 @@
innd will be in after the command finishes. *reason* is the comment
string provided on the ctlinnd command line.
- How to use these methods with innd
+ How to Use these Methods with innd
To register your methods with innd, you need to create an instance of
your class, import the built-in INN module, and pass the instance to
@@ -166,7 +166,7 @@
and "filter_messageid" methods have to return strings, or "None". If
you return something like an int, innd will *not* be happy.
- A note regarding buffer objects
+ A Note regarding Buffer Objects
Buffer objects are cousins of strings, new in Python 1.5.2. Using
buffer objects may take some getting used to, but we can create buffers
@@ -203,7 +203,7 @@
g = b + '>' # This is legal, returns the string 'def>'.
- Functions supplied by the built-in innd module
+ Functions Supplied by the Built-in innd Module
Besides "INN.set_filter_hook" which is used to register your methods
with innd as it has already been explained above, the following
@@ -290,9 +290,9 @@
else:
moderated = "something else"
-Writing an nnrpd filter
+Writing an nnrpd Filter
- Changes to Python authentication and access control support for nnrpd
+ Changes to Python Authentication and Access Control Support for nnrpd
The old authentication and access control functionality has been
combined with the new readers.conf mechanism by Erik Klavon
@@ -381,7 +381,7 @@
authenticator or resolver (which can be done in whatever language you
prefer).
- Python authentication support for nnrpd
+ Python Authentication Support for nnrpd
Support for authentication via Python is provided in nnrpd by the
inclusion of a *python_auth* parameter in a readers.conf auth group.
@@ -405,7 +405,7 @@
When the connection with the client is closed, the method "authen_close"
is called if it exists.
- Dynamic generation of access groups
+ Dynamic Generation of Access Groups
A Python script may be used to dynamically generate an access group
which is then used to determine the access rights of the client. This
@@ -435,7 +435,7 @@
the connection, then the client will be denied access since there are no
other access groups which could match the connection.
- Dynamic access control
+ Dynamic Access Control
If you need to have access control rules applied immediately without
having to restart all the nnrpd processes, you may apply access control
@@ -457,7 +457,7 @@
connection with the client is closed, the method "access_close" is
called if it exists.
- Writing a Python nnrpd authentication module
+ Writing a Python nnrpd Authentication Module
You need to create a nnrpd_auth.py module in INN's filter directory (see
the *pathfilter* setting in inn.conf) where you should define a class
@@ -522,7 +522,7 @@
state information or close a database connection. This method may
be omitted.
- The *attributes* dictionary
+ The *attributes* Dictionary
The keys and associated values of the *attributes* dictionary are
described below.
@@ -565,7 +565,7 @@
All the above values are buffer objects (see the notes above on what
buffer objects are).
- How to use these methods with nnrpd
+ How to Use these Methods with nnrpd
To register your methods with nnrpd, you need to create an instance of
your class, import the built-in nnrpd module, and pass the instance to
@@ -600,7 +600,7 @@
python -ic 'import nnrpd, nnrpd_auth'
- Functions supplied by the built-in nnrpd module
+ Functions Supplied by the Built-in nnrpd Module
Besides "nnrpd.set_auth_hook" used to pass a reference to the instance
of authentication and authorization class to nnrpd, the nnrpd built-in
Modified: pod/hook-python.pod
===================================================================
--- pod/hook-python.pod 2008-06-29 08:16:31 UTC (rev 7925)
+++ pod/hook-python.pod 2008-06-29 08:27:41 UTC (rev 7926)
@@ -33,7 +33,7 @@
and F<nnrpd_dynamic.py> samples in your filters directory for
a demonstration of how to get all this working.
-=head1 Writing an B<innd> filter
+=head1 Writing an B<innd> Filter
=head2 Introduction
@@ -128,7 +128,7 @@
=back
-=head2 How to use these methods with B<innd>
+=head2 How to Use these Methods with B<innd>
To register your methods with B<innd>, you need to create an instance of your
class, import the built-in INN module, and pass the instance to
@@ -171,7 +171,7 @@
methods have to return strings, or C<None>. If you return something like an
int, B<innd> will I<not> be happy.
-=head2 A note regarding buffer objects
+=head2 A Note regarding Buffer Objects
Buffer objects are cousins of strings, new in S<Python 1.5.2>. Using buffer
objects may take some getting used to, but we can create buffers much faster
@@ -207,7 +207,7 @@
g = b + '>' # This is legal, returns the string 'def>'.
-=head2 Functions supplied by the built-in B<innd> module
+=head2 Functions Supplied by the Built-in B<innd> Module
Besides C<INN.set_filter_hook> which is used to register your methods
with B<innd> as it has already been explained above, the following functions
@@ -305,9 +305,9 @@
else:
moderated = "something else"
-=head1 Writing an B<nnrpd> filter
+=head1 Writing an B<nnrpd> Filter
-=head2 Changes to Python authentication and access control support for B<nnrpd>
+=head2 Changes to Python Authentication and Access Control Support for B<nnrpd>
The old authentication and access control functionality has been
combined with the new F<readers.conf> mechanism by Erik Klavon
@@ -396,7 +396,7 @@
authenticator or resolver (which can be done in whatever language you
prefer).
-=head2 Python authentication support for B<nnrpd>
+=head2 Python Authentication Support for B<nnrpd>
Support for authentication via Python is provided in B<nnrpd> by the
inclusion of a I<python_auth> parameter in a F<readers.conf> auth
@@ -421,7 +421,7 @@
auth group continues as usual. When the connection with the client
is closed, the method C<authen_close> is called if it exists.
-=head2 Dynamic generation of access groups
+=head2 Dynamic Generation of Access Groups
A Python script may be used to dynamically generate an access group
which is then used to determine the access rights of the client. This
@@ -450,7 +450,7 @@
connection, then the client will be denied access since there are no
other access groups which could match the connection.
-=head2 Dynamic access control
+=head2 Dynamic Access Control
If you need to have access control rules applied immediately without
having to restart all the B<nnrpd> processes, you may apply access
@@ -471,7 +471,7 @@
operation is either permitted or denied. When the connection with the
client is closed, the method C<access_close> is called if it exists.
-=head2 Writing a Python B<nnrpd> authentication module
+=head2 Writing a Python B<nnrpd> Authentication Module
You need to create a F<nnrpd_auth.py> module in INN's filter directory
(see the I<pathfilter> setting in F<inn.conf>) where you should define a
@@ -545,7 +545,7 @@
=back
-=head2 The I<attributes> dictionary
+=head2 The I<attributes> Dictionary
The keys and associated values of the I<attributes> dictionary are
described below.
@@ -602,7 +602,7 @@
All the above values are buffer objects (see the notes above on what
buffer objects are).
-=head2 How to use these methods with B<nnrpd>
+=head2 How to Use these Methods with B<nnrpd>
To register your methods with B<nnrpd>, you need to create an instance of
your class, import the built-in B<nnrpd> module, and pass the instance to
@@ -637,7 +637,7 @@
python -ic 'import nnrpd, nnrpd_auth'
-=head2 Functions supplied by the built-in B<nnrpd> module
+=head2 Functions Supplied by the Built-in B<nnrpd> Module
Besides C<nnrpd.set_auth_hook> used to pass a reference to the instance
of authentication and authorization class to B<nnrpd>, the B<nnrpd> built-in
More information about the inn-committers
mailing list