diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-05-27 00:29:52 +0300 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2011-05-27 00:29:52 +0300 |
commit | a7e344ee831c2199751756b6addf8a5cb4450f29 (patch) | |
tree | 525c16f4f131f10a6e262d0fb3ec574521068a9e | |
parent | dad50b5cddf6fb55bea2492dc98e82ecb4d13430 (diff) | |
download | cfpeek-a7e344ee831c2199751756b6addf8a5cb4450f29.tar.gz cfpeek-a7e344ee831c2199751756b6addf8a5cb4450f29.tar.bz2 |
Prepare for the release
-rw-r--r-- | NEWS | 6 | ||||
-rw-r--r-- | README | 53 | ||||
-rw-r--r-- | README-hacking | 4 | ||||
-rw-r--r-- | configure.ac | 2 | ||||
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/cfpeek.1 | 4 | ||||
-rw-r--r-- | doc/cfpeek.texi | 2 |
7 files changed, 63 insertions, 10 deletions
@@ -1,12 +1,14 @@ -Cfpeek NEWS -- history of user-visible changes. 2011-05-03 +Cfpeek NEWS -- history of user-visible changes. 2011-05-27 Copyright (C) 2011 Sergey Poznyakoff See the end of file for copying conditions. -Please send cfpeek bug reports to <gray+cfpeek@gnu.org.ua> +Please send cfpeek bug reports to <bug-cfpeek@gnu.org.ua> Version 1.0 (Git) +Initial revision + ========================================================================= Copyright information: @@ -2,13 +2,62 @@ Cfpeek README Copyright (C) 2011 Sergey Poznyakoff See the end of file for copying conditions. +* Introduction + +This file contains brief information about configuring, testing +and running Cfpeek. It is *not* intended as a replacement +for the documentation, instead it is provided as a brief reference +only. The complete documentation is available in doc/ subdirectory. +To read the manpage without installing the package use `man +doc/cfpeek.1'. To read texinfo documentation without installing the +package, run `info -f doc/cfpeek.info'. After the package is installed +the documentation can be accessed by running `man cfpeek' and +`info cfpeek'. + +An online copy of the documentation in various formats is available +at http://cfpeek.man.gnu.org.ua. + * Overview -FIXME +Many programs keep their configuration data in structured +configuration files. Examples of such files are mailutils.conf, +used by GNU Mailutils, named.conf, used by named, or ~/.gitconfig, +used by GIT. + +Cfpeek provides a uniform and consistent command line interface for +various operations on such files. It can be used to list such files +in a uniform output format, to retrieve configuration values, both by +literal keyword matches and by using wildcard patterns, to reformat +the files in arbitrary way, and to apply external scripts to each +statement in the file. + +* Building + +Usual building rules apply: + +./configure +make +make install + +Read the file INSTALL for a description of configure utility and its +generic options. Cfpeek-specific options are: + +** --with-guile + +Compile with Guile support. By default, this is enabled if configure +determines that a sufficiently new version of Guile (i.e. 1.8 or +newer) is installed. + +See http://www.gnu.org/software/guile for additional information on +Guile including file downloads. + +** --with-guile-site-dir[=DIR] +Specify a directory to install guile modules to. Without argument -- +use Guile-specific default directory. * Bug reporting. -Send bug reports to <gray+cfpeek@gnu.org.ua>. +Send bug reports to <bug-cfpeek@gnu.org.ua>. * Copyright information: diff --git a/README-hacking b/README-hacking index 3b58b42..0df2208 100644 --- a/README-hacking +++ b/README-hacking @@ -13,6 +13,8 @@ latest stable version. - Bison <http://www.gnu.org/software/bison/> - Flex <http://flex.sourceforge.net/> - M4 <http://www.gnu.org/software/m4/> +- Git <http://git.or.cz> +- Texinfo <http://www.gnu.org/software/texinfo> * Bootstrapping @@ -29,7 +31,7 @@ which are extracted from other source packages: ./bootstrap Once done, proceed as described in the file README (section -INSTALLATION). +Building). * Copyright information diff --git a/configure.ac b/configure.ac index 4416c03..44241f1 100644 --- a/configure.ac +++ b/configure.ac @@ -15,7 +15,7 @@ # along with cfpeek. If not, see <http://www.gnu.org/licenses/>. AC_PREREQ(2.63) -AC_INIT([cfpeek], 1.0, [gray+cfpeek@gnu.org.ua]) +AC_INIT([cfpeek], 1.0, [bug-cfpeek@gnu.org.ua]) AC_CONFIG_SRCDIR([src/cfpeek.c]) AC_CONFIG_AUX_DIR([build-aux]) AC_CONFIG_HEADER([config.h]) diff --git a/doc/Makefile.am b/doc/Makefile.am index 2cc6690..8058c32 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -63,7 +63,7 @@ manual: TEXINPUTS=$(srcdir):$(top_srcdir)/build-aux:$(TEXINPUTS) \ MAKEINFO="$(MAKEINFO) $(MAKEINFOFLAGS)" \ TEXI2DVI="$(TEXI2DVI) -t @finalout" \ - $(GENDOCS) --texi2html $(PACKAGE) '$(PACKAGE_NAME) manual' + $(GENDOCS) --texi2html --html "--I=$(top_srcdir)/@GRECS_SUBDIR@/doc" $(PACKAGE) '$(PACKAGE_NAME) manual' # Checking check-tabs: diff --git a/doc/cfpeek.1 b/doc/cfpeek.1 index bf85184..088774b 100644 --- a/doc/cfpeek.1 +++ b/doc/cfpeek.1 @@ -33,7 +33,7 @@ used by \fBGIT\fR. .PP .B Cfpeek provides a uniform and consistent command line interface for various -operations over such files. It can be used to retrieve configuration +operations on such files. It can be used to retrieve configuration values, both by literal keyword matches and by using wildcard patterns, to reformat the files in arbitrary way, and to apply an external script to each statement in the file. @@ -835,7 +835,7 @@ documentation is available from <http://www.gnu.org.ua/software/cfpeek>. .SH AUTHORS Sergey Poznyakoff .SH "BUG REPORTS" -Report bugs to <gray+cfpeek@gnu.org.ua>. +Report bugs to <bug-cfpeek@gnu.org.ua>. .SH COPYRIGHT Copyright \(co 2011 Sergey Poznyakoff .br diff --git a/doc/cfpeek.texi b/doc/cfpeek.texi index 1bbd03a..da319d0 100644 --- a/doc/cfpeek.texi +++ b/doc/cfpeek.texi @@ -1262,7 +1262,7 @@ scripting facility, see @ref{Scripts}. @node Reporting Bugs @chapter How to Report a Bug -Please, report bugs and suggestions to @email{gray+cfpeek@@gnu.org.ua}. +Please, report bugs and suggestions to @email{bug-cfpeek@@gnu.org.ua}. You hit a bug if at least one of the conditions below is met: |