Also close bug

[filters.git] / kenny

#!/usr/bin/perl -w
#
# kenny.pl -- translate from and to KennySpeak
# 
# $Revision: 1.7 $
#
# Licensed unter the Artistic License:
# http://www.perl.com/language/misc/Artistic.html
#
# (C) 2001,2002 by Christian Garbs <mitch@cgarbs.de>, http://www.cgarbs.de
#                  Alan Eldridge <alane@geeksrus.net>
#
# KennySpeak invented by Kohan Ikin <syneryder@namesuppressed.com>
#                        http://www.namesuppressed.com/kenny/

#
# $Id: kenny.pl,v 1.7 2002/01/06 22:09:52 mitch Exp $
#

use strict;

#
# This is Perl POD documentation.
# You can generate a nice manpage with "pod2man kenny.pl > kenny.man".
# Or have a look at "perldoc perlpod" for other options
#

=head1 NAME

kenny.pl -- translate from and to KennySpeak

=head1 SYNOPSIS

B<kenny.pl>
S<[ B<-h> ]>
S<[ B<-u> ]>
S<[ B<-k> | B<-d> ]>
S<[ I<file1> ] [ I<file2> ] ...>

=head1 OVERVIEW

kenny.pl translates a given text from or to B<KennySpeak>. KennySpeak
looks like this:

    "Ppfmfp ppmffm mfmppfmpm, fmpmfpmppffm'fpmmpp
     pmpmffpmfpmfmppmpm Pmpmppppppppffm!"

=head1 DESCRIPTION

kenny.pl will read the given filenames, translate them and print the
results on stdout. If you don't give a filename, stdin is used. A F<->
as a filename means stdin.

Without any parameters, kenny.pl will look at the first line of input
and guess which way you want to translate. If kenny.pl guesses wrong,
you must select the translation mode using the B<-k> or B<-d> switch.

=head2 Switches

=over 5

=item B<-h>

This will print a short notice and a quick summary of the available
switches.

=item B<-u>

This will convert German umlauts to Ae, Oe, Ue, ae, oe, ue and ss
so that they can be kennyfied correctly.

=item B<-k>

Kennyfy. This forces the input to be translated into KennySpeak.

=item B<-d>

Dekennyfy. This forces the input to be translated back from
KennySpeak.

=back

=head1 VERSION

This is $Revision: 1.7 $.

=head1 BUGS

The B<-u> switch might not work for charsets other than Latin-1. You
might try to convert the kenny.pl script using B<recode> to change it
from Latin-1 to your preferred charset.

=head1 CREDITS

kenny.pl was written by B<Christian Garbs>. Look on his homepage for
newer versions of kenny.pl. Bug reports or comments about the program
should be sent to him:
       Christian Garbs <F<mitch@cgarbs.de>>
       F<http://www.cgarbs.de/weird.en.html>

KennySpeak was invented by B<Kohan Ikin>. See his homepage for an
online version of the original B<KennyTranslator>:
       Kohan Ikin <F<syneryder@namesuppressed.com>>
       F<http://www.namesuppressed.com/kenny/>

Alan Eldridge <F<alane@geeksrus.net>> patched in a signal handler to
print an appropriate message when kenny.pl is killed.

=head1 COPYRIGHT

kenny.pl is licensed unter the B<Artistic License> which can be found
at F<http://www.perl.com/language/misc/Artistic.html>. This license
has been chosen for keeping compatibility with the original KennySpeak
format.

=cut



######################################################################
#
# CHANGELOG
#
# $Log: kenny.pl,v $
# Revision 1.7  2002/01/06 22:09:52  mitch
# Included patch by Alan Eldridge <alane@geeksrus.net>
# to show a message when kenny.pl is killed.
#
# Revision 1.6  2001/07/20 19:04:49  mitch
# Removed warnings with Perl 5.6. 
# Thanks go to Alan Eldridge <alane@geeksrus.net>
#
# Revision 1.5  2001/07/15 10:27:57  mitch
# Included notice about -u and charsets other than Latin-1.
#
# Revision 1.4  2001/07/14 13:16:30  mitch
# Initial release.
#
#
#
######################################################################



#
# finally{}, the source code!
#



##### Declaration of function prototypes

sub generateKenny();
sub generateDeKenny($);
sub guessDialect($);
sub translate($);
sub addGermanUmlauts($);
sub printHelp();
sub theyKilledKenny();



##### Default values for various option:

my $dialect = 0;  # Translate from or to KennySpeak?
                  # 0=guess, 1=encode, 2=decode

my $umlauts = 0;  # Convert German Umlauts before translation?