[Rt-commit] r8234 - rtir/branches/2.3-EXPERIMENTAL/etc

[ruz at bestpractical.com]

Author: ruz
Date: Thu Jul 19 15:51:31 2007
New Revision: 8234

Modified:
   rtir/branches/2.3-EXPERIMENTAL/etc/add_constituency

Log:
* add POD

Modified: rtir/branches/2.3-EXPERIMENTAL/etc/add_constituency
==============================================================================
--- rtir/branches/2.3-EXPERIMENTAL/etc/add_constituency	(original)
+++ rtir/branches/2.3-EXPERIMENTAL/etc/add_constituency	Thu Jul 19 15:51:31 2007
@@ -1,4 +1,49 @@
 #!/usr/bin/perl
+
+=head1 NAME
+
+add_constituency - add or update constitiuensies
+
+=head1 SYNOPSIS
+
+    add_constituency --name <constituency> [options]
+    add_constituency --name EDUNET
+    add_constituency --name EDUNET --verbose
+    add_constituency --name EDUNET --corespond 'edunet at example.com' --verbose
+
+Run `perldoc add_constituency` to gte more info about the tool.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--name>
+
+Constituency name. Mandatory argument.
+
+=item --correspond
+
+Set/update correspond address.
+
+=item --comment
+
+Set/update comment address.
+
+=item --verbose
+
+Enable verbose output.
+
+=back
+
+=head1 DESCRIPTION
+
+This command line utitlity is a helper for activating advanced access control
+on tickets using the current value of the constituency field.
+
+Read more in F<docs/Constituencies.pod> using perldoc tool.
+
+=cut
+
 use warnings;
 use strict;