Improved documentation to be more precise regarding non-argument calls (thx @margaretha)
Change-Id: Ic80abd036ae66f9224063be747df3dcc248a1755
diff --git a/Readme.pod b/Readme.pod
index 68edde3..cd6258f 100644
--- a/Readme.pod
+++ b/Readme.pod
@@ -10,8 +10,8 @@
=head1 SYNOPSIS
$ korapxml2krill -z --input <directory> --output <filename>
- $ korapxml2krill archive -z --input <directory> --output <directory>
- $ korapxml2krill extract --input <directory> --output <filename> --sigle <SIGLE>
+ $ korapxml2krill archive -z --input <directory|archive> --output <directory>
+ $ korapxml2krill extract --input <directory|archive> --output <filename> --sigle <SIGLE>
=head1 DESCRIPTION
@@ -34,15 +34,17 @@
=head1 ARGUMENTS
+Without arguments, C<korapxml2krill> processes a directory of a single KorAP-XML document.
+
=over 2
=item B<archive>
-Process an archive as a Zip-file or a folder of KorAP-XML documents.
+Processes an archive as a Zip-file or a folder of KorAP-XML documents.
=item B<extract>
-Extract KorAP-XML files from a Zip-file.
+Extracts KorAP-XML files from a Zip-file.
=back
@@ -55,21 +57,26 @@
Directory or archive file of documents to convert.
-Archiving supports multiple input archives with the constraint,
+Without arguments, C<korapxml2krill> expects a folder of a single KorAP-XML
+document, while C<archive> and C<extract> support zip archives as well.
+
+C<archive> supports multiple input archives with the constraint,
that the first archive listed contains all primary data files
and all meta data files.
- -i file/news.zip -i file/news.malt.zip -i #file/news.tt.zip
+ -i file/news.zip -i file/news.malt.zip -i "#file/news.tt.zip"
(The directory structure follows the base directory format,
that may include a C<.> root folder.
In this case further archives lacking a C<.> root folder
-need to be passed with a hash sign in front of the archive's name.)
+need to be passed with a hash sign in front of the archive's name.
+This may require to quote the parameter.)
-B<To support zip files, a version of C<unzip> needs to be installed that is
-compatible with the archive file.>
+To support zip files, a version of C<unzip> needs to be installed that is
+compatible with the archive file.
-B<The root folder switch is experimental and may vanish in future versions.>
+B<The root folder switch using the hash sign is experimental and
+may vanish in future versions.>
=item B<--output|-o> <directory|file>
diff --git a/script/korapxml2krill b/script/korapxml2krill
index 05beb09..2713342 100644
--- a/script/korapxml2krill
+++ b/script/korapxml2krill
@@ -533,8 +533,8 @@
=head1 SYNOPSIS
$ korapxml2krill -z --input <directory> --output <filename>
- $ korapxml2krill archive -z --input <directory> --output <directory>
- $ korapxml2krill extract --input <directory> --output <filename> --sigle <SIGLE>
+ $ korapxml2krill archive -z --input <directory|archive> --output <directory>
+ $ korapxml2krill extract --input <directory|archive> --output <filename> --sigle <SIGLE>
=head1 DESCRIPTION
@@ -557,15 +557,17 @@
=head1 ARGUMENTS
+Without arguments, C<korapxml2krill> processes a directory of a single KorAP-XML document.
+
=over 2
=item B<archive>
-Process an archive as a Zip-file or a folder of KorAP-XML documents.
+Processes an archive as a Zip-file or a folder of KorAP-XML documents.
=item B<extract>
-Extract KorAP-XML files from a Zip-file.
+Extracts KorAP-XML files from a Zip-file.
=back
@@ -578,21 +580,26 @@
Directory or archive file of documents to convert.
-Archiving supports multiple input archives with the constraint,
+Without arguments, C<korapxml2krill> expects a folder of a single KorAP-XML
+document, while C<archive> and C<extract> support zip archives as well.
+
+C<archive> supports multiple input archives with the constraint,
that the first archive listed contains all primary data files
and all meta data files.
- -i file/news.zip -i file/news.malt.zip -i #file/news.tt.zip
+ -i file/news.zip -i file/news.malt.zip -i "#file/news.tt.zip"
(The directory structure follows the base directory format,
that may include a C<.> root folder.
In this case further archives lacking a C<.> root folder
-need to be passed with a hash sign in front of the archive's name.)
+need to be passed with a hash sign in front of the archive's name.
+This may require to quote the parameter.)
-B<To support zip files, a version of C<unzip> needs to be installed that is
-compatible with the archive file.>
+To support zip files, a version of C<unzip> needs to be installed that is
+compatible with the archive file.
-B<The root folder switch is experimental and may vanish in future versions.>
+B<The root folder switch using the hash sign is experimental and
+may vanish in future versions.>
=item B<--output|-o> <directory|file>
diff --git a/t/script/archive.t b/t/script/archive.t
index d797c20..2776c7e 100644
--- a/t/script/archive.t
+++ b/t/script/archive.t
@@ -31,7 +31,7 @@
sub {
system($call);
},
- qr!archive.+?Process an!s,
+ qr!archive.+?Processes an!s,
$call
);
diff --git a/t/script/extract.t b/t/script/extract.t
index 8e7cdfd..0f8f0b7 100644
--- a/t/script/extract.t
+++ b/t/script/extract.t
@@ -31,7 +31,7 @@
sub {
system($call);
},
- qr!extract.+?Extract KorAP-XML files!s,
+ qr!extract.+?Extracts KorAP-XML files!s,
$call
);