oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added proper POD documentation to utility scripts using POD::Usage.

Browse source
This commit is contained in:
Ernesto Hernández-Novich 2008-06-06 22:08:59 +00:00
parent 3a59968376
commit 4555e8ca8e
15 changed files with 1202 additions and 604 deletions
Download patch file Download diff file Expand all files Collapse all files

68
sbin/migrateCollabToGallery.pl
View file

@ -68,7 +68,7 @@ sub start {
# Show usage
if ($help) {
pod2usage(1);
pod2usage( verbose => 2);
}
unless ($configFile) {
@ -95,42 +95,50 @@ sub finish {
$session->close;
}
__END__
=head1 NAME
migrateCollabToGallery.pl -- Migrate a collaboration system into a Gallery
migrateCollabToGallery -- Migrate a collaboration system into a Gallery
=head1 SYNOPSIS
migrateCollabToGallery.pl --configFile=<config> <collab> <gallery>
migrateCollabToGallery --configFile config.conf collab gallery
=head1 ARGUMENTS
=over
=item collab
A collaboration system URL or asset ID. The URL must be an absolute URL, and
so must begin with a "/".
=item gallery
A Gallery URL or asset ID. The URL must be an absolute URL, and so much begin
with a "/".
=back
=head1 OPTIONS
=over
=item configFile
The WebGUI config file to use.
=back
migrateCollabToGallery --help
=head1 DESCRIPTION
This script migrates a collaboration system's threads into gallery albums. It
uses C<WebGUI::Utility::Gallery> for its major features.
This WebGUI utility script migrates a collaboration system's threads
into gallery albums. It uses C<WebGUI::Utility::Gallery> for its major
features.
=over
=item C<--configFile config.conf>
The WebGUI config file to use. Only the file name needs to be specified,
since it will be looked up inside WebGUI's configuration directory.
This parameter is required.
=item C<collab>
A WebGUI's Collaboration System URL or Asset ID. If an URL is given,
it must be an absolute URL beginning with a slash.
=item C<gallery>
A WebGUI's Gallery URL or Asset ID. If an URL is given, it must be
an absolute URL beginning with a slash.
=item C<--help>
Shows this documentation, then exits.
=back
=head1 AUTHOR
Copyright 2001-2008 Plain Black Corporation.
=cut