Skip to content

Latest commit

 

History

History
120 lines (65 loc) · 2.75 KB

Title.pod

File metadata and controls

120 lines (65 loc) · 2.75 KB

NAME

Random::Title returns a random title of a person.

VERSION

This document describes Random::Title version 1.000.

SYNOPSIS

use Random::Title qw(random_title);

my $title            = random_title();

my $noble_male       = random_title('noble male');
my $noble_female     = random_title('noble female');
my $military_rank    = random_title('military');
my $naval_rank       = random_title('naval');
my $government_title = random_title('government');

print random_title('help'); # get random_title options

DESCRIPTION

Random::Title returns a random title of a person.

random_title

Options

nothing, all, or undef

random_title;
random_title();
random_title('all');
random_title(undef);

These options return any value in any list. You can read the options below to see all of the potential values.

noble male

random_title('noble male');

The noble male option returns emperor, king, prince, archduke, duke, count, viscount, baron, squire, master, or lord.

noble female

random_title('noble female');

The noble female option returns empress, queen, princess, archduchess, duchess, countess, viscountess, baroness, dame, mistress, or lady.

military

random_title('military');

The military option returns marshal, general, colonel, major, captain, lieutenant, sergeant, corporal, or private.

navel

random_title('navel');

The naval option returns admiral, captain, commander, lieutenant, ensign, or seaman.

government

random_title('government');

The government options returns president, secretary, senator, governor, director, commissioner, mayor, administrator, or manager.

by keys

random_title('by keys');

The by keys option will select a random key listed above.

keys

random_title('keys');

The keys option will list all of the available keys in an array reference.

data

random_title('data');

The data option will return the data used in a hash reference.

help or options

random_title('help');
random_title('options');

The help or options options will return a list of all of your options.

Adding items to a list

my @additions = ('title 1', 'title 2');
random_title('<your option>', \@additions);

You can add items to the list by adding an array reference with the additional items as the second parameter.

DEPENDENCIES

Random::Title depends on Fancy::Rand and Exporter.

AUTHOR

Lady Aleena

LICENSE AND COPYRIGHT

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

Copyright © 2020, Lady Aleena (aleena@cpan.org). All rights reserved.