Skip to content

Commit

Permalink
release prep
Browse files Browse the repository at this point in the history
  • Loading branch information
ttscoff committed Nov 18, 2021
1 parent e920ebf commit 61a2f0b
Showing 1 changed file with 143 additions and 10 deletions.
153 changes: 143 additions & 10 deletions doing.rdoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
== doing - A CLI for a What Was I Doing system

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.
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.0.8.pre
v2.0.9.pre

=== Global Options
=== --config_file arg
Expand Down Expand Up @@ -87,6 +90,14 @@ Boolean used to combine multiple tags
[Must Match] (?i-mx:^(?:and|all|any|or|not|none)$)


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== --in SECTION_NAME

Add new entry to section (default: same section as repeated entry)
Expand Down Expand Up @@ -167,6 +178,14 @@ Tag boolean (AND|OR|NOT)
[Must Match] (?i-mx:^(?:and|all|any|or|not|none)$)


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -k|--keep X

How many items to keep (ignored if archiving by tag or search)
Expand Down Expand Up @@ -284,13 +303,28 @@ Boolean (AND|OR|NOT) with which to combine multiple tag filters
[Must Match] (?i-mx:^(?:and|all|any|or|not|none)$)


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -s|--section NAME

Section

[Default Value] None


===== --search QUERY

Cancel the last X entries matching search filter, surround with slashes for regex (e.g. "/query.*/"), start with single quote for exact match ("'query")

[Default Value] None


===== --tag TAG

Cancel the last X entries containing TAG. Separate multiple tags with comma (--tag=tag1,tag2)
Expand All @@ -308,11 +342,21 @@ Select item(s) to cancel from a menu of matching entries



===== --not
Finish items that *don't* match search/tag filters



===== -u|--unfinished
Cancel last entry (or entries) not already marked @done



===== -x|--exact
Force exact search string matching (case sensitive)



==== Command: <tt>choose </tt>
Select a section to display from a menu

Expand Down Expand Up @@ -493,6 +537,14 @@ Boolean (AND|OR|NOT) with which to combine multiple tag filters
[Must Match] (?i-mx:^(?:and|all|any|or|not|none)$)


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -s|--section NAME

Section
Expand Down Expand Up @@ -585,6 +637,14 @@ Constrain search to entries older than date
[Default Value] None


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -o|--output FORMAT

Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
Expand All @@ -607,11 +667,6 @@ Sort tags by (name|time)
[Must Match] (?i-mx:^(?:name|time)$)


===== --[no-]case
Force case sensitive matching



===== -i|--interactive
Display an interactive menu of results to perform further operations

Expand Down Expand Up @@ -671,6 +726,14 @@ Import entries older than date
[Default Value] None


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -f|--from DATE_OR_RANGE

Date range to import. Date range argument should be quoted. Date specifications can be natural language.
Expand Down Expand Up @@ -753,6 +816,14 @@ Tag boolean
[Must Match] (?i-mx:^(?:and|all|any|or|not|none)$)


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -s|--section NAME

Specify a section
Expand Down Expand Up @@ -834,6 +905,14 @@ How many recent entries to tag (0 for all)
[Must Match] (?-mix:^\d+$)


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -s|--section SECTION_NAME

Section
Expand Down Expand Up @@ -944,6 +1023,14 @@ Boolean (AND|OR|NOT) with which to combine multiple tag filters
[Must Match] (?i-mx:^(?:and|all|any|or|not|none)$)


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -s|--section NAME

Section
Expand Down Expand Up @@ -1158,6 +1245,14 @@ Boolean (AND|OR|NOT) with which to combine multiple tag filters
[Must Match] (?i-mx:^(?:and|all|any|or|not|none)$)


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -s|--section NAME

Limit search to section
Expand Down Expand Up @@ -1220,6 +1315,14 @@ Tag boolean (AND|OR|NOT)
[Must Match] (?i-mx:^(?:and|all|any|or|not|none)$)


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -k|--keep X

How many items to keep in each section (most recent)
Expand Down Expand Up @@ -1278,6 +1381,14 @@ Multiple selections are allowed, hit tab to add the highlighted entry to the
selection, and use ctrl-a to select all visible items. Return processes the
selected entries.
===== Options
===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -m|--move SECTION

Move selected items to section
Expand Down Expand Up @@ -1422,6 +1533,14 @@ Max count to show
[Default Value] 0


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -f|--from DATE_OR_RANGE

Date range to show, or a single day to filter date on.
Expand Down Expand Up @@ -1577,6 +1696,14 @@ How many recent entries to tag (0 for all)
[Must Match] (?-mix:^\d+$)


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== --rename ORIG_TAG

Replace existing tag with tag argument, wildcards (*,?) allowed, or use with --regex
Expand Down Expand Up @@ -1655,9 +1782,7 @@ Force exact search string matching (case sensitive)
Output HTML, CSS, and Markdown (ERB) templates for customization

Templates are printed to STDOUT for piping to a file.
Save them and use them in the configuration file under html_template.

Example `doing template haml > ~/styles/my_doing.haml`
Save them and use them in the configuration file under export_templates.
===== Options
===== -c
List in single column for completion
Expand Down Expand Up @@ -1771,6 +1896,14 @@ Count to display
[Must Match] (?-mix:^\d+$)


===== --case TYPE

Case sensitivity for search string matching [(c)ase-sensitive, (i)nsensitive, (s)mart]

[Default Value] smart
[Must Match] (?-mix:^[csi])


===== -o|--output FORMAT

Output to export format (csv|doing|html|markdown|say|taskpaper|template|timeline|wiki)
Expand Down

0 comments on commit 61a2f0b

Please sign in to comment.