view release on metacpan or  search on metacpan

lib/Fuse/PerlSSH/FS.pm  view on Meta::CPAN

=head2 new()

=head2 mount()

=head2 umount()

=head1 FUNCTIONS

A growing list of functions that match the FUSE bindings, all prefixed by "local_":

  local_readdir,
  local_getattr,
  local_mknod,
  local_mkdir,
  local_rmdir,
  local_rename,
  local_unlink,
  local_open,
  local_read,
  local_write,
  local_release,
  local_symlink,
  local_link,
  local_readlink,
  local_utime,
  local_truncate,
  local_ftruncate,
  local_statfs,
  local_listxattr,
  local_getxattr,
  local_setxattr,
  local_removexattr,

=head1 EXPORT

None by default.

=head1 CAVEATS or TODO

=head2 Reliability

Most tests via L<Test::Virtual::Filesystem> succeed but some still fail. So keep in mind
that this is beta quality code and don't rely on it to transfer critical data.

=head2 Remote "capabilities"

This module here requires Perl to be installed on the remote machine and L<File::ExtAttr>
to be installed. On connect some rudimentary checks are performed to find out what the
remote system is able to do, especially regarding xattribs - but that might not reveal any 
problem. So make sure the remote file-system is able to accept xattr calls (is mounted
with the I<user_xattr> option, or similar, on non *nix systems) and that the ssh host
has File::ExtAttr in place, if you want to use xattribs.

=head2 (Local) FUSE limitations

Keep in mind that even when the underlying filesystem on the remote end has everything in
place for extended attribs, your local stack might be incomplete. As of this writing,
FUSE implementations on NetBSD and FreeBSD do not support xattr, for example.

=head2 No keep-alive

Currently, there's no keep-alive mechanism and the automatic reconnect generally fails.
So the mount might become unresponsive after a certain time of inactivity.

=head1 SEE ALSO

L<FUSE|Fuse>, L<IPC::PerlSSH>. L<Filesys::Virtual::SSH>.

=head1 AUTHOR

Clipland GmbH L<http://www.clipland.com/>

=head1 COPYRIGHT & LICENSE

Copyright 2012-2013 Clipland GmbH. All rights reserved.

This library is free software, dual-licensed under L<GPLv3|http://www.gnu.org/licenses/gpl>/L<AL2|http://opensource.org/licenses/Artistic-2.0>.
You can redistribute it and/or modify it under the same terms as Perl itself.