aboutsummaryrefslogtreecommitdiff
path: root/doc/grecs_parse.3
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2011-07-01 18:59:30 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2011-07-01 18:59:30 +0300
commit6c28bd628ede02dfb6e8a5520d0b43cd19c03b57 (patch)
tree1430e744ceddadc5bb73300ebc13ae4ff1049569 /doc/grecs_parse.3
parenta01d5e230db6f61a6efd3384f1eafe184944c45d (diff)
downloadgrecs-6c28bd628ede02dfb6e8a5520d0b43cd19c03b57.tar.gz
grecs-6c28bd628ede02dfb6e8a5520d0b43cd19c03b57.tar.bz2
Update the docs.
Diffstat (limited to 'doc/grecs_parse.3')
-rw-r--r--doc/grecs_parse.310
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/grecs_parse.3 b/doc/grecs_parse.3
index dff6759..a8b70ca 100644
--- a/doc/grecs_parse.3
+++ b/doc/grecs_parse.3
@@ -14,7 +14,7 @@
.\" You should have received a copy of the GNU General Public License
.\" along with Grecs. If not, see <http://www.gnu.org/licenses/>.
.\"
-.TH GRECS_PARSE 3 "May 7, 2011" "GRECS" "Grecs User Reference"
+.TH GRECS_PARSE 3 "July 1, 2011" "GRECS" "Grecs User Reference"
.SH NAME
grecs_parse \- parse a configuration file.
.SH SYNOPSIS
@@ -46,6 +46,7 @@ typedef struct grecs_node {
struct grecs_node *next;
struct grecs_node *prev;
char *ident;
+ grecs_locus_t idloc;
union {
struct grecs_value *value;
struct grecs_symtab *texttab;
@@ -99,6 +100,9 @@ pidfile "/var/run/mypid";
.sp
will have \fBident\fR pointing to the string \fB/var/run/mypid\fR.
.PP
+The \fIidloc\fR contains the location of the identifier portion in the
+input file. Notice, that it differs from \fBlocus\fR described above.
+.PP
The \fBv\fR union keeps data which depend on the type of this node.
The \fBv.texttab\fR member is defined only for the root node (type
\fBgrecs_node_root\fR). It points to a symbol table which holds shared
@@ -112,6 +116,7 @@ the value associated with this statement. A value is defined as:
.in +5
typedef struct grecs_value {
int type;
+ grecs_locus_t locus;
union {
struct grecs_list *list;
char *string;
@@ -138,6 +143,9 @@ The list value is pointed to by \fBv.list\fR.
.B GRECS_TYPE_ARRAY
The array itself is stored in \fBv.arg.v\fR. The \fBv.arg.c\fR member
contains the number of elements in the array.
+.PP
+The \fBlocus\fR member contains the location of this value in the
+input file.
.SH RETURN VALUE
On success, a pointer to the root node. On error, \fBNULL\fR.
.SH EXAMPLE

Return to:

Send suggestions and report system problems to the System administrator.