mirror of
https://github.com/GothenburgBitFactory/taskwarrior.git
synced 2025-06-26 10:54:26 +02:00
Documentation
- Added tutorial scripts, which are the 1.9.3 scripts, largely unmodified. This is a work in progress.
This commit is contained in:
Paul Beckingham
parent
c51b472694
commit
4d7369ad5e
52 changed files with 14739 additions and 1 deletions
533
doc/misc/tutorial/reports/run.200
Executable file
533
doc/misc/tutorial/reports/run.200
Executable file
|
|
@ -0,0 +1,533 @@
|
|||
#! /bin/bash
|
||||
|
||||
rm -f /Users/paul/.task/pending.data /Users/paul/.task/completed.data /Users/paul/.task/undo.data
|
||||
|
||||
echo 'data.location=~/.task' > /Users/paul/.taskrc
|
||||
echo 'color=off' >> /Users/paul/.taskrc
|
||||
echo 'color.summary.background=on gray3' >> /Users/paul/.taskrc
|
||||
echo '#include /usr/local/share/doc/task/rc/dark-blue-256.theme' >> /Users/paul/.taskrc
|
||||
echo '#include /usr/local/share/doc/task/rc/dark-red-256.theme' >> /Users/paul/.taskrc
|
||||
echo '#include /usr/local/share/doc/task/rc/dark-256.theme' >> /Users/paul/.taskrc
|
||||
|
||||
# 1 Intro
|
||||
|
||||
# 2 Basic usage
|
||||
echo Basic usage --------------------------------------------------------------
|
||||
echo $ task add Select a free weekend in November
|
||||
task add Select a free weekend in November
|
||||
echo $ task add Select and book a venue
|
||||
task add Select and book a venue
|
||||
echo $ task add Come up with a guest list
|
||||
task add Come up with a guest list
|
||||
echo $ task add Mail invitations
|
||||
task add Mail invitations
|
||||
echo $ task add Select a caterer
|
||||
task add Select a caterer
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task log Order a special cake
|
||||
task log Order a special cake
|
||||
echo $ task 4 duplicate /Mail/Design/
|
||||
task 4 duplicate /Mail/Design/
|
||||
echo $ task 4 duplicate /Mail/Print/
|
||||
task 4 duplicate /Mail/Print/
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task 3 done
|
||||
task 3 done
|
||||
echo $ task list
|
||||
task list
|
||||
|
||||
# 3 Projects
|
||||
echo Projects --------------------------------------------------------------
|
||||
echo $ task add Pay teh rent on teh 31st
|
||||
task add Pay teh rent on teh 31st
|
||||
echo $ task 7 /teh/the/g
|
||||
task 7 /teh/the/g
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task 7 project:home
|
||||
task 7 project:home
|
||||
echo $ task 1-6 project:party
|
||||
echo 'All' | task 1-6 project:party
|
||||
echo $ task projects
|
||||
task projects
|
||||
echo $ task list project:home
|
||||
task list project:home
|
||||
echo $ task li pro:par
|
||||
task li pro:par
|
||||
|
||||
# 4 Priorities
|
||||
echo Priorities --------------------------------------------------------------
|
||||
echo $ task 1-3,5 priority:H
|
||||
echo 'All' | task 1-3,5 priority:H
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task 3 pri:
|
||||
task 3 pri:
|
||||
|
||||
# 5 Tags
|
||||
echo Tags --------------------------------------------------------------
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task 3,5,6 +mall
|
||||
echo 'All' | task 3,5,6 +mall
|
||||
echo $ task long
|
||||
task long
|
||||
echo $ task list +mall
|
||||
task list +mall
|
||||
echo $ task 3 -mall
|
||||
task 3 -mall
|
||||
|
||||
# 6 Modifications
|
||||
echo Modifications --------------------------------------------------------------
|
||||
echo $ task 7 Pay rent at the end of the month
|
||||
echo 'Yes' | task 7 Pay rent at the end of the month
|
||||
echo $ task add music
|
||||
task add music
|
||||
echo $ task 8 prepend Select some
|
||||
task 8 prepend Select some
|
||||
echo $ task 8 append for after dinner
|
||||
task 8 append for after dinner
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task edit
|
||||
#task edit
|
||||
echo $ task add Hire a band?
|
||||
#task add Hire a band?
|
||||
echo $ task add Hire a band\?
|
||||
#task add Hire a band\?
|
||||
echo $ task add "Hire a band?"
|
||||
#task add "Hire a band?"
|
||||
echo $ task add -- Hire a band\? +dj
|
||||
task add -- Hire a band\? +dj
|
||||
echo $ task undo
|
||||
echo 'y' | task undo
|
||||
echo $ task 1 delete
|
||||
echo 'y' | task 1 delete
|
||||
echo $ task undo
|
||||
echo 'y' | task undo
|
||||
|
||||
# 7 Info
|
||||
echo Info --------------------------------------------------------------
|
||||
echo $ task 1 info
|
||||
task 1 info
|
||||
echo $ task stats
|
||||
task stats
|
||||
|
||||
# 8 Annotations
|
||||
echo Annotations --------------------------------------------------------------
|
||||
echo $ task 1 annotate the 13 looks good
|
||||
task 1 annotate the 13 looks good
|
||||
sleep 1
|
||||
echo $ task 1 annotate or the 14th
|
||||
task 1 annotate or the 14th
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task list rc.annotations:full
|
||||
task list rc.annotations:full
|
||||
echo $ task list rc.annotations:sparse
|
||||
task list rc.annotations:sparse
|
||||
echo $ task list rc.annotations:none
|
||||
task list rc.annotations:none
|
||||
echo $ task 1 denotate 14th
|
||||
task 1 denotate 14th
|
||||
echo $ task list
|
||||
task list
|
||||
|
||||
# 9 Configuration
|
||||
echo Configuration --------------------------------------------------------------
|
||||
echo $ task show
|
||||
task show
|
||||
echo $ task config answer forty-two
|
||||
echo 'y' | task config answer forty-two
|
||||
echo $ task show answer
|
||||
task show answer
|
||||
echo $ task config answer
|
||||
echo 'y' | task config answer
|
||||
echo $ task rc.report.list.sort=description+ list
|
||||
task rc.report.list.sort=description+ list
|
||||
|
||||
# 10 Defaults
|
||||
echo Defaults --------------------------------------------------------------
|
||||
echo $ task config default.command list
|
||||
echo 'y' | task config default.command list
|
||||
echo $ task
|
||||
task
|
||||
echo $ task config default.priority H
|
||||
echo 'y' | task config default.priority H
|
||||
echo $ task config default.project Work
|
||||
echo 'y' | task config default.project Work
|
||||
echo $ task add New task
|
||||
task add New task
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task undo
|
||||
echo 'y' | task undo
|
||||
echo $ task config default.priority
|
||||
echo 'y' | task config default.priority
|
||||
echo $ task config default.project
|
||||
echo 'y' | task config default.project
|
||||
|
||||
# 11 Aliases
|
||||
echo Aliases --------------------------------------------------------------
|
||||
echo $ task config alias.zzz list
|
||||
echo 'y' | task config alias.zzz list
|
||||
echo $ task zzz
|
||||
task zzz
|
||||
echo $ task z
|
||||
task z
|
||||
|
||||
# 12 Color
|
||||
echo Color --------------------------------------------------------------
|
||||
echo $ task config color on
|
||||
echo 'y' | task config color on
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task 1 bg:on_red
|
||||
task 1 bg:on_red
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task 1 bg:
|
||||
task 1 bg:
|
||||
echo $ task color
|
||||
task color
|
||||
echo $ task color white on red
|
||||
task color white on red
|
||||
echo $ task color legend
|
||||
task color legend
|
||||
echo vi ~/.taskrc # include /usr/local/share/doc/task/rc/dark-blue-256.theme
|
||||
#vi ~/.taskrc # include /usr/local/share/doc/task/rc/dark-blue-256.theme
|
||||
echo 'include /usr/local/share/doc/task/rc/dark-blue-256.theme' >> x
|
||||
echo $ task color legend
|
||||
task color legend
|
||||
echo $ task list
|
||||
task list
|
||||
echo vi ~/.taskrc # include /usr/local/share/doc/task/rc/dark-red-256.theme
|
||||
#vi ~/.taskrc # include /usr/local/share/doc/task/rc/dark-red-256.theme
|
||||
sed 's/blue/red/' x >x2 && mv x2 x
|
||||
echo $ task color legend
|
||||
task color legend
|
||||
echo $ task list
|
||||
task list
|
||||
echo vi ~/.taskrc # include /usr/local/share/doc/task/rc/dark-256.theme
|
||||
#vi ~/.taskrc # include /usr/local/share/doc/task/rc/dark-256.theme
|
||||
sed 's/red-//' x >x2 && mv x2 x
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task "rc.color.project.party=on rgb001" rc.color.keyword.invit=bold list
|
||||
task "rc.color.project.party=on rgb001" rc.color.keyword.invit=bold list
|
||||
echo $ man task-color
|
||||
#man task-color
|
||||
|
||||
# 13 Active tasks
|
||||
echo Active tasks --------------------------------------------------------------
|
||||
echo $ task 2 start
|
||||
task 2 start
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task active
|
||||
task active
|
||||
echo $ task 2 stop
|
||||
task 2 stop
|
||||
|
||||
echo $ task config journal.time on
|
||||
task config journal.time on
|
||||
echo $ task config rc.dateformat.xxx xxx
|
||||
task config rc.dateformat.xxx xxx
|
||||
echo $ task config dateformat.annotation 'Y/m/d H:N'
|
||||
task config dateformat.annotation 'Y/m/d H:N'
|
||||
echo $ task 2 start
|
||||
task 2 start
|
||||
echo $ task list venue
|
||||
task list venue
|
||||
echo $ task 2 stop
|
||||
task 2 stop
|
||||
echo $ task list venue
|
||||
task list venue
|
||||
|
||||
# 14 Due dates
|
||||
echo Due dates --------------------------------------------------------------
|
||||
echo $ task 1 due:7/31/2010
|
||||
task 1 due:7/31/2010
|
||||
echo $ task 1 due:2wks
|
||||
task 1 due:2wks
|
||||
echo $ task 1 due:-2wks
|
||||
task 1 due:-2wks
|
||||
echo $ task 1 due:eom
|
||||
task 1 due:eom
|
||||
echo $ task 2 due:8th
|
||||
task 2 due:8th
|
||||
echo $ task 2 due:sunday
|
||||
task 2 due:sunday
|
||||
echo $ task 5 due:eow
|
||||
task 5 due:eow
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task overdue
|
||||
task overdue
|
||||
echo $ task rc.dateformat.report:Y-M-DTH:N:SZ list
|
||||
task rc.dateformat.report:Y-M-DTH:N:SZ list
|
||||
|
||||
# 15 Calendar
|
||||
echo Calendar --------------------------------------------------------------
|
||||
echo $ task calendar
|
||||
task calendar
|
||||
echo $ vi ~/.taskrc # include /usr/local/share/doc/task/rc/holidays-US.rc
|
||||
#vi ~/.taskrc # include /usr/local/share/doc/task/rc/holidays-US.rc
|
||||
echo 'include /usr/local/share/doc/task/rc/holidays-US.rc' >> x
|
||||
echo $ task calendar
|
||||
task calendar
|
||||
echo $ task cal 2010
|
||||
task cal 2010
|
||||
echo $ task rc.calendar.details:full cal
|
||||
task rc.calendar.details:full cal
|
||||
echo $ task rc.calendar.holidays:full cal
|
||||
task rc.calendar.holidays:full cal
|
||||
|
||||
# 16 Recurrence
|
||||
echo Recurrence --------------------------------------------------------------
|
||||
echo $ task 7 info
|
||||
task 7 info
|
||||
echo $ task 7 due:eom recur:monthly
|
||||
task 7 due:eom recur:monthly
|
||||
echo $ task 7
|
||||
task 7
|
||||
echo $ task 7 until:eoy
|
||||
task 7 until:eoy
|
||||
echo $ task recurring
|
||||
task recurring
|
||||
echo $ task add Pay taxes due:4/15/2007 recur:yearly
|
||||
task add Pay taxes due:4/15/2007 recur:yearly
|
||||
echo $ task long
|
||||
task long
|
||||
echo $ task 11 delete
|
||||
printf "y\ny\n" | task 11 delete # y, y
|
||||
echo $ task list
|
||||
task list
|
||||
|
||||
# 17 Shell
|
||||
echo Shell --------------------------------------------------------------
|
||||
echo $ task shell
|
||||
#task shell
|
||||
echo '> projects'
|
||||
#> projects
|
||||
echo '> tags'
|
||||
#> tags
|
||||
echo '> list'
|
||||
#> list
|
||||
echo '> quit'
|
||||
#> quit
|
||||
|
||||
# 18 Special tags
|
||||
echo Special tags --------------------------------------------------------------
|
||||
echo $ task 6 +nocolor
|
||||
task 6 +nocolor
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task tags
|
||||
task tags
|
||||
echo $ task 6 -nocolor
|
||||
task 6 -nocolor
|
||||
|
||||
# 19 Waiting
|
||||
echo Waiting --------------------------------------------------------------
|
||||
echo $ task add Look for new apartment due:eoy
|
||||
task add Look for new apartment due:eoy
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task 10 wait:12/1/2010
|
||||
task 10 wait:12/1/2010
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task waiting
|
||||
task waiting
|
||||
echo $ task add Do something in a few seconds
|
||||
task add Do something in a few seconds
|
||||
echo $ task 11 wait:5s
|
||||
task 11 wait:5s
|
||||
echo $ task list
|
||||
task list
|
||||
sleep 5
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task 11 rc.confirmation:no delete
|
||||
task 11 rc.confirmation:no delete
|
||||
|
||||
# 20 Dependencies
|
||||
echo Dependencies --------------------------------------------------------------
|
||||
echo $ task list pro:party
|
||||
task list pro:party
|
||||
echo $ task 3 depends:6
|
||||
task 3 depends:6
|
||||
echo $ task 6 dep:5
|
||||
task 6 dep:5
|
||||
echo $ task 2 dep:1
|
||||
task 2 dep:1
|
||||
echo $ task 5 dep:1,2
|
||||
task 5 dep:1,2
|
||||
echo $ task 4 dep:1
|
||||
task 4 dep:1
|
||||
echo $ task long pro:party
|
||||
task long pro:party
|
||||
echo $ task 5 dep:-1
|
||||
task 5 dep:-1
|
||||
echo $ task blocked
|
||||
task blocked
|
||||
echo $ task unblocked
|
||||
task unblocked
|
||||
echo $ task 1 info
|
||||
task 1 info
|
||||
echo $ task 2 info
|
||||
task 2 info
|
||||
echo $ task 2 done
|
||||
echo 'y' | task 2 done
|
||||
echo $ task 1 info
|
||||
task 1 info
|
||||
|
||||
# 21 Reports
|
||||
echo Reports --------------------------------------------------------------
|
||||
echo $ task minimal
|
||||
task minimal
|
||||
echo $ task ls
|
||||
task ls
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task long
|
||||
task long
|
||||
echo $ task all
|
||||
task all
|
||||
echo $ task completed
|
||||
task completed
|
||||
echo $ task recurring
|
||||
task recurring
|
||||
echo $ task waiting
|
||||
task waiting
|
||||
echo $ task blocked
|
||||
task blocked
|
||||
echo $ task oldest
|
||||
task oldest
|
||||
echo $ task newest
|
||||
task newest
|
||||
echo $ task timesheet
|
||||
task timesheet
|
||||
echo $ task next
|
||||
task next
|
||||
|
||||
# 22 Custom report
|
||||
echo Custom report --------------------------------------------------------------
|
||||
echo 'report.foo.description=My own report' >> x
|
||||
echo 'report.foo.columns=id,entry,description' >> x
|
||||
echo 'report.foo.labels=ID,Entered,Description' >> x
|
||||
echo 'report.foo.sort=entry+,description+' >> x
|
||||
echo 'report.foo.filter=status:pending' >> x
|
||||
echo 'task help | grep foo'
|
||||
task help | grep foo
|
||||
echo $ task show report.foo
|
||||
task show report.foo
|
||||
echo $ task foo
|
||||
task foo
|
||||
|
||||
# 23 Charts
|
||||
echo Charts --------------------------------------------------------------
|
||||
echo $ task history
|
||||
task history
|
||||
echo $ task history.annual
|
||||
task history.annual
|
||||
echo $ task ghistory
|
||||
task ghistory
|
||||
echo $ task ghistory.annual
|
||||
task ghistory.annual
|
||||
echo $ task summary
|
||||
task summary
|
||||
|
||||
# 24 Advanced filters
|
||||
echo Advanced filters --------------------------------------------------------------
|
||||
echo $ task list
|
||||
task list
|
||||
echo $ task list invit
|
||||
task list invit
|
||||
echo $ task list description.contains:invit
|
||||
task list description.contains:invit
|
||||
echo $ task list desc.word:the
|
||||
task list desc.word:the
|
||||
echo $ task list desc.noword:invitations
|
||||
task list desc.noword:invitations
|
||||
echo $ task list pro:party
|
||||
task list pro:party
|
||||
echo $ task list pro.is:party
|
||||
task list pro.is:party
|
||||
echo $ task list pro.not:party
|
||||
task list pro.not:party
|
||||
echo $ task list pro:party priority.over:L
|
||||
task list pro:party priority.over:L
|
||||
echo $ task list pro:party limit:2
|
||||
task list pro:party limit:2
|
||||
echo $ task list limit:page
|
||||
task list limit:page
|
||||
echo $ task all status:pending
|
||||
task all status:pending
|
||||
echo $ task all status:waiting
|
||||
task all status:waiting
|
||||
|
||||
# 25 Import/export
|
||||
echo Import/export --------------------------------------------------------------
|
||||
echo $ task export.csv
|
||||
task export.csv
|
||||
echo $ task export.csv venue
|
||||
task export.csv venue
|
||||
echo $ task export.vcalendar venue
|
||||
task export.vcalendar venue
|
||||
echo $ task export.yaml venue
|
||||
task export.yaml venue
|
||||
|
||||
cat <<EOF >file.text
|
||||
Remember to read the task man page
|
||||
EOF
|
||||
cat file.text
|
||||
echo $ task import file.text
|
||||
printf "y\n" | task import file.text
|
||||
|
||||
cat <<EOF >file.yaml
|
||||
%YAML 1.1
|
||||
---
|
||||
task:
|
||||
description: Visit http://taskwarrior.org
|
||||
due: 1281844800
|
||||
entry: 1281289630
|
||||
priority: H
|
||||
project: work
|
||||
status: pending
|
||||
uuid: 23afada0-a446-8d5a-c213-30d99d52c4b0
|
||||
...
|
||||
EOF
|
||||
cat file.yaml
|
||||
echo $ task import file.yaml
|
||||
printf "y\n" | task import file.yaml
|
||||
echo $ task new limit:2
|
||||
task new limit:2
|
||||
|
||||
# 26 Help
|
||||
echo Help --------------------------------------------------------------
|
||||
echo $ task help
|
||||
task help
|
||||
echo $ man task
|
||||
#man task
|
||||
echo $ man taskrc
|
||||
#man taskrc
|
||||
echo $ man task-color
|
||||
#man task-color
|
||||
echo $ man task-tutorial
|
||||
#man task-tutorial
|
||||
echo $ man task-faq
|
||||
#man task-faq
|
||||
echo $ man task-sync
|
||||
#man task-sync
|
||||
|
||||
# 27 Wrap up
|
||||
echo Wrap up --------------------------------------------------------------
|
||||
echo $ task version
|
||||
task version
|
||||
|
||||
exit
|
||||
|
||||
33
doc/misc/tutorial/reports/script.200.txt
Normal file
33
doc/misc/tutorial/reports/script.200.txt
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
[Make window 116x32 for movie recording, light text, dark background]
|
||||
|
||||
This is the script from which a 2.0-specific movie will be made. On the left
|
||||
are the typed commands, and on the right is the voice track.
|
||||
|
||||
It is intended that the left and right be combined and the result will be a new
|
||||
task-tutorial.5 man page.
|
||||
|
||||
|
||||
|
||||
---------------------------------------- Reports ---------------------------------------------------
|
||||
|
||||
task minimal Taskwarrior has a good many reports. There is the bare minimum.
|
||||
task ls The simple.
|
||||
task list The standard.
|
||||
task long The kitchen sink.
|
||||
task all The packrat.
|
||||
task completed Nostalgia.
|
||||
task recurring Groundhog day.
|
||||
task waiting Surprises.
|
||||
task blocked Wedged.
|
||||
task unblocked Unencumbered.
|
||||
task oldest Ancient history.
|
||||
task newest Contemporary.
|
||||
task timesheet Corporate.
|
||||
task next And "what should I work on next?" This one can be useful
|
||||
because it pulls a few of the highest priority tasks from
|
||||
all the projects. It's the report we should all be using.
|
||||
|
||||
---------------------------------------- End -------------------------------------------------------
|
||||
|
||||
New 'reports' command.
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue