Blame README

Packit 65f819
NAME
Packit 65f819
    Perl::OSType - Map Perl operating system names to generic types
Packit 65f819
Packit 65f819
VERSION
Packit 65f819
    version 1.010
Packit 65f819
Packit 65f819
SYNOPSIS
Packit 65f819
      use Perl::OSType ':all';
Packit 65f819
Packit 65f819
      $current_type = os_type();
Packit 65f819
      $other_type = os_type('dragonfly'); # gives 'Unix'
Packit 65f819
Packit 65f819
DESCRIPTION
Packit 65f819
    Modules that provide OS-specific behaviors often need to know if the
Packit 65f819
    current operating system matches a more generic type of operating
Packit 65f819
    systems. For example, 'linux' is a type of 'Unix' operating system and
Packit 65f819
    so is 'freebsd'.
Packit 65f819
Packit 65f819
    This module provides a mapping between an operating system name as given
Packit 65f819
    by $^O and a more generic type. The initial version is based on the OS
Packit 65f819
    type mappings provided in Module::Build and ExtUtils::CBuilder. (Thus,
Packit 65f819
    Microsoft operating systems are given the type 'Windows' rather than
Packit 65f819
    'Win32'.)
Packit 65f819
Packit 65f819
USAGE
Packit 65f819
    No functions are exported by default. The export tag ":all" will export
Packit 65f819
    all functions listed below.
Packit 65f819
Packit 65f819
  os_type()
Packit 65f819
      $os_type = os_type();
Packit 65f819
      $os_type = os_type('MSWin32');
Packit 65f819
Packit 65f819
    Returns a single, generic OS type for a given operating system name.
Packit 65f819
    With no arguments, returns the OS type for the current value of $^O. If
Packit 65f819
    the operating system is not recognized, the function will return the
Packit 65f819
    empty string.
Packit 65f819
Packit 65f819
  is_os_type()
Packit 65f819
      $is_windows = is_os_type('Windows');
Packit 65f819
      $is_unix    = is_os_type('Unix', 'dragonfly');
Packit 65f819
Packit 65f819
    Given an OS type and OS name, returns true or false if the OS name is of
Packit 65f819
    the given type. As with "os_type", it will use the current operating
Packit 65f819
    system as a default if no OS name is provided.
Packit 65f819
Packit 65f819
SEE ALSO
Packit 65f819
    *   Devel::CheckOS
Packit 65f819
Packit 65f819
SUPPORT
Packit 65f819
  Bugs / Feature Requests
Packit 65f819
    Please report any bugs or feature requests through the issue tracker at
Packit 65f819
    <https://github.com/Perl-Toolchain-Gang/Perl-OSType/issues>. You will be
Packit 65f819
    notified automatically of any progress on your issue.
Packit 65f819
Packit 65f819
  Source Code
Packit 65f819
    This is open source software. The code repository is available for
Packit 65f819
    public review and contribution under the terms of the license.
Packit 65f819
Packit 65f819
    <https://github.com/Perl-Toolchain-Gang/Perl-OSType>
Packit 65f819
Packit 65f819
      git clone https://github.com/Perl-Toolchain-Gang/Perl-OSType.git
Packit 65f819
Packit 65f819
AUTHOR
Packit 65f819
    David Golden <dagolden@cpan.org>
Packit 65f819
Packit 65f819
CONTRIBUTORS
Packit 65f819
    *   Chris 'BinGOs' Williams <chris@bingosnet.co.uk>
Packit 65f819
Packit 65f819
    *   David Golden <xdg@xdg.me>
Packit 65f819
Packit 65f819
    *   Graham Ollis <plicease@cpan.org>
Packit 65f819
Packit 65f819
    *   Jonas B. Nielsen <jonasbn@hoarfrost.local>
Packit 65f819
Packit 65f819
    *   Owain G. Ainsworth <oga@nicotinebsd.org>
Packit 65f819
Packit 65f819
    *   Paul Green <Paul.Green@stratus.com>
Packit 65f819
Packit 65f819
    *   Piotr Roszatycki <piotr.roszatycki@gmail.com>
Packit 65f819
Packit 65f819
COPYRIGHT AND LICENSE
Packit 65f819
    This software is copyright (c) 2016 by David Golden.
Packit 65f819
Packit 65f819
    This is free software; you can redistribute it and/or modify it under
Packit 65f819
    the same terms as the Perl 5 programming language system itself.
Packit 65f819