Skip to contentSkip to conversation

logger man page: improve logger --journald example

PATCH Applied Michal Schmidt 2 participants 2 messages Sep 3, 2015 – Sep 7, 2015 Util-Linux package

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 logger man page: improve logger --journald example

The example use of logger --journald in the man page has a couple of flaws:
- It's missing a "MESSAGE=" field. This is supposed to be the primary human readable text. Without it the log entry is invisible in a plain "journalctl" output.
- The MESSAGE_ID is supposed to be a 128-bit hexadecimal string that globally uniquely identifies the message type.
One can generate such an id with "journalctl --new-id".

This patches fixes the above and also changes the example to use a here-document instead of printf. In my opinion it makes the expected multi-line data format more obvious.

---
 misc-utils/logger.1 | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)
misc-utils/logger.1 +7 -1
index 36c923d52c..5deb3f0a1f 100644
@@ -81,7 +81,13 @@ for details.  The use of a MESSAGE_ID field is generally a good idea, as it
 makes finding entries easy.  Examples:
 .IP
 .nf
-\fB    printf \(dq%s\\n%s\\n%s\\n\(dq MESSAGE_ID=42 DOGS=bark \(dqCARAVAN=goes on\(dq | logger --journald
+\fB    logger --journald <<end
+\fB    MESSAGE_ID=67feb6ffbaf24c5cbec13c008dd72309
+\fB    MESSAGE=The dogs bark, but the caravan goes on.
+\fB    DOGS=bark
+\fB    CARAVAN=goes on
+\fB    end
+.IP
 \fB    logger --journald=entry.txt
 .fi
 .IP
Signature · 1 line
2.4.3
maintainer Applied
#1 lore raw
Quoted 2 lines · Michal Schmidt
 misc-utils/logger.1 | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

Applied, thanks.

Signature · 2 lines
 Karel Zak  <[email protected]>
 http://karelzak.blogspot.com