Rename the projectargot

1 files changed, 159 insertions, 0 deletions

diff --git a/doc/ARGOT_SETUP.3 b/doc/ARGOT_SETUP.3
new file mode 100644
index 0000000..3c18d1e
--- /dev/null
+++ b/doc/ARGOT_SETUP.3
@@ -0,0 +1,159 @@
+.\" This file is part of argot -*- nroff -*-
+.\" Copyright (C) 2007-2016 Sergey Poznyakoff
+.\"
+.\" Grecs is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 3, or (at your option)
+.\" any later version.
+.\"
+.\" Grecs is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with Grecs.  If not, see <http://www.gnu.org/licenses/>.
+.\"
+.TH ARGOT_SETUP 3 "August 13, 2012" "ARGOT" "Grecs User Reference"
+.SH NAME
+ARGOT_SETUP \- Initialize \fBargot\fR submodule.
+.SH SYNOPSIS
+.BI "ARGOT_SETUP(" "dir" ", " "options" ", " "pp-setup-file" )
+.SH DESCRIPTION
+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.
+.PP
+The 
+.I dir
+argument specifies the directory, relative to the source tree top,
+where \fBargot\fR has been cloned. If omitted, \fBargot\fR is assumed.
+.sp
+For example, if \fBargot\fR was cloned using the following command:
+.sp
+.nf
+    git clone ssh://git.gnu.org.ua/gitroot/argot.git lib/argot
+.fi
+.sp
+then the \fIdir\fR argument must be \fBlib/argot\fR.
+.PP
+The
+.I options
+argument is a space-separated list of options. The following options
+are understood:
+.TP
+.B all-parsers
+Compile all available parsers.
+.TP
+.B parser-bind
+Build the parser for BIND configuration files.
+.TP
+.B parser-dhcpd
+Build the parser for DHCPD configuration files.
+.TP
+.B parser-git
+Build the parser for GIT-style configuration files.
+.TP
+.B parser-meta1
+Build the parser for MeTA1 configuration files.
+.TP
+.B no-preproc
+Disable the use of preprocessor.
+.TP
+.B install
+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 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 \fBARGOT_INCLUDE_DIR\fR to the name of that directory.
+.TP
+.B std-pp-setup
+Install the standard \fBpp-setup\fR file.
+.TP
+.B pp-setup-option
+Add the
+.B --with-pp-setup-file
+option to the produced configuration file. This option allows user to
+control whether to install the \fBpp-setup\fR file.
+.TP
+.B tests
+Build tests.
+.TP
+.B getopt
+Add \fBgetopt.m4\fR to the distributed tarball. The file is located
+in \fIdir\fR/build-aux.
+.TP
+.B git2chg
+Add \fBgit2chg.awk\fR to the distributed tarball. The file is located
+in \fIdir\fR/build-aux.
+.TP
+.B syntax-doc
+Add \fBdoc/argot-syntax.texi\fR file to the distributed tarball. Use this
+if your texinfo documentation includes that file.
+.PP
+The
+.I pp-setup-file
+argument supplies the pathname of the alternative preprocessor
+setup file.  It is ignored if
+.B std-pp-setup option
+is given.
+.PP
+If neither
+.B std-pp-setup
+option, nor
+.I pp-setup-file
+parameter are supplied, no preprocessor setup file is installed.
+.SH EXAMPLE
+.SS "Default setup"
+.RS 4
+.nf
+ARGOT_SETUP
+.fi
+.RE
+.SS "Complex setup"
+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
+ARGOT_SETUP(lib/argot, [tests getopt], [$(top_srcdir)/src/pp-setup])
+.RE
+.SH "SEE ALSO"
+.BR getopt.m4 (5),
+.BR pp-setup (5).
+.SH AUTHORS
+Sergey Poznyakoff
+.SH "BUG REPORTS"
+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/argot>.
+.SH COPYRIGHT
+Copyright \(co 2011 Sergey Poznyakoff
+.br
+.na
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+.br
+.ad
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.\" Local variables:
+.\" eval: (add-hook 'write-file-hooks 'time-stamp)
+.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_]* [0-9] \""
+.\" time-stamp-format: "%:B %:d, %:y"
+.\" time-stamp-end: "\""
+.\" time-stamp-line-limit: 20
+.\" end:
+