From f5713dbb2ee1c182c5393066dfc7b15b2b267a0b Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Sat, 2 Jun 2007 19:32:30 +0000 Subject: ares_destroy_options() and ares_save_options() man pages by Brad House --- ares/Makefile.inc | 4 ++-- ares/ares_destroy_options.3 | 39 ++++++++++++++++++++++++++++++++++++ ares/ares_save_options.3 | 49 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 90 insertions(+), 2 deletions(-) create mode 100644 ares/ares_destroy_options.3 create mode 100644 ares/ares_save_options.3 (limited to 'ares') diff --git a/ares/Makefile.inc b/ares/Makefile.inc index 55735e2d6..8fad409c4 100644 --- a/ares/Makefile.inc +++ b/ares/Makefile.inc @@ -18,5 +18,5 @@ MANPAGES= ares_destroy.3 ares_expand_name.3 ares_expand_string.3 ares_fds.3 \ ares_parse_a_reply.3 ares_parse_ptr_reply.3 ares_process.3 \ ares_query.3 ares_search.3 ares_send.3 ares_strerror.3 ares_timeout.3 \ ares_version.3 ares_cancel.3 ares_parse_aaaa_reply.3 ares_getnameinfo.3 \ - ares_getsock.3 ares_parse_ns_reply.3 - + ares_getsock.3 ares_parse_ns_reply.3 \ + ares_destroy_options.3 ares_save_options.3 diff --git a/ares/ares_destroy_options.3 b/ares/ares_destroy_options.3 new file mode 100644 index 000000000..15c5f42f1 --- /dev/null +++ b/ares/ares_destroy_options.3 @@ -0,0 +1,39 @@ +.\" $Id$ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" +.\" Permission to use, copy, modify, and distribute this +.\" software and its documentation for any purpose and without +.\" fee is hereby granted, provided that the above copyright +.\" notice appear in all copies and that both that copyright +.\" notice and this permission notice appear in supporting +.\" documentation, and that the name of M.I.T. not be used in +.\" advertising or publicity pertaining to distribution of the +.\" software without specific, written prior permission. +.\" M.I.T. makes no representations about the suitability of +.\" this software for any purpose. It is provided "as is" +.\" without express or implied warranty. +.\" +.TH ARES_DESTROY_OPTIONS 3 "1 June 2007" +.SH NAME +ares_destroy_options \- Destroy options initialized with ares_save_options +.SH SYNOPSIS +.nf +.B #include +.PP +.B void ares_destroy_options(struct ares_options *\fIoptions\fP) +.fi +.SH DESCRIPTION +The +.B ares_destroy_options +function destroys the options struct identified by +.IR options , +freeing all memory allocated by ares_save_options. + +.SH SEE ALSO +.BR ares_save_options (3), +.BR ares_init_options (3) +.SH AUTHOR +Brad House +.br +Copyright 1998 by the Massachusetts Institute of Technology. diff --git a/ares/ares_save_options.3 b/ares/ares_save_options.3 new file mode 100644 index 000000000..46fd5967a --- /dev/null +++ b/ares/ares_save_options.3 @@ -0,0 +1,49 @@ +.\" $Id$ +.\" +.\" Copyright 1998 by the Massachusetts Institute of Technology. +.\" +.\" Permission to use, copy, modify, and distribute this +.\" software and its documentation for any purpose and without +.\" fee is hereby granted, provided that the above copyright +.\" notice appear in all copies and that both that copyright +.\" notice and this permission notice appear in supporting +.\" documentation, and that the name of M.I.T. not be used in +.\" advertising or publicity pertaining to distribution of the +.\" software without specific, written prior permission. +.\" M.I.T. makes no representations about the suitability of +.\" this software for any purpose. It is provided "as is" +.\" without express or implied warranty. +.\" +.TH ARES_SAVE_OPTIONS 3 "1 June 2007" +.SH NAME +ares_save_options \- Save configuration values obtained from initialized ares_channel +.SH SYNOPSIS +.nf +.B #include +.PP +.B void ares_save_options(ares_channel \fIchannel\fP, struct ares_options *\fIoptions\fP, int *\fIoptmask\fP) +.fi +.SH DESCRIPTION +The +.B ares_save_options +function saves the channel data identified by +.IR channel , +into the options struct identified by +.IR options , +and saves the mask of options which are set to the integer +pointer (passed by reference) identified by +.IR optmask . + +The resultant options and optmask are then able to be +passed directly to ares_init_options. When the options +are no longer needed, ares_destroy_options should be called +to free any associated memory. + + +.SH SEE ALSO +.BR ares_destroy_options (3), +.BR ares_init_options (3) +.SH AUTHOR +Brad House +.br +Copyright 1998 by the Massachusetts Institute of Technology. -- cgit v1.2.3