flo/todo.txt-cli
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation: Clarify basic regexp syntax of TERM in todo.sh list (#335)

Browse Source 
* Documentation: Clarify basic regexp syntax of TERM in todo.sh list

And give hints about escaping.
Issue raised by https://github.com/todotxt/todo.txt-cli/discussions/334

* Documentation: Correct quoting in todo.sh help list

Though the double quoting doesn't do harm when the single backslash is followed by the | character (\| is no valid escape sequence), it's technically more correct to use single quotes, and also is more in line with the quoting advice given directly below it.
This commit is contained in:
Ingo Karkat
2021-03-13 20:32:40 +01:00
committed by GitHub
parent 71b3991daf
commit 77c1f34609
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
todo.sh
View File

@@ -217,9 +217,13 @@ actionsHelp()
Displays all tasks that contain TERM(s) sorted by priority with line Displays all tasks that contain TERM(s) sorted by priority with line
numbers. Each task must match all TERM(s) (logical AND); to display numbers. Each task must match all TERM(s) (logical AND); to display
tasks that contain any TERM (logical OR), use tasks that contain any TERM (logical OR), use
"TERM1\|TERM2\|..." (with quotes), or TERM1\\\|TERM2 (unquoted). 'TERM1\|TERM2\|...' (with quotes), or TERM1\\\|TERM2 (unquoted).
Hides all tasks that contain TERM(s) preceded by a Hides all tasks that contain TERM(s) preceded by a
minus sign (i.e. -TERM). If no TERM specified, lists entire todo.txt. minus sign (i.e. -TERM).
TERM(s) are grep-style basic regular expressions; for literal matching,
put a single backslash before any [ ] \ $ * . ^ and enclose the entire
TERM in single quotes, or use double backslashes and extra shell-quoting.
If no TERM specified, lists entire todo.txt.
listall [TERM...] listall [TERM...]
lsa [TERM...] lsa [TERM...]