.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Plain 3pm"
.TH Plain 3pm "2022-11-19" "perl v5.36.0" "User Contributed Perl Documentation"
.\" 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"
Filesys::Virtual::Plain \- A Plain virtual filesystem
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        use Filesys::Virtual::Plain;
\&
\&        my $fs = Filesys::Virtual::Plain\->new();
\&
\&        $fs\->login(\*(Aqxantus\*(Aq, \*(Aqsupersekret\*(Aq);
\&
\&        print foreach ($fs\->list(\*(Aq/\*(Aq));
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is used by other modules to provide a pluggable filesystem.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "\fBnew()\fP"
.IX Subsection "new()"
You can pass the initial cwd, root_path, and home_path as a hash.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "login($username, $password, $become)"
.el .SS "login($username, \f(CW$password\fP, \f(CW$become\fP)"
.IX Subsection "login($username, $password, $become)"
Logs in a user.  Returns 0 on failure.  If \f(CW$username\fR is 'anonymous' then it
will try to login as 'ftp' with no password.  If \f(CW$become\fR is defined then it
will try to change ownership of the process to the uid/gid of the logged in
user.  \s-1BEWARE\s0 of the consequences of using \f(CW$become\fR.  \fBlogin()\fR also sets the 
uid, gid, home, gids, home_path, and chdir to the users'.
.SS "cwd"
.IX Subsection "cwd"
Gets or sets the current directory, assumes / if blank.
This is used in conjunction with the root_path for file operations.
No actual change directory takes place.
.SS "root_path($path)"
.IX Subsection "root_path($path)"
Get or set the root path.  All file paths are  off this and cwd
For example:
.PP
.Vb 3
\&        $self\->root_path(\*(Aq/home/ftp\*(Aq);
\&        $self\->cwd(\*(Aq/test\*(Aq);
\&        $self\->size(\*(Aqtestfile.txt\*(Aq);
.Ve
.PP
The size command would get the size for file /home/ftp/test/testfile.txt
not /test/testfile.txt
.SS "chmod($mode,$file)"
.IX Subsection "chmod($mode,$file)"
chmod's a file.
.SS "modtime($file)"
.IX Subsection "modtime($file)"
Gets the modification time of a file in \s-1YYYYMMDDHHMMSS\s0 format.
.SS "size($file)"
.IX Subsection "size($file)"
Gets the size of a file in bytes.
.SS "delete($file)"
.IX Subsection "delete($file)"
Deletes a file, returns 1 or 0 on success or failure.
.SS "chdir($dir)"
.IX Subsection "chdir($dir)"
Changes the cwd to a new path from root_path.
Returns undef on failure or the new path on success.
.ie n .SS "mkdir($dir, $mode)"
.el .SS "mkdir($dir, \f(CW$mode\fP)"
.IX Subsection "mkdir($dir, $mode)"
Creats a directory with \f(CW$mode\fR (defaults to 0755) and \fBchown()\fR's the directory
with the uid and gid.  The return value is from \fBmkdir()\fR.
.SS "rmdir($dir)"
.IX Subsection "rmdir($dir)"
Deletes a directory or file if \-d test fails.  Returns 1 on success or 0 on
failure.
.SS "list($dir)"
.IX Subsection "list($dir)"
Returns an array of the files in a directory.
.SS "list_details($dir)"
.IX Subsection "list_details($dir)"
Returns an array of the files in ls format.
.SS "stat($file)"
.IX Subsection "stat($file)"
Does a normal \fBstat()\fR on a file or directory
.SS "test($test,$file)"
.IX Subsection "test($test,$file)"
Perform a perl type test on a file and returns the results.
.PP
For example to perform a \-d on a directory.
.PP
.Vb 1
\&        $self\->test(\*(Aqd\*(Aq,\*(Aq/testdir\*(Aq);
.Ve
.PP
See filetests in perlfunc (commandline: perldoc perlfunc)
.SS "open_read($file,[params])"
.IX Subsection "open_read($file,[params])"
Opens a file with IO::File. Params are passed to \fBopen()\fR of IO::File.
It returns the file handle on success or undef on failure.  This could
be technically be used for any sort of open operation.  See IO::File's
open method.
.SS "close_read($fh)"
.IX Subsection "close_read($fh)"
Performs a \f(CW$fh\fR\->\fBclose()\fR
.ie n .SS "open_write($fh, $append)"
.el .SS "open_write($fh, \f(CW$append\fP)"
.IX Subsection "open_write($fh, $append)"
Performs an \f(CW$fh\fR\->open(\*(L">$file\*(R") or \f(CW$fh\fR\->open(\*(L">>$file\*(R") if \f(CW$append\fR is defined.
Returns the filehandle on success or undef on failure.
.SS "close_write($fh)"
.IX Subsection "close_write($fh)"
Performs a \f(CW$fh\fR\->\fBclose()\fR
.ie n .SS "seek($fh, $pos, $wence)"
.el .SS "seek($fh, \f(CW$pos\fP, \f(CW$wence\fP)"
.IX Subsection "seek($fh, $pos, $wence)"
Performs a \f(CW$fh\fR\->seek($pos, \f(CW$wence\fR). See IO::Seekable.
.ie n .SS "utime($atime, $mtime, @files)"
.el .SS "utime($atime, \f(CW$mtime\fP, \f(CW@files\fP)"
.IX Subsection "utime($atime, $mtime, @files)"
Performs a \fButime()\fR on the file(s).  It changes the access time and mod time of
those files.
.SH "AUTHOR"
.IX Header "AUTHOR"
David Davis, <xantus@cpan.org>, http://teknikill.net/
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1), Filesys::Virtual, Filesys::Virtual::SSH,
Filesys::Virtual::DAAP, POE::Component::Server::FTP,
Net::DAV::Server, HTTP::Daemon,
http://perladvent.org/2004/20th/