.lf 1 ./man/man3/fstrcmp.3
.\"
.\" fstrcmp - fuzzy string compare library
.\" Copyright (C) 2009, 2011 Peter Miller
.\" Written by Peter Miller <pmiller@opensource.org.au>
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
.\" General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.\"
.ds n) fstrcmp
.TH fstrcmp 3
.SH NAME
fstrcmp \- fuzzy comparison of two strings
.if require_index \{
.\}
.SH SYNOPSIS
#include <fstrcmp.h>
.sp 0.3
#define FSTRCMP_IDENTICAL
.br
#define FSTRCMP_THRESHOLD
.br
#define FSTRCMP_ERROR
.sp 0.3
double fstrcmp(const char *string1, const char *string2);
.SH DESCRIPTION
The \f[B]fstrcmp\fP() function compares the two strings,
\f[I]string1\fP and \f[I]string2\fP.
.SH RETURN VALUE
The \f[B]fstrcmp\fP function returns a floating point value between
0.0 and FSTRCMP_IDENTICAL.  A value of 0.0 means the strings are
utterly un-alike.  A value of FSTRCMP_IDENTICAL means the strings are
identical.  A value of more than FSTRCMP_THRESHOLD (it lies between 0.0
and FSTRCMP_IDENTICAL) would be considered "similar" by most people.
.PP
A value of FSTRCMP_ERROR (always negative) indicates a \f[I]malloc\fP(3)
failure.
.SH SEE ALSO
.TP 8n
\f[I]fmemcmp\fP(3)
fuzzy comparison of two memory areas
.TP 8n
\f[I]fstrcasecmp\fP(3)
fuzzy comparison of two strings ignoring case
.TP 8n
\f[I]fstrcmpi\fP(3)
fuzzy comparison of two strings
.TP 8n
\f[I]strcmp\fP(3)
compare two strings
.lf 1 ./man/man1/z_copyright.so
.\"
.\" fstrcmp - fuzzy string compare library
.\" Copyright (C) 2009 Peter Miller
.\" Written by Peter Miller <pmiller@opensource.org.au>
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
.\" General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License along
.\" with this program. If not, see <http://www.gnu.org/licenses/>.
.\"
.SH COPYRIGHT
.lf 1 ./etc/version.so
.ds v) 0.7
.ds V) 0.7.D001
.ds Y) 2009, 2011, 2012, 2014
.lf 21 ./man/man1/z_copyright.so
.if n .ds C) (C)
.if t .ds C) \(co
fstrcmp version \*(v)
.br
Copyright \*(C) 2009 Peter Miller
.br
Peter Miller <pmiller@opensource.org.au>
.PP
The comparison code is derived from the fuzzy comparison functions in
GNU Gettext 0.17.  The GNU Gettext comparison functions were, in turn,
derived from GNU Diff 2.7.
.PP
Copyright \*(C) 1988-2009 Free Software Foundation
.lf 62 ./man/man3/fstrcmp.3