summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--plugins/perl/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/plugins/perl/README.md b/plugins/perl/README.md
new file mode 100644
index 000000000..f2f4b79ec
--- /dev/null
+++ b/plugins/perl/README.md
@@ -0,0 +1,36 @@
+# Perl
+
+This plugin adds [perl](https://www.perl.org/) useful aliases/functions.
+
+To use it, add `perl` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... perl)
+```
+
+## Aliases
+
+| Aliases | Command | Description |
+| :------------ | :-------------- | :----------------------------------- |
+| pbi | perlbrew install|Install specific perl version |
+| pbl | perlbrew list |List all perl version installed |
+| pbo | perlbrew off |Go back to the system perl |
+| pbs | perlbrew switch |Turn it back on |
+| pbu | perlbrew use |Use specific version of perl |
+| pd | perldoc |Show the perl documentation |
+| ple | perl -wlne |Use perl like awk/sed |
+| latest-perl | curl `...` |Show the latest stable release of Perl|
+
+## Functions
+
+`newpl` - creates a basic Perl script file and opens it with $EDITOR
+
+`pgs` - Perl Global Substitution (find pattern = 1st arg ; replace pattern = 2nd arg ; filename = 3rd arg)
+
+`prep` - Perl grep, because 'grep -P' is terrible. Lets you work with pipes or files. (pattern = 1st arg ; filename = 2nd arg)
+
+## Requirements
+
+In order to make this work, you will need to have perl installed.
+
+More info on the usage and install: https://www.perl.org/get.html