.\" -*- 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::Probe::Vcpkg 3"
.TH Alien::Build::Plugin::Probe::Vcpkg 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::Probe::Vcpkg \- Probe for system libraries using Vcpkg
.SH VERSION
.IX Header "VERSION"
version 2.80
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use alienfile;
\& 
\& plugin \*(AqProbe::Vcpkg\*(Aq => \*(Aqlibffi\*(Aq;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This plugin probe can be used to find "system" packages using Microsoft's \f(CW\*(C`Vcpkg\*(C'\fR package manager for
Visual C++ builds of Perl.  \f(CW\*(C`Vcpkg\*(C'\fR is a package manager for Visual C++ that includes a number of
open source packages.  Although \f(CW\*(C`Vcpkg\*(C'\fR does also support Linux and macOS, this plugin does not
support finding \f(CW\*(C`Vcpkg\*(C'\fR packages on those platforms.  For more details on \f(CW\*(C`Vcpkg\*(C'\fR, see the project
github page here:
.PP
<https://github.com/microsoft/vcpkg>
.PP
Here is the quick start guide for getting Alien::Build to work with \f(CW\*(C`Vpkg\*(C'\fR:
.PP
.Vb 5
\& # install Vcpkg
\& C:\e> git clone https://github.com/Microsoft/vcpkg.git
\& C:\e> cd vcpkg
\& C:\evcpkg> .\ebootstrap\-vcpkg.bat
\& C:\evcpkg> .\evcpkg integrate install
\& 
\& # update PATH to include the bin directory
\& # so that .DLL files can be found by Perl
\& C:\evcpkg> path c:\evcpkg\einstalled\ex64\-windows\ebin;%PATH%
\& 
\& # install the packages that you want
\& C:\evcpkg> .\evcpkg install libffi
\& 
\& # install the alien that uses it
\& C:\evcpkg> cpanm Alien::FFI
.Ve
.PP
If you are using 32 bit build of Perl, then substitute \f(CW\*(C`x86\-windows\*(C'\fR for \f(CW\*(C`x64\-windows\*(C'\fR.  If you do
not want to add the \f(CW\*(C`bin\*(C'\fR directory to the \f(CW\*(C`PATH\*(C'\fR, then you can use \f(CW\*(C`x64\-windows\-static\*(C'\fR instead,
which will provide static libraries.  (As of this writing static libraries for 32 bit Windows are not
available).  The main downside to using \f(CW\*(C`x64\-windows\-static\*(C'\fR is that Aliens that require dynamic
libraries for FFI will not be installable.
.PP
If you do not want to install \f(CW\*(C`Vcpkg\*(C'\fR user wide (the \f(CW\*(C`integrate install\*(C'\fR command above), then you
can use the \f(CW\*(C`PERL_WIN32_VCPKG_ROOT\*(C'\fR environment variable instead:
.PP
.Vb 5
\& # install Vcpkg
\& C:\e> git clone https://github.com/Microsoft/vcpkg.git
\& C:\e> cd vcpkg
\& C:\evcpkg> .\ebootstrap\-vcpkg.bat
\& C:\evcpkg> set PERL_WIN32_VCPKG_ROOT=c:\evcpkg
.Ve
.SH PROPERTIES
.IX Header "PROPERTIES"
.SS name
.IX Subsection "name"
Specifies the name of the Vcpkg.  This should not be used with the \f(CW\*(C`lib\*(C'\fR property below, choose only one.
.PP
This is the default property, so these two are equivalent:
.PP
.Vb 1
\& plugin \*(AqProbe::Vcpkg\*(Aq => (name => \*(Aqfoo\*(Aq);
.Ve
.PP
and
.PP
.Vb 1
\& plugin \*(AqProbe::Vcpkg\*(Aq => \*(Aqfoo\*(Aq;
.Ve
.SS lib
.IX Subsection "lib"
Specifies the list of libraries that make up the Vcpkg.  This should not be used with the \f(CW\*(C`name\*(C'\fR property
above, choose only one.  Note that using this detection method, the version number of the package will
not be automatically determined (since multiple packages could potentially make up the list of libraries),
so you need to determine the version number another way if you need it.
.PP
This must be an array reference.  Do not include the \f(CW\*(C`.lib\*(C'\fR extension.
.PP
.Vb 1
\& plugin \*(AqProbe::Vcpkg\*(Aq => (lib => [\*(Aqfoo\*(Aq,\*(Aqbar\*(Aq]);
.Ve
.SS ffi_name
.IX Subsection "ffi_name"
Specifies an alternate ffi_name for finding dynamic libraries.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Alien::Build, alienfile, Alien::Build::MM, Alien
.SH AUTHOR
.IX Header "AUTHOR"
Author: Graham Ollis <plicease@cpan.org>
.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.