Name

Suggest — check existence of a capability

SYNOPSIS

type type-specific-value ...

DESCRIPTION

Just like Require or Capability, this directive checks for a feature or capability. When the tested feature is missing, a warning message is shown.

"Capabilities" you can suggest are:

  • globalsub — existence of a GlobalSub

  • sub — existence of a Sub

  • taggroup — existence of a TagGroup

  • usertag — existence of a UserTag

  • module (or perlmodule) — existence of a Perl module. Optional additional argument is the custom Perl module path.

  • include (or perlinclude) — prepend specified path to Perl's @INC include path (makes most sense with Require, not with Suggest or Capability even though it can be called that way for equivalent effect)

  • file — existence of a readable file

  • executable — existence of an executable file

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive,
Catalog directive

EXAMPLES

Example: Suggesting existence of all supported items

Suggest globalsub my_global_sub
Suggest sub my_sub
Suggest taggroup :group1,:group2 :group3
Suggest usertag my_global_usertag
Suggest usertag my_catalog_usertag
Suggest module Archive::Zip
Suggest module Set::Crontab /usr/local/perl/modules/
Suggest file /etc/syslog.conf
Suggest file relative-dir/file
Suggest executable /usr/local/bin/gfont
Suggest executable bin/gfont

Example: Testing for existence of old-style Perl modules

Suggest module /path/to/module.pl

Example: Testing for features

Suggest module    Archive::Zip
Suggest usertag   table_editor
Suggest globalsub file_info
Suggest module    Business::UPS

NOTES

AVAILABILITY

Suggest is available in Interchange versions:

4.6.0-5.7.0 (git-head)

SOURCE

Interchange 5.7.0:

Source: lib/Vend/Config.pm
Line 402

['Suggest',       'suggest',       ''],

Source: lib/Vend/Config.pm
Line 550

['Suggest',       'suggest',       ''],

Source: lib/Vend/Config.pm
Line 2681 (context shows lines 2681-2683)

sub parse_suggest {
return parse_require(@_, 1);
}

AUTHORS

Interchange Development Group

SEE ALSO

Require(7ic), Capability(7ic)

DocBook! Interchange!