.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "BootStrap 3"
.TH BootStrap 3 2023-07-29 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::DNS::SEC::Tools::BootStrap \- Optional loading of Perl modules
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Net::DNS::SEC::Tools::BootStrap;
\&
\&  dnssec_tools_load_mods(
\&     PerlModule => \*(AqAdditional help/error text\*(Aq
\&  );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The DNSSEC-Tools package requires a number of Perl modules that are only
needed by some of the tools.  This module helps determine at run-time, rather
than at installation time, if the right tools are available on the system.
If any module fails to load, \fR\f(BIdnssec_tools_load_mods()\fR\fI\fR will display an
error message and calls \fI\fR\f(BIexit()\fR\fI\fR.  The error message describes how to
install a module via CPAN.
.PP
The arguments to \fR\f(BIdnssec_tools_load_mods()\fR\fI\fR are given in pairs.  Each pair is
a module to try to load (and import) and a supplemental error message.  If
the module fails to load, the supplemental error message will be displayed
along with the installation-via-CPAN message.  If the error message consists
of the string "noerror", then no error message will be displayed before the
function exits.
.SH CAVEATS
.IX Header "CAVEATS"
The module will try to import any exported subroutines from the
module into the \fImain\fR namespace.  This means that the \fIBootStrap.pm\fR
module is likely to not be useful for importing symbols into other modules.
Work-arounds for this are:
.IP "\- import the symbols by hand" 4
.IX Item "- import the symbols by hand"
.Vb 3
\&  dnssec_tools_load_mods(
\&     PerlModule => \*(AqAdditional help/error text\*(Aq
\&  );
\&
\&  import PerlModule qw(func1 func2);
\&
\&  func1(arg1, arg2);
.Ve
.IP "\- call the fully qualified function name" 4
.IX Item "- call the fully qualified function name"
.Vb 3
\&  dnssec_tools_load_mods(
\&     PerlModule => \*(AqAdditional help/error text\*(Aq
\&  );
\&
\&  PerlModule::func1(arg1, arg2);
.Ve
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2006\-2014 SPARTA, Inc.  All rights reserved.
See the COPYING file included with the DNSSEC-Tools package for details.
.SH AUTHOR
.IX Header "AUTHOR"
Wes Hardaker <hardaker@users.sourceforge.net>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
http://www.dnssec\-tools.org/