# NAME

Text::Schmutz - YМЈouМЈr МЈScreМ’en is qМ’uiМЈtМ’e diМ‡rМЈtМ‡yМ‡, plМ’eМ’aМ’sМ’e clМ‡eМЈaМЈn iМ‡tМЈ.

# VERSION

version v0.1.2

# SYNOPSIS

```perl
use Text::Schmutz;

my $s = Text::Schmutz->new( prob => 0.1, use_small => 1 );

say $s->mangle($text);
```

# DESCRIPTION

"ThМ”oughМњtМ’s of dМЈirt spill МµoМ‡veМњr to МњyoНur МњuМ’nicoНdeМњ Нenabled tМµext"

This is a Perl adaptation of `schmutz.go` by Clemens Fries <github-schmutz@xenoworld.de>, from which a lot of the
documentation comes from.

# ATTRIBUTES

## prob

This is the probability that a character will be dirty, between 0 and 1. It defaults to 0.1.

## use\_small

"spray dust on your text".

If ["use\_large"](#use_large) and ["strike\_out"](#strike_out) are not enabled, then this is enabled by default.

For example:

```
LМЈorem iМ‡psМ’um М’dolМЈor sit amet, conseМ’cteМ‡tМЈur adipiscing elМЈitМ’, М’seМ’d М’dМ‡o
eiusmМЈoМ’d МЈtempor inciМЈdМЈidМ‡unt ut laМЈbore МЈeМ’t doloМ’re МЈmaМ’gnaМ’ МЈaliqМ’uaМ‡.
```

## use\_large

"a cookie got mangled in your typewriter"

For example, with ["prob"](#prob) set to 0.5:

```
LМ”oreМ”m Н“ipsumН dolН“orН“ sit amН“eНtМ”, Н“consН“ectetМ”ur НaМ”dМµiМњpiscМ”inМњg elМµiН“tН“,Н“ sМµeНdН doМ”
eiНusmН“odМњ Н“tempМњor Н“iМµnМ”cН“ididМµuМњnt ut М”laМ”boМњrМµe МµetМµ МµdoloreМњ maМµgnН“aН“ НalМµiМ”quaН“.Мµ
```

## strike\_out

"this is unacceptable"

For example, with ["prob"](#prob) set to 1.0:

```
Lвѓ«oвѓ“rвѓ«eМ·mвѓ“ вѓ’iвѓҐpвѓ“sМ¶uвѓ“mвѓҐ вѓ«dвѓ’oвѓҐlвѓ’oМµrвѓ¦ М¶sМ¶iвѓ«tМё М¶aвѓҐmМ¶eвѓ’tМ¶,вѓҐ Мµcвѓ«oвѓҐnвѓ“sМ·eвѓ“cМµtвѓ’eвѓ“tМ¶uМ¶rвѓ« вѓҐaвѓ’dвѓҐiМ¶pМµiМµsМ·cМёiвѓ“nвѓ’gвѓ’ МµeМёlвѓ¦iвѓ“tвѓ’,Мµ вѓҐsМµeвѓҐdМё МµdМ¶oМ¶
М·eМµiвѓҐuМµsвѓ“mвѓ“oвѓ«dМ¶ МёtМ¶eвѓ’mМёpвѓ“oвѓ¦rвѓ’ вѓ’iМ·nвѓҐcвѓ«iвѓ“dвѓҐiМµdМ·uМ·nМ¶tМё МµuМ·tвѓҐ М¶lМ·aвѓ¦bвѓҐoМµrвѓ“eвѓ’ вѓ’eМµtМё Мёdвѓ¦oМёlМµoМµrвѓ“eМ¶ вѓ’mМ·aМ·gМ·nМµaМµ Мµaвѓ¦lМ·iМ·qвѓҐuМёaМ¶.вѓ’
```

# METHODS

## mangle

```
$dirty = $s->mangle( $text, $prob );
```

# SOURCE

The development version is on github at [https://github.com/robrwo/perl-Text-Schmutz](https://github.com/robrwo/perl-Text-Schmutz)
and may be cloned from [git://github.com/robrwo/perl-Text-Schmutz.git](git://github.com/robrwo/perl-Text-Schmutz.git)

# BUGS

Please report any bugs or feature requests on the bugtracker website
[https://github.com/robrwo/perl-Text-Schmutz/issues](https://github.com/robrwo/perl-Text-Schmutz/issues)

When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.

# AUTHOR

Robert Rothenberg <rrwo@cpan.org>

The original [schmutz](https://github.com/githubert/schmutz) was written by Clemens Fries <github-schmutz@xenoworld.de>.

# COPYRIGHT AND LICENSE

This software is Copyright (c) 2024-2025 by Robert Rothenberg.

This is free software, licensed under:

```
The GNU General Public License, Version 3, June 2007
```