===================
Getting information
===================

You can get information about Mailman's environment by using the command line
script ``mailman info``.  By default, the info is printed to standard output.
::

    >>> from mailman.testing.documentation import cli
    >>> command = cli('mailman.commands.cli_info.info')

    >>> command('mailman info')
    GNU Mailman 3...
    Python ...
    ...
    config file: .../test.cfg
    db url: ...
    REST root url: http://localhost:9001/3.1/
    REST credentials: restadmin:restpass

By passing in the ``-o/--output`` option, you can print the info to a file.

    >>> from mailman.config import config
    >>> import os
    >>> output_path = os.path.join(config.VAR_DIR, 'output.txt')
    >>> command('mailman info -o ' + output_path)
    >>> with open(output_path) as fp:
    ...     print(fp.read())
    GNU Mailman 3...
    Python ...
    ...
    config file: .../test.cfg
    db url: ...
    devmode: DISABLED
    REST root url: http://localhost:9001/3.1/
    REST credentials: restadmin:restpass

You can also get more verbose information, which contains a list of the file
system paths that Mailman is using.

    >>> config.create_paths = False
    >>> config.push('fhs', """
    ... [mailman]
    ... layout: fhs
    ... """)
    >>> ignore = cleanups.callback(config.pop, 'fhs')
    >>> config.create_paths = True

The `Filesystem Hierarchy Standard`_ layout is the same everywhere by
definition.

    >>> command('mailman info --verbose')
    GNU Mailman 3...
    Python ...
    ...
    File system paths:
        ARCHIVE_DIR     = /var/lib/mailman/archives
        BIN_DIR         = /sbin
        CACHE_DIR       = /var/lib/mailman/cache
        CFG_FILE        = .../test.cfg
        DATA_DIR        = /var/lib/mailman/data
        ETC_DIR         = /etc
        LIST_DATA_DIR   = /var/lib/mailman/lists
        LOCK_DIR        = /var/lock/mailman
        LOCK_FILE       = /var/lock/mailman/master.lck
        LOG_DIR         = /var/log/mailman
        MESSAGES_DIR    = /var/lib/mailman/messages
        PID_FILE        = /var/run/mailman/master.pid
        QUEUE_DIR       = /var/spool/mailman
        TEMPLATE_DIR    = .../mailman/templates
        VAR_DIR         = /var/lib/mailman


.. _`Filesystem Hierarchy Standard`: http://www.pathname.com/fhs/
