GothenburgBitFactory/timewarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/timewarrior.git synced 2025-07-07 20:06:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: Removed content that is now available via the help command and man page

Browse source
This commit is contained in:
Paul Beckingham 2016-06-11 10:50:16 -04:00
parent e1770fcd12
commit 3c15dddce1
1 changed files with 0 additions and 109 deletions
Download patch file Download diff file Expand all files Collapse all files

109
doc/grammar.txt
View file

@ -1,109 +0,0 @@
CLI Syntax
----------
The CLI shall have a well-defined and unambiguous grammar.
timew
timew start [<date>] [<tagset>]
timew stop [<date>] [<tagset>]
timew track <filter>
timew clear <filter>
timew continue
timew [report] <report> [<filter>]
timew day [<filter>]
timew week [<filter>]
timew month [<filter>]
timew config [<name> [<value>]]
timew undo
timew tags [<filter>]
timew gaps [<filter>]
timew extensions
timew export [<filter>]
timew import <file>|- ...
timew help [<command>|<keyword>|hints|examples]
timew diagnostics
timew @<id> move <datetime> [:adjust]
timew @<id> shorten <duration> [:adjust]
timew @<id> lengthen <duration> [:adjust]
timew @<id> split
timew @<id> @<id> join
timew @<id> clear
timew @<id> tag <tag>
timew @<id> untag <tag>
Filter
------
A filter is a combination of an <interval> and <tagset>, both being optional.
An interval is a representation of a time range with tags.
<interval>:
["from"] <date> ["to"|"-" <date>]
["from"] <date> "for" <duration>
<duration> ["before"|"after" <date>]
Examples of an interval:
2016-04-15
29th
since socm
yesterday
from yesterday to tomorrow
4wks before socm
4wks
since socm for 2wks
A tagset is a set of unique UTF-8 strings, each identifying some trackable
entity.
<tagset>:
<tag> [<tag> ...]
Examples of a tagset:
Home (1 tag)
'Fiscal Policy Alignment Project' (1 tag)
Fiscal\ Policy\ Alignment\ Project (1 tag)
Home Garden (2 tags)
A tag may have any value that is not a supported form of date or duration.
Hints
-----
There are built-in and custom hints, that look like this:
:fill
They begin with a colon, and are heuristics for Timewarrior. They can override
feedback (:quiet) or offer guidance on how to create an interval (:fill). The
supported hints are:
:fill Fill in gap
:backfill Fill in gap, backwards only
:interrupt Identify the interval as a temporary interruption
:noreport Prevent the interval being reported
:quiet No feedback
:week Macro that means 'this week'
:debug Turns on debugging mode
:x User defined
:color Force use of color on
:nocolor Force use of color off
:yes Override confirmation
:ids Show ephemeral IDs for manipulation
:adjust When modifying intervals, adjust boundaries automatically
It is not an error to specify extra hints, because they will be simply ignored.
Unrecognized hints yield warnings.
--- Raw Notes ---
- 'timew import <file>' will merge data.