Add hint for OR'ing TERMs to help text for ls/list.

The regexp syntax and quoting rules aren't known to many who are not well versed in the Bash shell, and difficult to get right even for people in the know. This question came up just recently on the mailing list, too.

tests/t1950-report.sh

@@ -1,91 +0,0 @@
-#!/bin/sh
-
-test_description='report functionality
-
-This test checks the reporting and the format of the report file.
-'
-. ./test-lib.sh
-
-cat > todo.txt <<EOF
-(B) smell the uppercase Roses +flowers @outside
-stop and think
-smell the coffee +wakeup
-make the coffee +wakeup
-visit http://example.com
-EOF
-
-test_todo_session 'create new report' <<EOF
->>> todo.sh report
-2009-02-13T04:40:00 5 0
-TODO: Report file updated.
-
->>> todo.sh -p list
-1 (B) smell the uppercase Roses +flowers @outside
-4 make the coffee +wakeup
-3 smell the coffee +wakeup
-2 stop and think
-5 visit http://example.com
---
-TODO: 5 of 5 tasks shown
-EOF
-
-test_todo_session 'report of done tasks' <<EOF
->>> todo.sh -A do 3
-3 x 2009-02-13 smell the coffee +wakeup
-TODO: 3 marked as done.
-x 2009-02-13 smell the coffee +wakeup
-TODO: $HOME/todo.txt archived.
-
->>> todo.sh report
-2009-02-13T04:40:00 4 1
-TODO: Report file updated.
-
->>> todo.sh -p list
-1 (B) smell the uppercase Roses +flowers @outside
-3 make the coffee +wakeup
-2 stop and think
-4 visit http://example.com
---
-TODO: 4 of 4 tasks shown
-EOF
-
-test_todo_session 'report performs archiving' <<EOF
->>> todo.sh -a do 3
-3 x 2009-02-13 make the coffee +wakeup
-TODO: 3 marked as done.
-
->>> todo.sh report
-2009-02-13T04:40:00 3 2
-TODO: Report file updated.
-
->>> todo.sh -p list
-1 (B) smell the uppercase Roses +flowers @outside
-2 stop and think
-3 visit http://example.com
---
-TODO: 3 of 3 tasks shown
-
->>> todo.sh -p listfile done.txt
-2 x 2009-02-13 make the coffee +wakeup
-1 x 2009-02-13 smell the coffee +wakeup
---
-DONE: 2 of 2 tasks shown
-EOF
-
-test_todo_session 'report is unchanged when no changes' <<EOF
->>> cat report.txt
-2009-02-13T04:40:00 5 0
-2009-02-13T04:40:00 4 1
-2009-02-13T04:40:00 3 2
-
->>> todo.sh report
-2009-02-13T04:40:00 3 2
-TODO: Report file is up-to-date.
-
->>> cat report.txt
-2009-02-13T04:40:00 5 0
-2009-02-13T04:40:00 4 1
-2009-02-13T04:40:00 3 2
-EOF
-
-test_done

tests/t9999-testsuite_example.sh

@@ -85,8 +85,13 @@ TODO: $HOME/todo.txt archived.
 TODO: 5 of 5 tasks shown
 
 >>> todo.sh report
-2009-02-13T04:40:00 5 1
 TODO: Report file updated.
+2009-02-13-04:40:00 5 1
+
+>>> todo.sh report
+TODO: Report file updated.
+2009-02-13-04:40:00 5 1
+2009-02-13-04:40:00 5 1
 
 >>> todo.sh append g a
 usage: todo.sh append ITEM# "TEXT TO APPEND"

todo.sh

@@ -87,10 +87,10 @@ help()
 
 		  Options:
 		    -@
-		        Hide context names in list output. Use twice to show context
+		        Hide context names in list output.  Use twice to show context
 		        names (default).
 		    -+
-		        Hide project names in list output. Use twice to show project
+		        Hide project names in list output.  Use twice to show project
 		        names (default).
 		    -c
 		        Color mode
@@ -103,7 +103,7 @@ help()
 		    -p
 		        Plain mode turns off colors
 		    -P
-		        Hide priority labels in list output. Use twice to show
+		        Hide priority labels in list output.  Use twice to show
 		        priority labels (default).
 		    -a
 		        Don't auto-archive tasks automatically on completion
@@ -199,12 +199,15 @@ help()
 		    list [TERM...]
 		    ls [TERM...]
 		      Displays all tasks that contain TERM(s) sorted by priority with line
-		      numbers.  If no TERM specified, lists entire todo.txt.
+		      numbers.  Each task must match all TERMs (logical AND); to display
+		      tasks that contain any TERM (logical OR), use
+		      "TERM1\|TERM2\|..." (with quotes), or TERM1\\\|TERM2 (unquoted).
+		      If no TERM specified, lists entire todo.txt.
 
 		    listall [TERM...]
 		    lsa [TERM...]
 		      Displays all the lines in todo.txt AND done.txt that contain TERM(s)
-		      sorted by priority with line  numbers.  If no TERM specified, lists
+		      sorted by priority with line numbers.  If no TERM specified, lists
 		      entire todo.txt AND done.txt concatenated and sorted.
 
 		    listcon
@@ -214,8 +217,8 @@ help()
 		    listfile [SRC [TERM...]]
 		    lf [SRC [TERM...]]
 		      Displays all the lines in SRC file located in the todo.txt directory,
-		      sorted by priority with line  numbers.  If TERM specified, lists
+		      sorted by priority with line numbers.  If TERM specified, lists
-		      all lines that contain TERM in SRC file.
+		      all lines that contain TERM(s) in SRC file.
 		      Without any arguments, the names of all text files in the todo.txt
 		      directory are listed.
 
@@ -223,7 +226,7 @@ help()
 		    lsp [PRIORITY] [TERM...]
 		      Displays all tasks prioritized PRIORITY.
 		      If no PRIORITY specified, lists all prioritized tasks.
-		      If TERM specified, lists only prioritized tasks that contain TERM.
+		      If TERM specified, lists only prioritized tasks that contain TERM(s).
 
 		    listproj
 		    lsprj
@@ -1191,20 +1194,18 @@ note: PRIORITY must be anywhere from A to Z."
     sed '/^x /!d' "$TODO_FILE" >> "$DONE_FILE"
     sed -i.bak '/^x /d' "$TODO_FILE"
 
+    NUMLINES=$( sed -n '$ =' "$TODO_FILE" )
+    if [ ${NUMLINES:-0} = "0" ]; then
+         echo "datetime todos dones" >> "$REPORT_FILE"
+    fi
+    #now report
     TOTAL=$( sed -n '$ =' "$TODO_FILE" )
     TDONE=$( sed -n '$ =' "$DONE_FILE" )
-    NEWDATA="${TOTAL:-0} ${TDONE:-0}"
+    TECHO=$(echo $(date +%Y-%m-%d-%T); echo ' '; echo ${TOTAL:-0}; echo ' ';
-    LASTREPORT=$(sed -ne '$p' "$REPORT_FILE")
+    echo ${TDONE:-0})
-    LASTDATA=${LASTREPORT#* }   # Strip timestamp.
+    echo $TECHO >> "$REPORT_FILE"
-    if [ "$LASTDATA" = "$NEWDATA" ]; then
+    [ $TODOTXT_VERBOSE -gt 0 ] && echo "TODO: Report file updated."
-        echo "$LASTREPORT"
+    cat "$REPORT_FILE"
-        [ $TODOTXT_VERBOSE -gt 0 ] && echo "TODO: Report file is up-to-date."
-    else
-        NEWREPORT="$(date +%Y-%m-%dT%T) ${NEWDATA}"
-        echo "${NEWREPORT}" >> "$REPORT_FILE"
-        echo "${NEWREPORT}"
-        [ $TODOTXT_VERBOSE -gt 0 ] && echo "TODO: Report file updated."
-    fi
     ;;
 
 * )