Annotation of embedaddon/confuse/doc/man/man3/cfg_opt_t.3, revision 1.1.1.2
1.1.1.2 ! misho 1: .TH "cfg_opt_t" 3 "Thu Jun 25 2020" "Version 3.3" "confuse" \" -*- nroff -*-
1.1 misho 2: .ad l
3: .nh
4: .SH NAME
1.1.1.2 ! misho 5: cfg_opt_t \- Data structure holding information about an option\&.
1.1 misho 6:
7: .SH SYNOPSIS
8: .br
9: .PP
10: .PP
1.1.1.2 ! misho 11: \fC#include <confuse\&.h>\fP
1.1 misho 12: .SS "Data Fields"
13:
14: .in +1c
15: .ti -1c
1.1.1.2 ! misho 16: .RI "const char * \fBname\fP"
! 17: .br
! 18: .RI "The name of the option\&. "
! 19: .ti -1c
! 20: .RI "char * \fBcomment\fP"
1.1 misho 21: .br
1.1.1.2 ! misho 22: .RI "Optional comment/annotation\&. "
1.1 misho 23: .ti -1c
24: .RI "\fBcfg_type_t\fP \fBtype\fP"
25: .br
1.1.1.2 ! misho 26: .RI "Type of option\&. "
1.1 misho 27: .ti -1c
28: .RI "unsigned int \fBnvalues\fP"
29: .br
1.1.1.2 ! misho 30: .RI "Number of values parsed\&. "
1.1 misho 31: .ti -1c
32: .RI "\fBcfg_value_t\fP ** \fBvalues\fP"
33: .br
1.1.1.2 ! misho 34: .RI "Array of found values\&. "
1.1 misho 35: .ti -1c
36: .RI "cfg_flag_t \fBflags\fP"
37: .br
1.1.1.2 ! misho 38: .RI "Flags\&. "
1.1 misho 39: .ti -1c
40: .RI "\fBcfg_opt_t\fP * \fBsubopts\fP"
41: .br
1.1.1.2 ! misho 42: .RI "Suboptions (only applies to sections) "
1.1 misho 43: .ti -1c
44: .RI "\fBcfg_defvalue_t\fP \fBdef\fP"
45: .br
1.1.1.2 ! misho 46: .RI "Default value\&. "
1.1 misho 47: .ti -1c
48: .RI "\fBcfg_func_t\fP \fBfunc\fP"
49: .br
1.1.1.2 ! misho 50: .RI "Function callback for CFGT_FUNC options\&. "
1.1 misho 51: .ti -1c
1.1.1.2 ! misho 52: .RI "\fBcfg_simple_t\fP \fBsimple_value\fP"
1.1 misho 53: .br
1.1.1.2 ! misho 54: .RI "Pointer to user-specified variable to store simple values (created with the CFG_SIMPLE_* initializers) "
1.1 misho 55: .ti -1c
56: .RI "\fBcfg_callback_t\fP \fBparsecb\fP"
57: .br
1.1.1.2 ! misho 58: .RI "Value parsing callback function\&. "
1.1 misho 59: .ti -1c
60: .RI "\fBcfg_validate_callback_t\fP \fBvalidcb\fP"
61: .br
1.1.1.2 ! misho 62: .RI "Value validating parsing callback function\&. "
! 63: .ti -1c
! 64: .RI "\fBcfg_validate_callback2_t\fP \fBvalidcb2\fP"
! 65: .br
! 66: .RI "Value validating set callback function\&. "
1.1 misho 67: .ti -1c
68: .RI "\fBcfg_print_func_t\fP \fBpf\fP"
69: .br
1.1.1.2 ! misho 70: .RI "print callback function "
1.1 misho 71: .in -1c
72: .SH "Detailed Description"
73: .PP
1.1.1.2 ! misho 74: Data structure holding information about an option\&.
1.1 misho 75:
1.1.1.2 ! misho 76: The value(s) are stored as an array of fundamental values (strings, numbers, etc)\&.
1.1 misho 77: .PP
1.1.1.2 ! misho 78: \fBExamples\fP
1.1 misho 79: .in +1c
1.1.1.2 ! misho 80: \fBftpconf\&.c\fP, \fBreread\&.c\fP, and \fBsimple\&.c\fP\&.
1.1 misho 81:
82: .SH "Author"
83: .PP
1.1.1.2 ! misho 84: Generated automatically by Doxygen for confuse from the source code\&.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>