25 Apr 2022 21:31:17 UTC
- Distribution: Devel-CheckOS
- Module version: 1.93
- Source (raw)
- Browse (raw)
- How to Contribute
- Issues (0)
- Testers (924 / 0 / 1)
- KwaliteeBus factor: 1
- 88.27% Coverage
- License: unknown, open_source
- Perl: v5.6.0
- Activity24 month
- Download (35.74KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest version
- USING IT IN Makefile.PL or Build.PL
- PLATFORMS SUPPORTED
- BUGS and FEEDBACK
- SEE ALSO
- SOURCE CODE REPOSITORY
- COPYRIGHT and LICENCE
Devel::CheckOS - check what OS we're running on
A learned sage once wrote on IRC:
$^O is stupid and ugly, it wears its pants as a hat
Devel::CheckOS provides a more friendly interface to $^O, and also lets you check for various OS "families" such as "Unix", which includes things like Linux, Solaris, AIX etc.
It spares perl the embarrassment of wearing its pants on its head by covering them with a splendid Fedora.
use Devel::CheckOS qw(os_is); print "Hey, I know this, it's a Unix system\n" if(os_is('Unix')); print "You've got Linux 2.6\n" if(os_is('Linux::v2_6'));
If you want to use this from Makefile.PL or Build.PL, do not simply copy the module into your distribution as this may cause problems when PAUSE and search.cpan.org index the distro. Instead, use the use-devel-assertos script.
Devel::CheckOS implements the following functions, which load subsidiary OS-specific modules on demand to do the real work. They can all be exported by listing their names after
use Devel::CheckOS. You can also export groups of functions thus:
use Devel::CheckOS qw(:booleans); # export the boolean functions # and 'die_unsupported' use Devel::CheckOS qw(:fatal); # export those that die on no match use Devel::CheckOS qw(:all); # export everything exportable
Takes a list of OS names. If the current platform matches any of them, it returns true, otherwise it returns false. The names can be a mixture of OSes and OS families, eg ...
os_is(qw(Unix VMS)); # Unix is a family, VMS is an OS
Matching is case-insensitive provided that Taint-mode is not enabled, so the above could also be written:
If the current platform matches (case-insensitively) any of the parameters it returns false, otherwise it returns true.
os_is(), except that it dies instead of returning false. The die() message matches what the CPAN-testers look for to determine if a module doesn't support a particular platform.
os_isnt(), except that it dies instead of returning false.
This function simply dies with the message "OS unsupported", which is what the CPAN testers look for to figure out whether a platform is supported or not.
When called in list context, return a list of all the platforms for which the corresponding Devel::AssertOS::* module is available. This includes both OSes and OS families, and both those bundled with this module and any third-party add-ons you have installed.
In scalar context, returns a hashref keyed by platform with the filename of the most recent version of the supporting module that is available to you. This behaviour is deprecated.
Unfortunately, on some platforms this list may have file case broken. eg, some platforms might return 'freebsd' instead of 'FreeBSD'. This is because they have case-insensitive filesystems so things should Just Work anyway.
This function does not work in taint-mode.
Takes the name of an OS 'family' and returns a list of all its members. In list context, you get a list, in scalar context you get an arrayref.
If called on something that isn't a family, you get an empty list (or a ref to an empty array).
It takes two arguments, the first being an alias name, the second being the name of an OS. After the alias has been registered, any queries about the alias will return the appropriate result for the named OS.
It returns true unless you invoke it incorrectly or you attempt to change an existing alias.
Aliases don't work under taint-mode.
To see the list of platforms for which information is available, run this:
perl -MDevel::CheckOS -e 'print join(", ", Devel::CheckOS::list_platforms())'
These are the names of the underlying Devel::AssertOS::* modules which do the actual platform detection, so they have to be 'legal' filenames and module names, which unfortunately precludes funny characters, so platforms like OS/2 are mis-spelt deliberately. Sorry.
Also be aware that not all of them have been properly tested. I don't have access to most of them and have had to work from information gleaned from perlport and a few other places. For a complete list of OS families, see Devel::CheckOS::Families.
If you want to add your own OSes or families, see Devel::AssertOS::Extending and please feel free to upload the results to the CPAN.
I welcome feedback about my code, including constructive criticism. Bug reports should be made using https://github.com/DrHyde/perl-modules-Devel-CheckOS/issues.
You will need to include in your bug report the exact value of $^O, what the OS is called (eg Windows Vista 64 bit Ultimate Home Edition), and, if relevant, what "OS family" it should be in and who wrote it.
If you are feeling particularly generous you can encourage me in my open source endeavours by buying me something from my wishlist: http://www.cantrell.org.uk/david/wishlist/
Version 1.90 made all matches case-insensitive. This is a change in behaviour, but if it breaks your code then your code was already broken, you just didn't know it.
At some point after April 2024 the
list_platformsfunctions will stop being sensitive to whether they are called in list context or not, and will always return a list. From now until then calling them in non-list context will emit a warning. You can turn that off by setting
$Devel::CheckOS::NoDeprecationWarnings::Contextto a true value.
$^O in perlvar
The use-devel-assertos script
David Cantrell <firstname.lastname@example.org>
Thanks to David Golden for the name and ideas about the interface, and to the cpan-testers-discuss mailing list for prompting me to write it in the first place.
Thanks to Ken Williams, from whose Module::Build I lifted some of the information about what should be in the Unix family.
Thanks to Billy Abbott for finding some bugs for me on VMS.
Thanks to Matt Kraai for information about QNX.
Thanks to Kenichi Ishigaki and Gabor Szabo for reporting a bug on Windows, and to the former for providing a patch.
Thanks to Paul Green for some information about VOS.
Thanks to Yanick Champoux for a patch to let Devel::AssertOS support negative assertions.
Thanks to Brian Fraser for adding Android support.
Thanks to Dale Evans for Debian detection, a bunch of Mac OS X specific version detection modules, and perl 5.6 support.
Thanks to Graham Knop for fixing a build bug on perl 5.8.
Copyright 2007-2022 David Cantrell
This software is free-as-in-speech software, and may be used, distributed, and modified under the terms of either the GNU General Public Licence version 2 or the Artistic Licence. It's up to you which one you use. The full text of the licences can be found in the files GPL2.txt and ARTISTIC.txt, respectively.
I recommend buying a Fedora from http://hatsdirect.com/.
This module is also free-as-in-mason software.
Module Install Instructions
To install Devel::CheckOS, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Devel::CheckOS
For more information on module installation, please visit the detailed CPAN module installation guide.