From 3227de7c455d893ab94414d7c2df27c56c31ec17 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Thu, 11 Oct 2012 21:13:35 +0200 Subject: Add README and inline POD for script. --- README | 23 +++++++++++++++++++++++ bin/smsg | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 83 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..fcab9d2 --- /dev/null +++ b/README @@ -0,0 +1,23 @@ +NAME + App::smsg - utilities for short messages + +SYNOPSIS + use App::smsg; + App::smsg->run; + +DESCRIPTION + This is the module supporting the "smsg" command-line tool. + +AUTHOR + Jonas Smedegaard + +COPYRIGHT AND LICENCE + This software is copyright (c) 2012 by Jonas Smedegaard. + + This is free software; you can redistribute it and/or modify it under + the same terms as the Perl 5 programming language system itself. + +DISCLAIMER OF WARRANTIES + THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED + WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF + MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. diff --git a/bin/smsg b/bin/smsg index 6b3723d..d185686 100755 --- a/bin/smsg +++ b/bin/smsg @@ -2,3 +2,63 @@ use App::smsg; App::smsg->run; + +__END__ + +=head1 NAME + +smsg - utilities for short messages + +=head1 SYNOPSIS + +Wanna chat with a silly bot in some Jabber chatroom? + + $ smsg talk bot@example.org foo talkfile.txt room1@muc.example.org + connecting to bot@example.org... + +=head1 DESCRIPTION + +smsg is a command-line tool which provides a handful of helpful +utilities for short messages. For example, reporting on the status of a +Kannel server or a Jabber server; passing messages between them; +mirroring messages processed on a Kannel server in a Jabber chatroom, +and so on. + +This is an early version, so the number of utilities provided is fairly +limited, but will grow. Thanks to L, smsg has a modular +architecture, so you can write your own App::smsg plugins, and publish +them on CPAN. + +For a list of supported commands, run: + + $ smsg commands + +For help on a particular command, e.g. the "talk" command, run: + + $ smsg help talk + +=head1 BUGS + +Please report any bugs to +Edr@jones.dkE. + +=head1 SEE ALSO + +L. + +=head1 AUTHOR + +Jonas Smedegaard Edr@jones.dkE. + +=head1 COPYRIGHT AND LICENCE + +This software is copyright (c) 2012 by Jonas Smedegaard. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +=head1 DISCLAIMER OF WARRANTIES + +THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. -- cgit v1.2.3