Dpkg::Substvars man page on ElementaryOS

Man page or keyword search:  
man Server   4994 pages
apropos Keyword Search (all sections)
Output format
ElementaryOS logo
[printable version]

Dpkg::Substvars(3)		 libdpkg-perl		    Dpkg::Substvars(3)

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->set_as_used($key, $value)
	       Add/replace a substitution and mark it as used (no warnings
	       will be produced even if unused).

       $s->get($key)
	       Get the value of a given substitution.

       $s->delete($key)
	       Remove a given substitution.

       $s->mark_as_used($key)
	       Prevents warnings about a unused substitution, for example if
	       it is provided by default.

       $s->no_warn($key)
	       Obsolete function, use mark_as_used() instead.

       $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($sourceversion, $binaryversion)
	       Defines ${binary:Version}, ${source:Version} and
	       ${source:Upstream-Version} based on the given version strings.

	       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
       Raphaƫl Hertzog <hertzog@debian.org>.

1.17.5				  2013-12-10		    Dpkg::Substvars(3)
[top]

List of man pages available for ElementaryOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
...................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net