doing.rdoc in doing-2.1.12 vs doing.rdoc in doing-2.1.13

- old
+ new

@@ -3,16 +3,16 @@ Doing uses a TaskPaper-like formatting to keep a plain text record of what you've been doing, complete with tag-based time tracking. The command line tool allows you to add entries, annotate with tags and notes, and view your entries with myriad options, with a focus on a "natural" language syntax. -v2.1.10 +v2.1.13 === Global Options === --config_file arg -Use a specific configuration file. Deprecated, set $DOING_CONFIG instead. +Use a specific configuration file. Deprecated, set $DOING_CONFIG instead [Default Value] /Users/ttscoff/.config/doing/config.yml === -f|--doing_file arg @@ -88,15 +88,15 @@ ==== Command: <tt>again|resume </tt> Repeat last entry as new entry -This command is designed to allow multiple time intervals to be created for an entry by duplicating it with a new start (and end, eventually) time. +This command is designed to allow multiple time intervals to be created for an entry by duplicating it with a new start (and end, eventually) time ===== Options ===== --bool BOOLEAN -Boolean used to combine multiple tags. Use PATTERN to parse + and - as booleans. +Boolean used to combine multiple tags. Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) @@ -137,15 +137,23 @@ [Default Value] None ===== --tag TAG -Repeat last entry matching tags. Combine multiple tags with a comma. Wildcards allowed (*, ?). +Repeat last entry matching tags. Combine multiple tags with a comma. Wildcards allowed (*, ?) [Default Value] None +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + ===== -e|--editor Edit duplicated entry with vim before adding @@ -180,11 +188,11 @@ [Default Value] None ===== --bool BOOLEAN -Tag boolean (AND|OR|NOT). Use PATTERN to parse + and - as booleans. +Tag boolean (AND|OR|NOT). Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) @@ -218,15 +226,23 @@ [Default Value] Archive ===== --tag TAG -Tag filter, combine multiple tags with a comma. Wildcards allowed (*, ?). Added for compatibility with other commands. +Tag filter, combine multiple tags with a comma. Wildcards allowed (*, ?). Added for compatibility with other commands [Default Value] None +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + ===== --[no-]label Label moved items with @from(SECTION_NAME) @@ -301,15 +317,15 @@ ==== Command: <tt>cancel COUNT</tt> End last X entries with no time tracked -Adds @done tag without datestamp so no elapsed time is recorded. Alias for `doing finish --no-date`. +Adds @done tag without datestamp so no elapsed time is recorded. Alias for `doing finish --no-date` ===== Options ===== --bool BOOLEAN -Boolean (AND|OR|NOT) with which to combine multiple tag filters. Use PATTERN to parse + and - as booleans. +Boolean (AND|OR|NOT) with which to combine multiple tag filters. Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) @@ -335,15 +351,23 @@ [Default Value] None ===== --tag TAG -Cancel the last X entries containing TAG. Separate multiple tags with comma (--tag=tag1,tag2). Wildcards allowed (*, ?). +Cancel the last X entries containing TAG. Separate multiple tags with comma (--tag=tag1,tag2). Wildcards allowed (*, ?) [Default Value] None +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + ===== -a|--archive Archive entries @@ -491,11 +515,11 @@ Update default config file, adding any missing keys [Default Command] edit ==== Command: <tt>done|did ENTRY</tt> -Add a completed item with @done(date). No argument finishes last entry. +Add a completed item with @done(date). No argument finishes last entry Use this command to add an entry after you've already finished it. It will be immediately marked as @done. You can modify the start and end times of the entry using the --back, --took, and --at flags, making it an easy way to add entries in post and maintain accurate (albeit manual) time tracking. ===== Options @@ -581,11 +605,11 @@ [Default Value] None ===== --bool BOOLEAN -Boolean (AND|OR|NOT) with which to combine multiple tag filters. Use PATTERN to parse + and - as booleans. +Boolean (AND|OR|NOT) with which to combine multiple tag filters. Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) @@ -624,10 +648,18 @@ Separate multiple tags with comma (--tag=tag1,tag2), combine with --bool. Wildcards allowed (*, ?). [Default Value] None +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + ===== -a|--archive Archive entries @@ -675,22 +707,30 @@ To search with regular expressions, single quote the string and surround with slashes: `doing search '/m.*?x/'` ===== Options ===== --after DATE_STRING -Search entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day. +Search entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day [Default Value] None ===== --before DATE_STRING -Search entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day. +Search entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day [Default Value] None +===== --bool arg + +Combine multiple tags or value queries using AND, OR, or NOT + +[Default Value] AND +[Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) + + ===== --case TYPE Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart] [Default Value] smart @@ -729,15 +769,33 @@ [Default Value] name [Must Match] (?i-mx:^(?:name|time)$) +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + +===== -d|--delete +Delete matching entries + + + ===== --[no-]duration Show elapsed time on entries without @done tag +===== -e|--editor +Edit matching entries with vim + + + ===== -i|--interactive Display an interactive menu of results to perform further operations @@ -878,11 +936,11 @@ Shows the last entry. Using --search and --tag filters, you can view/edit the last entry matching a filter, allowing `doing last` to target historical entries. ===== Options ===== --bool BOOLEAN -Tag boolean (AND|OR|NOT). Use PATTERN to parse + and - as booleans. +Tag boolean (AND|OR|NOT). Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) @@ -908,15 +966,28 @@ [Default Value] None ===== --tag TAG -Tag filter, combine multiple tags with a comma. Wildcards allowed (*, ?). +Tag filter, combine multiple tags with a comma. Wildcards allowed (*, ?) [Default Value] None +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + +===== -d|--delete +Delete the last entry + + + ===== --[no-]duration Show elapsed time if entry is not tagged @done @@ -964,11 +1035,11 @@ ===== Options ===== --bool BOOLEAN -Boolean (AND|OR|NOT) with which to combine multiple tag filters. Use PATTERN to parse + and - as booleans. +Boolean (AND|OR|NOT) with which to combine multiple tag filters. Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) @@ -1008,10 +1079,18 @@ Separate multiple tags with comma (--tag=tag1,tag2), combine with --bool. Wildcards allowed (*, ?). [Default Value] None +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + ===== -d|--date Include current date/time with tag @@ -1093,11 +1172,11 @@ Use -e to load the last entry in a text editor where you can append a note. ===== Options ===== --bool BOOLEAN -Boolean (AND|OR|NOT) with which to combine multiple tag filters. Use PATTERN to parse + and - as booleans. +Boolean (AND|OR|NOT) with which to combine multiple tag filters. Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) @@ -1123,15 +1202,23 @@ [Default Value] None ===== --tag TAG -Add/remove note from last entry matching tag. Wildcards allowed (*, ?). +Add/remove note from last entry matching tag. Wildcards allowed (*, ?) [Default Value] None +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + ===== -e|--editor Edit entry with vim @@ -1335,11 +1422,11 @@ If no argument is provided, the start time will be reset to the current time. If a date string is provided as an argument, the start time will be set to the parsed result. ===== Options ===== --bool BOOLEAN -Boolean (AND|OR|NOT) with which to combine multiple tag filters +Boolean (AND|OR|NOT) with which to combine multiple tag filters. Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) @@ -1365,15 +1452,23 @@ [Default Value] None ===== --tag TAG -Reset last entry matching tag. Wildcards allowed (*, ?). +Reset last entry matching tag. Wildcards allowed (*, ?) [Default Value] None +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + ===== -i|--interactive Select from a menu of matching entries @@ -1407,11 +1502,11 @@ [Default Value] None ===== --bool BOOLEAN -Tag boolean (AND|OR|NOT). Use PATTERN to parse + and - as booleans. +Tag boolean (AND|OR|NOT). Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) @@ -1445,15 +1540,23 @@ [Default Value] None ===== --tag TAG -Tag filter, combine multiple tags with a comma. Wildcards allowed (*, ?). Added for compatibility with other commands. +Tag filter, combine multiple tags with a comma. Wildcards allowed (*, ?). Added for compatibility with other commands [Default Value] None +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + ===== --not Rotate items that *don't* match search string or tag filter @@ -1481,26 +1584,26 @@ selection, and use ctrl-a to select all visible items. Return processes the selected entries. Search in the menu by typing: -sbtrkt fuzzy-match Items that match sbtrkt +sbtrkt fuzzy-match Items that match s*b*t*r*k*t 'wild exact-match (quoted) Items that include wild !fire inverse-exact-match Items that do not include fire ===== Options ===== --after DATE_STRING -Select from entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day. +Select from entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day [Default Value] None ===== --before DATE_STRING -Select from entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day. +Select from entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day [Default Value] None ===== --case TYPE @@ -1563,10 +1666,18 @@ Tag selected entries [Default Value] None +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + ===== -a|--archive Archive selected items @@ -1599,16 +1710,16 @@ Add flag to selected item(s) ===== --force -Perform action without confirmation. +Perform action without confirmation ===== --[no-]menu -Use --no-menu to skip the interactive menu. Use with --query to filter items and act on results automatically. Test with `--output doing` to preview matches. +Use --no-menu to skip the interactive menu. Use with --query to filter items and act on results automatically. Test with `--output doing` to preview matches ===== --not Select items that *don't* match search/tag filters @@ -1642,26 +1753,26 @@ [Default Value] newest ===== --after DATE_STRING -Show entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day. +Show entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day [Default Value] None ===== -b|--bool BOOLEAN -Tag boolean (AND,OR,NOT). Use PATTERN to parse + and - as booleans. +Tag boolean (AND,OR,NOT). Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) ===== --before DATE_STRING -Show entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day. +Show entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day [Default Value] None ===== -c|--count MAX @@ -1714,11 +1825,11 @@ [Default Value] None ===== --tag TAG -Tag filter, combine multiple tags with a comma. Use `--tag pick` for a menu of available tags. Wildcards allowed (*, ?). Added for compatibility with other commands. +Tag filter, combine multiple tags with a comma. Use `--tag pick` for a menu of available tags. Wildcards allowed (*, ?). Added for compatibility with other commands [Default Value] None ===== --tag_order DIRECTION @@ -1735,10 +1846,18 @@ [Default Value] name [Must Match] (?i-mx:^(?:name|time)) +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + ===== --[no-]duration Show elapsed time on entries without @done tag @@ -1837,11 +1956,11 @@ Tag name arguments do not need to be prefixed with @. ===== Options ===== --bool BOOLEAN -Boolean (AND|OR|NOT) with which to combine multiple tag filters. Use PATTERN to parse + and - as booleans. +Boolean (AND|OR|NOT) with which to combine multiple tag filters. Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) @@ -1888,10 +2007,25 @@ Separate multiple tags with comma (--tag=tag1,tag2), combine with --bool. Wildcards allowed (*, ?). [Default Value] None +===== -v|--value VALUE + +Include a value, e.g. @tag(value) + +[Default Value] None + + +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + ===== -a|--autotag Autotag entries based on autotag configuration in ~/.config/doing/config.yml @@ -1933,18 +2067,30 @@ ===== -x|--exact Force exact search string matching (case sensitive) +==== Command: <tt>tag_dir TAG [TAG..]</tt> +Set the default tags for the current directory + +Adds default_tags to a .doingrc file in the current directory. Any entry created in this directory or its +subdirectories will be tagged with the default tags. You can modify these any time using the `config set` commnand or +manually editing the .doingrc file. +===== Options +===== -r|--remove +Remove all default_tags from the local .doingrc + + + ==== Command: <tt>tags </tt> List all tags in the current Doing file ===== Options ===== --bool BOOLEAN -Boolean used to combine multiple tags. Use PATTERN to parse + and - as booleans. +Boolean used to combine multiple tags. Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) @@ -1987,15 +2133,23 @@ [Must Match] (?-mix:^(?:n(?:ame)?|c(?:ount)?)$) ===== --tag TAG -Get tags for entries matching tags. Combine multiple tags with a comma. Wildcards allowed (*, ?). +Get tags for entries matching tags. Combine multiple tags with a comma. Wildcards allowed (*, ?) [Default Value] None +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) + + ===== -c|--[no-]counts Show count of occurrences @@ -2136,11 +2290,11 @@ Select from recent backups ===== -r|--[no-]redo -Redo last undo. Note: you cannot undo a redo. +Redo last undo. Note: you cannot undo a redo ==== Command: <tt>view VIEW_NAME</tt> Display a user-created view @@ -2148,11 +2302,11 @@ Views are defined in your configuration (use `doing config` to edit). Command line options override view configuration. ===== Options ===== --after DATE_STRING -View entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day. +View entries newer than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day [Default Value] None ===== --age AGE @@ -2162,19 +2316,19 @@ [Default Value] newest ===== -b|--bool BOOLEAN -Tag boolean (AND,OR,NOT). Use PATTERN to parse + and - as booleans. +Tag boolean (AND,OR,NOT). Use PATTERN to parse + and - as booleans [Default Value] PATTERN [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$) ===== --before DATE_STRING -View entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day. +View entries older than date. If this is only a time (8am, 1:30pm, 15:00), all dates will be included, but entries will be filtered by time of day [Default Value] None ===== -c|--count COUNT @@ -2226,11 +2380,11 @@ [Default Value] None ===== --tag TAG -Tag filter, combine multiple tags with a comma. Wildcards allowed (*, ?). +Tag filter, combine multiple tags with a comma. Wildcards allowed (*, ?) [Default Value] None ===== --tag_order DIRECTION @@ -2245,9 +2399,17 @@ Sort tags by (name|time) [Default Value] None [Must Match] (?i-mx:^(?:name|time)$) + + +===== --val QUERY + +Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool + +[Default Value] None +[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$) ===== --[no-]color Include colors in output