~rashi007/mailman/docsfix

« back to all changes in this revision

Viewing changes to src/mailman/commands/docs/conf.rst

  • Committer: Barry Warsaw
  • Date: 2014-11-08 15:27:56 UTC
  • mfrom: (7255 3.0)
  • mto: This revision was merged to the branch mainline in revision 7260.
  • Revision ID: barry@list.org-20141108152756-p37fhmb0z2dtl7hx
Trunk merge.

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
    ...     key = None
15
15
    ...     section = None
16
16
    ...     output = None
17
 
    ...     sort = False
18
17
    >>> from mailman.commands.cli_conf import Conf
19
18
    >>> command = Conf()
20
19
 
22
21
command without any options.
23
22
 
24
23
    >>> command.process(FakeArgs)
25
 
    [logging.archiver] path: mailman.log
 
24
    [antispam] header_checks:
26
25
    ...
27
 
    [passwords] password_length: 8
 
26
    [logging.bounce] level: info
28
27
    ...
29
28
    [mailman] site_owner: noreply@example.com
30
29
    ...
33
32
 
34
33
    >>> FakeArgs.section = 'shell'
35
34
    >>> command.process(FakeArgs)
36
 
    [shell] use_ipython: no
37
35
    [shell] banner: Welcome to the GNU Mailman shell
38
36
    [shell] prompt: >>>
 
37
    [shell] use_ipython: no
39
38
 
40
39
You can also pass a key and display all key-value pairs matching the given
41
40
key, along with the names of the corresponding sections.
44
43
    >>> FakeArgs.key = 'path'
45
44
    >>> command.process(FakeArgs)
46
45
    [logging.archiver] path: mailman.log
47
 
    [logging.locks] path: mailman.log
48
 
    [logging.mischief] path: mailman.log
 
46
    [logging.bounce] path: bounce.log
49
47
    [logging.config] path: mailman.log
 
48
    [logging.database] path: mailman.log
 
49
    [logging.debug] path: debug.log
50
50
    [logging.error] path: mailman.log
51
 
    [logging.smtp] path: smtp.log
52
 
    [logging.database] path: mailman.log
 
51
    [logging.fromusenet] path: mailman.log
53
52
    [logging.http] path: mailman.log
 
53
    [logging.locks] path: mailman.log
 
54
    [logging.mischief] path: mailman.log
54
55
    [logging.root] path: mailman.log
55
 
    [logging.fromusenet] path: mailman.log
56
 
    [logging.bounce] path: bounce.log
57
 
    [logging.vette] path: mailman.log
58
56
    [logging.runner] path: mailman.log
 
57
    [logging.smtp] path: smtp.log
59
58
    [logging.subscribe] path: mailman.log
60
 
    [logging.debug] path: debug.log
 
59
    [logging.vette] path: mailman.log
61
60
 
62
61
If you specify both a section and a key, you will get the corresponding value.
63
62
 
66
65
    >>> command.process(FakeArgs)
67
66
    noreply@example.com
68
67
 
69
 
You can also sort the output.  The output is first sorted by section, then by
70
 
key.
71
 
 
72
 
    >>> FakeArgs.key = None
73
 
    >>> FakeArgs.section = 'shell'
74
 
    >>> FakeArgs.sort = True
75
 
    >>> command.process(FakeArgs)
76
 
    [shell] banner: Welcome to the GNU Mailman shell
77
 
    [shell] prompt: >>>
78
 
    [shell] use_ipython: no
79
 
 
80
68
 
81
69
.. _`Postfix command postconf(1)`: http://www.postfix.org/postconf.1.html