GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  TOADER::FINDTOADERROOT (3)

.ds Aq ’

NAME

Toader::findToaderRoot - This finds the root Toader directory.

CONTENTS

VERSION

Version 0.1.0

SYNOPSIS



    use Toader::findToaderRoot;

    my $foo = Toader::findToaderRoot->new();

    my $root=$foo->findToaderRoot($directory);
    if($foo->error){
        warn(Error .$foo->error.: .$foo->errorString);
    }else{
        print $root."\n";
    }



METHODS

    new

This initiates the object.



    my $foo = Toader::findToaderRoot->new();



    findToaderRoot

This takes a directory and then finds the root for that Toader repo.

One argument is required and it is the directory to start in.

One value is returned and it is the root directory.



    my $root=$foo->findToaderRoot($directory);
    if($foo->error){
        warn(Error .$foo->error.: .$foo->errorString);
    }else{
        print $root."\n";
    }



ERROR CODES

    1, noDirSpecified

No directory specified.

    2, notAdir

Not a directory.

    3, notAtoaderDir

Not a Toader directory.

    4, isaToaderDirErrored

Toader::isaToaderDir->isaToaderDir errored.

    5, rootIsAtoaderDir

/ is the directory and it appears to be a Toader directory.

This is a major WTF and should not be even if ’/.toader’ exists.

AUTHOR

Zane C. Bowers-Hadley, <vvelox at vvelox.net>

BUGS

Please report any bugs or feature requests to bug-toader at rt.cpan.org, or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Toader>. I will be notified, and then you’ll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.



    perldoc Toader::findToaderRoot



You can also look for information at:
o RT: CPAN’s request tracker

<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Toader>

o AnnoCPAN: Annotated CPAN documentation

<http://annocpan.org/dist/Toader>

o CPAN Ratings

<http://cpanratings.perl.org/d/Toader>

o Search CPAN

<http://search.cpan.org/dist/Toader/>

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2013 Zane C. Bowers-Hadley.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 TOADER::FINDTOADERROOT (3) 2013-04-27

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.