Andy Wardley > AppConfig > AppConfig::Sys

Download:
AppConfig-1.66.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  31
Open  7
View/Report Bugs
Module Version: 1.65   Source  

NAME ^

AppConfig::Sys - Perl5 module defining platform-specific information and methods for other AppConfig::* modules.

SYNOPSIS ^

    use AppConfig::Sys;
    my $sys = AppConfig::Sys->new();

    @fields = $sys->getpwuid($userid);
    @fields = $sys->getpwnam($username);

OVERVIEW ^

AppConfig::Sys is a Perl5 module provides platform-specific information and operations as required by other AppConfig::* modules.

AppConfig::Sys is distributed as part of the AppConfig bundle.

DESCRIPTION ^

USING THE AppConfig::Sys MODULE

To import and use the AppConfig::Sys module the following line should appear in your Perl script:

     use AppConfig::Sys;

AppConfig::Sys is implemented using object-oriented methods. A new AppConfig::Sys object is created and initialised using the AppConfig::Sys->new() method. This returns a reference to a new AppConfig::Sys object.

    my $sys = AppConfig::Sys->new();

This will attempt to detect your operating system and create a reference to a new AppConfig::Sys object that is applicable to your platform. You may explicitly specify an operating system name to override this automatic detection:

    $unix_sys = AppConfig::Sys->new("Unix");

Alternatively, the package variable $AppConfig::Sys::OS can be set to an operating system name. The valid operating system names are: Win32, VMS, Mac, OS2 and Unix. They are not case-specific.

AppConfig::Sys METHODS

AppConfig::Sys defines the following methods:

getpwnam()

Calls the system function getpwnam() if available and returns the result. Returns undef if not available. The can_getpwnam() method can be called to determine if this function is available.

getpwuid()

Calls the system function getpwuid() if available and returns the result. Returns undef if not available. The can_getpwuid() method can be called to determine if this function is available.

AUTHOR ^

Andy Wardley, <abw@wardley.org>

COPYRIGHT ^

Copyright (C) 1997-2007 Andy Wardley. All Rights Reserved.

Copyright (C) 1997,1998 Canon Research Centre Europe Ltd.

This module is free software; you can redistribute it and/or modify it under the term of the Perl Artistic License.

SEE ALSO ^

AppConfig, AppConfig::File

syntax highlighting: