view release on metacpan or  search on metacpan

script/cwb-regedit  view on Meta::CPAN

Options:

  -r <dir>, --registry=<dir>  use registry directory <dir> [system default]
  -h, --help                  display usage summary
     

Commands:

  :info
       print basic information about the registry entry
  (:id | :home | :name | :ifile) [<value>]
       print or set corpus ID (:id), data directory (:home),
       descriptive name (:name) or info file path (:ifile)
  :prop <property> [<value>]
       query or set corpus property
  :list (:p | :s | :a)
       list declared attributes of specified type
  :add (:p | :s | :a) <names>
       add positional, structural or alignment attributes
  :del <names>
       delete attributes of any type

Command names are case-insensitive, and some intuitive abbreviations and variations
are allowed (but only the forms listed above are guaranteed to work).


=head1 DESCRIPTION

B<cwb-regedit> is a simple command-line editor for CWB registry files in B<canonical format>.
It allows you to display and modify header information, corpus properties and attribute declarations.
For more complex editing tasks (such as adding descriptive comments), use the functionality
provided by the B<CWB> module (see L<CWB/"REGISTRY FILE EDITING"> manpage).

The first argument must be the name of a CWB registry file or a corpus ID.
In the latter case, B<cwb-regedit> will attempt to locate the corresponding registry file in
the system registry, or in a directory specified with the C<--registry> (C<-r>) option.
The remaining arguments are editing or display commands, which are applied to the registry entry in turn.
If any changes have been made, the modified registry file will be written back to disk automatically.

The following commands are currently supported:

=over 4

=item B<:info>

Print basic information about the registry entry, including pathname of the registry file,
corpus ID, name, data directory and info file, as well as all corpus properties defined in the registry entry.

=item (B<:id> | B<:name> | B<:home> | B<:ifile>)

Display corpus header information (corpus ID, corpus name, data directory, info file).

=item (B<:id> | B<:name> | B<:home> | B<:ifile>) I<value>

Modify corpus header information (corpus ID, corpus name, data directory, info file).
Don't forget to quote I<value> with single or double quotes if it contains whitespace or other special characters.

=item B<:prop> I<name>

Display corpus property I<name>.  If this property is not defined, B<cwb-regedit> prints an
empty line and issues a warning message on B<stderr>.

=item B<:prop> I<name> I<value>

Modify or add corpus property I<name>.  Don't forget to quote I<value> if it contains whitespace or special characters.

=item B<:list> (B<:p> | B<:s> | B<:a>) ...

List all attributes of the specified type: B<:p> for positional attributes, B<:s> for structural attributes, 
and B<:a> for alignment attributes.  Attribute names are printed on a single line separated by blanks.
You can specify multiple attribute types without repeating the B<:list> keyword, e.g. C<:list :p :s>.

=item B<:add> (B<:p> | B<:s> | B<:a>) I<name> ... [ (B<:p> | B<:s> | B<:a>) I<name> ... ]

Add one or more attribute declarations to the registry entry.  The attribute type is indicated by 
B<:p> (positional), B<:s> (structural) or B<:a> (alignment), followed by the names of the new attributes.
For structural attributes, the same extended specifications are supported as in the B<cwb-encode> program
(see the L<cwb-encode> manpage and the I<Corpus Encoding Tutorial> for details).

=item B<:del> I<name> ...

Delete attribute declarations, regardless of attribute type.  Note that the corresponding data files
will not automatically be deleted.

=back

=head1 COPYRIGHT

Copyright (C) 2002-2010 Stefan Evert [http::/purl.org/stefan.evert]

This software is provided AS IS and the author makes no warranty as to
its use and performance. You may use the software, redistribute and
modify it under the same terms as Perl itself.

=cut