summaryrefslogtreecommitdiffstats
path: root/man/sd_journal_add_match.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2016-04-22 04:52:25 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2016-04-22 04:56:44 +0200
commitfb0c7174e33eedadb51ac1a512b4794205f6973d (patch)
treee080f47575e73d410e474377cd16817f47c6bb92 /man/sd_journal_add_match.xml
parenthwdb: add trust illuminated mouse gxt 152 (#3085) (diff)
downloadsystemd-fb0c7174e33eedadb51ac1a512b4794205f6973d.tar.xz
systemd-fb0c7174e33eedadb51ac1a512b4794205f6973d.zip
man: document size param of sd_journal_add_match
Fixes #1724.
Diffstat (limited to 'man/sd_journal_add_match.xml')
-rw-r--r--man/sd_journal_add_match.xml18
1 files changed, 13 insertions, 5 deletions
diff --git a/man/sd_journal_add_match.xml b/man/sd_journal_add_match.xml
index 3b27444f8d..98415d53fd 100644
--- a/man/sd_journal_add_match.xml
+++ b/man/sd_journal_add_match.xml
@@ -88,11 +88,19 @@
<citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>
and
<citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
- Matches are of the form <literal>FIELD=value</literal>, where the
- field part is a short uppercase string consisting only of 0–9, A–Z
- and the underscore. It may not begin with two underscores or be
- the empty string. The value part may be any value, including
- binary. If a match is applied, only entries with this field set
+ Parameter <parameter>data</parameter> must be of the form
+ <literal><replaceable>FIELD</replaceable>=<replaceable>value</replaceable></literal>,
+ where the <replaceable>FIELD</replaceable> part is a short uppercase string consisting only
+ of 0–9, A–Z and the underscore; it may not begin with two underscores or be the empty
+ string. The <replaceable>value</replaceable> part may be anything, including binary. Parameter
+ <parameter>size</parameter> specifies the number of bytes in <parameter>data</parameter>
+ (i.e. the length of <replaceable>FIELD</replaceable>, plus one, plus the length of
+ <replaceable>value</replaceable>). Parameter <parameter>size</parameter> may also be
+ specified as <constant>0</constant>, in which case <parameter>data</parameter>
+ must be a <constant>NUL</constant>-terminated string, and the bytes before the terminating
+ zero are used as the match.</para>
+
+ <para>If a match is applied, only entries with this field set
will be iterated. Multiple matches may be active at the same time:
If they apply to different fields, only entries with both fields
set like this will be iterated. If they apply to the same fields,