Check-in [476bfb745f]
Overview
Comment:Subversion to Fossil Copy Commit. Please Ignore. Recording copying libconfig.3.in to lc_handle_type.3.in.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 476bfb745fe160e65c77800cb4ca2e9a8d99c72b
User & Date: rkeene on 2006-12-17 19:40:52
Other Links: manifest | tags
Context
2006-12-17
19:40
libconfig 0.2.1 Updated typos in man pages, made "SEE ALSO" more consistent Added manpage formatting for new man pages, added lc_handle_type man page check-in: 8e0181d70f user: rkeene tags: trunk, 0.2.1
19:40
Subversion to Fossil Copy Commit. Please Ignore. Recording copying libconfig.3.in to lc_handle_type.3.in. check-in: 476bfb745f user: rkeene tags: trunk
19:15
libconfig 0.2.0 released check-in: f205c925b8 user: rkeene tags: trunk, 0.2.0
Changes

build/prep.sh became a regular file with contents [3f4d67e154].


Added lc_handle_type.3.in version [93e1c94d05].

            1  +.TH LIBCONFIG 3 "25 Oct 04" "@PACKAGE_STRING@"
            2  +.SH NAME
            3  +libconfig \- Consistent configuration library.
            4  +
            5  +.SH SYNOPSIS
            6  +.B #include <libconfig.h>
            7  +.sp
            8  +.BI "int lc_register_callback(const char *" var ", char " opt ", lc_var_type_t " type ", int (*" callback ")(const char *, const char *, const char *, const char *, lc_flags_t, void *), void *" extra ");"
            9  +
           10  +.BI "int lc_register_var(const char *" var ", lc_var_type_t " type ", void *" data ", char " opt ");"
           11  +
           12  +.BI "int lc_process(int " argc ", char **" argv ", const char *" appname ", lc_conf_type_t " type ", const char *" extra ");"
           13  +
           14  +.BI "lc_err_t lc_geterrno(void);"
           15  +
           16  +.BI "char *lc_geterrstr(void);"
           17  +
           18  +.BI "void lc_geterrstr(const char *" errstr ");"
           19  +
           20  +.SH DESCRIPTION
           21  +Libconfig is a library to provide easy access to configuration data in a consistent and logical manner.  Variables (registered through
           22  +.BR lc_register_var (3)
           23  +or
           24  +.BR lc_register_callback (3))
           25  +are processed with the
           26  +.BR lc_process (3)
           27  +and
           28  +.BR lc_process_file (3)
           29  +functions.  Errors can be examined through
           30  +.BR lc_geterrno (3)
           31  +and
           32  +.BR lc_geterrstr (3).
           33  +Clean-up may be performed using the
           34  +.BR lc_cleanup (3)
           35  +function.
           36  +
           37  +.SH EXAMPLE
           38  +.nf
           39  +#include <libconfig.h>
           40  +#include <stdlib.h>
           41  +#include <stdio.h>
           42  +
           43  +int main(int argc, char **argv) {
           44  +	int lc_p_ret, lc_rv_ret;
           45  +	char *filename = NULL;
           46  +
           47  +	lc_rv_ret = lc_register_var("File", LC_VAR_STRING,
           48  +	                            &filename, 'f');
           49  +
           50  +	if (lc_rv_ret != 0) {
           51  +		fprintf(stderr, "Error registering variable: %i.\\n",
           52  +		        lc_geterrno());
           53  +		return(EXIT_FAILURE);
           54  +	}
           55  +
           56  +	lc_p_ret = lc_process(argc, argv, "example", LC_CONF_APACHE,
           57  +	                      NULL);
           58  +
           59  +	lc_cleanup();
           60  +
           61  +	if (lc_p_ret != 0) {
           62  +		fprintf(stderr, "Error processing configuration: \\
           63  +		        %s\\n", lc_geterrstr());
           64  +		return(EXIT_FAILURE);
           65  +	}
           66  +
           67  +	if (filename != NULL) {
           68  +		printf("File specified was: %s\\n", filename);
           69  +	} else {
           70  +		printf("No filename specified.\\n");
           71  +	}
           72  +
           73  +	return(EXIT_SUCCESS);
           74  +}
           75  +.fi
           76  +
           77  +.SH "SEE ALSO"
           78  +.BR lc_register_var (3),
           79  +.BR lc_register_callback (3),
           80  +.BR lc_geterr (3),
           81  +.BR lc_geterrstr (3),
           82  +.BR lc_seterrstr (3),
           83  +.BR lc_cleanup (3),
           84  +.BR lc_process (3),
           85  +.BR lc_process_file (3)