[svn:parrot] r37794 - trunk/tools/dev

[jkeenan at svn.parrot.org]

Author: jkeenan
Date: Sat Mar 28 02:16:29 2009
New Revision: 37794
URL: https://trac.parrot.org/parrot/changeset/37794

Log:
Add documentation in POD format.

Modified:
   trunk/tools/dev/nopaste.pl

Modified: trunk/tools/dev/nopaste.pl
==============================================================================
--- trunk/tools/dev/nopaste.pl	Sat Mar 28 01:53:06 2009	(r37793)
+++ trunk/tools/dev/nopaste.pl	Sat Mar 28 02:16:29 2009	(r37794)
@@ -65,6 +65,34 @@
     exit 0;
 }
 
+########## DOCUMENTATION ##########
+
+=head1 NAME
+
+tools/dev/nopaste.pl - paste the contents of a file via a pastebot server
+
+=head1 SYNOPSIS
+
+  nopaste.pl -t "TITLE" [ -c CHANNEL ] [ -n NAME ] [ FILENAME ]
+
+    TITLE     the title of the paste
+    CHANNEL   the irc channel (defaults to #parrot)
+    NAME      the username (defaults to username or 'someone')
+    FILENAME  the name of the file to paste (defaults to STDIN)
+
+=head1 DESCRIPTION
+
+This program can be used to paste the contents of a file on a pastebot server
+-- specifically, B<nopaste.snit.ch> -- for immediate linkage on an IRC channel --
+by default, B<#parrot>.
+
+=head1 AUTHOR
+
+Originally written by particle, with subsequent contributions to functionality
+by LimbicRegion, paultcochrane and cotto.
+
+=cut
+
 # Local Variables:
 #   mode: cperl
 #   cperl-indent-level: 4