10.0.0.21 Git - tlspool/blob - doc/man/tlspool_configvar.c

   1 .TH TLSPOOL_CONFIGVAR 3 "August 2016" "ARPA2.net" "Library Calls"
   2 .SH NAME
   3 tlspool_configvar \- Retrieve a TLS Pool configuration variable value
   4 .SH SYNOPSIS
   5 .B #include <tlspool/starttls.h>
   6 .sp
   7 .B char *tlspool_configvar (char *\fIcfgfile\fB, char *\fIvarname\fB);
   8 .SH DESCRIPTION
   9 .PP
  10 .BR tlspool_configvar ()
  11 fetches the value of a configuration file variable as setup for the
  12 TLS Pool.  The configuration file can be provided in the
  13 .IR cfgfile parameter
  14 or, if it is NULL, then first the environment variable
  15 .BR TLSPOOL_CFGFILE
  16 and, failing to find that, it tries the compile-time setting
  17 .BR TLSPOOL_DEFAULT_CONFIG_PATH .
  18
  19 .SH "RETURN VALUE"
  20 The value returned is NULL when the requested variable was not
  21 found, but also when the configuration file did not load.  The
  22 error output may hold further hints on the cause of problems.
  23 .SH AUTHOR
  24 .PP
  25 Written by Rick van Rein of OpenFortress.nl, for the ARPA2.net project.
  26 .SH "REPORTING BUGS"
  27 .PP
  28 For any discussion, including about bugs, please use the mailing list
  29 found on
  30 .IR http://lists.arpa2.org/mailman/listinfo/tls-pool .
  31 .PP
  32 Please read the software distribution's
  33 .IR README ", " INSTALL " and " TODO " files"
  34 for information about the
  35 .I tlspool
  36 implementation status.
  37 .SH COPYRIGHT
  38 .PP
  39 Copyright \(co 2016 Rick van Rein, ARPA2.net.
  40 .PP
  41 ARPA2 is funded from InternetWide.org, which in turns receives donations
  42 from various funding sources with an interest in a private and secure
  43 Internet that gives users control over their online presence.  This particular
  44 project has been sponsored in part by NCSC.
  45 .SH "SEE ALSO"
  46 .IR tlspool "(8)"
  47 .PP
  48 The TLS Pool API is documented in the include file
  49 .IR <tlspool/commands.h> " and " <tlspool/starttls.h>
  50 for C, and the
  51 .I tlspool.py
  52 module for Python.
  53 .PP
  54 Online resources may be found on the project home page,
  55 .IR http://tlspool.arpa2.net .