Browse Source

- added POD

master
Andreas Romeyke 2 months ago
parent
commit
f00fd90a67
1 changed files with 55 additions and 16 deletions
  1. +55
    -16
      lib/File/FormatIdentification/Pronom.pm

+ 55
- 16
lib/File/FormatIdentification/Pronom.pm View File

@@ -954,7 +954,7 @@ __END__

=head1 NAME

File::FormatIdentification::Pronom - Perl extension for parsing Pronom-Signatures using DROID-Signature file
File::FormatIdentification::Pronom - Perl extension for parsing PRONOM-Signatures using DROID-Signature file

=head1 SYNOPSIS

@@ -965,40 +965,79 @@ File::FormatIdentification::Pronom - Perl extension for parsing Pronom-Signature

=head1 DESCRIPTION

Stub documentation for File::FormatIdentification::Pronom, created by h2xs. It looks like the
author of the extension was negligent enough to leave the stub
unedited.
The module allows to handle Droid signatures. Droid is a utility which
uses the PRONOM database to identify file formats.

Blah blah blah.
See https://www.nationalarchives.gov.uk/PRONOM/ for details.

=head2 EXPORT
With this module you could:

None by default.
=over

=item convert Droid signatures to Perl regular expressions

=item analyze files and display which/where pattern of Droid signature matches via tag-files for wxHexEditor

=head1 SEE ALSO
=item calc statistics about Droid signatures

=back

The module is in early alpha state and should not be used in production.

=head2 Examples

=head3 Colorize wxHexeditor fields

See example file F<bin/pronom2wxhexeditor.pl>. This colorizes the hex-blob to check PRONOM pattern matches for a given file.

=head3 Identify file

There are better tools for the job, but as a proof of concept certainly not bad: Identifying the file type of a file.

See example file F<bin/pronomidentify.pl>

=head3 Get PRONOM Statistics

Mention other useful documentation such as the documentation of
related modules or operating system documentation (such as man pages
in UNIX), or any relevant external documentation such as RFCs or
standards.
To get a feeling for which signatures need to be revised in PRONOM, or why which file formats are difficult to recognize,
you can get detailed statistics for given signature files.

If you have a mailing list set up for your module, mention it here.
=head2 EXPORT

None by default.

If you have a web site set up for your module, mention it here.
=head1 SEE ALSO

L<File::FormatIdentification::Regex>

=head1 AUTHOR

art1
Andreas Romeyke L<pause@andreas-romeyke.de>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2018/19 by art1
Copyright (C) 2018/19/20 by Andreas Romeyke

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.24.1 or,
at your option, any later version of Perl 5 you may have available.

The droid-signature file in t/ is from L<https://www.nationalarchives.gov.uk/PRONOM/Default.aspx>
and without guarantee, it does not look like it is legally protected. If there are any legal claims,
please let me know that I can remove them from the distribution.

=head1 BUGS

=over

=item Some droid recipes results in PCREs which are greedy and therefore the running
time could be exponential with size of binary file.

=back

=head1 CONTRIBUTING

Please feel free to send me comments and patches to my email address. You can clone the modules
from L<https://art1pirat.spdns.org/art1/File-FormatIdentification-Pronom> and send me merge requests.

=cut


Loading…
Cancel
Save