view release on metacpan or  search on metacpan

lib/AFS/Command/FS.pod  view on Meta::CPAN

    getPathNames()		list of strings, each of which is a single pathname
    getPaths()			list of AFS::Object::Path objects, one for each path
    getPath($pathname)		a single AFS::Object::Path object, for the pathname $pathname

B<AFS::Object::Path>

If errors were encountered for any given path, then its object will
have the following attributes:

    Attributes			Values
    ----------			------
    path			The pathname
    error			The error string for that path

If no errors were encountered, then the following attributes will be present:

    Attributes			Values
    ----------			------
    path			The pathname
    cell			Cell in which the pathname lives

=back

=head2 wscell

=over

=item Arguments

The fs help string is:

    fs wscell: list workstation's cell
    Usage: fs wscell

The corresponding method invocation looks like:

    my $result = $fs->wscell();

=item Return Values

This method returns an AFS::Object::CacheManager object which has one
attribute.

    my $result = $fs->wscell() || die $fs->errors();
    print "This client lives in cell '" . $result->cell() . "'\n";

The object has the following attribute:

    Attributes			Values
    ----------			------
    cell			The AFS cell of the client

=back

=head1 METHODS (with simple return values)

=head2 checkvolumes

The fs help string is:

    fs checkvolumes: check volumeID/name mappings
    Usage: fs checkvolumes

The corresponding method invocation looks like:

    my $result = $fs->checkvolumes();

=head2 cleanacl

The fs help string is:

    fs cleanacl: clean up access control list
    Usage: fs cleanacl [-path <dir/file path>+]

The corresponding method invocation looks like:

    my $result = $fs->cleanacl
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );

=head2 copyacl

The fs help string is:

    fs copyacl: copy access control list
    Usage: fs copyacl -fromdir <source directory (or DFS file)>
		      -todir <destination directory (or DFS file)>+
		      [-clear] [-id] [-if]
    Where: -clear  first clear dest access list
	   -id     initial directory acl
	   -if     initial file acl

The corresponding method invocation looks like:

    my $result = $fs->copyacl
      (
       # Required arguments
       fromdir			=> $fromdir,
       todir			=> $todir, # OR [ $todir1, $todir2, ... ]
       # Optional arguments
       clear			=> 1,
       id			=> 1,
       if			=> 1,
      );

=head2 flush

The fs help string is:

    fs flush: flush file from cache
    Usage: fs flush [-path <dir/file path>+]

The corresponding method invocation looks like:

    my $result = $fs->flush
      (
       # Optional arguments
       path			=> $path, # OR [ $path1, $path2, ... ]
      );