From fb2e85baa261e648628b158dfa8395d647439d1e Mon Sep 17 00:00:00 2001 From: Jamie Jennings Date: Tue, 8 Nov 2016 16:38:31 -0500 Subject: [PATCH] Updated mentions of "./run" to the new "./bin/rosie" command to run rosie --- doc/cli.md | 17 +++++++---------- doc/repl.md | 2 +- doc/rpl.md | 4 ++-- 3 files changed, 10 insertions(+), 13 deletions(-) diff --git a/doc/cli.md b/doc/cli.md index 243b349..7033e1d 100644 --- a/doc/cli.md +++ b/doc/cli.md @@ -10,23 +10,20 @@ ### Running Rosie -The `run` script in the Rosie install directory starts the command line interface (CLI), which can be used to match rpl pattern expressions against files of data. (To match against a single string, use the [interactive read-eval-print loop (repl)](repl.md).) +The `bin/rosie` script in the Rosie install directory starts the command line interface (CLI), which can be used to match rpl pattern expressions against files of data. (To match against a single string, use the [interactive read-eval-print loop (repl)](repl.md).) The Rosie Pattern Engine reads input files one line at a time, and tries to match each line against the pattern expression given on the command line. -A good way to run Rosie is to define an alias. In the bash shell, you can write (substituting your Rosie install directory for mine): +One way to run Rosie is to define an alias. In the bash shell, you can write (substituting your Rosie install directory for mine): ``` -alias rosie='/Users/jjennings/Dev/rosie-pattern-language/run' +alias rosie='/Users/jjennings/Dev/rosie-pattern-language/bin/rosie' ``` -Or if you cd into the Rosie install directory, this: +Or use `make install` to place a link in `/usr/local/bin/rosie`. -``` -alias rosie=`pwd`/run -``` +More detail about the way Rosie is installed can be found [here](install.md). -Putting this alias definition into your `~/.bashrc` file will load it every time an interactive bash shell starts. Now you can type `rosie` to start the Rosie CLI. ### A quick "sniff test" to see if things are working @@ -47,11 +44,11 @@ Rosie supports output in a few formats, which are controlled by the value of the ### Help is available ``` -bash-3.2$ ./run -help +bash-3.2$ ./bin/rosie -help This is Rosie v0.99a The Rosie install directory is: /Users/jjennings/Work/Dev/rosie-pattern-language Rosie help: -Rosie usage: ./run * +Rosie usage: ./bin/rosie * Valid are: -help -patterns -verbose -all -repl -grep -eval -wholefile -manifest -f -e -encode -help prints this message diff --git a/doc/repl.md b/doc/repl.md index 7b745c0..307626a 100644 --- a/doc/repl.md +++ b/doc/repl.md @@ -7,7 +7,7 @@ In the [Rosie Command Line Interface documentation](cli.md) you will find the processing any other command line options. For example: ``` -jjennings$ ./run -repl +jjennings$ ./bin/rosie -repl Rosie CLI warning: missing pattern argument Rosie CLI warning: missing filename arguments This is Rosie v0.99a diff --git a/doc/rpl.md b/doc/rpl.md index 0a0716a..2c22e3b 100644 --- a/doc/rpl.md +++ b/doc/rpl.md @@ -294,7 +294,7 @@ But this is not quite enough, because this pattern will consume characters as lo The pattern above says "while not looking at _ear_, consume all characters; then match _ear_ at the end of the line." Using this expression, we get: ```shell -bash-3.2$ ./run '{{!"ear" .}* "ear"}$' /usr/share/dict/words | head -5 +bash-3.2$ ./bin/rosie '{{!"ear" .}* "ear"}$' /usr/share/dict/words | head -5 abear afear anear @@ -306,7 +306,7 @@ Observe that the form of this pattern is `{{ !X .}* X}`, in other words, "consum ```shell -bash-3.2$ ./run '{"c" {!"ear" .}* "ear"$}' /usr/share/dict/words +bash-3.2$ ./bin/rosie '{"c" {!"ear" .}* "ear"$}' /usr/share/dict/words circumnuclear clear coappear