/ 
File-Info-1.02
River stage zero No dependents
/ fileinfo-dump

NAME

fileinfo-dump - Dump information found in .fileinfo file in human-readable fashion.

SYNOPSIS

fileinfo-dump [options] file+

option:         Value     Default   Unit   Meaning

--verbose       repeating 0                Output informational messages
--progress      [string]  undefined        Output progress report
--stats         [string]  undefined        Output statistical information

--help                                     Produce summary help on stdout
--longhelp                                 Produce long help on stdout
--man                                      Produce full man page on stdout
--version                                  Produce full version on stdout
--copyright                                Produce full copyright on stdout
-V|--briefversion                          Produce brief version on stdout

--dry-run       boolean   false
--debug         repeating 0

DESCRIPTION

OPTIONS

Options come in short (single-character) and/or long forms. Short options are preceded by a single dash (-x), whilst long options are preceded by a double-dash (--option). Long options may be abbreviated to the minimal distinct prefix. Single char options may not be bundled (-v -a -x != -vax). Options taking string values will assume that anything immediately following is a string value, even if the string is optional and/or the "value" could be interpreted as another option (if -v takes a string, -vax will give the value "ax" to the option -v).

Options which are boolean must use the long form to negate, prefixed by "no" (--foo may be negated by --no_foo).

Options which are repeating may be invoked multiple times for greater effect.

Option & argument order does not matter: all options will be processed prior to any arguments.

A lone "--" may be used to terminate options processing; any text(s) following this will be treated as arguments, rather than options.

verbose|v

Enable informational messages about choices made, etc. to stderr. This option may be invoked multiple times to increase the level of verbosity.

progress

Enable regular messages to inform the user of progress made. These may be in simple text form, or where appropriate, progress bars may be used.

This option takes an optional string argument. If provided, this names a file to output information messages to (unless the first character is a colon). If the first character of the string option is a colon, then the rest of the option must be a (non-negative) integer. This integer will be interpreted as a file descriptor to use.

This file will be opened for write only, and no seek issued; this is so character special files, named pipes, etc. may be used.

Only the characters [A-Za-z0-9_-.\/] (that is both forward- and back- slashes) are acceptable as filenames). All else (including colons other than the first character) will cause an error.

If a string filename is given, an error will ensue if that file already exists (and is a plain file). This is to avoid accidents due to the optional string syntax.

Beware the optional string; if you use the progress option, then any string following it will be treated as an option if it looks like an option. If you mean an option-looking thing to be a value, use --progress=value. If you want to follow it with an argument that looks like a value to --progress, follow it with --.

stats

Enable statistical information to be output to the user.

This option takes an optional string argument. If provided, this names a file to output information messages to (unless the first character is a colon). If the first character of the string option is a colon, then the rest of the option must be a (non-negative) integer. This integer will be interpreted as a file descriptor to use.

This file will be opened for write only, and no seek issued; this is so character special files, named pipes, etc. may be used.

Only the characters [A-Za-z0-9_-.\/] (that is both forward- and back- slashes) are acceptable as filenames). All else (including colons other than the first character) will cause an error.

If a string filename is given, an error will ensue if that file already exists (and is a plain file). This is to avoid accidents due to the optional string syntax.

Beware the optional string; if you use the stats option, then any string following it will be treated as an option if it looks like an option. If you mean an option-looking thing to be a value, use --stats=value. If you want to follow it with an argument that looks like a value to --stats, follow it with --.

help

Print a brief help message and exit.

longhelp

Print a longer help message and exit.

man

Print the manual page and exit.

version

Print the version number (of the source package) and the copyright notice, and exit.

Print the copyright notice, and exit.

briefversion|V

Print the version number (of the source package), in the form

scriptname (packagename) version

and exit. scriptname is the canonical installed name of the script.

debug

Enable debugging output.

dry-run

Do not write any files (other than temporary files), nor make any changes to any RDBMS (other than disposable ones).

ENVIRONMENT

This program has no special environment handling

DIAGNOSTICS

The following exit codes may be observed in abnormal cases:

  1   Successful, but abnormal termination
  2   A utility function was requested (--help, --version etc.)
  3   Incorrect usage.
  4   Prerequisites not satisifed
  5   Filesystem error on open/read.
  6   Filesystem error on close/write.
  7   RDBMS access error on read/connect.
  8   RDBMS access error on on write
255   Unknown Error

EXAMPLES

BUGS

REPORTING BUGS

Log them in gnats.

AUTHOR

Martyn J. Pearce fluffy@cpan.org

COPYRIGHT

Copyright (c) 2002 Martyn J. Pearce.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO