From 2ac2aafbe78a645ae103eb16c3eece6caf12fc61 Mon Sep 17 00:00:00 2001 From: Paul Beckingham Date: Sat, 30 May 2009 17:14:00 -0400 Subject: [PATCH] Patch - Pushed man pages to version 1.8.0 From eb1beb066956f95521298fc699359a20b9aa4ed9 Mon Sep 17 00:00:00 2001 From: Federico Hernandez Date: Sat, 30 May 2009 22:47:45 +0200 Subject: [PATCH 2/2] Pushed man pages to version 1.8.0 Changed references for documentation to taskwarrior.org Added stub for new man page task-tutorial.5 --- Makefile.am | 2 +- doc/man1/task.1 | 35 ++++++------------- doc/man5/task-tutorial.5 | 48 ++++++++++++++++++++++++++ doc/man5/taskrc.5 | 73 +++++++++++++++++----------------------- 4 files changed, 91 insertions(+), 67 deletions(-) create mode 100644 doc/man5/task-tutorial.5 diff --git a/Makefile.am b/Makefile.am index 7749058e1..7a88e2bd7 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,7 +1,7 @@ SUBDIRS = src dist_man1_MANS = doc/man1/task.1 -dist_man5_MANS = doc/man5/taskrc.5 +dist_man5_MANS = doc/man5/taskrc.5 doc/man5/task-tutorial.5 docdir = $(datadir)/doc/${PACKAGE}-${VERSION} doc_DATA = AUTHORS ChangeLog COPYING INSTALL NEWS README diff --git a/doc/man1/task.1 b/doc/man1/task.1 index 3086f934f..e5cede670 100644 --- a/doc/man1/task.1 +++ b/doc/man1/task.1 @@ -1,4 +1,4 @@ -.TH task 1 2009-05-14 "Task 1.7.0" "User Manuals" +.TH task 1 2009-05-30 "Task 1.8.0" "User Manuals" .SH NAME task \- A command line todo manager. @@ -319,16 +319,14 @@ could be list, ls or long. .SH EXAMPLES -A small section for examples e.g. some stuff from +For examples please see the online documentation at .br -http://www.beckingham.net/30second.html -.br -http://www.beckingham.net/simple.html + .SH FILES .TP -~/.taskrc User configuration file. +~/.taskrc User configuration file - see also taskrc(5). .TP ~/.task The default directory where task stores its data files. The location @@ -352,31 +350,20 @@ task is distributed under the GNU General Public License. See http://www.gnu.org/licenses/gpl-2.0.txt for more information. .SH SEE ALSO -.BR taskrc (5) +.BR taskrc(5), +.BR task-tutorial(7) For more information regarding task, the following may be referenced: .TP - -The official site. - -.TP - -The official mailing list. +The official site at + .TP +The official code repository at -The official code repository. .SH REPORTING BUGS +.TP Bugs in task may be reported to the issue-tracker at - -.RS - -.RE - -or to the mailing list at - -.RS - -.RE + diff --git a/doc/man5/task-tutorial.5 b/doc/man5/task-tutorial.5 new file mode 100644 index 000000000..12d564621 --- /dev/null +++ b/doc/man5/task-tutorial.5 @@ -0,0 +1,48 @@ +.TH task-tutorial 5 2009-05-30 "Task 1.8.0" "User Manuals" + +.SH NAME +task-tutorial \- A tutorial for the task(1) command line todo manager. + +.SH DESCRIPTION +Task is a command line TODO list manager. It maintains a list of tasks that you +want to do, allowing you to add/remove, and otherwise manipulate them. Task +has a rich list of subcommands that allow you to do various things with it. + +.SH 30 second tutorial +30 second tutorial + +.SH Simple usage of task +Simple usage of task + +.SH Advanced usage of task +Advanced usage of task + +.SH "CREDITS & COPYRIGHTS" +task was written by P. Beckingham . +.br +Copyright (C) 2006 \- 2009 P. Beckingham + +This man page was originally written by Federico Hernandez. It is based on the task man page, which +was originally written by P.C. Shyamshankar. + +task is distributed under the GNU General Public License. See +http://www.gnu.org/licenses/gpl-2.0.txt for more information. + +.SH SEE ALSO +.BR task(1), +.BR taskrc(5) + +For more information regarding task, the following may be referenced: + +.TP +The official site at + + +.TP +The official code repository at + + +.SH REPORTING BUGS +.TP +Bugs in task may be reported to the issue-tracker at + diff --git a/doc/man5/taskrc.5 b/doc/man5/taskrc.5 index 01aeaa51f..bd91ef907 100644 --- a/doc/man5/taskrc.5 +++ b/doc/man5/taskrc.5 @@ -1,10 +1,11 @@ -.TH taskrc 5 2009-05-14 "Task 1.7.0" "User Manuals" +.TH taskrc 5 2009-05-30 "Task 1.8.0" "User Manuals" .SH NAME taskrc \- Configuration file for the task(1) command .SH SYNOPSIS .B $HOME/.taskrc +.br .B task rc:/.taskrc .SH DESCRIPTION @@ -305,94 +306,93 @@ The output columns, their labels and the sort order can be set using the corresp variables for each report. .TP -.B +.B report.long.description Lists all task, all data, matching the specified criteria .TP -.B +.B report.long.labels=ID,Project,Pri,Added,Started,Due,Recur,Age,Tags,Description .RE .br -.B +.B report.long.columns=id,project,priority,entry,start,due,recur,age,tags,description .br -.B +.B report.long.sort=due+,priority-,project+ .TP -.B +.B report.list.description Lists all tasks matching the specified criteria .TP -.B +.B report.list.labels=ID,Project,Pri,Due,Active,Age,Description .RE .br -.B +.B report.list.columns=id,project,priority,due,active,age,description .br -.B +.B report.list.sort=due+,priority-,project+ .TP -.B +.B report.ls.description Minimal listing of all tasks matching the specified criteria .TP -.B +.B report.ls.labels=ID,Project,Pri,Description .RE .br -.B +.B report.ls.columns=id,project,priority,description .br -.B +.B report.ls.sort=priority-,project+ .TP -.B +.B report.newest.description Shows the newest tasks .TP -.B +.B report.newest.labels=ID,Project,Pri,Due,Active,Age,Description .RE .br -.B +.B report.newest.columns=id,project,priority,due,active,age,description .br -.B +.B report.newest.sort=id- .br -.B +.B report.newest.limit=10 .TP -.B +.B report.oldest.description Shows the oldest tasks .TP -.B +.B report.oldest.labels=ID,Project,Pri,Due,Active,Age,Description .RE .br -.B +.B report.oldest.columns=id,project,priority,due,active,age,description .br -.B +.B report.oldest.sort=id+ .br -.B +.B report.oldest.limit=10 - .SH "CREDITS & COPYRIGHTS" task was written by P. Beckingham . .br @@ -405,31 +405,20 @@ task is distributed under the GNU General Public License. See http://www.gnu.org/licenses/gpl-2.0.txt for more information. .SH SEE ALSO -.BR task (1) +.BR task(1), +.BR task-tutorial(7) For more information regarding task, the following may be referenced: .TP - -The official site. - -.TP - -The official mailing list. +The official site at + .TP +The official code repository at -The official code repository. .SH REPORTING BUGS +.TP Bugs in task may be reported to the issue-tracker at - -.RS - -.RE - -or to the mailing list at - -.RS - -.RE +