← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/errmsg_stderr/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/errmsg_stderr/docs/index.rst
 
1
Error Messages To STDERR
 
2
========================
 
3
 
 
4
:program:`errmsg_stderr` is an error message plugin that prints all
 
5
:program:`drizzled`: error messages to ``STDERR``.  Only server errors are
 
6
printed; SQL errors, replication errors, etc. are not captured by error
 
7
message plugins.
 
8
 
 
9
.. _errmsg_stderr_loading:
 
10
 
 
11
Loading
 
12
-------
 
13
 
 
14
This plugin is loaded by default, but it may need to be configured.  See
 
15
the plugin's :ref:`errmsg_stderr_configuration` and
 
16
:ref:`errmsg_stderr_variables`.
 
17
 
 
18
To stop the plugin from loading by default, start :program:`drizzled`
 
19
with::
 
20
 
 
21
   --plugin-remove=errmsg_stderr
 
22
 
 
23
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
24
 
 
25
.. _errmsg_stderr_configuration:
 
26
 
 
27
Configuration
 
28
-------------
 
29
 
 
30
This plugin does not have any command line options.
 
31
 
 
32
.. _errmsg_stderr_variables:
 
33
 
 
34
Variables
 
35
---------
 
36
 
 
37
This plugin does not register any variables.
 
38
 
 
39
.. _errmsg_stderr_examples:
 
40
 
 
41
Examples
 
42
--------
 
43
 
 
44
Redirect ``STDOUT`` and ``STDERR`` to :file:`drizzled.err`::
 
45
 
 
46
   sbin/drizzled >> drizzled.err 2>&1
 
47
 
 
48
.. _errmsg_stderr_authors:
 
49
 
 
50
Authors
 
51
-------
 
52
 
 
53
Mark Atwood
 
54
 
 
55
.. _errmsg_stderr_version:
 
56
 
 
57
Version
 
58
-------
 
59
 
 
60
This documentation applies to **errmsg_stderr 0.1**.
 
61
 
 
62
To see which version of the plugin a Drizzle server is running, execute:
 
63
 
 
64
.. code-block:: mysql
 
65
 
 
66
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='errmsg_stderr'
 
67
 
 
68
Changelog
 
69
---------
 
70
 
 
71
v0.1
 
72
^^^^
 
73
* First release.