summaryrefslogtreecommitdiffabout
path: root/README
blob: 67fdc88b5234702a976e8d1813b443f9151b65d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
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

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 <bug-cfpeek@gnu.org.ua>. 


* Copyright information:

Copyright (C) 2011 Sergey Poznyakoff

   Permission is granted to anyone to make or distribute verbatim copies
   of this document as received, in any medium, provided that the
   copyright notice and this permission notice are preserved,
   thus giving the recipient permission to redistribute in turn.

   Permission is granted to distribute modified versions
   of this document, or of portions of it,
   under the above conditions, provided also that they
   carry prominent notices stating who last changed them.


Local Variables:
mode: outline
paragraph-separate: "[ 	]*$"
version-control: never
End:

Return to:

Send suggestions and report system problems to the System administrator.