Platform Neutrality¶

In the Unix world, many different types of data can be mixed together in your home directory (although on some Unix platforms this is no longer the case, particularly for "desktop"-oriented platforms).

On some non-Unix platforms, separate directories are allocated for different types of data and have been for a long time.

When writing applications on top of File::HomeDir, you should thus always try to use the most specific method you can. User documents should be saved in "my_documents", data that supports an application but isn't normally editing by the user directory should go into "my_data".

On platforms that do not make any distinction, all these different methods will harmlessly degrade to the main home directory, but on platforms that care File::HomeDir will always try to Do The Right Thing(tm).

my_home¶

The "my_home" method takes no arguments and returns the main home/profile directory for the current user.

If the distinction is important to you, the term "current" refers to the real user, and not the effective user.

This is also the case for all of the other "my" methods.

Returns the directory path as a string, "undef" if the current user does not have a home directory, or dies on error.

my_desktop¶

The "my_desktop" method takes no arguments and returns the "desktop" directory for the current user.

Due to the diversity and complexity of implementations required to deal with implementing the required functionality fully and completely, the "my_desktop" method may or may not be implemented on each platform.

That said, I am extremely interested in code to implement "my_desktop" on Unix, as long as it is capable of dealing (as the Windows implementation does) with internationalization. It should also avoid false positive results by making sure it only returns the appropriate directories for the appropriate platforms.

Returns the directory path as a string, "undef" if the current user does not have a desktop directory, or dies on error.

my_documents¶

The "my_documents" method takes no arguments and returns the directory (for the current user) where the user's documents are stored.

Returns the directory path as a string, "undef" if the current user does not have a documents directory, or dies on error.

my_music¶

The "my_music" method takes no arguments and returns the directory where the current user's music is stored.

No bias is made to any particular music type or music program, rather the concept of a directory to hold the user's music is made at the level of the underlying operating system or (at least) desktop environment.

Returns the directory path as a string, "undef" if the current user does not have a suitable directory, or dies on error.

my_pictures¶

The "my_pictures" method takes no arguments and returns the directory where the current user's pictures are stored.

No bias is made to any particular picture type or picture program, rather the concept of a directory to hold the user's pictures is made at the level of the underlying operating system or (at least) desktop environment.

Returns the directory path as a string, "undef" if the current user does not have a suitable directory, or dies on error.

my_videos¶

The "my_videos" method takes no arguments and returns the directory where the current user's videos are stored.

No bias is made to any particular video type or video program, rather the concept of a directory to hold the user's videos is made at the level of the underlying operating system or (at least) desktop environment.

Returns the directory path as a string, "undef" if the current user does not have a suitable directory, or dies on error.

my_data¶

The "my_data" method takes no arguments and returns the directory where local applications should store their internal data for the current user.

Generally an application would create a subdirectory such as ".foo", beneath this directory, and store its data there. By creating your directory this way, you get an accurate result on the maximum number of platforms. But see the documentation about "my_dist_config()" or "my_dist_data()" below.

For example, on Unix you get "~/.foo" and on Win32 you get "~/Local Settings/Application Data/.foo"

Returns the directory path as a string, "undef" if the current user does not have a data directory, or dies on error.

my_dist_config¶

  File::HomeDir->my_dist_config( $dist [, \%params] );
  
  # For example...
  
  File::HomeDir->my_dist_config( 'File-HomeDir' );
  File::HomeDir->my_dist_config( 'File-HomeDir', { create => 1 } );

The "my_dist_config" method takes a distribution name as argument and returns an application-specific directory where they should store their internal configuration.

The base directory will be either "my_config" if the platform supports it, or "my_documents" otherwise. The subdirectory itself will be "BASE/Perl/Dist-Name". If the base directory is the user's home directory, "my_dist_config" will be in "~/.perl/Dist-Name" (and thus be hidden on all Unixes).

The optional last argument is a hash reference to tweak the method behaviour. The following hash keys are recognized:

•

create

Passing a true value to this key will force the creation of the directory if it doesn't exist (remember that "File::HomeDir"'s policy is to return "undef" if the directory doesn't exist).

Defaults to false, meaning no automatic creation of directory.

my_dist_data¶

  File::HomeDir->my_dist_data( $dist [, \%params] );
  
  # For example...
  
  File::HomeDir->my_dist_data( 'File-HomeDir' );
  File::HomeDir->my_dist_data( 'File-HomeDir', { create => 1 } );

The "my_dist_data" method takes a distribution name as argument and returns an application-specific directory where they should store their internal data.

This directory will be of course a subdirectory of "my_data". Platforms supporting data-specific directories will use "DATA_DIR/perl/dist/Dist-Name" following the common "DATA/vendor/application" pattern. If the "my_data" directory is the user's home directory, "my_dist_data" will be in "~/.perl/dist/Dist-Name" (and thus be hidden on all Unixes).

The optional last argument is a hash reference to tweak the method behaviour. The following hash keys are recognized:

•

create

Passing a true value to this key will force the creation of the directory if it doesn't exist (remember that "File::HomeDir"'s policy is to return "undef" if the directory doesn't exist).

Defaults to false, meaning no automatic creation of directory.

users_home¶

  $home = File::HomeDir->users_home('foo');

The "users_home" method takes a single parameter and is used to locate the parent home/profile directory for an identified user on the system.

While most of the time this identifier would be some form of user name, it is permitted to vary per-platform to support user ids or UUIDs as applicable for that platform.

Returns the directory path as a string, "undef" if that user does not have a home directory, or dies on error.

users_documents¶

  $docs = File::HomeDir->users_documents('foo');

Returns the directory path as a string, "undef" if that user does not have a documents directory, or dies on error.

users_data¶

  $data = File::HomeDir->users_data('foo');

Returns the directory path as a string, "undef" if that user does not have a data directory, or dies on error.

users_desktop¶

  $docs = File::HomeDir->users_desktop('foo');

Returns the directory path as a string, "undef" if that user does not have a desktop directory, or dies on error.

users_music¶

  $docs = File::HomeDir->users_music('foo');

Returns the directory path as a string, "undef" if that user does not have a music directory, or dies on error.

users_pictures¶

  $docs = File::HomeDir->users_pictures('foo');

Returns the directory path as a string, "undef" if that user does not have a pictures directory, or dies on error.

users_videos¶

  $docs = File::HomeDir->users_videos('foo');

Returns the directory path as a string, "undef" if that user does not have a videos directory, or dies on error.

home¶

  use File::HomeDir;
  $home = home();
  $home = home('foo');
  $home = File::HomeDir::home();
  $home = File::HomeDir::home('foo');

The "home" function is exported by default and is provided for compatibility with legacy applications. In new applications, you should use the newer method-based interface above.

Returns the directory path to a named user's home/profile directory.

If provided no parameter, returns the directory path to the current user's home/profile directory.