From: W. Trevor King <wking@drexel.edu>
Date: Wed, 29 Sep 2010 11:42:59 +0000 (-0400)
Subject: Quote backslash-containing arguments in doc/tutorial.py.
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=2cf4a97efc2e3ac3f21908707495f6af692b039b;p=hooke.git

Quote backslash-containing arguments in doc/tutorial.py.
---

diff --git a/doc/tutorial.txt b/doc/tutorial.txt
index 13e0694..1e0b957 100644
--- a/doc/tutorial.txt
+++ b/doc/tutorial.txt
@@ -106,13 +106,20 @@ and you want to analyze them all.
 
 You then can ``cd`` (change directory) to the directory::
 
-    hooke> cd --path c:\curves
+    hooke> cd --path "c:\curves"
 
-Type ``pwd`` (print working directory) to check the directory is correct.::
+Hooke parses it's commandline using `POSIX rules`_, so you need to
+quote arguments with backslashes to keep them from being expanded as
+escape sequences (e.g. ``\t`` → ``TAB``).
+
+Type ``pwd`` (print working directory) to check the directory is
+correct.::
 
     hooke> pwd
     c:\curves
 
+.. _POSIX rules: http://docs.python.org/library/shlex#parsing-rules
+
 You can list the files in the directory using ``ls`` or ``dir``
 (they’re synonyms).::