/usr/local/lp/sonarperl/man/man3/ Current File: //usr/local/lp/sonarperl/man/man3/Perl::OSType.3
.\" -*- 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 "Perl::OSType 3"
.TH Perl::OSType 3 2019-02-18 "perl v5.38.0" "Perl Programmers Reference Guide"
.\" 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
Perl::OSType \- Map Perl operating system names to generic types
.SH VERSION
.IX Header "VERSION"
version 1.010
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Perl::OSType \*(Aq:all\*(Aq;
\&
\&  $current_type = os_type();
\&  $other_type = os_type(\*(Aqdragonfly\*(Aq); # gives \*(AqUnix\*(Aq
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Modules that provide OS-specific behaviors often need to know if
the current operating system matches a more generic type of
operating systems. For example, 'linux' is a type of 'Unix' operating system
and so is 'freebsd'.
.PP
This module provides a mapping between an operating system name as given by
\&\f(CW$^O\fR and a more generic type.  The initial version is based on the OS type
mappings provided in Module::Build and ExtUtils::CBuilder.  (Thus,
Microsoft operating systems are given the type 'Windows' rather than 'Win32'.)
.SH USAGE
.IX Header "USAGE"
No functions are exported by default. The export tag ":all" will export
all functions listed below.
.SS \fBos_type()\fP
.IX Subsection "os_type()"
.Vb 2
\&  $os_type = os_type();
\&  $os_type = os_type(\*(AqMSWin32\*(Aq);
.Ve
.PP
Returns a single, generic OS type for a given operating system name.  With no
arguments, returns the OS type for the current value of \f(CW$^O\fR.  If the
operating system is not recognized, the function will return the empty string.
.SS \fBis_os_type()\fP
.IX Subsection "is_os_type()"
.Vb 2
\&  $is_windows = is_os_type(\*(AqWindows\*(Aq);
\&  $is_unix    = is_os_type(\*(AqUnix\*(Aq, \*(Aqdragonfly\*(Aq);
.Ve
.PP
Given an OS type and OS name, returns true or false if the OS name is of the
given type.  As with \f(CW\*(C`os_type\*(C'\fR, it will use the current operating system as a
default if no OS name is provided.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP \(bu 4
Devel::CheckOS
.SH SUPPORT
.IX Header "SUPPORT"
.SS "Bugs / Feature Requests"
.IX Subsection "Bugs / Feature Requests"
Please report any bugs or feature requests through the issue tracker
at <https://github.com/Perl\-Toolchain\-Gang/Perl\-OSType/issues>.
You will be notified automatically of any progress on your issue.
.SS "Source Code"
.IX Subsection "Source Code"
This is open source software.  The code repository is available for
public review and contribution under the terms of the license.
.PP
<https://github.com/Perl\-Toolchain\-Gang/Perl\-OSType>
.PP
.Vb 1
\&  git clone https://github.com/Perl\-Toolchain\-Gang/Perl\-OSType.git
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
David Golden <dagolden@cpan.org>
.SH CONTRIBUTORS
.IX Header "CONTRIBUTORS"
.IP \(bu 4
Chris 'BinGOs' Williams <chris@bingosnet.co.uk>
.IP \(bu 4
David Golden <xdg@xdg.me>
.IP \(bu 4
Graham Ollis <plicease@cpan.org>
.IP \(bu 4
Jonas B. Nielsen <jonasbn@hoarfrost.local>
.IP \(bu 4
Owain G. Ainsworth <oga@nicotinebsd.org>
.IP \(bu 4
Paul Green <Paul.Green@stratus.com>
.IP \(bu 4
Piotr Roszatycki <piotr.roszatycki@gmail.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by David Golden.
.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.