Package: moreutils
Version: 0.60-1
Severity: minor
File: /usr/bin/vidir
Tags: upstream

Dear Maintainer,

vidir(1) reads:

> =head1 SYNOPSIS
> 
> B<vidir> [--verbose] [directory|file|-] ...

However, the "DESCRIPTION" section does not explain how a I<file>
argument is handled:

> =head1 DESCRIPTION
> 
> vidir allows editing of the contents of directory in a text editor. If no
> directory is specified, the current directory is edited. 
> 
> When editing a directory, each item in the directory will appear on its own
> numbered line. These numbers are how vidir keeps track of what items are
> changed. Delete lines to remove files from the directory, or
> edit filenames to rename files. You can also switch pairs of numbers to
> swap filenames.
> 
> Note that if "-" is specified as the directory to edit, it reads a list of
> filenames from stdin and displays those for editing. Alternatively, a list
> of files can be specified on the command line.

I'm guessing that «vidir *.jpeg» is for renaming/deleting just *.jpeg
files, but that's not clear from the text.

Cheers,

Daniel

P.S. As a separate / secondary issue, it would also be nice if the
"DESCRIPTION" used B<>/I<>/C<> POD markup around the terms "directory"
and "file" when they are used not as common nouns, but to refer to the
placeholders from the synopsis; for example, change

    vidir editing the contents of directory.  … the current directory is edited 
…

to

    vidir editing the contents of I<directory>.  … the current directory is 
edited …

Reply via email to