e2d5426f42a8e8dc1d8d93da6dfadf7d361c2e0f

Author
Marc Cornellà <marc.cornella@live.com>
Committer
GitHub <noreply@github.com>
Date

Message

perl: add README (#8215)

Diff

 1diff --git a/plugins/perl/README.md b/plugins/perl/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..dd9b7dc75392d155674f5dd669f9db40d0b09a9d
 4--- /dev/null
 5+++ b/plugins/perl/README.md
 6@@ -0,0 +1,37 @@
 7+# Perl
 8+
 9+This plugin adds [perl](https://www.perl.org/) useful aliases/functions.
10+
11+To use it, add `perl` to the plugins array in your zshrc file:
12+
13+```zsh
14+plugins=(... perl)
15+```
16+
17+## Aliases
18+
19+| Aliases       | Command            |  Description                           |
20+| :------------ | :----------------- | :------------------------------------- |
21+| pbi           | `perlbrew install` | Install specific perl version          |
22+| pbl           | `perlbrew list`    | List all perl version installed        |
23+| pbo           | `perlbrew off`     | Go back to the system perl             |
24+| pbs           | `perlbrew switch`  | Turn it back on                        |
25+| pbu           | `perlbrew use`     | Use specific version of perl           |
26+| pd            | `perldoc`          | Show the perl documentation            |
27+| ple           | `perl -wlne`       | Use perl like awk/sed                  |
28+| latest-perl   | `curl ...`         | Show the latest stable release of Perl |
29+
30+## Functions
31+
32+* `newpl`: creates a basic Perl script file and opens it with $EDITOR.
33+
34+* `pgs`: Perl Global Substitution: `pgs <find_pattern> <replace_pattern> <filename>`
35+  Looks for `<find_pattern>` and replaces it with `<replace_pattern>` in `<filename>`.
36+
37+* `prep`: Perl grep, because 'grep -P' is terrible: `prep <pattern> [<filename>]`
38+  Lets you work with pipes or files (if no `<filename>` provided, use stdin).
39+
40+## Requirements
41+
42+In order to make this work, you will need to have perl installed.
43+More info on the usage and install: https://www.perl.org/get.html