source: web/old/remctl-2.14/docs/api/remctl_new.pod @ f6f3e91

web
Last change on this file since f6f3e91 was f6f3e91, checked in by Jessica B. Hamrick <jhamrick@…>, 15 years ago

Preserve directory hierarchy (not sure what happened to it)

  • Property mode set to 100644
File size: 1.1 KB
Line 
1=for stopwords
2remctl API ENOMEM Allbery
3
4=head1 NAME
5
6remctl_new - Create a new remctl client
7
8=head1 SYNOPSIS
9
10#include <remctl.h>
11
12struct remctl *B<remctl_new>(void);
13
14=head1 DESCRIPTION
15
16remctl_new() creates a new remctl client.  The resulting remctl struct is
17opaque from the perspective of the caller, but should be the first
18argument to all subsequent calls into the remctl API.  Normally, the next
19call after remctl_new() would be remctl_open() to connect to a remote
20server.
21
22The resulting struct should be freed by calling remctl_close().
23
24=head1 RETURN VALUE
25
26remctl_new() returns a pointer to an opaque remctl struct on success and
27NULL on failure.  If it returns NULL, errno will be set to an appropriate
28error code (normally ENOMEM).
29
30=head1 SEE ALSO
31
32remctl_open(3), remctl_command(3), remctl_commandv(3), remctl_output(3),
33remctl_close(3)
34
35The current version of the remctl library and complete details of the
36remctl protocol are available from its web page at
37L<http://www.eyrie.org/~eagle/software/remctl/>.
38
39=head1 AUTHOR
40
41Russ Allbery <rra@stanford.edu>
42
43=cut
Note: See TracBrowser for help on using the repository browser.