.\" -*- 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 "Alien::Build::Plugin::Extract::Directory 3" .TH Alien::Build::Plugin::Extract::Directory 3 2023-07-25 "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 Alien::Build::Plugin::Extract::Directory \- Plugin to extract a downloaded directory to a build directory .SH VERSION .IX Header "VERSION" version 2.80 .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 2 \& use alienfile; \& plugin \*(AqExtract::Directory\*(Aq; .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" Some Download or Fetch plugins may produce a directory instead of an archive file. This plugin is used to mirror the directory from the Download step into a fresh directory in the Extract step. An example of when you might use this plugin is if you were using the \f(CW\*(C`git\*(C'\fR command in the Download step, which results in a directory hierarchy. .SH PROPERTIES .IX Header "PROPERTIES" .SS format .IX Subsection "format" Should always set to \f(CW\*(C`d\*(C'\fR (for directories). .SH METHODS .IX Header "METHODS" .SS handles .IX Subsection "handles" .Vb 2 \& Alien::Build::Plugin::Extract::Directory\->handles($ext); \& $plugin\->handles($ext); .Ve .PP Returns true if the plugin is able to handle the archive of the given format. Only returns true for \f(CW\*(C`d\*(C'\fR (for directory). .SS available .IX Subsection "available" .Vb 2 \& Alien::Build::Plugin::Extract::Directory\->available($ext); \& $plugin\->available($ext); .Ve .PP Returns true if the plugin can extract the given format with what is already installed. .SH "SEE ALSO" .IX Header "SEE ALSO" Alien::Build::Plugin::Extract::Negotiate, Alien::Build::Plugin::Extract::File, Alien::Build, alienfile, Alien::Build::MM, Alien .SH AUTHOR .IX Header "AUTHOR" Author: Graham Ollis .PP Contributors: .PP Diab Jerius (DJERIUS) .PP Roy Storey (KIWIROY) .PP Ilya Pavlov .PP David Mertens (run4flat) .PP Mark Nunberg (mordy, mnunberg) .PP Christian Walde (Mithaldu) .PP Brian Wightman (MidLifeXis) .PP Zaki Mughal (zmughal) .PP mohawk (mohawk2, ETJ) .PP Vikas N Kumar (vikasnkumar) .PP Flavio Poletti (polettix) .PP Salvador Fandiño (salva) .PP Gianni Ceccarelli (dakkar) .PP Pavel Shaydo (zwon, trinitum) .PP Kang-min Liu (劉康民, gugod) .PP Nicholas Shipp (nshp) .PP Juan Julián Merelo Guervós (JJ) .PP Joel Berger (JBERGER) .PP Petr Písař (ppisar) .PP Lance Wicks (LANCEW) .PP Ahmad Fatoum (a3f, ATHREEF) .PP José Joaquín Atria (JJATRIA) .PP Duke Leto (LETO) .PP Shoichi Kaji (SKAJI) .PP Shawn Laffan (SLAFFAN) .PP Paul Evans (leonerd, PEVANS) .PP Håkon Hægland (hakonhagland, HAKONH) .PP nick nauwelaerts (INPHOBIA) .PP Florian Weimer .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2011\-2022 by Graham Ollis. .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.