summaryrefslogtreecommitdiff
path: root/plugins/perl/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-10-07 17:40:51 +0200
committerGitHub <noreply@github.com>2019-10-07 17:40:51 +0200
commit896dd271c8cadce8b8a618225cb4e79b9bca50f7 (patch)
tree72540701d4f8499fdd660bc1a5d5b5d05887cfd9 /plugins/perl/README.md
parent53d987346f4d465c100f3dab234953db48eed7a1 (diff)
downloadzsh-896dd271c8cadce8b8a618225cb4e79b9bca50f7.tar.gz
zsh-896dd271c8cadce8b8a618225cb4e79b9bca50f7.tar.bz2
zsh-896dd271c8cadce8b8a618225cb4e79b9bca50f7.zip
Some syntax changes and more function docs
Diffstat (limited to 'plugins/perl/README.md')
-rw-r--r--plugins/perl/README.md29
1 files changed, 15 insertions, 14 deletions
diff --git a/plugins/perl/README.md b/plugins/perl/README.md
index f2f4b79ec..dd9b7dc75 100644
--- a/plugins/perl/README.md
+++ b/plugins/perl/README.md
@@ -10,27 +10,28 @@ 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|
+| 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
+* `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)
+* `pgs`: Perl Global Substitution: `pgs <find_pattern> <replace_pattern> <filename>`
+ Looks for `<find_pattern>` and replaces it with `<replace_pattern>` in `<filename>`.
-`prep` - Perl grep, because 'grep -P' is terrible. Lets you work with pipes or files. (pattern = 1st arg ; filename = 2nd arg)
+* `prep`: Perl grep, because 'grep -P' is terrible: `prep <pattern> [<filename>]`
+ Lets you work with pipes or files (if no `<filename>` provided, use stdin).
## 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