Markup fixes.

This commit is contained in:
Georg Brandl 2010-04-24 08:56:58 +00:00
parent b558f17b18
commit f8bff488bd
1 changed files with 39 additions and 43 deletions

View File

@ -1,4 +1,3 @@
:mod:`syslog` --- Unix syslog library routines :mod:`syslog` --- Unix syslog library routines
============================================== ==============================================
@ -11,66 +10,63 @@ This module provides an interface to the Unix ``syslog`` library routines.
Refer to the Unix manual pages for a detailed description of the ``syslog`` Refer to the Unix manual pages for a detailed description of the ``syslog``
facility. facility.
This module wraps the system ``syslog`` module. A pure Python This module wraps the system ``syslog`` family of routines. A pure Python
library that can speak to a syslog server is available in library that can speak to a syslog server is available in the
the :mod:`logging.handlers` module as :class:`SysLogHandler`. :mod:`logging.handlers` module as :class:`SysLogHandler`.
The module defines the following functions: The module defines the following functions:
.. function:: syslog([priority,] message) .. function:: syslog([priority,] message)
Send the string *message* to the system logger. A trailing newline is Send the string *message* to the system logger. A trailing newline is added
added if necessary. Each message is tagged with a priority composed if necessary. Each message is tagged with a priority composed of a
of a *facility* and a *level*. The optional *priority* argument, which *facility* and a *level*. The optional *priority* argument, which defaults
defaults to :const:`LOG_INFO`, determines the message priority. If the to :const:`LOG_INFO`, determines the message priority. If the facility is
facility is not encoded in *priority* using logical-or (``LOG_INFO | not encoded in *priority* using logical-or (``LOG_INFO | LOG_USER``), the
LOG_USER``), the value given in the :func:`openlog` call is used. value given in the :func:`openlog` call is used.
If :func:`openlog` has not been called prior to the call to If :func:`openlog` has not been called prior to the call to :func:`syslog`,
:func:'syslog', ``openlog()`` will be called with no arguments. ``openlog()`` will be called with no arguments.
.. function:: openlog([ident[, logopt[, facility]]]) .. function:: openlog([ident[, logopt[, facility]]])
Logging options of subsequent :func:`syslog` calls can be set by Logging options of subsequent :func:`syslog` calls can be set by calling
calling :func:`openlog`. :func:`syslog` will call :func:`openlog` :func:`openlog`. :func:`syslog` will call :func:`openlog` with no arguments
with no arguments if the log is not currently open. if the log is not currently open.
The optional *ident* keyword argument is a string which is prepended The optional *ident* keyword argument is a string which is prepended to every
to every message, and defaults to ''sys.argv[0]'' with leading message, and defaults to ``sys.argv[0]`` with leading path components
path components stripped. The optional *logopt* keyword argument stripped. The optional *logopt* keyword argument (default is 0) is a bit
(default=0) is a bit field - see below for possible values to combine. field -- see below for possible values to combine. The optional *facility*
The optional *facility* keyword argument (default=:const:`LOG_USER`) keyword argument (default is :const:`LOG_USER`) sets the default facility for
sets the default facility for messages which do not have a facility messages which do not have a facility explicitly encoded.
explicitly encoded.
.. versionchanged::3.2 .. versionchanged:: 3.2
In previous versions, keyword arguments were not allowed, and *ident* In previous versions, keyword arguments were not allowed, and *ident* was
was required. The default for *ident* was dependent on the system required. The default for *ident* was dependent on the system libraries,
libraries, and often was ''python'' instead of the name of the and often was ``python`` instead of the name of the python program file.
python program file.
.. function:: closelog() .. function:: closelog()
Reset the syslog module values and call the system library Reset the syslog module values and call the system library ``closelog()``.
''closelog()''.
This causes the module to behave as it does when initially imported. This causes the module to behave as it does when initially imported. For
For example, :func:'openlog' will be called on the first :func:'syslog' example, :func:`openlog` will be called on the first :func:`syslog` call (if
call (if :func:'openlog' hasn't already been called), and *ident* :func:`openlog` hasn't already been called), and *ident* and other
and other :func:'openlog' parameters are reset to defaults. :func:`openlog` parameters are reset to defaults.
.. function:: setlogmask(maskpri) .. function:: setlogmask(maskpri)
Set the priority mask to *maskpri* and return the previous mask value. Set the priority mask to *maskpri* and return the previous mask value. Calls
Calls to :func:`syslog` with a priority level not set in *maskpri* to :func:`syslog` with a priority level not set in *maskpri* are ignored.
are ignored. The default is to log all priorities. The function The default is to log all priorities. The function ``LOG_MASK(pri)``
``LOG_MASK(pri)`` calculates the mask for the individual priority calculates the mask for the individual priority *pri*. The function
*pri*. The function ``LOG_UPTO(pri)`` calculates the mask for all ``LOG_UPTO(pri)`` calculates the mask for all priorities up to and including
priorities up to and including *pri*. *pri*.
The module defines the following constants: The module defines the following constants:
@ -103,9 +99,9 @@ A simple set of examples::
if error: if error:
syslog.syslog(syslog.LOG_ERR, 'Processing started') syslog.syslog(syslog.LOG_ERR, 'Processing started')
An example of setting some log options, these would include the process ID An example of setting some log options, these would include the process ID in
in logged messages, and write the messages to the destination facility logged messages, and write the messages to the destination facility used for
used for mail logging:: mail logging::
syslog.openlog(logopt=syslog.LOG_PID, facility=syslog.LOG_MAIL) syslog.openlog(logopt=syslog.LOG_PID, facility=syslog.LOG_MAIL)
syslog.syslog('E-mail processing initiated...') syslog.syslog('E-mail processing initiated...')