diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2020-12-12 16:31:53 -0800 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2020-12-12 16:31:53 -0800 |
| commit | eb329bdac9fe56d67cb130fb6cdbb28743c6504b (patch) | |
| tree | 8ba8bded07820519de06728618e4e32e80da3af4 /README.md | |
| parent | 6e1fd928148cc7e46015e06c27f824d4111f96ee (diff) | |
Bunch of changes, including some bpeg->bp renaming, and adding
visualizations
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 6 insertions, 6 deletions
@@ -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/) |