* Overview

Xenv is a text preprocessor.  It reads input from files (or the
standard input, if none are supplied) and prints it on the standard
output, replacing references to environment variables with their actual
values.

Variables are referenced using POSIX-compatible shell syntax: $NAME,
${NAME}, ${NAME:-word}, ${NAME+=word}, ${NAME:=word}, ${NAME:?word}.

A special ternary construct is provided: ${NAME:|word1|word2}, which
substitutes the expansion of word1 if NAME is set and the expansion of
word2 otherwise.

A bash-like construct ${NAME/PATTERN/STRING} expands to the value of
the variable NAME with the first occurrence (or all occurrences) of
PATTERN replaced with STRING.

Conditional preprocessor statements are provided, which allow parts of
input to be excluded depending on value of an environment variable or
exit code of an external command.

For a detailed discussion, please see the documentation.  If you
have GNU texinfo system installed, run `info -f ./xenv.info' from the
top-level source directory.  An online copy of the xenv documentation
is available at https://www.gnu.org.ua/software/xenv/.  A manual page 
xenv(1) is also provided (available online at https://man.gnu.org.ua/1/xenv).

* Bug reports

Send bug reports and suggestions to <gray@gnu.org>.  Be sure to
mention "xenv" somewhere in the Subject line.

* Compiling

The usual procedure applies:

  ./configure
  make
  make install

The last command will install xenv in /usr/local/bin by default.  To
change this, use the --prefix option, e.g.:

  ./configute --prefix=/usr

For a detailed discussion of generic configure options, refer to:
https://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.71/html_node/Running-configure-Scripts.html

* Building from git sources

If you have cloned the package from git, you will need the following
tools to build it:

** Flex
** A C compiler
** make
** GNU autoconf and automake

First, bootstrap the project by running

  autoreconf -f -i -s

Once done, proceed as described above.

* Downloading and other links

Xenv can be downloaded from

  https://download.gnu.org.ua/release/xenv

Online documentation is available at:

  https://www.gnu.org.ua/software/xenv/

Project's git repository:

  https://git.gnu.org.ua/cgit/xenv.git/

Development page:

  https://puszcza.gnu.org.ua/projects/xenv/


* Copyright information:

Copyright (C) 2021-2023 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:
