Documentation

- Updated demo of aliases.
- Updated advanced filters section.
- Added import/export section.
This commit is contained in:
Paul Beckingham 2010-08-08 16:29:10 -04:00
parent 07e36e695d
commit 36c3cad5a5
2 changed files with 51 additions and 6 deletions

View file

@ -246,6 +246,8 @@ echo Advanced filters
task rc:x list
task rc:x list invit
task rc:x list description.contains:invit
task rc:x list desc.word:the
task rc:x list desc.noword:invitations
task rc:x list pro:party
task rc:x list pro.is:party
task rc:x list pro.not:party
@ -257,10 +259,33 @@ task rc:x all status:waiting
# Import/export
echo Import/export
task rc:x export.csv
task rc:x export.csv venue
task rc:x export.vcalendar venue
task rc:x export.yaml venue
cat <<EOF >file.text
Remember to read the task man page
EOF
cat file.text
printf "y\n" | task rc:x 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
printf "y\n" | task rc:x import file.yaml
task rc:x new limit:2
# Help
echo Help

View file

@ -193,6 +193,8 @@ task config default.project
task config alias.zzz list You can create aliases to effectively rename task commands.
task zzz
task z You can abbreviate those, too.
---------------------------------------- Color -----------------------------------------------------
task config color on All the examples so far have been shown with color turned
@ -416,9 +418,15 @@ task list invit unfiltered list, which shows all tasks.
task list description.contains:invit This is the equivalent form using attribute modifiers. In
this example we are filtering on descriptions that contain
the work fragment. Here we are using the 'contains'
the word fragment. Here we are using the 'contains'
modifier, but there are many others.
task list desc.word:the All tasks containing the whole word 'the'. See how
annotations are also searched?
task list desc.noword:invitations Here is a list of all tasks that do not contain the whole
word 'invitations'.
task list pro:party Here list all tasks in the 'party' project.
task list pro.is:party And the full equivalent.
task list pro.not:party Here list tasks that are not in the 'party' project. I
@ -442,9 +450,21 @@ task all status:waiting The 'waiting' report is similarly defin
---------------------------------------- Import/Export ---------------------------------------------
import
export.yaml
export.csv
task export.csv You can export your tasks. Here you see all tasks being
exported in CSV format.
task export.csv venue Let's just export one task in CSV format...
task export.vcalendar venue Or in VCalendar format...
task export.yaml venue Or YAML.
cat file.text Task can also import. Here I am importing simple lines
task import file.text of text. Task recognizes the format and confirms.
cat file.yaml Here is a YAML example. Task can read several formats,
task import file.yaml including old versions task data. Using YAML, you can
round-trip the data without loss.
task new limit:2 Here are the imported tasks.
---------------------------------------- Help ------------------------------------------------------