.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.38.2.
.TH CFGET "1" "July 2010" "cfget 0.15" "User Commands"
.SH NAME
cfget \- get values from a config file
.SH SYNOPSIS
.B cfget
[\fIoptions\fR] \fIsection/key\fR
.br
.B cfget
[\fIoptions\fR] \fI--dump=STYLE \fR[\fIsection/key \fR[\fIsection/key\fR...]]
.br
.B cfget
[\fIoptions\fR] \fI--template=STYLE \fR[\fIinfile \fR[\fIoutfile\fR]]
.SH DESCRIPTION
Get values from a config file.
.PP
cfget is a simple tool to read values from configuration files.  It is
useful, for example, to create configurable shellscripts or makefiles.
.P
It can also be configured to support virtual configuration values that, if not
present in the config file, are automatically computed from the existing
values. This makes it convenient, for example, to get a "duration" value from
a configuration file that only contains a "start date" and an "end date".
.SH OPTIONS
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-q\fR, \fB\-\-quiet\fR
quiet mode: only output fatal errors
.TP
\fB\-v\fR, \fB\-\-verbose\fR
verbose mode
.TP
\fB\-\-debug\fR
verbose mode
.TP
\fB\-C\fR file, \fB\-\-cfg\fR=\fIfile\fR
config file to read; the option can be given more than
once to read more than one file. If missing, read a
colon separated list from the CFGET_CFG env variable.
.TP
\fB\-P\fR file, \fB\-\-plugin\fR=\fIfile\fR
list of plugin files or directories to load. The
option can be given more than once to read more than
one file. If missing, read a colon separated list from
the CFGET_PLUGINS env variable.
.TP
\fB\-d\fR name, \fB\-\-dump\fR=\fIname\fR
dump the contents of the database using the given
style. Use '\-\-dump=list' for a list of available
styles. If one or more paths are provided in the
command line, dump only those paths, otherwise dump
all.
.TP
\fB\-t\fR name, \fB\-\-template\fR=\fIname\fR
read a template file, expand template placeholders
using the configuration data and output the result.
Use '\-\-template=list' for a list of available styles.
.TP
\fB\-f\fR name, \fB\-\-format\fR=\fIname\fR
use a custom configuration file format (default: ini).
Use '\-\-format=list' for a list of available formats.
The CFGET_FORMAT environment value, if defined, can be
used to provide a different default value.
.TP
\fB\-r\fR path, \fB\-\-root\fR=\fIpath\fR
restrict all work to values under the given path
.SH EXAMPLES
.nf
	# Get a key from a config file
	cfget \-C file.ini general/name

	# More can be specified, they will be searched in order
	cfget \-C general.ini \-C local.ini general/name

	# Use a plugin to add virtual entries
	cfget \-C file.ini \-\-plugin=virtual.py general/name

	# A plugin can also a directory containing .py files
	# and plugins can also be specified more than once
	cfget \-C file.ini \-\-plugin=virtual.py \-\-plugin=virtual/ general/name

	# In a shellscript, you may want to use environment variables if you
	# invoke cfget many times:
	#!/bin/sh
	CFGET_CFG=general.ini:local.ini
	CFGET_PLUGINS=virtual.py:virtual/
	START=`cfget general/start`
	END=`cfget general/end`
	DURATION=`cfget general/duration`

	# Quick way to copy all config values to the environment
	eval `cfget \-\-dump=exports \-C file.ini`

	# Autoconf-style template substitution
	cfget \-\-template=autoconf \-C file.ini script.in script

	# Curly braces substitute literally
	cfget \-C file.ini "general/start_{general/type}"

	# One can use simple expressions
	cfget \-C file.ini "general/start + general/duration"
	cfget \-C file.ini "round(general/age / 2)"
.fi

.SH AUTHOR
\fBcfget\fP has been written by Enrico Zini <enrico@enricozini.org>.