Index: /trunk/Nebulous/lib/Nebulous/Client.pod
===================================================================
--- /trunk/Nebulous/lib/Nebulous/Client.pod	(revision 2912)
+++ /trunk/Nebulous/lib/Nebulous/Client.pod	(revision 2912)
@@ -0,0 +1,164 @@
+=pod
+
+=head1 NAME
+
+PS::IPP::IData::Client - iData client component
+
+=head1 SYNOPSIS
+
+    use PS::IPP::IData::Client;
+
+    my $idata = PS::IPP::IData::Client->new(
+        proxy   => 'http://localhost:80/idata'
+    );
+
+    my $fh = $idata->create( "key", 0, "node01", "example" );
+    $idata->replicate( "key", "node01" );
+    $idata->cull( "key" );
+    $idata->lock( "key", 'write' );
+    $idata->unlock( "key", 'write' );
+    my $uris = $idata->find_instances( "key", "node01" );
+    my $path = $idata->find( "key" );
+    my $fh = $idata->open( "key", 'read' );
+    $data->delete( "key" );
+    $data->copy( "key", "new_key" );
+    $data->move( "key", "new_key" );
+    $data->delete_instance( $uri );
+    my $stats = $idata->stat( "key" );
+
+=head1 DESCRIPTION
+
+This component provides client access to the iData storage system.  It provides
+an interface for files to be added, managed, and removed from the system.
+
+=head1 USAGE
+
+=head2 Import Parameters
+
+This module accepts a hash as argument to it's C<import> method and exports no
+I<symbols>.
+
+    use PS::IPP::IData::Client trace => qw( debug );
+
+The hash is allowed to have a single key, C<trace>.  This controls the level of
+tracing sent to the standard out.  The value maybe one of: C<off>, C<fatal>,
+C<error>, C<warn>, C<info>, C<debug>, C<all>. 
+
+The default level of tracing is C<warn>.
+
+=head2 Methods
+
+=head3 Constructors
+
+=over 4
+
+=item * new( ... )
+
+Accepts a mandatory hash.
+
+    my $idata = PS::IPP::IData::Client->new(
+        proxy   => 'http://localhost:80/idata'
+        uri     => 'urn:PS/IPP/IData/Server',
+    );
+
+=over 4
+
+=item * proxy
+
+The URL of the iData server to connect to.
+
+=item * uri
+
+The namespace of the SOAP service.  Unless you know what your doing, don't set
+this key.
+
+This key is optional.
+
+=back
+
+=back
+
+=head3 Object Methods
+
+=over 4
+
+=item * create
+
+=item * replicate
+
+=item * cull
+
+=item * lock
+
+=item * unlock
+
+=item * find_instances
+
+=item * find
+
+=item * open
+
+=item * delete
+
+=item * copy
+
+=item * move
+
+=item * delete_instance
+
+=item * stat
+
+=back
+
+=head1 DEVELOPER NOTES
+
+=head1 REFERENCES
+
+=over 4
+
+=item MogileFS
+
+The iData system is similar in function to MogileFS but very different in
+implementation and operation.
+
+L<http://www.danga.com/mogilefs/>
+
+=back
+
+=head1 CREDITS
+
+Just me, myself, and I.
+
+=head1 SUPPORT
+
+Please contact the author directly via e-mail.
+
+=head1 AUTHOR
+
+Joshua Hoblitt <jhoblitt@cpan.org>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2004-2005  Joshua Hoblitt.  All rights reserved.
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+Place - Suite 330, Boston, MA  02111-1307, USA.
+
+The full text of the license can be found in the LICENSE file included with
+this module, or in the L<perlgpl> Pod as supplied with Perl 5.8.1 and later.
+
+=head1 SEE ALSO
+
+L<PS::IPP::IData::Server>
+
+=cut