.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 turned on, 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Test::TempDir 3pm" .TH Test::TempDir 3pm "2016-02-21" "perl v5.22.1" "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" Test::TempDir \- (DEPRECATED) Temporary files support for testing .SH "VERSION" .IX Header "VERSION" version 0.10 .SH "DEPRECATION NOTICE" .IX Header "DEPRECATION NOTICE" There have been numerous issues found with this module, particularly with its use of locks (unreliable, may result in your entire \f(CW$TMPDIR\fR being deleted) and MSWin32 compatibility. As well, it uses Moose, which is nowadays considered to be heavier than necessary. .PP Test::TempDir::Tiny was written as a replacement. Please use it instead! .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Test::TempDir; \& \& my $test_tempdir = temp_root(); \& \& my ( $fh, $file ) = tempfile(); \& \& my $directory_scratch_obj = scratch(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Test::TempDir provides temporary directory creation with testing in mind. .PP The differences between using this and using File::Temp are: .IP "\(bu" 4 .Sp If \f(CW\*(C`t/tmp\*(C'\fR is available (writable, creatable, etc) it's preferred over \&\f(CW$ENV{TMPDIR}\fR etc. Otherwise a temporary directory will be used. .Sp This is \f(CW\*(C`temp_root\*(C'\fR .IP "\(bu" 4 Lock files are used on \f(CW\*(C`t/tmp\*(C'\fR, to prevent race conditions when running under a parallel test harness. .IP "\(bu" 4 The \f(CW\*(C`temp_root\*(C'\fR is cleaned at the end of a test run, but not if tests failed. .IP "\(bu" 4 \&\f(CW\*(C`temp_root\*(C'\fR is emptied at the beginning of a test run unconditionally. .IP "\(bu" 4 The default policy is not to clean the individual \f(CW\*(C`tempfiles\*(C'\fR and \f(CW\*(C`tempdirs\*(C'\fR within \f(CW\*(C`temp_root\*(C'\fR, in order to aid in debugging of failed tests. .SH "EXPORTS" .IX Header "EXPORTS" .ie n .SS """temp_root""" .el .SS "\f(CWtemp_root\fP" .IX Subsection "temp_root" The root of the temporary stuff. .ie n .SS """tempfile""" .el .SS "\f(CWtempfile\fP" .IX Subsection "tempfile" .ie n .SS """tempdir""" .el .SS "\f(CWtempdir\fP" .IX Subsection "tempdir" Wrappers for the File::Temp functions of the same name. .PP The default options are changed to use \f(CW\*(C`temp_root\*(C'\fR for \f(CW\*(C`DIR\*(C'\fR and disable \&\f(CW\*(C`CLEANUP\*(C'\fR, but these are overridable. .ie n .SS """scratch""" .el .SS "\f(CWscratch\fP" .IX Subsection "scratch" Loads Directory::Scratch and instantiates a new one, with the same default options as \f(CW\*(C`tempfile\*(C'\fR and \f(CW\*(C`tempdir\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "\(bu" 4 File::Temp, .IP "\(bu" 4 Directory::Scratch .IP "\(bu" 4 Path::Class .SH "AUTHOR" .IX Header "AUTHOR" \&\s-1XXXX XXX\s0'\s-1XX \s0(Yuval Kogman) .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2006 by \s-1XXXX XXX\s0'\s-1XX \s0(Yuval Kogman). .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" .IP "\(bu" 4 Karen Etheridge .IP "\(bu" 4 Florian Ragwitz