← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/regex_policy/docs/index.rst

  • Committer: Daniel Nichter
  • Date: 2011-08-13 20:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 2413.
  • Revision ID: daniel@percona.com-20110813204138-stxa89ca1t7cg1uy
https://launchpad.net/bugs/793182
Skeleton documentation for all plugins, more complete docu for first half of plugins.
Clean up plugin.ini titles and descriptions.
Reformat and reorganize root index.
Change Administrative to Administration and remove empty files (logging, etc.)
Add, fix, and tag documentation for functions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/regex_policy/docs/index.rst
 
1
Regex-based Authorization
 
2
=========================
 
3
 
 
4
Authorization plugin which implements a regex to object mapping.
 
5
 
 
6
.. _regex_policy_loading:
 
7
 
 
8
Loading
 
9
-------
 
10
 
 
11
To load this plugin, start :program:`drizzled` with::
 
12
 
 
13
   --plugin-add=regex_policy
 
14
 
 
15
Loading the plugin may not enable or configure it.  See the plugin's
 
16
:ref:`regex_policy_configuration` and :ref:`regex_policy_variables`.
 
17
 
 
18
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
19
 
 
20
.. _regex_policy_configuration:
 
21
 
 
22
Configuration
 
23
-------------
 
24
 
 
25
These command line options configure the plugin when :program:`drizzled`
 
26
is started.  See :doc:`/configuration` for more information about specifying
 
27
command line options.
 
28
 
 
29
.. program:: drizzled
 
30
 
 
31
.. option:: --regex-policy.policy ARG
 
32
 
 
33
   :Default: DEFAULT_POLICY_FILE.string(
 
34
   :Variable: :ref:`regex_policy_policy <regex_policy_policy>`
 
35
 
 
36
   File to load for regex authorization policies
 
37
 
 
38
.. _regex_policy_variables:
 
39
 
 
40
Variables
 
41
---------
 
42
 
 
43
These variables show the running configuration of the plugin.
 
44
See `variables` for more information about querying and setting variables.
 
45
 
 
46
.. _regex_policy_policy:
 
47
 
 
48
* ``regex_policy_policy``
 
49
 
 
50
   :Scope: Global
 
51
   :Dynamic: No
 
52
   :Option: :option:`--regex-policy.policy`
 
53
 
 
54
   File to load for regex authorization policies
 
55
 
 
56
.. _regex_policy_examples:
 
57
 
 
58
Examples
 
59
--------
 
60
 
 
61
Sorry, there are no examples for this plugin.
 
62
 
 
63
.. _regex_policy_authors:
 
64
 
 
65
Authors
 
66
-------
 
67
 
 
68
Clint Byrum
 
69
 
 
70
.. _regex_policy_version:
 
71
 
 
72
Version
 
73
-------
 
74
 
 
75
This documentation applies to **regex_policy 1.0**.
 
76
 
 
77
To see which version of the plugin a Drizzle server is running, execute:
 
78
 
 
79
.. code-block:: mysql
 
80
 
 
81
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='regex_policy'
 
82