69 lines
2.4 KiB
Groff
69 lines
2.4 KiB
Groff
|
'\" t
|
||
|
|
.\" Title: upscli_splitaddr
|
||
|
|
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
||
|
|
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
||
|
|
.\" Date: 12/24/2010
|
||
|
|
.\" Manual: NUT Manual
|
||
|
|
.\" Source: Network UPS Tools
|
||
|
|
.\" Language: English
|
||
|
|
.\"
|
||
|
|
.TH "UPSCLI_SPLITADDR" "3" "12/24/2010" "Network UPS Tools" "NUT Manual"
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * Define some portability stuff
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
.\" http://bugs.debian.org/507673
|
||
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
||
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
.ie \n(.g .ds Aq \(aq
|
||
|
|
.el .ds Aq '
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * set default formatting
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" disable hyphenation
|
||
|
|
.nh
|
||
|
|
.\" disable justification (adjust text to left margin only)
|
||
|
|
.ad l
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.\" * MAIN CONTENT STARTS HERE *
|
||
|
|
.\" -----------------------------------------------------------------
|
||
|
|
.SH "NAME"
|
||
|
|
upscli_splitaddr \- split a listening address into its components
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.sp
|
||
|
|
.nf
|
||
|
|
#include <upsclient\&.h>
|
||
|
|
.fi
|
||
|
|
.sp
|
||
|
|
.nf
|
||
|
|
int upscli_splitaddr(const char *buf, char **hostname,
|
||
|
|
int *port)
|
||
|
|
.fi
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.sp
|
||
|
|
The \fBupscli_splitaddr()\fR function takes a pointer to the raw UPS definition \fIbuf\fR and returns pointers to dynamically allocated memory in \fIupsname\fR and \fIhostname\fR\&. It also copies the port number into \fIport\fR\&.
|
||
|
|
.SH "FORMATTING"
|
||
|
|
.sp
|
||
|
|
A listening address definition is specified according to this format:
|
||
|
|
.sp
|
||
|
|
.if n \{\
|
||
|
|
.RS 4
|
||
|
|
.\}
|
||
|
|
.nf
|
||
|
|
<hostname>[:<port>]
|
||
|
|
.fi
|
||
|
|
.if n \{\
|
||
|
|
.RE
|
||
|
|
.\}
|
||
|
|
.sp
|
||
|
|
Definitions without an explicit port value receive the default value of 3493\&.
|
||
|
|
.SH "MEMORY USAGE"
|
||
|
|
.sp
|
||
|
|
You must \fBfree\fR(3) the pointer \fIhostname\fR when you are done with it to avoid memory leaks\&.
|
||
|
|
.SH "RETURN VALUE"
|
||
|
|
.sp
|
||
|
|
The \fBupscli_splitaddr()\fR function returns 0 on success, or \-1 if an error occurs\&.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.sp
|
||
|
|
\fBupscli_fd\fR(3), \fBupscli_get\fR(3), \fBupscli_readline\fR(3), \fBupscli_sendline\fR(3), \fBupscli_splitname\fR(3), \fBupscli_ssl\fR(3), \fBupscli_strerror\fR(3), \fBupscli_upserror\fR(3)
|