--- embedaddon/confuse/doc/man/man3/cfg_t.3 2017/01/24 14:48:55 1.1.1.1 +++ embedaddon/confuse/doc/man/man3/cfg_t.3 2021/03/17 00:49:17 1.1.1.2 @@ -1,67 +1,74 @@ -.TH "cfg_t" 3 "21 Feb 2010" "Version 2.7" "confuse" \" -*- nroff -*- +.TH "cfg_t" 3 "Thu Jun 25 2020" "Version 3.3" "confuse" \" -*- nroff -*- .ad l .nh .SH NAME -cfg_t \- Data structure holding information about a 'section'. +cfg_t \- Data structure holding information about a 'section'\&. -.PP .SH SYNOPSIS .br .PP -\fC#include \fP .PP +\fC#include \fP .SS "Data Fields" .in +1c .ti -1c .RI "cfg_flag_t \fBflags\fP" .br -.RI "\fIAny flags passed to \fBcfg_init()\fP. \fP" +.RI "Any flags passed to \fBcfg_init()\fP " .ti -1c .RI "char * \fBname\fP" .br -.RI "\fIThe name of this section, the root section returned from \fBcfg_init()\fP is always named 'root'. \fP" +.RI "The name of this section, the root section returned from \fBcfg_init()\fP is always named 'root'\&. " .ti -1c +.RI "char * \fBcomment\fP" +.br +.RI "Optional annotation/comment\&. " +.ti -1c .RI "\fBcfg_opt_t\fP * \fBopts\fP" .br -.RI "\fIArray of options. \fP" +.RI "Array of options\&. " .ti -1c .RI "char * \fBtitle\fP" .br -.RI "\fIOptional title for this section, only set if CFGF_TITLE flag is set. \fP" +.RI "Optional title for this section, only set if CFGF_TITLE flag is set\&. " .ti -1c .RI "char * \fBfilename\fP" .br -.RI "\fIName of the file being parsed. \fP" +.RI "Name of the file being parsed\&. " .ti -1c .RI "int \fBline\fP" .br -.RI "\fILine number in the config file. \fP" +.RI "Line number in the config file\&. " .ti -1c .RI "\fBcfg_errfunc_t\fP \fBerrfunc\fP" .br -.RI "\fIThis function (if set with cfg_set_error_function) is called for any error message. \fP" +.RI "This function (if set with cfg_set_error_function) is called for any error message\&. " +.ti -1c +.RI "cfg_searchpath_t * \fBpath\fP" +.br +.RI "Linked list of directories to search\&. " +.ti -1c +.RI "\fBcfg_print_filter_func_t\fP \fBpff\fP" +.br +.RI "Printing filter function\&. " .in -1c .SH "Detailed Description" .PP -Data structure holding information about a 'section'. +Data structure holding information about a 'section'\&. -Sections can be nested. A section has a list of options (strings, numbers, booleans or other sections) grouped together. +Sections can be nested\&. A section has a list of options (strings, numbers, booleans or other sections) grouped together\&. .PP -\fBExamples: \fP +\fBExamples\fP .in +1c -.PP -\fBftpconf.c\fP, \fBreread.c\fP, and \fBsimple.c\fP. +\fBftpconf\&.c\fP, \fBreread\&.c\fP, and \fBsimple\&.c\fP\&. .SH "Field Documentation" .PP -.SS "\fBcfg_errfunc_t\fP \fBcfg_t::errfunc\fP" -.PP -This function (if set with cfg_set_error_function) is called for any error message. -.PP +.SS "\fBcfg_errfunc_t\fP cfg_t::errfunc" .PP -Referenced by cfg_error(), cfg_init(), cfg_set_error_function(), and cfg_setopt(). +This function (if set with cfg_set_error_function) is called for any error message\&. .SH "Author" .PP -Generated automatically by Doxygen for confuse from the source code. +Generated automatically by Doxygen for confuse from the source code\&.