Documentation

- Updated docs for beta.
This commit is contained in:
Paul Beckingham 2013-09-07 14:42:35 -04:00
parent 88abd93e52
commit af38b3bb7b
5 changed files with 8 additions and 193 deletions

View file

@ -7,7 +7,7 @@ include (CheckStructHasMember)
set (HAVE_CMAKE true) set (HAVE_CMAKE true)
project (task) project (task)
set (PROJECT_VERSION "2.3.0") set (PROJECT_VERSION "2.3.0.beta1")
SET (TASK_MAN1DIR share/man/man1 CACHE STRING "Installation directory for man pages, section 1") SET (TASK_MAN1DIR share/man/man1 CACHE STRING "Installation directory for man pages, section 1")
SET (TASK_MAN5DIR share/man/man5 CACHE STRING "Installation directory for man pages, section 5") SET (TASK_MAN5DIR share/man/man5 CACHE STRING "Installation directory for man pages, section 5")

2
NEWS
View file

@ -8,9 +8,9 @@ New Features in taskwarrior 2.3.0
- French translation has begun. - French translation has begun.
- UDA fields now allow default values. - UDA fields now allow default values.
- Now requires libuuid. - Now requires libuuid.
- New '_get' DOM accessor helper command.
- New virtual tags: WEEK, MONTH, YEAR, PARENT. - New virtual tags: WEEK, MONTH, YEAR, PARENT.
- New 'remaining' format for date columns. - New 'remaining' format for date columns.
- New '_get' DOM accessor helper command.
New commands in taskwarrior 2.3.0 New commands in taskwarrior 2.3.0

View file

@ -1,10 +1,9 @@
Welcome To Taskwarrior 2.3.0 Alpha Welcome To Taskwarrior 2.3.0 Beta
---------------------------------- ---------------------------------
The alpha release of Taskwarrior 2.3.0 is for testing the Task Server. The beta release of Taskwarrior 2.3.0 is for testing the Task Server. There are
Currently Taskwarrior is the only client for the Task Server. There are several several unaddressed bugs in this release, so proper precautions with your data
unaddressed bugs in this release, so proper precautions with your data are are required.
required.
Building Taskwarrior Building Taskwarrior

1
doc/man/.gitignore vendored
View file

@ -4,3 +4,4 @@ task-sync.5
task-tutorial.5 task-tutorial.5
task.1 task.1
taskrc.5 taskrc.5
tasksh.1

View file

@ -1,185 +0,0 @@
.TH tasksh 1 2013-03-09 "task 2.3.0" "User Manuals"
.SH NAME
tasksh \- Interactive taskwarrior shell
.SH SYNOPSIS
.B tasksh [<commands-file>]
.br
.B tasksh --version
.br
.B tasksh --help
.SH DESCRIPTION
The tasksh program can be used to create a more immersive task environment.
Any task command you run outside the shell can also be run inside the shell,
without the need to prefix every command with "task".
.br
Moreover, task commands can be written in a file which can be passed or
redirected to tasksh for batch execution.
.RS
$ tasksh
.br
.B task 2.3.0
shell
.br
.br
Enter any task command (such as 'list'), or hit 'Enter'.
.br
There is no need to include the 'task' command itself.
.br
Enter 'quit' to end the session.
.br
.br
task> projects
.br
.br
Project Tasks Pri:None Pri:L Pri:M Pri:H
.br
------- ----- -------- ----- ----- -----
.br
7 7 0 0 0
.br
home 2 2 0 0 0
.br
party 6 3 0 0 3
.br
.br
3 projects (15 tasks)
.br
task> tags
.br
.br
Tag Count
.br
mall 2
.br
.br
1 tag (15 tasks)
.br
task> list
.br
.br
ID Project Pri Due Active Age Description
.br
---------------------------------------------------------------------
.br
2 party H 10/17/2010 2 hrs Select and book a venue
.br
5 party H 10/22/2010 2 hrs Design invitations
.br
9 home 10/31/2010 1 hr Pay rent
.br
3 party 2 hrs Mail invitations
.br
4 party 2 hrs Select a caterer
.br
6 party 2 hrs Print invitations
.br
.br
8 tasks
.br
task> quit
.br
$
.br
$ cat task.commands
.br
add foo
.br
add bar
.br
$ tasksh task.commands
.br
task 2.3.0 shell
.br
.br
Enter any task command (such as 'list'), or hit 'Enter'.
.br
There is no need to include the 'task' command itself.
.br
Enter 'quit' to end the session.
.br
.br
task> add foo
.br
Created task 8.
.br
task> add bar
.br
Created task 9.
.br
$
.br
$ cat task.commands | tasksh
.br
task 2.3.0 shell
.br
.br
Enter any task command (such as 'list'), or hit 'Enter'.
.br
There is no need to include the 'task' command itself.
.br
Enter 'quit' to end the session.
.br
.br
task> add foo
.br
Created task 8.
.br
task> add bar
.br
Created task 9.
.br
.RE
.SH "CREDITS & COPYRIGHTS"
Copyright (C) 2006 \- 2013 P. Beckingham, F. Hernandez.
This man page was originally written by Federico Hernandez.
Taskwarrior is distributed under the MIT license. See
http://www.opensource.org/licenses/mit-license.php for more information.
.SH SEE ALSO
.BR task(1),
.BR task-tutorial(5),
.BR taskrc(5),
.BR task-faq(5),
.BR task-color(5),
.BR task-sync(5)
For more information regarding taskwarrior, see the following:
.TP
The official site at
<http://taskwarrior.org>
.TP
The official code repository at
<git://tasktools.org/task.git/>
.TP
You can contact the project by emailing
<support@taskwarrior.org>
.SH REPORTING BUGS
.TP
Bugs in taskwarrior may be reported to the issue-tracker at
<http://taskwarrior.org>