File::Listing(3) User Contributed Perl Documentation File::Listing(3)
NAME
File::Listing - parse directory listing
SYNOPSIS
use File::Listing qw(parse_dir);
$ENV{LANG} = "C"; # dates in non-English locales not supported
for (parse_dir(`ls -l`)) {
($name, $type, $size, $mtime, $mode) = @$_;
next if $type ne 'f'; # plain file
#...
}
# directory listing can also be read from a file
open(LISTING, "zcat ls-lR.gz|");
$dir = parse_dir(\*LISTING, '+0000');
DESCRIPTION
This module exports a single function called "parse_dir", which can be
used to parse directory listings.
FUNCTIONS
parse_dir
my $dir = parse_dir( $listing );
my $dir = parse_dir( $listing, $time_zone );
my $dir = parse_dir( $listing, $time_zone, $type );
my $dir = parse_dir( $listing, $time_zone, $type, $error );
my @files = parse_dir( $listing );
my @files = parse_dir( $listing, $time_zone );
my @files = parse_dir( $listing, $time_zone, $type );
my @files = parse_dir( $listing, $time_zone, $type, $error );
The first parameter ($listing) is the directory listing to parse. It
can be a scalar, a reference to an array of directory lines or a glob
representing a filehandle to read the directory listing from.
The second parameter ($time_zone) is the time zone to use when parsing
time stamps in the listing. If this value is undefined, then the local
time zone is assumed.
The third parameter ($type) is the type of listing to assume.
Currently supported formats are 'unix', 'apache' and 'dosftp'. The
default value is 'unix'. Ideally, the listing type should be
determined automatically.
The fourth parameter ($error) specifies how unparseable lines should be
treated. Values can be 'ignore', 'warn' or a code reference. Warn
means that the perl warn() function will be called. If a code
reference is passed, then this routine will be called and the return
value from it will be incorporated in the listing. The default is
'ignore'.
Only the first parameter is mandatory.
# list context
foreach my $file (parse_dir($listing)) {
my($name, $type, $size, $mtime, $mode) = @$file;
}
# scalar context
my $dir = parse_dir($listing);
foreach my $file (@$dir) {
my($name, $type, $size, $mtime, $mode) = @$file;
}
The return value from parse_dir() is a list of directory entries. In a
scalar context the return value is a reference to the list. The
directory entries are represented by an array consisting of:
name
The name of the file.
type
One of: "f" file, "d" directory, "l" symlink, "?" unknown.
size
The size of the file.
time
The number of seconds since January 1, 1970.
mode
Bitmask a la the mode returned by "stat".
SEE ALSO
File::Listing::Ftpcopy(3)
Provides the same interface but uses XS and the parser
implementation from "ftpcopy".
COPYRIGHT
Copyright 1996-2010, Gisle Aas Copyright 2020 Graham Ollis
Based on lsparse.pl (from Lee McLoughlin's ftp mirror package) and
Net::FTP's parse_dir (Graham Barr).
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
perl v5.30.3 2020-09-30 File::Listing(3)
file-listing 6.70.0 - Generated Tue Oct 6 08:39:24 CDT 2020