NAME

Mac::SystemDirectory - Locate Mac OS X Standard System Directories

SYNOPSIS

use Mac::SystemDirectory qw[:all];

$path = FindDirectory(NSDocumentDirectory);
$path = HomeDirectory();
$path = TemporaryDirectory();

DESCRIPTION

Locate Mac OS X Standard System Directories

FUNCTIONS

FindDirectory(Directory [, DomainMask])

Creates a list of path strings for the specified directories in the specified domains. The list is in the order in which you should search the directories.

Usage

$path  = FindDirectory(NSApplicationDirectory);
@paths = FindDirectory(NSApplicationDirectory);

Arguments

Directory: "Directory" constant.
DomainMask (optional): "DomainMask" constant. Defaults to NSUserDomainMask.

Returns

When called in scalar context this function returns the first matching directory. In list context it returns all matching directories. If no directories are found, undef is returned in a scalar context and an empty list in a list context.

HomeDirectory()

Path to the current user's home directory.

Usage

$path = HomeDirectory();

Returns

A string containing the path of the current user's home directory.

TemporaryDirectory()

Path to the current user's temporary directory.

Usage

$path = TemporaryDirectory();

Returns

A string containing the path of the temporary directory for the current user. If no such directory is currently available, returns undef.

CONSTANTS

DomainMask

Bitmask constants that identify the file-system domain (User, System, Local, Network) or all domains.

NSUserDomainMask

The user's home directory-the place to install user's personal items (~).