Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Tools::GenTemp.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::Tools::GenTemp 3pm"
61 .TH Test2::Tools::GenTemp 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::Tools::GenTemp \- Tool for generating a populated temp directory.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This exports a tool that helps you make a temporary directory, nested
71 directories and text files within.
72 .SH SYNOPSIS
73 .IX Header "SYNOPSIS"
74 .Vb 1
75 \& use Test2::Tools::GenTemp qw/gen_temp/;
76 \&
77 \& my $dir = gen_temp(
78 \& a_file => "Contents of a_file",
79 \& a_dir => {
80 \& \*(Aqa_file\*(Aq => \*(AqContents of a_dir/afile\*(Aq,
81 \& a_nested_dir => { ... },
82 \& },
83 \& ...
84 \& );
85 \&
86 \& done_testing;
87 .Ve
88 .SH EXPORTS
89 .IX Header "EXPORTS"
90 All subs are exported by default.
91 .IP "gen_temp(file => \*(Aqcontent\*(Aq, subdir => [ sub_dir_file => \*(Aqcontent\*(Aq, ...], ...)" 4
92 .IX Item "gen_temp(file => 'content', subdir => [ sub_dir_file => 'content', ...], ...)"
93 .PD 0
94 .IP "gen_temp(\-tempdir => \e@TEMPDIR_ARGS, file => \*(Aqcontent\*(Aq, subdir => [ sub_dir_file => \*(Aqcontent\*(Aq, ...], ...)" 4
95 .IX Item "gen_temp(-tempdir => @TEMPDIR_ARGS, file => 'content', subdir => [ sub_dir_file => 'content', ...], ...)"
96 .PD
97 This will generate a new temporary directory with all the files and subdirs you
98 specify, recursively. The initial temp directory is created using
99 \&\f(CWFile::Temp::tempdir()\fR, you may pass arguments to tempdir using the
100 \&\f(CW\*(C`\-tempdir => [...]\*(C'\fR argument.
101 .SH SOURCE
102 .IX Header "SOURCE"
103 The source code repository for Test2\-Suite can be found at
104 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
105 .SH MAINTAINERS
106 .IX Header "MAINTAINERS"
107 .IP "Chad Granum <[email protected]>" 4
108 .IX Item "Chad Granum <[email protected]>"
109 .SH AUTHORS
110 .IX Header "AUTHORS"
111 .IP "Chad Granum <[email protected]>" 4
112 .IX Item "Chad Granum <[email protected]>"
113 .SH COPYRIGHT
114 .IX Header "COPYRIGHT"
115 Copyright Chad Granum <[email protected]>.
116 .PP
117 This program is free software; you can redistribute it and/or
118 modify it under the same terms as Perl itself.
119 .PP
120 See \fIhttp://dev.perl.org/licenses/\fR