← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/simple_user_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/simple_user_policy/docs/index.rst
 
1
User-based Authorization
 
2
========================
 
3
 
 
4
Authorization plugin which implements a simple policy-based strategy.
 
5
 
 
6
.. _simple_user_policy_loading:
 
7
 
 
8
Loading
 
9
-------
 
10
 
 
11
To load this plugin, start :program:`drizzled` with::
 
12
 
 
13
   --plugin-add=simple_user_policy
 
14
 
 
15
Loading the plugin may not enable or configure it.  See the plugin's
 
16
:ref:`simple_user_policy_configuration` and :ref:`simple_user_policy_variables`.
 
17
 
 
18
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
19
 
 
20
.. _simple_user_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
.. _simple_user_policy_variables:
 
32
 
 
33
Variables
 
34
---------
 
35
 
 
36
These variables show the running configuration of the plugin.
 
37
See `variables` for more information about querying and setting variables.
 
38
 
 
39
.. _simple_user_policy_examples:
 
40
 
 
41
Examples
 
42
--------
 
43
 
 
44
Sorry, there are no examples for this plugin.
 
45
 
 
46
.. _simple_user_policy_authors:
 
47
 
 
48
Authors
 
49
-------
 
50
 
 
51
Monty Taylor
 
52
 
 
53
.. _simple_user_policy_version:
 
54
 
 
55
Version
 
56
-------
 
57
 
 
58
This documentation applies to **simple_user_policy 1.0**.
 
59
 
 
60
To see which version of the plugin a Drizzle server is running, execute:
 
61
 
 
62
.. code-block:: mysql
 
63
 
 
64
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='simple_user_policy'
 
65