Update documentation

[gruntmaster-data.git] / gruntmaster-problem

diff --git a/gruntmaster-problem b/gruntmaster-problem
index 80aa68d7485f8d38f5894ffe395d4c4912d96bd1..e5a02d8fb2fbc7d099c7c6e02ff3f6ccc9f9da3e 100755 (executable)
--- 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