Write POD for Gruntmaster::App::*

[gruntmaster-data.git] / lib / Gruntmaster / App / Command / List.pm

diff --git a/lib/Gruntmaster/App/Command/List.pm b/lib/Gruntmaster/App/Command/List.pm
index 3c62604c221178f89b090ded5352061880734c23..e447a67a8a6644c7eac1fcf46e62abd95da180f5 100644 (file)
--- a/lib/Gruntmaster/App/Command/List.pm
+++ b/lib/Gruntmaster/App/Command/List.pm
@@ -23,3 +23,52 @@ sub execute {
 
 1;
 __END__
+
+=encoding utf-8
+
+=head1 NAME
+
+Gruntmaster::App::Command::List - list all objects of a type
+
+=head1 SYNOPSIS
+
+  gm -c list
+  # test_contest
+  # some_other_contest
+
+  gm -j list # This is pretty pointless
+  # 1
+  # 2
+  # 3
+
+  gm -p list
+  # aplusb
+  # aminusb
+
+  gm -u list
+  # MGV
+  # nobody
+
+=head1 DESCRIPTION
+
+The list command lists the IDs of all objects of a type, one per line.
+The list is sorted.
+
+=head1 SEE ALSO
+
+L<gm>
+
+=head1 AUTHOR
+
+Marius Gavrilescu, E<lt>marius@ieval.roE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2015 by Marius Gavrilescu
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself, either Perl version 5.20.1 or,
+at your option, any later version of Perl 5 you may have available.
+
+
+=cut