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/t1900-archive.sh

@@ -1,35 +0,0 @@
-#!/bin/sh
-
-test_description='archive functionality
-
-Ensure we can archive items successfully.
-'
-. ./test-lib.sh
-
-cat > todo.txt <<EOF
-one
-two
-three
-one
-x done
-four
-EOF
-
-test_todo_session 'archive with duplicates' <<EOF
->>> todo.sh archive
-x done
-TODO: $HOME/todo.txt archived.
-EOF
-
-test_todo_session 'list after archive' <<EOF
->>> todo.sh ls
-5 four
-1 one
-4 one
-3 three
-2 two
---
-TODO: 5 of 5 tasks shown
-EOF
-
-test_done

tests/t1910-deduplicate.sh

@@ -1,103 +0,0 @@
-#!/bin/sh
-
-test_description='deduplicate functionality
-
-Ensure we can deduplicate items successfully.
-'
-. ./test-lib.sh
-
-cat > todo.txt <<EOF
-duplicated
-two
-x done
-duplicated
-double task
-double task
-three
-EOF
-
-test_todo_session 'deduplicate and preserve line numbers' <<EOF
->>> todo.sh deduplicate
-TODO: 2 duplicate task(s) removed
-
->>> todo.sh -p ls
-5 double task
-1 duplicated
-7 three
-2 two
-3 x done
---
-TODO: 5 of 5 tasks shown
-EOF
-
-test_todo_session 'deduplicate without duplicates' <<EOF
->>> todo.sh deduplicate
-TODO: No duplicate tasks found
-EOF
-
-cat > todo.txt <<EOF
-duplicated
-two
-x done
-duplicated
-double task
-double task
-three
-EOF
-test_todo_session 'deduplicate and delete lines' <<EOF
->>> todo.sh -n deduplicate
-TODO: 2 duplicate task(s) removed
-
->>> todo.sh -p ls
-4 double task
-1 duplicated
-5 three
-2 two
-3 x done
---
-TODO: 5 of 5 tasks shown
-EOF
-
-cat > todo.txt <<EOF
-one
-duplicated
-three
-duplicated
-duplicated
-six
-duplicated
-EOF
-test_todo_session 'deduplicate more than two occurrences' <<EOF
->>> todo.sh deduplicate
-TODO: 3 duplicate task(s) removed
-
->>> todo.sh -p ls
-2 duplicated
-1 one
-6 six
-3 three
---
-TODO: 4 of 4 tasks shown
-EOF
-
-cat > todo.txt <<EOF
-normal task
-a bold action
-something else
-a bold action
-something more
-EOF
-test_todo_session 'deduplicate with non-printable duplicates' <<EOF
->>> todo.sh deduplicate
-TODO: 1 duplicate task(s) removed
-
->>> todo.sh -p ls
-2 a bold action
-1 normal task
-3 something else
-5 something more
---
-TODO: 4 of 4 tasks shown
-EOF
-
-test_done

tests/t9999-testsuite_example.sh

@@ -85,12 +85,10 @@ TODO: $HOME/todo.txt archived.
 TODO: 5 of 5 tasks shown
 
 >>> todo.sh report
-TODO: $HOME/todo.txt archived.
 TODO: Report file updated.
 2009-02-13-04:40:00 5 1
 
 >>> todo.sh report
-TODO: $HOME/todo.txt archived.
 TODO: Report file updated.
 2009-02-13-04:40:00 5 1
 2009-02-13-04:40:00 5 1

todo.sh

@@ -50,7 +50,6 @@ shorthelp()
 		    append|app ITEM# "TEXT TO APPEND"
 		    archive
 		    command [ACTIONS]
-		    deduplicate
 		    del|rm ITEM# [TERM]
 		    depri|dp ITEM#[, ITEM#, ITEM#, ...]
 		    do ITEM#[, ITEM#, ITEM#, ...]
@@ -88,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
@@ -104,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
@@ -181,9 +180,6 @@ help()
 		      Runs the remaining arguments using only todo.sh builtins.
 		      Will not call any .todo.actions.d scripts.
 
-		    deduplicate
-		      Removes duplicate lines from todo.txt.
-
 		    del ITEM# [TERM]
 		    rm ITEM# [TERM]
 		      Deletes the task on line ITEM# in todo.txt.
@@ -203,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
@@ -218,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.
 
@@ -227,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
@@ -357,6 +356,20 @@ getNewtodo()
     [ -z "$newtodo" ] && die "$(getPrefix "$2"): No updated task $item."
 }
 
+archive()
+{
+    #defragment blank lines
+    sed -i.bak -e '/./!d' "$TODO_FILE"
+    [ $TODOTXT_VERBOSE -gt 0 ] && grep "^x " "$TODO_FILE"
+    grep "^x " "$TODO_FILE" >> "$DONE_FILE"
+    sed -i.bak '/^x /d' "$TODO_FILE"
+    cp "$TODO_FILE" "$TMP_FILE"
+    sed -n 'G; s/\n/&&/; /^\([ ~-]*\n\).*\n\1/d; s/\n//; h; P' "$TMP_FILE" > "$TODO_FILE"
+    if [ $TODOTXT_VERBOSE -gt 0 ]; then
+	echo "TODO: $TODO_FILE archived."
+    fi
+}
+
 replaceOrPrepend()
 {
   action=$1; shift
@@ -923,15 +936,7 @@ case $action in
     ;;
 
 "archive" )
-    # defragment blank lines
+    archive;;
-    sed -i.bak -e '/./!d' "$TODO_FILE"
-    [ $TODOTXT_VERBOSE -gt 0 ] && grep "^x " "$TODO_FILE"
-    grep "^x " "$TODO_FILE" >> "$DONE_FILE"
-    sed -i.bak '/^x /d' "$TODO_FILE"
-    if [ $TODOTXT_VERBOSE -gt 0 ]; then
-	echo "TODO: $TODO_FILE archived."
-    fi
-    ;;
 
 "del" | "rm" )
     # replace deleted line with a blank line when TODOTXT_PRESERVE_LINE_NUMBERS is 1
@@ -1033,9 +1038,7 @@ case $action in
     done
 
     if [ $TODOTXT_AUTO_ARCHIVE = 1 ]; then
-        # Recursively invoke the script to allow overriding of the archive
+        archive
-        # action.
-        "$TODO_FULL_SH" archive
     fi
     ;;
 
@@ -1187,10 +1190,9 @@ note: PRIORITY must be anywhere from A to Z."
     ;;
 
 "report" )
-    # archive first
+    #archive first
-    # Recursively invoke the script to allow overriding of the archive
+    sed '/^x /!d' "$TODO_FILE" >> "$DONE_FILE"
-    # action.
+    sed -i.bak '/^x /d' "$TODO_FILE"
-    "$TODO_FULL_SH" archive
 
     NUMLINES=$( sed -n '$ =' "$TODO_FILE" )
     if [ ${NUMLINES:-0} = "0" ]; then
@@ -1206,42 +1208,6 @@ note: PRIORITY must be anywhere from A to Z."
     cat "$REPORT_FILE"
     ;;
 
-"deduplicate" )
-    if [ $TODOTXT_PRESERVE_LINE_NUMBERS = 0 ]; then
-        deduplicateSedCommand='d'
-    else
-        deduplicateSedCommand='{ s/^.*//; p; b }'
-    fi
-
-    # To determine the difference when deduplicated lines are preserved, only
-    # non-empty lines must be counted.
-    originalTaskNum=$( sed -e '/./!d' "$TODO_FILE" | sed -n '$ =' )
-
-    # Look for duplicate lines and discard the second occurrence.
-    # We start with an empty hold space on the first line.  For each line:
-    #   G - appends newline + hold space to the pattern space
-    #   s/\n/&&/; - double up the first new line so we catch adjacent dups
-    #   /^\([^\n]*\n\).*\n\1/
-    #       If the first line of the hold space shows up again later as an
-    #       entire line, it's a duplicate.
-    #       d;                 - Delete the current pattern space, quit this line
-    #                            and move on to the next, or:
-    #       { s/^.*//; p; b }; - Clear the task text, print this line and move on
-    #                            to the next.
-    #   s/\n//;   - else, drop the doubled newline
-    #   h;        - replace the hold space with the expanded pattern space
-    #   P;        - print up to the first newline (that is, the input line)
-    sed -i.bak -n 'G; s/\n/&&/; /^\([^\n]*\n\).*\n\1/'"$deduplicateSedCommand"'; s/\n//; h; P' "$TODO_FILE"
-
-    newTaskNum=$( sed -e '/./!d' "$TODO_FILE" | sed -n '$ =' )
-    deduplicateNum=$(( originalTaskNum - newTaskNum ))
-    if [ $deduplicateNum -eq 0 ]; then
-        echo "TODO: No duplicate tasks found"
-    else
-        echo "TODO: $deduplicateNum duplicate task(s) removed"
-    fi
-    ;;
-
 * )
     usage;;
 esac