X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_id128_randomize.xml;h=0b9580308ac1bbb5d4af849c9217a35ddea30f42;hp=cb374196632970d50f55e9759bb20d6119febf49;hb=1fda0ab5fc9cf7454c8da32941e433dc38ba9991;hpb=cb07866b1b7c11e687a322d70dd9f9d73bbbe488 diff --git a/man/sd_id128_randomize.xml b/man/sd_id128_randomize.xml index cb3741966..0b9580308 100644 --- a/man/sd_id128_randomize.xml +++ b/man/sd_id128_randomize.xml @@ -44,9 +44,7 @@ sd_id128_randomize - sd_id128_get_machine - sd_id128_get_boot - Generate or retrieve 128 bit IDs + Generate 128-bit IDs @@ -58,16 +56,6 @@ sd_id128_t* ret - - int sd_id128_get_machine - sd_id128_t* ret - - - - int sd_id128_get_boot - sd_id128_t* ret - - @@ -75,57 +63,30 @@ Description sd_id128_randomize() - generates a new randomized 128 bit ID and returns it + generates a new randomized 128-bit ID and returns it in ret. Every invocation returns a new randomly generated ID. This uses the /dev/urandom kernel random number generator. - sd_id128_get_machine() - returns the machine ID of the executing host. This - reads and parses the - machine-id5 - file. This function caches the machine ID internally - to make retrieving the machine ID a cheap - operation. - - sd_id128_get_boot() returns - the boot ID of the executing kernel. This reads and - parses the - /proc/sys/kernel/random/boot_id - file exposed by the kernel. It is randomly generated - early at boot and is unique for every running kernel - instance. See - random4 - for more information. This function also internally - caches the returned ID to make this call a cheap - operation. - Note that - sd_id128_randomize() and - sd_id128_get_boot() always return - a UUID v4 compatible - ID. sd_id128_get_machine() will - also return a UUID v4 compatible ID on new - installations, but might not on older. It is possible - to convert the machine ID into an UUID v4 compatible - one. For more information see - machine-id5. + sd_id128_randomize() always returns + a UUID v4-compatible ID. For more information about the - sd_id128_t type see + sd_id128_t type, see sd-id1283. journalctl1's - --new-id command may be used as - command line front-end for + option may be used as a + command-line front-end for sd_id128_randomize(). Return Value - The three calls return 0 on success (in which + The call returns 0 on success (in which case ret is filled in), or a negative errno-style error code. @@ -133,13 +94,10 @@ Notes - The sd_id128_randomize(), - sd_id128_get_machine() and - sd_id128_get_boot() interfaces - are available as shared library, which can be compiled + The sd_id128_randomize() interface + is available as shared library, which can be compiled and linked to with the - libsystemd-id128 - pkg-config1 + libsystemd-id128 pkg-config1 file. @@ -150,7 +108,8 @@ systemd1, sd-id1283, machine-id5, - random4 + random4, + sd_id128_get_machine3