Devel::CheckOS(3p)

NAME
Devel::CheckOS - check what OS we're running on

DESCRIPTION
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.

SYNOPSIS
    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'));

USING IT IN Makefile.PL or Build.PL
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.

FUNCTIONS
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

  Boolean functions
os_is

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:

    os_is(qw(unix vms));

os_isnt

If the current platform matches (case-insensitively) any of the parameters it returns false, otherwise it returns true.

  Fatal functions
die_if_os_isnt

As 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.

die_if_os_is

As os_isnt(), except that it dies instead of returning false.

  And some utility functions ...
die_unsupported

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.

list_platforms

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.

Unfortunately, on some platforms this list may have platform names' case broken, eg you might see '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.

list_family_members

Takes the name of an OS 'family' and returns a list of all its members.

If called on something that isn't a family, you get an empty list.

register_alias

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.

See Devel::AssertOS::Extending.

PLATFORMS SUPPORTED
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.

BUGS and FEEDBACK
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/>

COMPATIBILITY
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.

As of version 2.00 the list_* functions always return plain old lists. Calling them in scalar context was deprecated and has emitted warnings for over 2 years, since version 1.90.

SEE ALSO
$^O in perlvar

perlport

Devel::AssertOS

Devel::AssertOS::Extending

Probe::Perl

The use-devel-assertos script

Module::Install::AssertOS

AUTHOR
David Cantrell <david@cantrell.org.uk>

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.

Thanks to Alceu Rodrigues de Freitas Junior for improving Ubuntu detection and providing a way to detect a lot more Linux variants.

Thanks to Leos Stejskal for https://github.com/stejskalleos/os_release from which I got many sample /etc/os-release files.

SOURCE CODE REPOSITORY
<git://github.com/DrHyde/perl-modules-Devel-CheckOS.git>

COPYRIGHT and LICENCE
Copyright 2024 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.

HATS
I recommend buying a Fedora from <http://hatsdirect.com/>.

CONSPIRACY
This module is also free-as-in-mason software.