summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2017-03-16 23:46:11 -0400
committerGitHub <noreply@github.com>2017-03-16 23:46:11 -0400
commit91cc19ca5d95aaa6ef2188c226c9cbcf8b19537f (patch)
treeeed4a8f6e66622b7a45d58cf4685b8e5b6920905 /README.rst
parent2d4b43a4901122d7918af4030c440a3c93892a4f (diff)
parent3fceb279272f1a1595071420494905dc29b6dd82 (diff)
downloadcmd2-git-91cc19ca5d95aaa6ef2188c226c9cbcf8b19537f.tar.gz
Merge pull request #82 from python-cmd2/regex_transcript
Improved documentation for regular expressions in transcripts
Diffstat (limited to 'README.rst')
-rwxr-xr-xREADME.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index d36b3456..2d7c805b 100755
--- a/README.rst
+++ b/README.rst
@@ -240,9 +240,14 @@ example/exampleSession.txt::
blah blah blah
(Cmd) & look, a shortcut!
look, a shortcut!
+ (Cmd) show color
+ colors: /(True|False)/
(Cmd) set prompt "---> "
prompt - was: (Cmd)
now: --->
---> say goodbye
goodbye
+Note how a regular expression ``/True|False/`` is used near the end for output of the **show color** command since
+colored text is currently not available for cmd2 on Windows. Regular expressions can be used anywhere within a
+transcript file simply by embedding them within two forward slashes, ``/``.