mirror of
https://github.com/GothenburgBitFactory/taskwarrior.git
synced 2025-07-07 20:06:36 +02:00
Documentation Update
- Removed 1.9.x references. - Cleared out NEWS file.
This commit is contained in:
parent
4de854a3c3
commit
589b84982f
5 changed files with 29 additions and 70 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1,4 +1,5 @@
|
|||
cmake.h
|
||||
auto.h
|
||||
commit.h
|
||||
Makefile
|
||||
*/*task
|
||||
|
|
|
@ -2,6 +2,7 @@
|
|||
------ current release ---------------------------
|
||||
|
||||
2.0.0 ()
|
||||
+ autoconf eliminated.
|
||||
|
||||
------ old releases ------------------------------
|
||||
|
||||
|
|
32
INSTALL
32
INSTALL
|
@ -1,21 +1,20 @@
|
|||
Installation Instructions
|
||||
-------------------------
|
||||
|
||||
Building task with autotools has been phased out. As of version 1.9.4
|
||||
task uses and builds now with cmake.
|
||||
|
||||
Please follow the instructions below to build task with cmake.
|
||||
|
||||
|
||||
Pre-requisites
|
||||
--------------
|
||||
|
||||
You will need the CMake build system installed in order to build taskwarrior
|
||||
from source.
|
||||
|
||||
More information on cmake can be obtained at http://cmake.org
|
||||
|
||||
Optionally, you might want to have Lua installed, if you wish to write plugins
|
||||
and modify taskwarrior.
|
||||
|
||||
More information on cmake can be obtained at http://cmake.org
|
||||
|
||||
Basic Installation
|
||||
------------------
|
||||
|
@ -49,20 +48,21 @@ These commands are explained below:
|
|||
Build and configurations options
|
||||
--------------------------------
|
||||
|
||||
You can customize the configuration run with cmake variables. This will modify the
|
||||
installation process:
|
||||
You can customize the configuration run with cmake variables. This will modify
|
||||
the installation process:
|
||||
|
||||
To change the installation directory you use the following configuration variable:
|
||||
To change the installation directory you use the following configuration
|
||||
variable:
|
||||
|
||||
$ cmake -DCMAKE_INSTALL_PREFIX=<path-to-installation-dir> .
|
||||
|
||||
cmake configuration variables are applied with the -D option and consist of a <name>
|
||||
and a <value>:
|
||||
cmake configuration variables are applied with the -D option and consist of a
|
||||
<name> and a <value>:
|
||||
|
||||
$ cmake -D<name>=<value> .
|
||||
|
||||
Four more variables can customize the installation process. The following table lists
|
||||
them and their defaults plus the CMAKE_INSTALL_PREFIX:
|
||||
Four more variables can customize the installation process. The following table
|
||||
lists them and their defaults plus the CMAKE_INSTALL_PREFIX:
|
||||
|
||||
CMAKE_INSTALL_PREFIX /usr/local
|
||||
TASK_BINDIR bin
|
||||
|
@ -70,8 +70,8 @@ them and their defaults plus the CMAKE_INSTALL_PREFIX:
|
|||
TASK_MAN1DIR share/man/man1
|
||||
TASK_MAN5DIR share/man/man5
|
||||
|
||||
The correpsonding TASK_* variables will be combined with CMAKE_INSTALL_PREFIX to get
|
||||
absolute installation directoris:
|
||||
The corresponding TASK_* variables will be combined with CMAKE_INSTALL_PREFIX to
|
||||
get absolute installation directoris:
|
||||
|
||||
CMAKE_INSTALL_PREFIZ/TASK_BINDIR /usr/local/bin
|
||||
CMAKE_INSTALL_PREFIZ/TASK_DOCDIR /usr/local/share/doc/task
|
||||
|
@ -92,9 +92,9 @@ step 7 above, they must first be regenerated by following steps [1], [2] and
|
|||
Taskwarrior Build Notes
|
||||
-----------------------
|
||||
|
||||
Taskwarrior 1.9.4 has dependencies that are detected by cmake in almost all cases,
|
||||
but there are situations and operating systems that mean you will need to offer
|
||||
a little help.
|
||||
Taskwarrior has dependencies that are detected by cmake in almost all cases, but
|
||||
there are situations and operating systems that mean you will need to offer a
|
||||
little help.
|
||||
|
||||
If taskwarrior will not build on your system, first take a look at the Operating
|
||||
System notes below. If this doesn't help, then go to the Troubleshooting
|
||||
|
|
59
NEWS
59
NEWS
|
@ -1,65 +1,22 @@
|
|||
|
||||
New Features in taskwarrior 1.9.4
|
||||
New Features in taskwarrior 2.0.0
|
||||
|
||||
- New burndown charts.
|
||||
- New 'count' helper command.
|
||||
- Inifinite width reports, when redirecting output.
|
||||
- Added highlighting for the show command that indicates which values differ
|
||||
from the defaults.
|
||||
- Added change log display to the 'info' command.
|
||||
- The first month in the calendar report can now be changed with an offset
|
||||
value.
|
||||
- No more dependency on ncurses.
|
||||
- New '_query' helper command for script writers, which accepts a filter like
|
||||
any other report, but returns unformatted JSON. The new alias 'export.json'
|
||||
maps to the _query command.
|
||||
- Import can now read from files and URLs.
|
||||
- Assorted bug fixes.
|
||||
- New literal date "later" and "someday" to be used with the wait attribute to
|
||||
hide a task until somepoint in time (this sets the wait date to 1/18/2038).
|
||||
- Total active time now shown on the info report.
|
||||
- Add-on scripts: export-xml.pl, export-xml.py, export-xml.rb, export-ical.pl,
|
||||
export-csv.pl and export-yaml.pl.
|
||||
- New dark-gray-256 color theme.
|
||||
-
|
||||
|
||||
Please refer to the ChangeLog file for full details. There are too many to
|
||||
list here.
|
||||
|
||||
New commands in taskwarrior 1.9.4
|
||||
New commands in taskwarrior 2.0.0
|
||||
|
||||
- 'burndown.daily', 'burndown.weekly', 'burndown.monthly', also with
|
||||
'burndown' that is an alias to burndown.weekly.
|
||||
- 'count' accepts a filter, and simply returns a count of the tasks
|
||||
matching the filter. Used as a helper command by scripts.
|
||||
- '_query' helper command for all future export formats.
|
||||
-
|
||||
|
||||
New configuration options in taskwarrior 1.9.4
|
||||
New configuration options in taskwarrior 2.0.0
|
||||
|
||||
- color.burndown.pending, color.burndown.started and color.burndown.done
|
||||
control the color of the burndown charts.
|
||||
- burndown.bias, which is a tweakable control for the completion estimation
|
||||
for the burndown charts, and is documented in taskrc(5).
|
||||
- defaultwidth=0 is causes word-wrapping to be turned off, and effectively
|
||||
set reports to potentially have infinite width .
|
||||
- journal.info controls whether a change log for each task is displayed by
|
||||
the 'info' command.
|
||||
- gc=off can be used, temporarily, to defer GC until later commands, which
|
||||
eliminates problems with task ID numbers for script writers.
|
||||
- calendar.offset=off and calendar.offset.value=-1 to apply an offset value
|
||||
to change the effective first month in the calendar report.
|
||||
- default.due can be specified, and adds a default due date to all added
|
||||
and imported tasks that don't otherwise have a due date.
|
||||
- edit.verbose can be set to 'off' to eliminated the help text when using
|
||||
the 'task edit' command.
|
||||
- xterm.title can be set to 'on' to update the xterm window title when a
|
||||
report is run.
|
||||
- new holidays configuration file for New Zealand, Italy, Austria.
|
||||
-
|
||||
|
||||
Newly deprecated features in taskwarrior 1.9.4
|
||||
Newly deprecated features in taskwarrior 2.0.0
|
||||
|
||||
- The export commands (export, export.csv, export.yaml, export.ical and
|
||||
export.vcalendar) are deprecated, and will be replaced in future releases
|
||||
by add-on scripts.
|
||||
-
|
||||
|
||||
---
|
||||
|
||||
|
|
|
@ -256,7 +256,7 @@ Note: This is being written from the OSX 10.6 perspective, and may therefore
|
|||
|
||||
$ /usr/local/bin/task version
|
||||
|
||||
task 1.9.4 built for darwin
|
||||
task 2.0.0 built for darwin
|
||||
Copyright (C) 2006 - 2011 P. Beckingham, F. Hernandez.
|
||||
|
||||
Taskwarrior may be copied only under the terms of the GNU General Public
|
||||
|
@ -269,9 +269,9 @@ Note: This is being written from the OSX 10.6 perspective, and may therefore
|
|||
$ man task
|
||||
...
|
||||
...
|
||||
task 1.9.4 2011-0l-10 task 1.9.4
|
||||
task 2.0.0 2011-0l-10 task 2.0.0
|
||||
|
||||
The man page should list 1.9.2 as the version number, but the date will be
|
||||
The man page should list 2.0.0 as the version number, but the date will be
|
||||
different.
|
||||
|
||||
9. Email the package to Fredde.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue