X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;ds=sidebyside;f=man%2Fsd-id128.xml;h=abd2004d1caeb244d1554f48c9fd34cbf12f8db0;hb=15804cebfdf7bef91db1374967ee813cd4a93588;hp=cbc130d7513578326a173a41abcc8eca3bbc3b06;hpb=12355095821fc17529af5b6eaefa31c3c520be39;p=elogind.git
diff --git a/man/sd-id128.xml b/man/sd-id128.xml
index cbc130d75..abd2004d1 100644
--- a/man/sd-id128.xml
+++ b/man/sd-id128.xml
@@ -39,13 +39,14 @@
sd-id128
- 7
+ 3
sd-id128
sd_id128_t
SD_ID128_MAKE
+ SD_ID128_CONST_STR
SD_ID128_FORMAT_STR
SD_ID128_FORMAT_VAL
sd_id128_equal
@@ -78,10 +79,11 @@
See
- sd_id128_to_string3 and
- sd_id128_randomize3
- for more information about the functions
- implemented.
+ sd_id128_to_string3,
+ sd_id128_randomize3 and
+ sd_id128_get_machine3
+ for more information about the implemented
+ functions.
A 128 bit ID is implemented as the following
union type:
@@ -92,9 +94,9 @@
} sd_id128_t;
This union type allows accessing the 128 bit ID
- as 16 separate bytes or 2 64 bit words. It is generally
+ as 16 separate bytes or two 64 bit words. It is generally
safer to access the ID components by their 8 bit array
- to avoid endianess issues. This union is intended to
+ to avoid endianness issues. This union is intended to
be passed call-by-value (as opposed to
call-by-reference) and may be directly manipulated by
clients.
@@ -103,11 +105,21 @@
decode 128 bit IDs:
SD_ID128_MAKE() may be used
- to write a 128 bit ID in source code. A commonly used
- idiom is to give 128 bit IDs names using this macro:
+ to denote a constant 128 bit ID in source code. A
+ commonly used idiom is to assign a name to a 128 bit
+ ID using this macro:
#define SD_MESSAGE_COREDUMP SD_ID128_MAKE(fc,2e,22,bc,6e,e6,47,b6,b9,07,29,ab,34,a2,50,b1)
+ SD_ID128_CONST_STR() may be
+ use to convert constant 128bit IDs into constant
+ strings for output. The following example code will
+ output the string
+ "fc2e22bc6ee647b6b90729ab34a250b1":
+ int main(int argc, char *argv[]) {
+ puts(SD_ID128_CONST_STR(SD_MESSAGE_COREDUMP));
+}
+
SD_ID128_FORMAT_STR and
SD_ID128_FORMAT_VAL() may be used
to format a 128 bit ID in a
@@ -137,13 +149,13 @@
Note that new, randomized IDs may be generated
with
journalctl1's
- --new-id command.
+ --new-id option.
Notes
- These APIs are implemented as shared library,
+ These APIs are implemented as a shared library,
which can be compiled and linked to with the
libsystemd-id128
pkg-config1
@@ -157,6 +169,7 @@
systemd1,
sd_id128_to_string3,
sd_id128_randomize3,
+ sd_id128_get_machine3,
printf3,
journalctl1,
sd-journal7,