NAME
Dpkg::Substvars - handle variable substitution in strings
DESCRIPTION
It provides some an object which is able to substitute variables in
strings.
METHODS
my $s = Dpkg::Substvars->new($file)
Create a new object that can do substitutions. By default it
contains generic substitutions like ${Newline}, ${Space},
${Tab}, ${dpkg:Version} and ${dpkg:Upstream-Version}.
Additional substitutions will be read from the $file passed as
parameter.
It keeps track of which substitutions were actually used (only
counting substvars(), not get()), and warns about unused
substvars when asked to. The substitutions that are always
present are not included in these warnings.
$s->set($key, $value)
Add/replace a substitution.
$s->get($key)
Get the value of a given substitution.
$s->delete($key)
Remove a given substitution.
$s->no_warn($key)
Prevents warnings about a unused substitution, for example if
it is provided by default.
$s->load($file)
Add new substitutions read from $file.
$s->parse($fh, $desc)
Add new substitutions read from the filehandle. $desc is used
to identify the filehandle in error messages.
$s->set_version_substvars($version)
Defines ${binary:Version}, ${source:Version} and
${source:Upstream-Version} based on the given version string.
These will never be warned about when unused.
$s->set_arch_substvars()
Defines architecture variables: ${Arch}.
This will never be warned about when unused.
$newstring = $s->substvars($string)
Substitutes variables in $string and return the result in
$newstring.
$s->warn_about_unused()
Issues warning about any variables that were set, but not used
$s->set_msg_prefix($prefix)
Define a prefix displayed before all warnings/error messages
output by the module.
$s->save($file)
Store all substitutions variables except the automatic ones in
the indicated file.
"$s" Return a string representation of all substitutions variables
except the automatic ones.
$str = $s->output($fh)
Print all substitutions variables except the automatic ones in
the filehandle and return the content written.
AUTHOR
Raphal Hertzog <hertzog@debian.org>.