aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org>2016-08-08 08:53:46 +0300
committerSergey Poznyakoff <gray@gnu.org>2016-08-08 08:53:46 +0300
commitbd5b7c29986b8106595f35cbe303fc44cf8c4d0d (patch)
tree84b39cc6d228b3642f7105c48162193a05982882 /doc
parent102d1b9c1a94548dfa0c498845c77933db6a7738 (diff)
downloadgrecs-bd5b7c29986b8106595f35cbe303fc44cf8c4d0d.tar.gz
grecs-bd5b7c29986b8106595f35cbe303fc44cf8c4d0d.tar.bz2
Rename the projectargot
Diffstat (limited to 'doc')
-rw-r--r--doc/ARGOT_SETUP.3 (renamed from doc/GRECS_SETUP.3)38
-rw-r--r--doc/Makefile.am32
-rw-r--r--doc/argot-syntax.texi (renamed from doc/grecs-syntax.texi)8
-rw-r--r--doc/argot_asprintf.3 (renamed from doc/grecs_asprintf.3)28
-rw-r--r--doc/argot_config.5 (renamed from doc/grecs_config.5)20
-rw-r--r--doc/argot_error.3 (renamed from doc/grecs_error.3)48
-rw-r--r--doc/argot_format_locus.3 (renamed from doc/grecs_format_locus.3)32
-rw-r--r--doc/argot_format_node.3 (renamed from doc/grecs_format_node.3)56
-rw-r--r--doc/argot_format_node_path.3 (renamed from doc/grecs_format_node_path.3)36
-rw-r--r--doc/argot_format_value.3 (renamed from doc/grecs_format_value.3)30
-rw-r--r--doc/argot_include_path_setup.3 (renamed from doc/grecs_include_path_setup.3)26
-rw-r--r--doc/argot_malloc.3 (renamed from doc/grecs_malloc.3)72
-rw-r--r--doc/argot_node_free.3 (renamed from doc/grecs_node_free.3)20
-rw-r--r--doc/argot_parse.3 (renamed from doc/grecs_parse.3)92
-rw-r--r--doc/argot_stmt_path.5 (renamed from doc/grecs_stmt_path.5)12
-rw-r--r--doc/argot_strdup.3 (renamed from doc/grecs_strdup.3)24
-rw-r--r--doc/argot_tree_free.3 (renamed from doc/grecs_tree_free.3)20
-rw-r--r--doc/tmpl.310
-rw-r--r--doc/wordsplit.36
19 files changed, 305 insertions, 305 deletions
diff --git a/doc/GRECS_SETUP.3 b/doc/ARGOT_SETUP.3
index 8aa086a..3c18d1e 100644
--- a/doc/GRECS_SETUP.3
+++ b/doc/ARGOT_SETUP.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,14 +14,14 @@
.\" 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_SETUP 3 "August 13, 2012" "GRECS" "Grecs User Reference"
+.TH ARGOT_SETUP 3 "August 13, 2012" "ARGOT" "Grecs User Reference"
.SH NAME
-GRECS_SETUP \- Initialize \fBgrecs\fR submodule.
+ARGOT_SETUP \- Initialize \fBargot\fR submodule.
.SH SYNOPSIS
-.BI "GRECS_SETUP(" "dir" ", " "options" ", " "pp-setup-file" )
+.BI "ARGOT_SETUP(" "dir" ", " "options" ", " "pp-setup-file" )
.SH DESCRIPTION
-The \fBGRECS_SETUP\fR macro is invoked from the host project's
-\fBconfigure.ac\fR. It initializes the \fBgrecs\fR submodule
+The \fBARGOT_SETUP\fR macro is invoked from the host project's
+\fBconfigure.ac\fR. It initializes the \fBargot\fR submodule
variables for compilation within that project.
.PP
All arguments are optional.
@@ -29,15 +29,15 @@ All arguments are optional.
The
.I dir
argument specifies the directory, relative to the source tree top,
-where \fBgrecs\fR has been cloned. If omitted, \fBgrecs\fR is assumed.
+where \fBargot\fR has been cloned. If omitted, \fBargot\fR is assumed.
.sp
-For example, if \fBgrecs\fR was cloned using the following command:
+For example, if \fBargot\fR was cloned using the following command:
.sp
.nf
- git clone ssh://git.gnu.org.ua/gitroot/grecs.git lib/grecs
+ git clone ssh://git.gnu.org.ua/gitroot/argot.git lib/argot
.fi
.sp
-then the \fIdir\fR argument must be \fBlib/grecs\fR.
+then the \fIdir\fR argument must be \fBlib/argot\fR.
.PP
The
.I options
@@ -63,19 +63,19 @@ Build the parser for MeTA1 configuration files.
Disable the use of preprocessor.
.TP
.B install
-Create and install shared library \fBlibgrecs.so\fR. Install the
+Create and install shared library \fBlibargot.so\fR. Install the
documentation as well.
.TP
.B shared
Create a shared convenience library. By default, a static library is
-created. Use this option if you want to incorporate grecs into another
+created. Use this option if you want to incorporate argot into another
shared library.
.TP
.B install-header
Install header files. This option is valid only when used together
with \fBshared\fR. Header files will be installed in
\fBpkgincludedir\fR. To select another installation directory, define
-the variable \fBGRECS_INCLUDE_DIR\fR to the name of that directory.
+the variable \fBARGOT_INCLUDE_DIR\fR to the name of that directory.
.TP
.B std-pp-setup
Install the standard \fBpp-setup\fR file.
@@ -98,7 +98,7 @@ Add \fBgit2chg.awk\fR to the distributed tarball. The file is located
in \fIdir\fR/build-aux.
.TP
.B syntax-doc
-Add \fBdoc/grecs-syntax.texi\fR file to the distributed tarball. Use this
+Add \fBdoc/argot-syntax.texi\fR file to the distributed tarball. Use this
if your texinfo documentation includes that file.
.PP
The
@@ -117,17 +117,17 @@ parameter are supplied, no preprocessor setup file is installed.
.SS "Default setup"
.RS 4
.nf
-GRECS_SETUP
+ARGOT_SETUP
.fi
.RE
.SS "Complex setup"
-The library sources are in \fBlib/grecs\fR. Configure the testsuite
+The library sources are in \fBlib/argot\fR. Configure the testsuite
and add the \fBgetopt.m4\fR file to the distribution. Install
preprocessor setup file from \fBsrc/pp-setup\fR:
.sp
.RS 4
.nf
-GRECS_SETUP(lib/grecs, [tests getopt], [$(top_srcdir)/src/pp-setup])
+ARGOT_SETUP(lib/argot, [tests getopt], [$(top_srcdir)/src/pp-setup])
.RE
.SH "SEE ALSO"
.BR getopt.m4 (5),
@@ -135,11 +135,11 @@ GRECS_SETUP(lib/grecs, [tests getopt], [$(top_srcdir)/src/pp-setup])
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/Makefile.am b/doc/Makefile.am
index a646367..ac32a36 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
-# This file is part of grecs - Gray's Extensible Configuration System
+# This file is part of argot - Gray's Extensible Configuration System
# Copyright (C) 2007-2016 Sergey Poznyakoff
#
# Grecs is free software; you can redistribute it and/or modify
@@ -15,19 +15,19 @@
# along with Grecs. If not, see <http://www.gnu.org/licenses/>.
dist_man_MANS = \
- GRECS_SETUP.3\
- grecs_asprintf.3\
- grecs_config.5\
- grecs_error.3\
- grecs_format_locus.3\
- grecs_format_node_path.3\
- grecs_format_node.3\
- grecs_format_value.3\
- grecs_include_path_setup.3\
- grecs_malloc.3\
- grecs_node_free.3\
- grecs_parse.3\
- grecs_stmt_path.5\
- grecs_strdup.3\
- grecs_tree_free.3
+ ARGOT_SETUP.3\
+ argot_asprintf.3\
+ argot_config.5\
+ argot_error.3\
+ argot_format_locus.3\
+ argot_format_node_path.3\
+ argot_format_node.3\
+ argot_format_value.3\
+ argot_include_path_setup.3\
+ argot_malloc.3\
+ argot_node_free.3\
+ argot_parse.3\
+ argot_stmt_path.5\
+ argot_strdup.3\
+ argot_tree_free.3
diff --git a/doc/grecs-syntax.texi b/doc/argot-syntax.texi
index 2ddedea..db81133 100644
--- a/doc/grecs-syntax.texi
+++ b/doc/argot-syntax.texi
@@ -1,4 +1,4 @@
-@c This file is part of grecs - Gray's Extensible Configuration System
+@c This file is part of argot - Gray's Extensible Configuration System
@c Copyright (C) 2007-2016 Sergey Poznyakoff
@c
@c Grecs is free software; you can redistribute it and/or modify
@@ -20,7 +20,7 @@
@c @lowersections:
@c
@c @raisesections
-@c @include grecs-syntax.texi
+@c @include argot-syntax.texi
@c @lowersections
@c
@c 2. This texinfo source refers to the following values:
@@ -219,8 +219,8 @@ physical lines, e.g.:
If the character following a backslash is not one of those specified
above, the backslash is ignored and a warning is issued.
-@c FIXME: If grecs_parser_options variable has
-@c FIXME: GRECS_OPTION_QUOTED_STRING_CONCAT bit set, then the
+@c FIXME: If argot_parser_options variable has
+@c FIXME: ARGOT_OPTION_QUOTED_STRING_CONCAT bit set, then the
@c FIXME: following holds:
@ignore
diff --git a/doc/grecs_asprintf.3 b/doc/argot_asprintf.3
index 25279be..fa86190 100644
--- a/doc/grecs_asprintf.3
+++ b/doc/argot_asprintf.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,25 +14,25 @@
.\" 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_ASPRINTF 3 "May 4, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_ASPRINTF 3 "May 4, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
-grecs_asprintf, grecs_vasprintf \- print to allocated string
+argot_asprintf, argot_vasprintf \- print to allocated string
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
-.BI "int grecs_vasprintf(char " "**pbuf" ", size_t " "*psize" \
+.BI "int argot_vasprintf(char " "**pbuf" ", size_t " "*psize" \
", const char " "*format" ", "
.ti +17
.BI "va_list " "ap" );
.br
-.BI "int grecs_asprintf(char " "**pbuf" ", size_t " "*psize" \
+.BI "int argot_asprintf(char " "**pbuf" ", size_t " "*psize" \
", const char *" "format" ", ...);"
.SH DESCRIPTION
The functions
-.BI grecs_asprintf ()
+.BI argot_asprintf ()
and
-.BI grecs_vasprintf ()
+.BI argot_vasprintf ()
are analogs of
.BR sprintf (3)
and
@@ -52,23 +52,23 @@ In both cases, if the buffer has been reallocated, on return
\fBpbuf\fR will contain its new address and \fBpsize\fR its new size.
.PP
For initial allocation,
-.BR grecs_malloc (3)
+.BR argot_malloc (3)
is used. To reallocate memory, both functions use
-.BR grecs_realloc (3).
+.BR argot_realloc (3).
.SH RETURN VALUE
None. If memory allocation fails, a diagnostics is output and the
program is terminated.
.SH "SEE ALSO"
-.BR grecs_malloc (3),
-.BR grecs_realloc (3).
+.BR argot_malloc (3),
+.BR argot_realloc (3).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_config.5 b/doc/argot_config.5
index 5fdaed4..abd6420 100644
--- a/doc/grecs_config.5
+++ b/doc/argot_config.5
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -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_CONFIG 3 "December 25, 2014" "GRECS" "Grecs User Reference"
+.TH ARGOT_CONFIG 3 "December 25, 2014" "ARGOT" "Grecs User Reference"
.SH NAME
\fBGrecs\fR configuration file syntax
.SH DESCRIPTION
@@ -94,11 +94,11 @@ the program which uses the configuration file, and \fIVERSION\fR for
its version number.
.sp
The include search path can be modified using the
-.BI grecs_include_path_setup ()
+.BI argot_include_path_setup ()
and
-.BI grecs_include_path_setup_v ()
+.BI argot_include_path_setup_v ()
functions. Refer to
-.BR grecs_include_path_setup (3),
+.BR argot_include_path_setup (3),
for a detailed discussion.
.TP
.BR "#include_once <" "file" >
@@ -323,17 +323,17 @@ advantage that it works with non-GNU m4 implementations as
well.
.SH "SEE ALSO"
.BR m4 (1),
-.BR grecs_parse (3),
-.BR grecs_include_path_setup (3),
-.BR grecs_tree_process (3).
+.BR argot_parse (3),
+.BR argot_include_path_setup (3),
+.BR argot_tree_process (3).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_error.3 b/doc/argot_error.3
index a020d36..ab623dc 100644
--- a/doc/grecs_error.3
+++ b/doc/argot_error.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,29 +14,29 @@
.\" 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_ERROR 3 "July 1, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_ERROR 3 "July 1, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
-grecs_error, grecs_warning \- grecs error reporting functions
+argot_error, argot_warning \- argot error reporting functions
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
-.BI "void grecs_error(grecs_locus_t " "*locus" ", int " "errnum" ", "
+.BI "void argot_error(argot_locus_t " "*locus" ", int " "errnum" ", "
.ti +17
.BI "const char " "*format" ", ...);"
.br
-.BI "void grecs_warning(grecs_locus_t " "*locus" ", int " "errnum" ", "
+.BI "void argot_warning(argot_locus_t " "*locus" ", int " "errnum" ", "
.ti +17
.BI "const char " "*format" ", ...);"
.sp
-.BI "void (*grecs_print_diag_fun)(grecs_locus_t " "*locus" ", "
+.BI "void (*argot_print_diag_fun)(argot_locus_t " "*locus" ", "
.ti +17
.BI "int " "err" ", int " "errnum" ", const char " "*msg" );
.sp
-.B extern int grecs_error_count;
+.B extern int argot_error_count;
.SH DESCRIPTION
-.BI grecs_error ()
-is a error reporting function for \fBgrecs\fR library. It flushes
+.BI argot_error ()
+is a error reporting function for \fBargot\fR library. It flushes
stdout, and outputs to stderr the file name and line number, as
supplied by the
.BI locus
@@ -52,22 +52,22 @@ If \fIlocus\fR is \fBNULL\fR, it is ignored and no file location is
printed.
.PP
Each call to
-.BI grecs_error ()
+.BI argot_error ()
increments the value of the
-.BI grecs_error_count
+.BI argot_error_count
global variable.
The
-.BI grecs_warning ()
+.BI argot_warning ()
function works the same as
-.BI grecs_error (),
+.BI argot_error (),
except that it outputs, before the formatted message and after the
file location, the word \fBwarning\fR, followed by a semicolon
and a space character. It does not modify the
-.BI grecs_error_count
+.BI argot_error_count
variable.
.PP
Calling program can modify the behavior of both functions by setting
-.BI grecs_print_diag_fun
+.BI argot_print_diag_fun
to the address of a custom error-reporting function. This function is
called with the following arguments:
.TP
@@ -86,21 +86,21 @@ System error code, or \fB0\fR, if no system error occurred.
.I msg
Formatted message.
.PP
-The \fBgrecs_locus_t\fR structure consists of two \fBpoints\fR, each
+The \fBargot_locus_t\fR structure consists of two \fBpoints\fR, each
point describing the beginning and the end of the input fragment in
question:
.sp
.nf
.in +5
-struct grecs_locus_point {
+struct argot_locus_point {
char *file;
unsigned line;
unsigned col;
};
typedef struct {
- struct grecs_locus_point beg;
- struct grecs_locus_point end;
-} grecs_locus_t;
+ struct argot_locus_point beg;
+ struct argot_locus_point end;
+} argot_locus_t;
.in
.fi
.PP
@@ -109,7 +109,7 @@ member contains the input line number and the \fBcol\fR member
contains the column number. Both lines and columns are numbered from
1.
.PP
-On output, the \fBgrecs_locus_t\fR structure is formatted as follows:
+On output, the \fBargot_locus_t\fR structure is formatted as follows:
.sp
.nf
.in +5
@@ -160,11 +160,11 @@ None.
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_format_locus.3 b/doc/argot_format_locus.3
index 5ab3542..52bfc3d 100644
--- a/doc/grecs_format_locus.3
+++ b/doc/argot_format_locus.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,27 +14,27 @@
.\" 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_FORMAT_LOCUS 3 "May 19, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_FORMAT_LOCUS 3 "May 19, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
-grecs_format_locus \- format and output source file location
+argot_format_locus \- format and output source file location
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
-.BI "void grecs_format_locus(grecs_locus_t " "*locus" ","
+.BI "void argot_format_locus(argot_locus_t " "*locus" ","
.ti +17
-.BI "struct grecs_format_closure " "*clos" );
+.BI "struct argot_format_closure " "*clos" );
.sp
-.BI "void grecs_print_locus(grecs_locus_t " "*locus" ", FILE " "*fp" );
+.BI "void argot_print_locus(argot_locus_t " "*locus" ", FILE " "*fp" );
.SH DESCRIPTION
-\fBgrecs_print_locus\fR formats the location from \fIlocus\fR in the
+\fBargot_print_locus\fR formats the location from \fIlocus\fR in the
human-readable form and outputs it using the format closure
\fIclos\fR. The closure is defined as:
.sp
.nf
.in +5
-struct grecs_format_closure
+struct argot_format_closure
{
int (*fmtfun)(const char *str, void *data);
void *data;
@@ -47,7 +47,7 @@ be called one or more times. On each invocation, it is supplied with
the string to be output as its first argument, and pointer to
\fBdata\fR as the second one.
.PP
-\fBgrecs_print_locus\fR is an alternative interface, which formats the
+\fBargot_print_locus\fR is an alternative interface, which formats the
location from \fIlocus\fR in the human-readable form and outputs it to
file \fBfp\fR.
.PP
@@ -60,21 +60,21 @@ doing anything.
None.
.SH NOTES
This are auxiliary functions used by
-.BR grecs_format_node (3)
+.BR argot_format_node (3)
and
-.BR grecs_print_node (3),
+.BR argot_print_node (3),
correspondingly. They are is seldom needed in user programs.
.SH "SEE ALSO"
-.BR grecs_format_node (3),
-.BR grecs_print_node (3).
+.BR argot_format_node (3),
+.BR argot_print_node (3).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_format_node.3 b/doc/argot_format_node.3
index bf2b8db..3e0a9fb 100644
--- a/doc/grecs_format_node.3
+++ b/doc/argot_format_node.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,26 +14,26 @@
.\" 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_FORMAT_NODE 3 "May 19, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_FORMAT_NODE 3 "May 19, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
-grecs_format_node \- format and print a single node from a syntax tree
+argot_format_node \- format and print a single node from a syntax tree
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
-.BI "void grecs_format_node(struct grecs_node *" "node" ", int " \
+.BI "void argot_format_node(struct argot_node *" "node" ", int " \
"flags" ","
.ti +17
-.BI "struct grecs_format_closure " "*clos" );
+.BI "struct argot_format_closure " "*clos" );
.sp
-.BI "void grecs_print_node(struct grecs_node *" "node" ", int " \
+.BI "void argot_print_node(struct argot_node *" "node" ", int " \
"flags" ", FILE " "*fp" );
.SH DESCRIPTION
-\fBgrecs_format_node\fR formats the contents of a parse tree node
+\fBargot_format_node\fR formats the contents of a parse tree node
\fInode\fR, according to formatting options, given by \fIflags\fR. The
formatter closure \fIclos\fR is used for actual output.
.PP
-\fBgrecs_print_node\fR is an alternative entry point, which formats
+\fBargot_print_node\fR is an alternative entry point, which formats
the node to the given file.
.PP
The \fBflags\fR argument is a bitwise \fBOR\fR of one or more of the
@@ -43,49 +43,49 @@ following options:
This character will be used as pathname component separator, instead
of the default dot.
.TP
-.B GRECS_NODE_FLAG_LOCUS
+.B ARGOT_NODE_FLAG_LOCUS
Print the source location. The location is printed as the file name,
followed by a semicolon, followed by the line number and another
semicolon. Locations are separated from the rest of output by a single
space character.
.TP
-.B GRECS_NODE_FLAG_PATH
+.B ARGOT_NODE_FLAG_PATH
Print the \fInode path\fR. See
-.BR grecs_stmt_path (5),
+.BR argot_stmt_path (5),
for a description. If printed, the path is separated from the
remaining output on its right by a semicolon and a space.
.TP
-.B GRECS_NODE_FLAG_VALUE
+.B ARGOT_NODE_FLAG_VALUE
Print the node value.
.TP
-.B GRECS_NODE_FLAG_QUOTE
+.B ARGOT_NODE_FLAG_QUOTE
Always quote the value. By default, the value will be quoted only
when necessary, i.e. if it contains white space, quotes or special
characters. This option is useful only together with
-\fBGRECS_NODE_FLAG_VALUE\fR.
+\fBARGOT_NODE_FLAG_VALUE\fR.
.TP
-.B GRECS_NODE_FLAG_NOQUOTE
-Never quote values. If both \fBGRECS_NODE_FLAG_QUOTE\fR and
-\fBGRECS_NODE_FLAG_NOQUOTE\fR are given, the former takes precedence
+.B ARGOT_NODE_FLAG_NOQUOTE
+Never quote values. If both \fBARGOT_NODE_FLAG_QUOTE\fR and
+\fBARGOT_NODE_FLAG_NOQUOTE\fR are given, the former takes precedence
over the latter.
.TP
-.B GRECS_NODE_FLAG_QUOTE_HEX
+.B ARGOT_NODE_FLAG_QUOTE_HEX
Print non-printable characters as C hex escapets. This option is
-ignored if \fBGRECS_NODE_FLAG_NOQUOTE\fR is set.
+ignored if \fBARGOT_NODE_FLAG_NOQUOTE\fR is set.
.TP
-.B GRECS_NODE_FLAG_DEFAULT
+.B ARGOT_NODE_FLAG_DEFAULT
Same as
.sp
.nf
-GRECS_NODE_FLAG_PATH|GRECS_NODE_FLAG_VALUE|GRECS_NODE_FLAG_QUOTE
+ARGOT_NODE_FLAG_PATH|ARGOT_NODE_FLAG_VALUE|ARGOT_NODE_FLAG_QUOTE
.PP
-If \fBflag\fR is 0, \fBGRECS_NODE_FLAG_DEFAULT\fR is assumed.
+If \fBflag\fR is 0, \fBARGOT_NODE_FLAG_DEFAULT\fR is assumed.
.SH CLOSURE
The format closure is defined as:
.sp
.nf
.in +5
-struct grecs_format_closure
+struct argot_format_closure
{
int (*fmtfun)(const char *str, void *data);
void *data;
@@ -100,16 +100,16 @@ the string to be output as its first argument, and pointer to
.SH "RETURN VALUE"
None.
.SH "SEE ALSO"
-.BR grecs_config (5),
-.BR grecs_stmt_path (5).
+.BR argot_config (5),
+.BR argot_stmt_path (5).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_format_node_path.3 b/doc/argot_format_node_path.3
index 0d4fa85..e85e2bb 100644
--- a/doc/grecs_format_node_path.3
+++ b/doc/argot_format_node_path.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,55 +14,55 @@
.\" 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_FORMAT_NODE_PATH 3 "May 19, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_FORMAT_NODE_PATH 3 "May 19, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
-grecs_format_node_path \- format and output statement pathname for the
+argot_format_node_path \- format and output statement pathname for the
node
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
-.BI "void grecs_format_node_path(struct grecs_node " "*node" ", int " \
+.BI "void argot_format_node_path(struct argot_node " "*node" ", int " \
"flag" ", "
.ti +17
-.BI "struct grecs_format_closure " "*clos" );
+.BI "struct argot_format_closure " "*clos" );
.sp
-.BI "void grecs_print_node_path(struct grecs_node " "*node" ", int " \
+.BI "void argot_print_node_path(struct argot_node " "*node" ", int " \
"flag" ", FILE " "*fp" );
.SH DESCRIPTION
-\fBgrecs_format_node_path\fR computes the \fIstatement pathname\fR for
+\fBargot_format_node_path\fR computes the \fIstatement pathname\fR for
the \fInode\fR, and outputs it using the closure \fIclos\fR. See
section \fBCLOSURE\fR in
-.BR grecs_format_node (3),
-for a description of struct grecs_format_closure.
+.BR argot_format_node (3),
+for a description of struct argot_format_closure.
.PP
-\fBgrecs_print_node_path\fR is an alternative interface that outputs
+\fBargot_print_node_path\fR is an alternative interface that outputs
the formatted data to the file.
.PP
The \fIflags\fR argument describes what character to use as a pathname
component separator and how to format the statement tag, if \fInode\fR
refers to a block statement. See
-.BR grecs_format_node (3),
+.BR argot_format_node (3),
for a discussion of available flags.
.SH "RETURN VALUE"
None.
.SH NOTES
This are auxiliary functions used by
-.BR grecs_format_node (3)
+.BR argot_format_node (3)
and
-.BR grecs_print_node (3),
+.BR argot_print_node (3),
correspondingly. They are is seldom needed in user programs.
.SH "SEE ALSO"
-.BR grecs_format_node (3),
-.BR grecs_stmt_path (5).
+.BR argot_format_node (3),
+.BR argot_stmt_path (5).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_format_value.3 b/doc/argot_format_value.3
index bfd90a2..73a667c 100644
--- a/doc/grecs_format_value.3
+++ b/doc/argot_format_value.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,47 +14,47 @@
.\" 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_FORMAT_VALUE 3 "May 19, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_FORMAT_VALUE 3 "May 19, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
-grecs_format_value \- format and output a configuration value
+argot_format_value \- format and output a configuration value
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
-.BI "void grecs_format_value(struct grecs_value *" "val" ", int " \
+.BI "void argot_format_value(struct argot_value *" "val" ", int " \
"flags" ", "
.ti +17
-.BI "struct grecs_format_closure " "*clos" );
+.BI "struct argot_format_closure " "*clos" );
.sp
-.BI "void grecs_print_value(struct grecs_value *" "val" ", int " \
+.BI "void argot_print_value(struct argot_value *" "val" ", int " \
"flags" ", FILE " "*fp" );
.SH DESCRIPTION
-\fBgrecs_format_value\fR formats the value \fIval\fR and outputs it
+\fBargot_format_value\fR formats the value \fIval\fR and outputs it
using the formatting closure \fIclos\fR. The \fIflags\fR argument
describes how to format the value. See
-.BR grecs_format_node (3),
+.BR argot_format_node (3),
for a discussion of available flags.
.PP
-\fBgrecs_print_value\fR is an alternative interface that outputs the
+\fBargot_print_value\fR is an alternative interface that outputs the
formatted data to a file.
.SH "RETURN VALUE"
None.
.SH NOTES
This are auxiliary functions used by
-.BR grecs_format_node (3)
+.BR argot_format_node (3)
and
-.BR grecs_print_node (3),
+.BR argot_print_node (3),
correspondingly. They are is seldom needed in user programs.
.SH "SEE ALSO"
-.BR grecs_format_node (3).
+.BR argot_format_node (3).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_include_path_setup.3 b/doc/argot_include_path_setup.3
index 6e61ec9..49ce06f 100644
--- a/doc/grecs_include_path_setup.3
+++ b/doc/argot_include_path_setup.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,39 +14,39 @@
.\" 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_INCLUDE_PATH_SETUP 3 "May 4, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_INCLUDE_PATH_SETUP 3 "May 4, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
-grecs_include_path_setup, grecs_include_path_setup_v \- add
-directories to the \fBgrecs\fR preprocessor include path
+argot_include_path_setup, argot_include_path_setup_v \- add
+directories to the \fBargot\fR preprocessor include path
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
-.BI "void grecs_include_path_setup(const char *" "dir" ", ...);"
+.BI "void argot_include_path_setup(const char *" "dir" ", ...);"
.br
-.BI "void grecs_include_path_setup_v(char **" "dirs" );
+.BI "void argot_include_path_setup_v(char **" "dirs" );
.SH DESCRIPTION
These functions add directories to the end of the include search path
-used by the \fBgrecs\fR preprocessor.
+used by the \fBargot\fR preprocessor.
.PP
-\fBgrecs_include_path_setup\fR takes arbitrary number of
+\fBargot_include_path_setup\fR takes arbitrary number of
arguments. Each argument must be pointer to a directory name. The
argument list must terminate with a \fBNULL\fR argument.
.PP
-\fBgrecs_include_path_setup_v\fR takes directory names from a
+\fBargot_include_path_setup_v\fR takes directory names from a
\fBNULL\fR-terminated array of character pointers.
.SH "RETURN VALUE"
None.
.SH "SEE ALSO"
-.BR grecs_config (5).
+.BR argot_config (5).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_malloc.3 b/doc/argot_malloc.3
index 97d4273..0059bbb 100644
--- a/doc/grecs_malloc.3
+++ b/doc/argot_malloc.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,41 +14,41 @@
.\" 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_MALLOC 3 "May 7, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_MALLOC 3 "May 7, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
-grecs_malloc, grecs_zalloc, grecs_calloc, grecs_realloc \- Allocate
+argot_malloc, argot_zalloc, argot_calloc, argot_realloc \- Allocate
dynamic memory for \fBGrecs\fR.
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
-.BI "void *grecs_malloc(size_t " "size" );
+.BI "void *argot_malloc(size_t " "size" );
.br
-.BI "void *grecs_zalloc(size_t " "size" );
+.BI "void *argot_zalloc(size_t " "size" );
.br
-.BI "void *grecs_calloc(size_t " "nmemb" ", size_t " "size" );
+.BI "void *argot_calloc(size_t " "nmemb" ", size_t " "size" );
.br
-.BI "void *grecs_realloc(void " "*ptr" ", size_t " "size" );
+.BI "void *argot_realloc(void " "*ptr" ", size_t " "size" );
.br
-.BI "void grecs_free(void " "*ptr" );
+.BI "void argot_free(void " "*ptr" );
.br
-.BI "void grecs_alloc_die(void);"
+.BI "void argot_alloc_die(void);"
.sp
-.BI "void *(*grecs_malloc_fun)(size_t " "size" );
+.BI "void *(*argot_malloc_fun)(size_t " "size" );
.br
-.BI "void *(*grecs_realloc_fun)(void " "*ptr" ", size_t " "size" );
+.BI "void *(*argot_realloc_fun)(void " "*ptr" ", size_t " "size" );
.br
-.BI "void (*grecs_free_fun)(void " "*ptr" );
+.BI "void (*argot_free_fun)(void " "*ptr" );
.br
-.BI "void (*grecs_alloc_die_fun)(void);"
+.BI "void (*argot_alloc_die_fun)(void);"
.SH DESCRIPTION
.PP
-The \fBgrecs_malloc\fR, \fBgrecs_calloc\fR and \fBgrecs_realloc\fR
+The \fBargot_malloc\fR, \fBargot_calloc\fR and \fBargot_realloc\fR
functions work exactly as they \fIlibc\fR counterparts do, except that
if unable to allocate memory they terminate the program, by calling
-\fBgrecs_alloc_die\fR function.
+\fBargot_alloc_die\fR function.
.PP
-.BR grecs_calloc ()
+.BR argot_calloc ()
allocates memory for an array of
.I nmemb
elements of
@@ -56,13 +56,13 @@ elements of
bytes each and returns a pointer to the allocated memory.
The memory is set to zero.
.PP
-.BR grecs_malloc ()
+.BR argot_malloc ()
allocates
.I size
bytes and returns a pointer to the allocated memory.
The memory is not cleared.
.PP
-.BR grecs_realloc ()
+.BR argot_realloc ()
changes the size of the memory block pointed to by
.I ptr
to
@@ -72,56 +72,56 @@ The contents will be unchanged to the minimum of the old and new
sizes;
newly allocated memory will be uninitialized.
.PP
-.BR grecs_zalloc ()
+.BR argot_zalloc ()
allocates
.I size
bytes and returns a pointer to the allocated memory. The memory is
set to zero.
.PP
-.BR grecs_free ()
+.BR argot_free ()
frees the memory space pointed to by \fBptr\fR, which must have been
returned by a previous call to one of the memory allocation functions
discussed above.
.PP
-The \fBgrecs_malloc_fun\fR hook is used \fBgrecs_malloc\fR,
-\fBgrecs_calloc\fR and \fBgrecs_zalloc\fR to allocate new memory
+The \fBargot_malloc_fun\fR hook is used \fBargot_malloc\fR,
+\fBargot_calloc\fR and \fBargot_zalloc\fR to allocate new memory
chunk. By default it points to
.BR malloc (3).
.PP
-Similarly, the \fBgrecs_realloc_fun\fR, is used by
-\fBgrecs_realloc\fR function. By default it points to
+Similarly, the \fBargot_realloc_fun\fR, is used by
+\fBargot_realloc\fR function. By default it points to
.BR realloc (3).
.PP
-The \fBgrecs_free_fun\fR is used by
-.BR grecs_free ().
+The \fBargot_free_fun\fR is used by
+.BR argot_free ().
By default it points to
.BR free (3).
.PP
These hooks provide a way for the calling program to use its custom
memory allocation routines.
.PP
-.BR grecs_alloc_die ()
+.BR argot_alloc_die ()
This function is called when memory allocation fails. It prints
-appropriate diagnostics using \fBgrecs_error(3)\fR and aborts the
-program. If \fBgrecs_alloc_die_fun\fR, it is called prior to
+appropriate diagnostics using \fBargot_error(3)\fR and aborts the
+program. If \fBargot_alloc_die_fun\fR, it is called prior to
outputting the diagnostics.
.SH "RETURN VALUE"
-For \fBgrecs_malloc\fR, \fBgrecs_calloc\fR, \fBgrecs_zalloc\fR and
-\fBgrecs_realloc\fR return a pointer to the allocated memory, which is
+For \fBargot_malloc\fR, \fBargot_calloc\fR, \fBargot_zalloc\fR and
+\fBargot_realloc\fR return a pointer to the allocated memory, which is
suitably aligned for any kind of variable.
.PP
-On error, \fBgrecs_alloc_die\fR is called and the program is terminated.
+On error, \fBargot_alloc_die\fR is called and the program is terminated.
.SH "SEE ALSO"
-.BR grecs_strdup (3)
+.BR argot_strdup (3)
.SH AUTHORS
Sergey Poznyakoff.
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_node_free.3 b/doc/argot_node_free.3
index 8637811..6fd6f61 100644
--- a/doc/grecs_node_free.3
+++ b/doc/argot_node_free.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,34 +14,34 @@
.\" 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_NODE_FREE 3 "May 4, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_NODE_FREE 3 "May 4, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
-grecs_node_free \- reclaim the memory used by a node
+argot_node_free \- reclaim the memory used by a node
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
-.BI "void grecs_node_free(struct grecs_node " "*node" );
+.BI "void argot_node_free(struct argot_node " "*node" );
.SH DESCRIPTION
-\fBgrecs_node_free\fR reclaims the memory used by the parse tree node
+\fBargot_node_free\fR reclaims the memory used by the parse tree node
\fInode\fR.
.PP
The function does not unlink the node from the lists it is part of,
see
-.BR grecs_tree_free (3),
+.BR argot_tree_free (3),
if this is what you need.
.SH "RETURN VALUE"
None.
.SH "SEE ALSO"
-.BR grecs_tree_free (3).
+.BR argot_tree_free (3).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_parse.3 b/doc/argot_parse.3
index 27e451b..4db155c 100644
--- a/doc/grecs_parse.3
+++ b/doc/argot_parse.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,23 +14,23 @@
.\" 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 "July 1, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_PARSE 3 "July 1, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
-grecs_parse \- parse a configuration file.
+argot_parse \- parse a configuration file.
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
-.BI "struct grecs_node *grecs_parse(const char *" "name" );
+.BI "struct argot_node *argot_parse(const char *" "name" );
.SH DESCRIPTION
The
-.BR grecs_parse ()
+.BR argot_parse ()
function reads the file \fBname\fR, which must be formatted
according to
-.BR grecs_config (5)
+.BR argot_config (5)
and returns the parsed-out syntax tree. On errors, \fBNULL\fR is
returned and appropriate diagnostic messages are printed using
-.BR grecs_error (3).
+.BR argot_error (3).
.PP
The syntax tree consists of \fInodes\fR, linked together so as to
represent the file structure. A node is described by the following
@@ -38,32 +38,32 @@ object:
.sp
.nf
.in +5
-typedef struct grecs_node {
- enum grecs_node_type type;
- grecs_locus_t locus;
- struct grecs_node *up;
- struct grecs_node *down;
- struct grecs_node *next;
- struct grecs_node *prev;
+typedef struct argot_node {
+ enum argot_node_type type;
+ argot_locus_t locus;
+ struct argot_node *up;
+ struct argot_node *down;
+ struct argot_node *next;
+ struct argot_node *prev;
char *ident;
- grecs_locus_t idloc;
+ argot_locus_t idloc;
union {
- struct grecs_value *value;
- struct grecs_symtab *texttab;
+ struct argot_value *value;
+ struct argot_symtab *texttab;
} v;
-} grecs_node_t;
+} argot_node_t;
.in
.fi
.PP
The \fItype\fR member describes the type of this node. Its value is
-\fBgrecs_node_stmt\fR for simple statements and
-\fBgrecs_node_block\fR, for block statements. The topmost node (the
-one returned by \fBgrecs_tree_parse\fR) has type \fBgrecs_node_root\fR.
+\fBargot_node_stmt\fR for simple statements and
+\fBargot_node_block\fR, for block statements. The topmost node (the
+one returned by \fBargot_tree_parse\fR) has type \fBargot_node_root\fR.
.PP
The \fIlocus\fR describes the location in the input file, which this
node described. See
-.BR grecs_error (3),
-for a description of \fBgrecs_locus_t\fR.
+.BR argot_error (3),
+for a description of \fBargot_locus_t\fR.
.PP
Adjacent nodes form a doubly-linked list using the \fBnext\fR and
\fBprev\fR pointers. Thus, the node pointed to by \fBnext\fR
@@ -71,7 +71,7 @@ describes the statement that appears immediately after the one
described by the current node, whereas \fBprev\fR points to the node
describing a preceding statement.
.PP
-If \fItype\fR is \fBgrecs_node_block\fR, the \fBdown\fR member points
+If \fItype\fR is \fBargot_node_block\fR, the \fBdown\fR member points
to the first \fBsub-statement\fR in this block. \fBdown->next\fR
will point to the second statement (if any), and so on.
.PP
@@ -105,7 +105,7 @@ 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
+\fBargot_node_root\fR). It points to a symbol table which holds shared
strings for this tree. In particular, this table holds file names
referenced by \fBlocus\fR members of all underlying nodes.
.PP
@@ -114,33 +114,33 @@ the value associated with this statement. A value is defined as:
.sp
.nf
.in +5
-typedef struct grecs_value {
+typedef struct argot_value {
int type;
- grecs_locus_t locus;
+ argot_locus_t locus;
union {
- struct grecs_list *list;
+ struct argot_list *list;
char *string;
struct {
size_t c;
- struct grecs_value **v;
+ struct argot_value **v;
} arg;
} v;
-} grecs_value_t;
+} argot_value_t;
.in
.fi
.PP
-The \fBtype\fR will be \fBGRECS_TYPE_STRING\fR, for string values,
-\fBGRECS_TYPE_LIST\fR, for list values, and \fBGRECS_TYPE_ARRAY\fR,
+The \fBtype\fR will be \fBARGOT_TYPE_STRING\fR, for string values,
+\fBARGOT_TYPE_LIST\fR, for list values, and \fBARGOT_TYPE_ARRAY\fR,
for arrays of values. Depending on its value, the following members
of the union are used:
.TP
-.B GRECS_TYPE_STRING
+.B ARGOT_TYPE_STRING
Actual string value is pointed to by \fBv.string\fR.
.TP
-.B GRECS_TYPE_LIST
+.B ARGOT_TYPE_LIST
The list value is pointed to by \fBv.list\fR.
.TP
-.B GRECS_TYPE_ARRAY
+.B ARGOT_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
@@ -157,29 +157,29 @@ screen:
int
main(int argc, char **argv)
{
- struct grecs_node *tree;
+ struct argot_node *tree;
- tree = grecs_parse(argv[1]);
- grecs_format_node(tree, GRECS_NODE_FLAG_DEFAULT, stdout);
+ tree = argot_parse(argv[1]);
+ argot_format_node(tree, ARGOT_NODE_FLAG_DEFAULT, stdout);
fputc('\\n', stdout);
- grecs_tree_free(tree);
+ argot_tree_free(tree);
exit(0);
}
.in
.fi
.SH "SEE ALSO"
-.BR grecs_config (5),
-.BR grecs_error (3),
-.BR grecs_format_node (3),
-.BR grecs_tree_free (3).
+.BR argot_config (5),
+.BR argot_error (3),
+.BR argot_format_node (3),
+.BR argot_tree_free (3).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_stmt_path.5 b/doc/argot_stmt_path.5
index 2436630..bc2cc0a 100644
--- a/doc/grecs_stmt_path.5
+++ b/doc/argot_stmt_path.5
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,10 +14,10 @@
.\" 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_STMT_PATH 5 "May 4, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_STMT_PATH 5 "May 4, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
Statement pathname \- a unique identifier of a statement in
-\fBgrecs\fR configuration file.
+\fBargot\fR configuration file.
.SH DESCRIPTION
\fBGrecs\fR configuration files have a distinct hierarchical
structure. Each statement in such a file can therefore be identified
@@ -93,15 +93,15 @@ component separator, e.g.:
.program=\(dqa.out\(dq.bar.baz
.fi
.SH "SEE ALSO"
-.BR grecs_config (5).
+.BR argot_config (5).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_strdup.3 b/doc/argot_strdup.3
index e180264..ce53b07 100644
--- a/doc/grecs_strdup.3
+++ b/doc/argot_strdup.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,41 +14,41 @@
.\" 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_STRDUP 3 "May 7, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_STRDUP 3 "May 7, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
-grecs_strdup \- duplicate a string
+argot_strdup \- duplicate a string
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
-.BI "char *grecs_strdup(const char *" "str" );
+.BI "char *argot_strdup(const char *" "str" );
.SH DESCRIPTION
The
.BR strdup ()
function returns a pointer to a new string which is a duplicate of the
string \fIstr\fR. Memory for the new string is obtained with
-.BR grecs_malloc (3),
+.BR argot_malloc (3),
and must be freed with
-.BR grecs_free (3).
+.BR argot_free (3).
.SH "RETURN VALUE"
The
-.BR grecs_strdup ()
+.BR argot_strdup ()
function returns a pointer to the duplicated string.
.PP
On error,
-.BR grecs_alloc_die (3)
+.BR argot_alloc_die (3)
is called, which terminates the program.
.SH "SEE ALSO"
-.BR grecs_alloc_die (3)
+.BR argot_alloc_die (3)
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/grecs_tree_free.3 b/doc/argot_tree_free.3
index 7b0faf6..b064a23 100644
--- a/doc/grecs_tree_free.3
+++ b/doc/argot_tree_free.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,32 +14,32 @@
.\" 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_XXX 3 "May 4, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_XXX 3 "May 4, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
-grecs_tree_free \- reclaim the memory used by entire parse tree
+argot_tree_free \- reclaim the memory used by entire parse tree
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
-.BI "void grecs_tree_free(struct grecs_node " "*node" );
+.BI "void argot_tree_free(struct argot_node " "*node" );
.SH DESCRIPTION
-\fBgrecs_tree_free\fR reclaims the memory used by \fInode\fR and all
+\fBargot_tree_free\fR reclaims the memory used by \fInode\fR and all
nodes it points to, recursively.
.PP
The argument \fInode\fR must be the root of a parse tree.
.SH "RETURN VALUE"
None.
.SH "SEE ALSO"
-.BR grecs_parse (3),
-.BR grecs_node_free (3).
+.BR argot_parse (3),
+.BR argot_node_free (3).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/tmpl.3 b/doc/tmpl.3
index b4eeb96..6827d77 100644
--- a/doc/tmpl.3
+++ b/doc/tmpl.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -14,12 +14,12 @@
.\" 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_XXX 3 "May 4, 2011" "GRECS" "Grecs User Reference"
+.TH ARGOT_XXX 3 "May 4, 2011" "ARGOT" "Grecs User Reference"
.SH NAME
.SH SYNOPSIS
.nf
-.B #include <grecs.h>
+.B #include <argot.h>
.sp
.SH DESCRIPTION
.SH "RETURN VALUE"
@@ -28,11 +28,11 @@
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR
-documentation, visit <http://www.gnu.org.ua/software/grecs>.
+documentation, visit <http://www.gnu.org.ua/software/argot>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
diff --git a/doc/wordsplit.3 b/doc/wordsplit.3
index 067ea5e..13b634b 100644
--- a/doc/wordsplit.3
+++ b/doc/wordsplit.3
@@ -1,4 +1,4 @@
-.\" This file is part of grecs -*- nroff -*-
+.\" This file is part of argot -*- nroff -*-
.\" Copyright (C) 2007-2016 Sergey Poznyakoff
.\"
.\" Grecs is free software; you can redistribute it and/or modify
@@ -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 WORDSPLIT 3 "December 3, 2014" "GRECS" "Grecs User Reference"
+.TH WORDSPLIT 3 "December 3, 2014" "ARGOT" "Grecs User Reference"
.SH NAME
wordsplit \- split string into words
.SH SYNOPSIS
@@ -971,7 +971,7 @@ char **shell_parse(char *s)
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
-Report bugs to <gray+grecs@gnu.org.ua>.
+Report bugs to <gray+argot@gnu.org.ua>.
.SH COPYRIGHT
Copyright \(co 2009-2014 Sergey Poznyakoff
.br

Return to:

Send suggestions and report system problems to the System administrator.