Return to cfg_t.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / confuse / doc / man / man3

Annotation of embedaddon/confuse/doc/man/man3/cfg_t.3, revision 1.1.1.2

1.1.1.2 ! misho       1: .TH "cfg_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_t \- Data structure holding information about a 'section'\&.  
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
                     16: .RI "cfg_flag_t \fBflags\fP"
                     17: .br
1.1.1.2 ! misho      18: .RI "Any flags passed to \fBcfg_init()\fP "
1.1       misho      19: .ti -1c
                     20: .RI "char * \fBname\fP"
                     21: .br
1.1.1.2 ! misho      22: .RI "The name of this section, the root section returned from \fBcfg_init()\fP is always named 'root'\&. "
        !            23: .ti -1c
        !            24: .RI "char * \fBcomment\fP"
        !            25: .br
        !            26: .RI "Optional annotation/comment\&. "
1.1       misho      27: .ti -1c
                     28: .RI "\fBcfg_opt_t\fP * \fBopts\fP"
                     29: .br
1.1.1.2 ! misho      30: .RI "Array of options\&. "
1.1       misho      31: .ti -1c
                     32: .RI "char * \fBtitle\fP"
                     33: .br
1.1.1.2 ! misho      34: .RI "Optional title for this section, only set if CFGF_TITLE flag is set\&. "
1.1       misho      35: .ti -1c
                     36: .RI "char * \fBfilename\fP"
                     37: .br
1.1.1.2 ! misho      38: .RI "Name of the file being parsed\&. "
1.1       misho      39: .ti -1c
                     40: .RI "int \fBline\fP"
                     41: .br
1.1.1.2 ! misho      42: .RI "Line number in the config file\&. "
1.1       misho      43: .ti -1c
                     44: .RI "\fBcfg_errfunc_t\fP \fBerrfunc\fP"
                     45: .br
1.1.1.2 ! misho      46: .RI "This function (if set with cfg_set_error_function) is called for any error message\&. "
        !            47: .ti -1c
        !            48: .RI "cfg_searchpath_t * \fBpath\fP"
        !            49: .br
        !            50: .RI "Linked list of directories to search\&. "
        !            51: .ti -1c
        !            52: .RI "\fBcfg_print_filter_func_t\fP \fBpff\fP"
        !            53: .br
        !            54: .RI "Printing filter function\&. "
1.1       misho      55: .in -1c
                     56: .SH "Detailed Description"
                     57: .PP 
1.1.1.2 ! misho      58: Data structure holding information about a 'section'\&. 
1.1       misho      59: 
1.1.1.2 ! misho      60: Sections can be nested\&. A section has a list of options (strings, numbers, booleans or other sections) grouped together\&. 
1.1       misho      61: .PP
1.1.1.2 ! misho      62: \fBExamples\fP
1.1       misho      63: .in +1c
1.1.1.2 ! misho      64: \fBftpconf\&.c\fP, \fBreread\&.c\fP, and \fBsimple\&.c\fP\&.
1.1       misho      65: .SH "Field Documentation"
                     66: .PP 
1.1.1.2 ! misho      67: .SS "\fBcfg_errfunc_t\fP cfg_t::errfunc"
1.1       misho      68: 
                     69: .PP
1.1.1.2 ! misho      70: This function (if set with cfg_set_error_function) is called for any error message\&. 
1.1       misho      71: 
                     72: .SH "Author"
                     73: .PP 
1.1.1.2 ! misho      74: Generated automatically by Doxygen for confuse from the source code\&.