.\" -*- 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 "Test2::Tools::GenTemp 3pm"
.TH Test2::Tools::GenTemp 3pm 2024-05-08 "perl v5.38.2" "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
Test2::Tools::GenTemp \- Tool for generating a populated temp directory.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This exports a tool that helps you make a temporary directory, nested
directories and text files within.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Test2::Tools::GenTemp qw/gen_temp/;
\&
\&    my $dir = gen_temp(
\&        a_file => "Contents of a_file",
\&        a_dir  => {
\&            \*(Aqa_file\*(Aq => \*(AqContents of a_dir/afile\*(Aq,
\&            a_nested_dir => { ... },
\&        },
\&        ...
\&    );
\&
\&    done_testing;
.Ve
.SH EXPORTS
.IX Header "EXPORTS"
All subs are exported by default.
.IP "gen_temp(file => 'content', subdir => [ sub_dir_file => 'content', ...], ...)" 4
.IX Item "gen_temp(file => 'content', subdir => [ sub_dir_file => 'content', ...], ...)"
.PD 0
.IP "gen_temp(\-tempdir => \e@TEMPDIR_ARGS, file => 'content', subdir => [ sub_dir_file => 'content', ...], ...)" 4
.IX Item "gen_temp(-tempdir => @TEMPDIR_ARGS, file => 'content', subdir => [ sub_dir_file => 'content', ...], ...)"
.PD
This will generate a new temporary directory with all the files and subdirs you
specify, recursively. The initial temp directory is created using
\&\f(CWFile::Temp::tempdir()\fR, you may pass arguments to tempdir using the
\&\f(CW\*(C`\-tempdir => [...]\*(C'\fR argument.
.SH SOURCE
.IX Header "SOURCE"
The source code repository for Test2\-Suite can be found at
\&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
.SH MAINTAINERS
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH AUTHORS
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2018 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR