From: Marius Gavrilescu <marius@ieval.ro>
Date: Sat, 1 Feb 2014 19:55:33 +0000 (+0200)
Subject: Update documentation
X-Git-Tag: 5999.000_001~6
X-Git-Url: http://git.ieval.ro/?a=commitdiff_plain;h=e90402be973e38af429acb2d1adc789868914940;p=gruntmaster-data.git

Update documentation
---

diff --git a/gruntmaster-contest b/gruntmaster-contest
index c2608c9..dfa2a38 100755
--- a/gruntmaster-contest
+++ b/gruntmaster-contest
@@ -68,6 +68,40 @@ gruntmaster-contest - shell interface to Gruntmaster 6000 contests
 
 =head1 DESCRIPTION
 
+gruntmaster-contest is a tool for managing contests.
+
+=over
+
+=item B<list>
+
+Prints the list of contests.
+
+=item B<show> I<id>
+
+Prints detailed information about the contest with id I<id>.
+
+=item B<add> I<id>
+
+Adds a new contest with id I<id>.
+
+=item B<rm> I<id>
+
+Removes the contest with id 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
diff --git a/gruntmaster-job b/gruntmaster-job
index 7adab69..23e9cd2 100755
--- 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
diff --git a/gruntmaster-problem b/gruntmaster-problem
index 80aa68d..e5a02d8 100755
--- a/gruntmaster-problem
+++ b/gruntmaster-problem
@@ -114,14 +114,58 @@ gruntmaster-problem - shell interface to Gruntmaster 6000 problems
 
 =head1 SYNOPSIS
 
-  gruntmaster-problem add problem_id
-  gruntmaster-problem list
-  gruntmaster-problem rm problem_id
-  gruntmaster-problem show problem_id
-  
+  gruntmaster-problem [--contest=mycontest] add problem_id
+  gruntmaster-problem [--contest=mycontest] list
+  gruntmaster-problem [--contest=mycontest] rm problem_id
+  gruntmaster-problem [--contest=mycontest] show problem_id
+  gruntmaster-problem [--contest=mycontest] set [--file] problem_id key value
 
 =head1 DESCRIPTION
 
+gruntmaster-problem is a tool for managing problems.
+
+Select the contest with the optional argument I<--contest>.
+
+=over
+
+=item B<list>
+
+Prints the list of problems in the selected contest.
+
+=item B<show> I<id>
+
+Prints detailed information about problem I<id>.
+
+=item B<add> I<id>
+
+Adds a new problem with id I<id>.
+
+=item B<rm> I<id>
+
+Removes the problem with id I<id>.
+
+=item B<set> I<id> I<key> I<value>
+
+Sets the I<key> configuration option of problem I<id> to I<value>.
+
+=item B<set> --file I<id> I<key> I<file>
+
+Sets the I<key> configuration option of problem I<id> to the contents of the file I<file>.
+
+=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