summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorZbyszek Jędrzejewski-Szmek <zbyszek@in.waw.pl>2012-07-10 10:14:56 +0200
committerZbyszek Jędrzejewski-Szmek <zbyszek@in.waw.pl>2012-07-10 10:20:31 +0200
commit78a234c6d3b82775a41c866b3a242d7829851b63 (patch)
tree55a910528ddbc214039c3a1f790add6b4320cd89 /README.md
parent167f51b25c9ac46f36a86ada3f7e1894d5c75a9c (diff)
downloadpython-systemd-78a234c6d3b82775a41c866b3a242d7829851b63.tar.gz
Wrap README to 80 lines
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/README.md b/README.md
index 21e9111..69ae4f6 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,9 @@
journald-python
===============
-Python module for native access to the journald facilities in recent versions of systemd. In particular, this capability includes passing key/value pairs as fields that journald can use for filtering.
+Python module for native access to the journald facilities in recent
+versions of systemd. In particular, this capability includes passing
+key/value pairs as fields that journald can use for filtering.
Installation
============
@@ -17,15 +19,20 @@ Usage
Quick example:
import journald
- journald.send('MESSAGE=Hello world.')
- journald.send('MESSAGE=Hello, again, world.', 'FIELD2=Greetings!', 'FIELD3=Guten tag.')
+ journald.send('MESSAGE=Hello world')
+ journald.send('MESSAGE=Hello, again, world', 'FIELD2=Greetings!', 'FIELD3=Guten tag')
journald.send('ARBITRARY=anything', 'FIELD3=Greetings!')
Notes:
- * Each argument must be in the form of a KEY=value pair, environmental variable style.
- * Unlike the native C version of journald's sd_journal_send(), printf-style substitution is not supported. Perform any substitution using Python's % operator or .format() capabilities first.
- * The base message is usually sent in the form MESSAGE=hello. The MESSAGE field is, however, not required.
+ * Each argument must be in the form of a KEY=value pair,
+ environmental variable style.
+ * Unlike the native C version of journald's sd_journal_send(),
+ printf-style substitution is not supported. Perform any
+ substitution using Python's % operator or .format() capabilities
+ first.
+ * The base message is usually sent in the form MESSAGE=hello. The
+ MESSAGE field is, however, not required.
* Invalid or zero arguments results in nothing recorded in journald.
Viewing Output