summaryrefslogtreecommitdiff
path: root/src/python-systemd/docs/journal.rst
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-02-28 19:53:42 -0500
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-02-28 20:05:12 -0500
commit37d3ab1b7e114f0fb6dfb2e7273569b42794b76a (patch)
treeb69f73466e4719b6f02d4b30fcaa42ec43f1c40d /src/python-systemd/docs/journal.rst
parent54c31a79f72ff57ac8eba089acacc4ab482b745d (diff)
parent7f41820b07ccb8a6da5552c466818fcce3d085bf (diff)
Merge branch 'python-systemd-reader'
* python-systemd-reader: python-systemd: rename Journal to Reader build-sys: upload python documentation to freedesktop.org systemd-python: add Journal class for reading journal python: build html docs using sphinx journalct: also print Python code in --new-id python: utilize uuid.UUID in logging python: add systemd.id128 module ... and 34 other commits In short: python module systemd.id128 is added, and existing systemd.journal gains a new class systemd.journal.Reader, which can be used to iterate over journal entries. Documentation is provided, and accessible under e.g. pydoc3 systemd.journal.Reader or firefox http://www.freedesktop.org/software/systemd/man/python-systemd/
Diffstat (limited to 'src/python-systemd/docs/journal.rst')
-rw-r--r--src/python-systemd/docs/journal.rst49
1 files changed, 49 insertions, 0 deletions
diff --git a/src/python-systemd/docs/journal.rst b/src/python-systemd/docs/journal.rst
new file mode 100644
index 0000000000..78b831afff
--- /dev/null
+++ b/src/python-systemd/docs/journal.rst
@@ -0,0 +1,49 @@
+`systemd.journal` module
+========================
+
+.. automodule:: systemd.journal
+ :members: send, sendv, stream, stream_fd
+ :undoc-members:
+
+`JournalHandler` class
+----------------------
+
+.. autoclass:: JournalHandler
+
+Accessing the Journal
+---------------------
+
+.. autoclass:: _Reader
+ :undoc-members:
+ :inherited-members:
+
+.. autoclass:: Reader
+ :undoc-members:
+ :inherited-members:
+
+ .. automethod:: __init__
+
+.. autoclass:: Monotonic
+
+.. autoattribute:: systemd.journal.DEFAULT_CONVERTERS
+
+Whence constants
+~~~~~~~~~~~~~~~~
+
+.. autoattribute:: systemd.journal.SEEK_SET
+.. autoattribute:: systemd.journal.SEEK_CUR
+.. autoattribute:: systemd.journal.SEEK_END
+
+Journal access types
+~~~~~~~~~~~~~~~~~~~~
+
+.. autoattribute:: systemd.journal.LOCAL_ONLY
+.. autoattribute:: systemd.journal.RUNTIME_ONLY
+.. autoattribute:: systemd.journal.SYSTEM_ONLY
+
+Journal event types
+~~~~~~~~~~~~~~~~~~~
+
+.. autoattribute:: systemd.journal.NOP
+.. autoattribute:: systemd.journal.APPEND
+.. autoattribute:: systemd.journal.INVALIDATE