X-Git-Url: http://git.silcnet.org/gitweb/?p=silc.git;a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilcconfig.h;h=b4f5a70482e677b2054f3973f3b131a631ed0e3a;hp=132657349acc5d0c3be6427875711db70da8d9e8;hb=386c883d8774999c6e74d7c6c37e52e4163a4cb1;hpb=73e02ea64eb9744bde0121ee487f8ce8eb803aa9 diff --git a/lib/silcutil/silcconfig.h b/lib/silcutil/silcconfig.h index 13265734..b4f5a704 100644 --- a/lib/silcutil/silcconfig.h +++ b/lib/silcutil/silcconfig.h @@ -26,20 +26,21 @@ * (or File object) and SilcConfigEntity (or Entity). The File objects are * structs directly corresponding to the real files in the filesystem, while * Entities are a little more abstract. + * * An Entity is composed by delimited area on a File object (it can take the * whole File object or just part of it), plus a group of known options. - * * In order to parse this file, first you need to create a File object with * the silc_config_open() function, and then you need to create the Entity * with the silc_config_init() function. + * * Now you can use the newly created Entity to register a group of expected * known options and sub-blocks, and then you can call the main parsing loop - * with the silc_config_main() function. - * When silc_config_main() will return, if some error encoured the object file - * will point to the file that caused this error (this can be different from - * the originally opened file if it contained `Include' directives). If no - * errors encoured then the File objects will still point to the original - * file. + * with the silc_config_main() function. When silc_config_main() will + * return, if some error encoured the object file will point to the file + * that caused this error (this can be different from the originally + * opened file if it contained `Include' directives). If no errors + * encoured then the File objects will still point to the original file. + * * While silc_config_main() will take care of destroying Entities before * returning, you need to take care that the File object you created is freed * with the silc_config_close() function. @@ -51,6 +52,7 @@ * The config file syntax is pretty straightforward. All lines starting * with `#' will be skipped, while sub-blocks are delimited by braces (see * the example below). + * * Options with argument must have the `=' character between the option * name and the value. Simple words and numbers does not require quoting. * There is a special built-in directive "Include" which allows you to include