Update documentation

[gruntmaster-data.git] / gruntmaster-job

diff --git a/gruntmaster-job b/gruntmaster-job
index 7adab69797a5ab43e7d5e9a5b1330d7399406662..23e9cd2870ea57553a103d4eada12462010a7687 100755 (executable)
--- a/gruntmaster-job
+++ b/gruntmaster-job
@@ -61,12 +61,44 @@ gruntmaster-job - shell interface to Gruntmaster 6000 job log
 
 =head1 SYNOPSIS
 
-  gruntmaster-job card
-  gruntmaster-job show 5
-  gruntmaster-job rerun 7
+  gruntmaster-job [--contest=mycontest] card
+  gruntmaster-job [--contest=mycontest] show 5
+  gruntmaster-job [--contest=mycontest] rerun 7
 
 =head1 DESCRIPTION
 
+gruntmaster-job is a tool for managing jobs.
+
+Select the contest with the optional argument I<--contest>.
+
+=over
+
+=item B<card>
+
+Prints the number of jobs in the selected contest.
+
+=item B<show> I<id>
+
+Prints detailed information about the job with id I<id>.
+
+=item B<rerun> I<id>
+
+Reruns job I<id>.
+
+=back
+
+=head1 AUTHOR
+
+Marius Gavrilescu E<lt>marius@ieval.roE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2014 by Marius Gavrilescu
+
+This library is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
 
 
 =cut