1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
=for stopwords
remctl API ENOMEM Allbery SPDX-License-Identifier FSFAP
=head1 NAME
remctl_new - Create a new remctl client
=head1 SYNOPSIS
#include <remctl.h>
struct remctl *B<remctl_new>(void);
=head1 DESCRIPTION
remctl_new() creates a new remctl client. The resulting remctl struct is
opaque from the perspective of the caller, but should be the first
argument to all subsequent calls into the remctl API. Normally, the next
call after remctl_new() would be remctl_open() to connect to a remote
server.
The resulting struct should be freed by calling remctl_close().
=head1 RETURN VALUE
remctl_new() returns a pointer to an opaque remctl struct on success and
NULL on failure. If it returns NULL, errno will be set to an appropriate
error code (normally ENOMEM).
=head1 COMPATIBILITY
This interface has been provided by the remctl client library since its
initial release in version 2.0.
=head1 AUTHOR
Russ Allbery <eagle@eyrie.org>
=head1 COPYRIGHT AND LICENSE
Copyright 2007, 2009, 2014 The Board of Trustees of the Leland Stanford
Junior University
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
remctl_open(3), remctl_command(3), remctl_commandv(3), remctl_output(3),
remctl_close(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
|
