cryb-to/lib/hash/cryb_hash.3

93 lines
3 KiB
Groff
Raw Normal View History

2016-01-08 16:27:27 +00:00
.\"-
.\" Copyright (c) 2016 Dag-Erling Smørgrav
2016-01-08 16:27:27 +00:00
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote
.\" products derived from this software without specific prior written
.\" permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd September 17, 2016
2016-01-08 16:27:27 +00:00
.Dt CRYB_HASH 3
.Os
.Sh NAME
.Nm cryb_hash_version ,
.Nm cryb_adler32_hash ,
.Nm cryb_fletcher16_hash ,
.Nm cryb_fletcher32_hash ,
.Nm cryb_fletcher64_hash ,
.Nm cryb_pearson_hash ,
.Nm cryb_pearson_hash_str
.Nd hash and checksum functions
2016-01-08 16:27:27 +00:00
.Sh LIBRARY
.Lb libcryb-hash
.Sh SYNOPSIS
.In stddef.h
2016-01-08 16:27:27 +00:00
.In stdint.h
.In cryb/hash.h
.Ft const char *
.Fn cryb_hash_version "void"
.Ft uint32_t
.Fn cryb_adler32_hash "const void *data" "size_t len"
.Ft uint16_t
.Fn fletcher16_hash "const void *data" "size_t len"
.Ft uint32_t
.Fn fletcher32_hash "const void *data" "size_t len"
.Ft uint64_t
.Fn fletcher64_hash "const void *data" "size_t len"
2016-01-08 16:27:27 +00:00
.Ft uint8_t
.Fn cryb_pearson_hash "const void *data" "size_t len"
2016-01-08 16:27:27 +00:00
.Ft uint8_t
.Fn cryb_pearson_hash_str "const char *str"
2016-01-08 16:27:27 +00:00
.Sh DESCRIPTION
The
.Fn cryb_hash_version
function returns a pointer to a string containing the specific version
of the
.Lb libcryb-hash
library.
2016-01-08 16:27:27 +00:00
.Pp
For descriptions of the other functions in this library, see their
respective manual pages.
2016-01-08 16:27:27 +00:00
.Sh SEE ALSO
.Xr cryb_adler32 3 ,
.Xr cryb_fletcher 3 ,
.Xr cryb_pearson 3
2016-01-08 16:27:27 +00:00
.Sh AUTHORS
The
.Fn cryb_hash_version ,
.Fn cryb_adler32_hash ,
.Fn cryb_fletcher16 ,
.Fn cryb_fletcher32
and
.Fn cryb_fletcher64
functions and corresponding manual pages were written by
.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
.Pp
The
.Fn cryb_pearson_hash
2016-01-08 16:27:27 +00:00
and
.Fn cryb_pearson_hash_str
functions and corresponding manual pages were written for the
University of Oslo by
2016-01-08 16:27:27 +00:00
.An Dag-Erling Sm\(/orgrav Aq Mt d.e.smorgrav@usit.uio.no .