From b0753dcf37eafe8ba44aaaf6cc2214a305c9a4b1 Mon Sep 17 00:00:00 2001 From: CuleX Date: Mon, 28 Aug 2017 15:11:29 +0200 Subject: [PATCH] Remove Xr to system man pages These create broken links when generating the manual page and there is no way to selectively disable link generation in mandoc. This change should not create much of an impact to readers on console, who would enter a man command for the respective page regardless. This also fixes a small usage error of the Xr macro in crypto_aead_lock.3monocypher. --- man/3monocypher/crypto_aead_lock.3monocypher | 3 ++- man/3monocypher/crypto_argon2i.3monocypher | 2 +- man/3monocypher/crypto_memcmp.3monocypher | 3 +-- man/3monocypher/intro.3monocypher | 8 ++++---- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/man/3monocypher/crypto_aead_lock.3monocypher b/man/3monocypher/crypto_aead_lock.3monocypher index f66a921..0db754b 100644 --- a/man/3monocypher/crypto_aead_lock.3monocypher +++ b/man/3monocypher/crypto_aead_lock.3monocypher @@ -44,7 +44,8 @@ Note: using these functions is discouraged: if the data you are transmitting is worth authenticating, it is probably worth encrypting as well. Do so if you can, using -.Xr crypto_lock 3monocypher and +.Xr crypto_lock 3monocypher +and .Xr crypto_unlock 3monocypher . .Ef .Pp diff --git a/man/3monocypher/crypto_argon2i.3monocypher b/man/3monocypher/crypto_argon2i.3monocypher index 998c148..a85c970 100644 --- a/man/3monocypher/crypto_argon2i.3monocypher +++ b/man/3monocypher/crypto_argon2i.3monocypher @@ -61,7 +61,7 @@ It must be big enough to hold .Fa nb_blocks blocks and suitably aligned for 64-bit integers. A block is 1024 bytes in length. -.Xr malloc 3 +.Fn malloc should yield a suitable chunk of memory. .It Fa nb_blocks the number of blocks for the work area. diff --git a/man/3monocypher/crypto_memcmp.3monocypher b/man/3monocypher/crypto_memcmp.3monocypher index 6aa18c0..cbe9fd9 100644 --- a/man/3monocypher/crypto_memcmp.3monocypher +++ b/man/3monocypher/crypto_memcmp.3monocypher @@ -53,7 +53,7 @@ or .Fn crypto_zerocmp . If you are in doubt whether you need to use these functions, prefer these over -.Xr memcmp 3 . +.Fn memcmp . .Sh RETURN VALUES The .Fn crypto_memcmp @@ -63,5 +63,4 @@ The function returns 0 if all bytes of the memory chunk are zero, -1 otherwise. .Sh SEE ALSO -.Xr memcmp 3 , .Xr intro 3monocypher diff --git a/man/3monocypher/intro.3monocypher b/man/3monocypher/intro.3monocypher index 34915bc..1f1e4d3 100644 --- a/man/3monocypher/intro.3monocypher +++ b/man/3monocypher/intro.3monocypher @@ -19,13 +19,13 @@ in the past, typically by repeating parts of the random stream. They typically require an external random seed anyway. .Pp On Linux, you can use the -.Xr getrandom 2 +.Fn getrandom system call from .In linux/random.h . Do not set any flag. .Pp On BSD, you can use -.Xr arc4random_buf 3 +.Fn arc4random_buf from .In stdlib.h or @@ -60,12 +60,12 @@ In addition, you can disable swap locally \(en this is often the only way. .Pp To disable swap on specific memory regions, UNIX systems provide the -.Xr mlock 2 +.Fn mlock system call. Windows has .Fn VirtualLock . UNIX systems also provide the -.Xr mlockall 2 +.Fn mlockall system call, which locks .Em all memory used by a single process. -- 2.47.3