diff options
| author | Mattias Andrée <maandree@kth.se> | 2017-02-10 15:46:21 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2017-02-10 15:46:21 +0100 |
| commit | 82afa682cfaaa09c3564299fc9f709e80081c661 (patch) | |
| tree | 572c313ddc8f219a1c5fcd18b7b59633256fca0a /doc/man/libkeccak_state_create.3 | |
| parent | bump year and change e-mail (diff) | |
| download | libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.gz libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.bz2 libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.xz | |
Work on man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
| -rw-r--r-- | doc/man/libkeccak_state_create.3 | 29 |
1 files changed, 17 insertions, 12 deletions
diff --git a/doc/man/libkeccak_state_create.3 b/doc/man/libkeccak_state_create.3 index f94ebe8..77880a3 100644 --- a/doc/man/libkeccak_state_create.3 +++ b/doc/man/libkeccak_state_create.3 @@ -1,4 +1,4 @@ -.TH LIBKECCAK_STATE_CREATE 3 LIBKECCAK-%VERSION% +.TH LIBKECCAK_STATE_CREATE 3 LIBKECCAK .SH NAME libkeccak_state_create - Allocate and initialise hash state .SH SYNOPSIS @@ -6,23 +6,31 @@ libkeccak_state_create - Allocate and initialise hash state .nf #include <libkeccak.h> .P -libkeccak_state_t *libkeccak_state_create(const libkeccak_spec_t *\fIspec\fP); +libkeccak_state_t * +libkeccak_state_create(const libkeccak_spec_t *\fIspec\fP); .fi .P -Link with \fI-lkeccak\fP. +Link with +.IR -lkeccak . .SH DESCRIPTION The .BR libkeccak_state_create () -function allocates a new \fIlibkeccak_state_t*\fP with one -initialised element, and sets the algorithm tuning parameters -to those specified by \fI*spec\fP. +function allocates a new +.I libkeccak_state_t* +with one initialised element, and sets the algorithm +tuning parameters to those specified by +.IR *spec . .SH RETURN VALUES The .BR libkeccak_state_create () -function returns a newly allocated \fIlibkeccak_state_t*\fP +function returns a newly allocated +.I libkeccak_state_t* (of one initialised element) upon successful completion. -On error, \fINULL\fP is returned and \fIerrno\fP is set to -describe the error. +On error, +.I NULL +is returned and +.I errno +is set to describe the error. .SH ERRORS The .BR libkeccak_state_create () @@ -33,9 +41,6 @@ function may fail for any specified for the function .BR libkeccak_state_free (3), .BR libkeccak_state_fast_free (3) .BR libkeccak_state_duplicate (3) -.SH AUTHORS -Principal author, Mattias Andrée. See the LICENSE file for the full -list of authors. .SH BUGS Please report bugs to https://github.com/maandree/libkeccak/issues or to maandree@kth.se |