Browse Source

Some syntax changes and more function docs

Marc Cornellà 4 years ago
parent
commit
896dd271c8
1 changed files with 15 additions and 14 deletions
  1. 15 14
      plugins/perl/README.md

+ 15 - 14
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