file::homedir.3

视频监控网络部分的协议ddns,的模块的实现代码,请大家大胆指正.

If the distinction is important to you, the term \*(L"current\*(R" refers to the
real user, and not the effective user.
.PP
This is also the case for all of the other \*(L"my\*(R" methods.
.PP
Returns the directory path as a string, \f(CW\*(C`undef\*(C'\fR if the current user
does not have a home directory, or dies on error.
.Sh "my_desktop"
.IX Subsection "my_desktop"
The \f(CW\*(C`my_desktop\*(C'\fR method takes no arguments and returns the \*(L"desktop\*(R"
directory for the current user.
.PP
Due to the diversity and complexity of implementions required to deal with
implementing the required functionality fully and completely, for the moment
\&\f(CW\*(C`my_desktop\*(C'\fR is \fBnot\fR going to be implemented.
.PP
That said, I am extremely interested in code to implement \f(CW\*(C`my_desktop\*(C'\fR on
Unix, as long as it is capable of dealing (as the Windows implementation
does) with internationalisation. It should also avoid false positive
results by making sure it only returns the appropriate directories for the
appropriate platforms.
.PP
Returns the directory path as a string, \f(CW\*(C`undef\*(C'\fR if the current user
does not have a desktop directory, or dies on error.
.Sh "my_documents"
.IX Subsection "my_documents"
The \f(CW\*(C`my_documents\*(C'\fR method takes no arguments and returns the directory (for
the current user) where the user's documents are stored.
.PP
Returns the directory path as a string, \f(CW\*(C`undef\*(C'\fR if the current user
does not have a documents directory, or dies on error.
.Sh "my_music"
.IX Subsection "my_music"
The \f(CW\*(C`my_music\*(C'\fR method takes no arguments and returns the directory
where the current user's music is stored.
.PP
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.
.PP
Returns the directory path as a string, \f(CW\*(C`undef\*(C'\fR if the current user
does not have a suitable directory, or dies on error.
.Sh "my_pictures"
.IX Subsection "my_pictures"
The \f(CW\*(C`my_pictures\*(C'\fR method takes no arguments and returns the directory
where the current user's pictures are stored.
.PP
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.
.PP
Returns the directory path as a string, \f(CW\*(C`undef\*(C'\fR if the current user
does not have a suitable directory, or dies on error.
.Sh "my_videos"
.IX Subsection "my_videos"
The \f(CW\*(C`my_videos\*(C'\fR method takes no arguments and returns the directory
where the current user's videos are stored.
.PP
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.
.PP
Returns the directory path as a string, \f(CW\*(C`undef\*(C'\fR if the current user
does not have a suitable directory, or dies on error.
.Sh "my_data"
.IX Subsection "my_data"
The \f(CW\*(C`my_data\*(C'\fR takes no arguments and returns the directory where
local applications should stored their internal data for the current
user.
.PP
Generally an application would create a subdirectory such as \f(CW\*(C`.foo\*(C'\fR,
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.
.PP
For example, on Unix you get \f(CW\*(C`~/.foo\*(C'\fR and on Win32 you get
\&\f(CW\*(C`~/Local Settings/Application Data/.foo\*(C'\fR
.PP
Returns the directory path as a string, \f(CW\*(C`undef\*(C'\fR if the current user
does not have a data directory, or dies on error.
.Sh "users_home"
.IX Subsection "users_home"
.Vb 1
\&  $home = File::HomeDir\->users_home(\*(Aqfoo\*(Aq);
.Ve
.PP
The \f(CW\*(C`users_home\*(C'\fR method takes a single param and is used to locate the
parent home/profile directory for an identified user on the system.
.PP
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.
.PP
Returns the directory path as a string, \f(CW\*(C`undef\*(C'\fR if that user
does not have a home directory, or dies on error.
.Sh "users_documents"
.IX Subsection "users_documents"
.Vb 1
\&  $docs = File::HomeDir\->users_documents(\*(Aqfoo\*(Aq);
.Ve
.PP
Returns the directory path as a string, \f(CW\*(C`undef\*(C'\fR if that user
does not have a documents directory, or dies on error.
.Sh "users_data"
.IX Subsection "users_data"
.Vb 1
\&  $data = File::HomeDir\->users_data(\*(Aqfoo\*(Aq);
.Ve
.PP
Returns the directory path as a string, \f(CW\*(C`undef\*(C'\fR if that user
does not have a data directory, or dies on error.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.Sh "home"
.IX Subsection "home"
.Vb 5
\&  use File::HomeDir;
\&  $home = home();
\&  $home = home(\*(Aqfoo\*(Aq);
\&  $home = File::HomeDir::home();
\&  $home = File::HomeDir::home(\*(Aqfoo\*(Aq);
.Ve
.PP
The \f(CW\*(C`home\*(C'\fR 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.
.PP
Returns the directory path to a named user's home/profile directory.
.PP
If provided no param, returns the directory path to the current user's
home/profile directory.
.SH "TIED INTERFACE"
.IX Header "TIED INTERFACE"
.Sh "%~"
.IX Subsection "%~"
.Vb 7
\&  $home = $~{""};
\&  $home = $~{undef};
\&  $home = $~{$user};
\&  $home = $~{username};
\&  print "... $~{\*(Aq\*(Aq} ...";
\&  print "... $~{$user} ...";
\&  print "... $~{username} ...";
.Ve
.PP
This calls \f(CW\*(C`home($user)\*(C'\fR or \f(CW\*(C`home(\*(Aqusername\*(Aq)\*(C'\fR \*(-- except that if you
ask for \f(CW$~{some_user}\fR and there is no such user, it will die.
.PP
Note that this is especially useful in double-quotish strings, like:
.PP
.Vb 2
\&     print "Jojo\*(Aqs .newsrc is ", \-s "$~{jojo}/.newsrc", "b long!\en";
\&      # (helpfully dies if there is no user \*(Aqjojo\*(Aq)
.Ve
.PP
If you want to avoid the fatal errors, first test the value of
\&\f(CW\*(C`home(\*(Aqjojo\*(Aq)\*(C'\fR, which will return undef (instead of dying) in case of
there being no such user.
.PP
Note, however, that if the hash key is "\*(L" or undef (whether thru being
a literal \*(R"", or a scalar whose value is empty-string or undef), then
this returns zero-argument \f(CW\*(C`home()\*(C'\fR, i.e., your home directory:
.PP
Further, please note that because the %~ hash compulsorily modifies
a hash outside of it's namespace, and presents an overly simplistic
approach to home directories, it is likely to ultimately be removed.
.PP
The interface is currently expected to be formally deprecated from 2010
(but no earlier) and removed from 2015 (but no earlier). If very heavy
use is found in the wild, these plans may be pushed back.
.SH "TO DO"
.IX Header "TO DO"
.IP "\(bu" 4
Become generally clearer on situations in which a user might not
have a particular resource.
.IP "\(bu" 4
Merge remaining edge case code in File::HomeDir::Win32
.IP "\(bu" 4
Add more granularity to Unix, and add support to \s-1VMS\s0 and other
esoteric platforms, so we can consider going core.
.IP "\(bu" 4
Add consistent support for users_* methods
.SH "SUPPORT"
.IX Header "SUPPORT"
This module is stored in an Open Repository at the following address.
.PP
<http://svn.ali.as/cpan/trunk/File\-HomeDir>
.PP
Write access to the repository is made available automatically to any
published \s-1CPAN\s0 author, and to most other volunteers on request.
.PP
If you are able to submit your bug report in the form of new (failing)
unit tests, or can apply your fix directly instead of submitting a patch,
you are \fBstrongly\fR encouraged to do so as the author currently maintains
over 100 modules and it can take some time to deal with non-Critical bug
reports or patches.
.PP
This will guarantee that your issue will be addressed in the next
release of the module.
.PP
If you cannot provide a direct test or fix, or don't have time to do so,
then regular bug reports are still accepted and appreciated via the \s-1CPAN\s0
bug tracker.
.PP
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File\-HomeDir>
.PP
For other issues, for commercial enhancement or support, or to have your
write access enabled for the repository, contact the author at the email
address above.
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
The biggest acknowledgement must go to Chris Nandor, who wielded his
legendary Mac-fu and turned my initial fairly ordinary Darwin
implementation into something that actually worked properly everywhere,
and then donated a Mac \s-1OS\s0 X license to allow it to be maintained properly.
.SH "AUTHORS"
.IX Header "AUTHORS"
Adam Kennedy <[e-mail]>
.PP
Sean M. Burke <[e-mail]>
.PP
Chris Nandor <[e-mail]>
.PP
Stephen Steneker <[e-mail]>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
File::ShareDir, File::HomeDir::Win32 (legacy)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2005, 2006 Adam Kennedy.
.PP
Some parts copyright 2000 Sean M. Burke.
.PP
Some parts copyright 2006 Chris Nandor.
.PP
Some parts copyright 2006 Stephen Steneker.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.