Menu

USAGE_EXPLOREFS

explorefs (1)
Carlos Celso de Almeida

Return HOME or USAGE

Name:

Explore FileSystems Entries

USAGE

 ExploreFS -volume=[mount-point] -output=[output-file] [options]
 or
 ExploreFS -help | -? | -version | -license | -description

Description:

This tools was created to extract a list of entries in the Data Volume.

It is can run on Unix, Linux and Windows Systems.

The system requirement is: The Perl must be installed on the system.

The Data Volume consists a "Unix/Linux FileSystem" or "Windows Letter
Disk". This area may be local or remote, since mounted on your the
system (must be mounted).

The ExploreFS can extract control data from a root entry o folder entry
and sub-items (depends on what do you need -- see the extended options).

The process will explore recursivily the volume and create a report and
sumary.

The report contains a list of entries and information about size, owner,
timestamp status and entry identifier. The summary contains the number
of processed data, number of erros, etc. The summary error report
contains the list of entries and the system message error.

IMPORTANT: No file's data will be written on the reports.

FAQ: This tools read my data file? Answer: DEPEND. The option
'with-md5key or with-sha256' force the read of datafile to create a
checksum key. Running without this option 'no datafile will be read'.
Remember: The read datafile will take a long time to complete the
process. Use it wisely

FAQ: What happen well i read my data file? Answer: The main problem is
you 'access time' attribute. When the FileSystem is writeable the
'access time' will be changed. ToFix: Mount the volume disabling the
access time attribute updates.

FAQ: What is the output report format? Answer: The process will create
three report files:

 [output].map   Information Summary
 [output].lst   List of Mapped entries
 [output].err   List of non-Mapped entries

NOTE: The [output] is the name reported on 'output' option.

For each Mapped Entries we will have:

 [atime] [mtime] [ftype] [uid] [gid] [units] [fileid]

Where:

 [atime]        Last Access Time
 [mtime]        Last Modification Time
 [ftype]        Type of Entry
 [uid]          user unix id, for non-unix systems will be ZERO
 [gid]          group unix id, for non-unix systems will be ZERO
 [units]        size of file based in the unit type (see: 'unit' option)
 [fileid]       relative/fullpath of entry

Type of Entry :

  1     Pipe Handle File
  2     Character special file
  4     Directory
  6     Block Device
  8     Flat File
 10     Link File
 12     Socket File

Options:

Mandatory Options:

-volume=[mount-point]
    The explore fullpath directory

-output=[output-file]
    The list of files mapped on explore process

Additional Options:

-date-type=[a|m]
    Force the range of start/finis time. Use -date-type=a for 'access
    date', -date-type=m for 'modify date'. This option is required to
    use the 'date-start|date-finis' option.

-date-start=[yyyymmdd]|[+/-nnn]
    The start date to map.

-date-finis=[yyyymmdd]|[+/-nnn]
    The finis date to map.

-ftypes=f1 -ftypes=f2 ...
    The list of filetype to map on report. Only mapped filetypes will be
    extracted.

-ignore-entries
    List of name (entries only) to be ignored, where entries are list of
    folders and files names that will be ignored, not explored.
    Remember: If the entry is a folder, all internals entries will be
    ignored. i.e.:

     ExploreFS ... -ignore-entries=$RECYCLE.BIN     # Windows removed files
     ExploreFS ... -ignore-entries=.Trash           # Linux removed files

-type=[a|d]
    The type of data. Use type=a for files, type=d for directories. The
    default is 'all entries'.

-with-fullpath
    Force the fullpath for each entries

-with-timestamp
    Convert the local system timestamp format for 'yyyymmdd' format.

-with-utc
    Convert the utc system timestamp format for 'yyyymmdd' format.

-without-atime
    Suppress the atime information. One '-' will be sent.

Extended Options:

-blocks
    Use number of blocks as size (ignoring the number of bytes)

-dlmt
    Use special caracter for delimiter fields. The default is space.

-fork
    Run the explore in background (forked).

-iobuffer=[size]
    Change iobuffer size. The default is 64k entries per I/O write.

-mount
    Force same mountpoint, explore cross filesystems. By default the
    ExploreFS will not explore folder and subfolder based mountpoint
    entry. This options enable the cros between different volumes
    (filesystems, etc);

-osname=[osname]
    The symbolic name for the Name of OS. The default is current host.

    NOTE: This informantion it is only for summary porpuse. no actions
    will be done.

-server=[servername]
    The symbolic name for the hostname. The default is current host.

    NOTE: This informantion it is only for summary porpuse. no actions
    will be done.

-system=[systename]
    The symbolic name for the system type. The default is current
    platform class (Windows, Unix, etc).

    NOTE: This informantion it is only for summary porpuse. no actions
    will be done.

-volid=[volidname]
    The symbolic name for this explore process. The default value is
    [server]:[system]:[volume]

    NOTE: This informantion it is only for summary porpuse. no actions
    will be done.

-unit=[units]
    Use special unit to convert the size of files. i.e: 'use -unit=1024
    for 1Kbytes'. The default is number of bytes.

-without-ctlr
    Remove the 'specials caracteres'.

-with-filemask
    Convert the system fileclass format. Where a=files, d=directories,
    p=special files, l=symbolic links, b=blocks files.

-with-md5key
    Get the md5key for each file. Warning: The access time will be
    change. Remember: The read datafile will take a long time to
    complete the process. Use it wisely

-with-sha256
    Get the sha256 for each file. Warning: The access time will be
    change. Remember: The read datafile will take a long time to
    complete the process. Use it wisely

-with-snapshot
    Force explore the snapshot areas. The default is 'do not explore
    ".snapshot".

-with-splited-fid
    Split the directory, filename and filetype for each entry.

-with-uidname
    Get the real name for the uid/gid (unix format).

-without-hardlink
    Force map hardlink files. The files will be kept in the report,
    however, an entry will be added as error. See [output].err

-without-space
    Translate the spaces to '*'.

-without-subdir
    Do not explore subdirectories.

-without-symlink
    Disable the map of symlink files and translate for the type of
    destination file. By default the symbolic files are also mapped.
    Disabling the files will be mapped as the source.

    CAUTION: Mapping as source, you may get an incorrect volume's
    allocation size if you sum all the [units] of all files.

Others Options:

-debug=[level]
    Debug mode (for support only). The debug will written data on the
    STDERR (long data).

-description
    Show the module description.

-help
    This help

-license
    Show the License Aggreement.

ENDED


Monday.com Logo