diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-05-04 20:10:36 +0300 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-05-04 21:41:39 +0300 |
commit | a60eb4b18345626a84e23784d77ca231812e1dff (patch) | |
tree | 80192afeadd44b073958c2762491cc7dfea778a1 /doc/GRECS_SETUP.3 | |
parent | b65bfa7564f564f85d3c595c6c1030af2acf5056 (diff) | |
download | grecs-a60eb4b18345626a84e23784d77ca231812e1dff.tar.gz grecs-a60eb4b18345626a84e23784d77ca231812e1dff.tar.bz2 |
Improve docs. Add an option to create installable distribution.
Diffstat (limited to 'doc/GRECS_SETUP.3')
-rw-r--r-- | doc/GRECS_SETUP.3 | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/doc/GRECS_SETUP.3 b/doc/GRECS_SETUP.3 new file mode 100644 index 0000000..23c0ad5 --- /dev/null +++ b/doc/GRECS_SETUP.3 @@ -0,0 +1,131 @@ +.\" This file is part of grecs -*- nroff -*- +.\" Copyright (C) 2007, 2009-2011 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/>. +.\" This file is part of SLB. +.\" Copyright (C) 2011 Sergey Poznyakoff +.\" +.TH GRECS_SETUP 3 "May 4, 2011" "GRECS" "Grecs User Reference" +.SH NAME +GRECS_SETUP \- Initialize \fBgrecs\fR submodule. +.SH SYNOPSIS +.BI "GRECS_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 +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 \fBgrecs\fR has been cloned. If omitted, \fBgrecs\fR is assumed. +.sp +For example, if \fBgrecs\fR was cloned using the following command: +.sp +.nf + git clone ssh://git.gnu.org.ua/gitroot/grecs.git lib/grecs +.fi +.sp +then the \fIdir\fR argument must be \fBlib/grecs\fR. +.PP +The +.I options +argument is a space-separated list of options. The following options +are understood: +.TP +.B no-preproc +Disable the use of preprocessor. +.TP +.B install +Create and install shared library \fBlibgrecs.so\fR. Install the +documentation as well. +.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. +.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 +GRECS_SETUP +.fi +.RE +.SS "Complex setup" +The library sources are in \fBlib/grecs\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]) +.RE +.SH "SEE ALSO" +.BR getopt.m4 (5), +.BR pp-setup (5). +.SH AUTHORS +Sergey Poznyakoff +.SH "BUG REPORTS" +Report bugs to <gray+grecs@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>. +.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: + |