lib/librpcsec_gss/rpc_gss_is_installed.3

   1 .\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/
   2 .\" Authors: Doug Rabson <dfr@rabson.org>
   3 .\" Developed with Red Inc: Alfred Perlstein <alfred@freebsd.org>
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .Dd July 4, 2008
  28 .Dt RPC_GSS_IS_INSTALLED 3
  29 .Os
  30 .Sh NAME
  31 .Nm rpc_gss_is_installed
  32 .Nd "Query for the presence os a security mechanism"
  33 .Sh LIBRARY
  34 .Lb librpcsec_gss
  35 .Sh SYNOPSIS
  36 .In rpc/rpcsec_gss.h
  37 .Ft bool_t
  38 .Fn rpc_gss_is_installed "const char *mech"
  39 .Sh DESCRIPTION
  40 This function looks up a mechanism by name by reading the file
  41 /etc/gss/mech.
  42 .Sh PARAMETERS
  43 .Bl -tag
  44 .It mech
  45 The mechanism to search for
  46 .El
  47 .Sh RETURN VALUES
  48 Returns
  49 .Dv TRUE
  50 if the mechanism is installed,
  51 .Dv FALSE
  52 otherwise.
  53 .Sh SEE ALSO
  54 .Xr rpc 3 ,
  55 .Xr gssapi 3 ,
  56 .Xr rpcset_gss 3
  57 .Sh HISTORY
  58 The
  59 .Nm
  60 manual page example first appeared in
  61 .Fx 8.0 .
  62 .Sh AUTHORS
  63 This
  64 manual page was written by
  65 .An Doug Rabson Aq dfr@FreeBSD.org .