← Back to branch summary

~iheino+ub/+junk/nut-upsconf-docfix

« back to all changes in this revision

Viewing changes to docs/man/upscli_add_host_cert.3

  • Committer: Tuomas Heino
  • Author(s): Laurent Bigonville
  • Date: 2014-04-22 20:46:12 UTC
  • Revision ID: iheino+ub@cc.hut.fi-20140422204612-1x2gh3nkezfsdao4
Tags: upstream-2.7.2
Import upstream version 2.7.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/upscli_add_host_cert.3
 
1
'\" t
 
2
.\"     Title: upscli_add_host_cert
 
3
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 
4
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
 
5
.\"      Date: 02/15/2014
 
6
.\"    Manual: NUT Manual
 
7
.\"    Source: Network UPS Tools 2.7.1.5
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "UPSCLI_ADD_HOST_CERT" "3" "02/15/2014" "Network UPS Tools 2\&.7\&.1\&." "NUT Manual"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * Define some portability stuff
 
13
.\" -----------------------------------------------------------------
 
14
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
15
.\" http://bugs.debian.org/507673
 
16
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
 
17
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
18
.ie \n(.g .ds Aq \(aq
 
19
.el       .ds Aq '
 
20
.\" -----------------------------------------------------------------
 
21
.\" * set default formatting
 
22
.\" -----------------------------------------------------------------
 
23
.\" disable hyphenation
 
24
.nh
 
25
.\" disable justification (adjust text to left margin only)
 
26
.ad l
 
27
.\" -----------------------------------------------------------------
 
28
.\" * MAIN CONTENT STARTS HERE *
 
29
.\" -----------------------------------------------------------------
 
30
.SH "NAME"
 
31
upscli_add_host_cert \- Register a security rule for an host\&.
 
32
.SH "SYNOPSIS"
 
33
.sp
 
34
.nf
 
35
#include <upsclient\&.h>
 
36
.fi
 
37
.sp
 
38
.nf
 
39
void upscli_add_host_cert(const char* hostname, const char* certname,
 
40
                       int certverify, int forcessl);
 
41
.fi
 
42
.SH "DESCRIPTION"
 
43
.sp
 
44
The \fBupscli_add_host_cert()\fR function register a security rule associated to the \fIhostname\fR\&. All connections to this host use this rule\&.
 
45
.sp
 
46
The rule is composed of the certificate name \fIcertname \*(Aqexpected for the host, \*(Aqcertverify\fR if the certificate must be validated for the host and \fIforcessl\fR if a secured connection must be used to connect to the host\&.
 
47
.SH "RETURN VALUE"
 
48
.sp
 
49
\fBupscli_add_host_cert()\fR returns no value\&.
 
50
.SH "SEE ALSO"
 
51
.sp
 
52
\fBupscli_init\fR(3), \fBupscli_connect\fR(3), \fBupscli_ssl\fR(3), \fBupscli_strerror\fR(3), \fBupscli_upserror\fR(3)