aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index 9eb3b03..537055c 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ BPEG is a parsing expression grammar tool for the command line.
It's written in pure C with no dependencies.
## Usage
-`bpeg [flags] <pattern> [<input files>...]`
+`bp [flags] <pattern> [<input files>...]`
### Flags
* `-h` `--help` print the usage and quit
@@ -12,13 +12,13 @@ It's written in pure C with no dependencies.
* `-i` `--ignore-case` perform a case-insensitive match
* `-d` `--define <name>:<def>` define a grammar rule
* `-D` `--define-string <name>:<def>` define a grammar rule (string-pattern)
-* `-p` `--pattern <pat>` provide a pattern (equivalent to bpeg '
-* `-P` `--pattern-string <pat>` provide a string pattern (equivalent to bpeg '<pat>', but may be useful if '<pat>' begins with a '-')
+* `-p` `--pattern <pat>` provide a pattern (equivalent to `bp '\(<pat>)'`)
+* `-P` `--pattern-string <pat>` provide a string pattern (equivalent to `bp '<pat>'`, but may be useful if `'<pat>'` begins with a '-')
* `-r` `--replace <replacement>` replace the input pattern with the given replacement
-* `-m` `--mode <mode>` set the behavior mode (defult: find-all)
+* `-m` `--mode <mode>` set the behavior mode (defult: `find-all`)
* `-g` `--grammar <grammar file>` use the specified file as a grammar
-See `man ./bpeg.1` for more details.
+See `man ./bp.1` for more details.
## BPEG Patterns
BPEG patterns are a mixture of Parsing Expression Grammar and Regular
@@ -63,7 +63,7 @@ Pattern | Meaning
`#( block comment )#` | A block comment
`# line comment` | A line comment
-See `man ./bpeg.1` for more details.
+See `man ./bp.1` for more details.
## License
BPEG is provided under the MIT license with the [Commons Clause](https://commonsclause.com/)