oracular (3) Sys::Filesystem::Unix.3pm.gz

NAME

       Sys::Filesystem::Unix - Return generic Unix filesystem information to Sys::Filesystem

SYNOPSIS

       See Sys::Filesystem.

INHERITANCE

         Sys::Filesystem::Unix
         ISA UNIVERSAL

METHODS

       version()
           Return the version of the (sub)module.

       readFsTab
           This method provides the capability to parse a standard unix fstab file.

           It expects following arguments:

           fstabPath
                   Full qualified path to the fstab file to read.

           fstabKeys
                   The column names for the fstab file through an array reference.

           special_fs
                   Hash reference containing the names of all special file systems having a true value as key.

           This method return true in case the specified file could be opened for reading, false otherwise.

       readMntTab
           This method provides the capability to read abd parse a standard unix mount-tab file. The file is
           locked using flock after opening it.

           It expects following arguments:

           mnttabPath
                   Full qualified path to the mnttab file to read.

           mnttabKeys
                   The column names for the mnttab file through an array reference.

           $special_fs
                   Hash reference containing the names of all special file systems having a true value as key.

           This method return true in case the specified file could be opened for reading and locked, false
           otherwise.

       readMounts
           This method is called to parse the information got from "mount" system command.  It expects following
           arguments:

           mount_rx
                   Regular expression to extract the information from each mount line.

           pridx   Array reference containing the index for primary keys of interest in match in following
                   order: device, mount_point, type.

           keys    Array reference of the columns of the match - in order of paranteses in regular expression.

           special Array reference containing the names of the special file system types.

           lines   Array containing the lines to parse.

       readSwap
           This method is called to parse the information from the swap status.  It expects following arguments:

           swap_rx Regular expression to extract the information from each swap status line.  This regular
                   expression should have exact one pair of parantheses to identify the swap device.

           lines   Array containing the lines to parse.

AUTHOR

       Nicola Worthington <nicolaw@cpan.org> - <http://perlgirl.org.uk>

       Jens Rehsack <rehsack@cpan.org> - <http://www.rehsack.de/>

COPYRIGHT

       Copyright 2004,2005,2006 Nicola Worthington.

       Copyright 2008-2020 Jens Rehsack.

       This software is licensed under The Apache Software License, Version 2.0.

       <http://www.apache.org/licenses/LICENSE-2.0>