]> git.codecow.com Git - Monocypher.git/commitdiff
Remove Xr to system man pages
authorCuleX <cculex@gmail.com>
Mon, 28 Aug 2017 13:11:29 +0000 (15:11 +0200)
committerCuleX <cculex@gmail.com>
Mon, 28 Aug 2017 13:11:29 +0000 (15:11 +0200)
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
man/3monocypher/crypto_argon2i.3monocypher
man/3monocypher/crypto_memcmp.3monocypher
man/3monocypher/intro.3monocypher

index f66a9212e6e3b43dcade04c976bd729cc03d0119..0db754ba076c1e087159447cbb32eeb1086e3f17 100644 (file)
@@ -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
index 998c148f124c8721f5bf05061987e31ea966b037..a85c970b452b222189485a383b85aae7ba3faa72 100644 (file)
@@ -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.
index 6aa18c04c65bd875e56fb56891132f406bec41ba..cbe9fd99b1cdd1b775cc92255562aae3566a5b6a 100644 (file)
@@ -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
index 34915bc91a39ccf95d479c56878692baef96aba8..1f1e4d3d25548c20a845a5536f2a66be02592659 100644 (file)
@@ -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.