Docs: Added more CLI grammar

This commit is contained in:
Paul Beckingham 2015-12-17 00:02:29 -05:00
parent 5ff567f40f
commit 079cd0cbf6
3 changed files with 23 additions and 4 deletions

View file

@ -48,8 +48,8 @@ Record yesterday's time:
Defining Exclusions: Defining Exclusions:
$ timew holidays eng-USA $ timew define holidays eng-USA
$ timew holidays work 2015-11-26 $ timew define holidays work 2015-11-26
$ timew define workweek mon-fri $ timew define workweek mon-fri
$ timew define workday start 8:30am $ timew define workday start 8:30am
$ timew define workday end 1730 $ timew define workday end 1730

View file

@ -7,6 +7,19 @@ The CLI shall have a well-defined and unambiguous grammar.
timew track [<interval>] [<tagset>] timew track [<interval>] [<tagset>]
timew [<filter>] report <report> timew [<filter>] report <report>
timew define holidays <locale>
timew define holidays work <date>
timew define week <day>[- <day>] [, <day>] ...
timew define day start <time>
timew define day end <time>
timew define day <day> start <time>
timew define day <day> end <time>
timew define tag <tag>
timew define tag <tag> description <string>
timew define tag <tag> start <date>
timew define tag <tag> end <date>
CLI Grammar CLI Grammar
----------- -----------
@ -47,3 +60,9 @@ CLI Grammar
string: "\"" .+ "\"" string: "\"" .+ "\""
.+ .+
Rules Grammar
-------------
---

View file

@ -73,7 +73,7 @@ Yields a combined:
Possible exclusions include: Possible exclusions include:
$ timew holidays eng-USA $ timew define holidays eng-USA
$ timew define workweek mon-fri $ timew define workweek mon-fri
$ timew define workday start 8:30am $ timew define workday start 8:30am
$ timew define workday end 1730 $ timew define workday end 1730
@ -82,7 +82,7 @@ Possible exclusions include:
Yielding: Yielding:
define exclusions: define exclusions:
interval holidays eng-USA interval define holidays eng-USA
interval work 2015-11-26 interval work 2015-11-26
interval workweek mon,tue,wed,thu,fri interval workweek mon,tue,wed,thu,fri
interval workday start 8:30am interval workday start 8:30am