From 9511aa34e3d741b04e126f3ec060915ab49190ef Mon Sep 17 00:00:00 2001 From: "Ryan S. Arnold" Date: Wed, 8 Aug 2018 10:33:18 -0500 Subject: [PATCH] Add escaping control characters info to readme.md Add instructions about how to escape control characters in order to use them in task descriptions. --- readme.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/readme.md b/readme.md index fef9b9ee..529d00c2 100644 --- a/readme.md +++ b/readme.md @@ -94,6 +94,8 @@ $ tb --help $ tb $ tb --task Make some buttercream $ tb --task @coding Improve documentation + $ tb --task @coding Improve documentation\'s \"Create Task\" \& \"Create Note\" sections + $ tb --task @coding "Improve documentation's \"Create Task\" & \"Create Note\" sections" $ tb --task @coding @reviews Review PR #42 $ tb --note @coding Mergesort worse-case O(nlogn) $ tb --check 1 2 @@ -179,6 +181,18 @@ To create a new task use the `--task`/`-t` option with your task's description f $ tb -t Improve documentation ``` +The shell reserves a number of common characters as control characters, e.g., `\`, `'`, `"`, `&`. To use these characters in your description use the shell escape character `\` before the control character. + +``` +$tb -t Improve documentation\'s \"Create Task\" \& \"Create Note\" sections +``` + +Alternatively you may enclose the text to be escaped in double-quotes making sure to escape any contained double-quotes. + +``` +$tb -t "Improve documentation's \"Create Task\" & \"Create Note\" sections" +``` + ### Create Note To create a new note use the `--note`/`-n` option with your note's body following right after.