From 1ebc802a89a78f3b004ab1b5e889318bd27b758c Mon Sep 17 00:00:00 2001 From: Haitham Gad Date: Sun, 10 Mar 2013 00:36:08 -0500 Subject: [PATCH] Adding a man page and refering to it from other man pages --- doc/CMakeLists.txt | 2 +- doc/man/task-color.5.in | 1 + doc/man/task-faq.5.in | 1 + doc/man/task-sync.5.in | 1 + doc/man/task-tutorial.5.in | 1 + doc/man/task.1.in | 1 + doc/man/taskrc.5.in | 1 + doc/man/tasksh.1 | 185 +++++++++++++++++++++++++++++++++++++ doc/man/tasksh.1.in | 185 +++++++++++++++++++++++++++++++++++++ 9 files changed, 377 insertions(+), 1 deletion(-) create mode 100644 doc/man/tasksh.1 create mode 100644 doc/man/tasksh.1.in diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index e0a880af6..d19a888b8 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required (VERSION 2.8) message ("-- Configuring man pages") -set (man_FILES task-color.5 task-faq.5 task-sync.5 task-tutorial.5 task.1 taskrc.5) +set (man_FILES task-color.5 task-faq.5 task-sync.5 task-tutorial.5 taskrc.5 task.1 tasksh.1) foreach (man_FILE ${man_FILES}) configure_file ( man/${man_FILE}.in diff --git a/doc/man/task-color.5.in b/doc/man/task-color.5.in index f80ea80f1..7fab12ac2 100644 --- a/doc/man/task-color.5.in +++ b/doc/man/task-color.5.in @@ -311,6 +311,7 @@ http://www.opensource.org/licenses/mit-license.php for more information. .SH SEE ALSO .BR task(1), +.BR tasksh(1), .BR taskrc(5), .BR task-faq(5), .BR task-tutorial(5), diff --git a/doc/man/task-faq.5.in b/doc/man/task-faq.5.in index a54e993b9..e5dc7b1f4 100644 --- a/doc/man/task-faq.5.in +++ b/doc/man/task-faq.5.in @@ -362,6 +362,7 @@ http://www.opensource.org/licenses/mit-license.php for more information. .SH SEE ALSO .BR task(1), +.BR tasksh(1), .BR taskrc(5), .BR task-tutorial(5), .BR task-color(5), diff --git a/doc/man/task-sync.5.in b/doc/man/task-sync.5.in index cb5da60e8..49038ccd4 100644 --- a/doc/man/task-sync.5.in +++ b/doc/man/task-sync.5.in @@ -362,6 +362,7 @@ http://www.opensource.org/licenses/mit-license.php for more information. .SH SEE ALSO .BR task(1), +.BR tasksh(1), .BR taskrc(5), .BR task-faq(5), .BR task-color(5), diff --git a/doc/man/task-tutorial.5.in b/doc/man/task-tutorial.5.in index 0d6f5b51a..20332340b 100644 --- a/doc/man/task-tutorial.5.in +++ b/doc/man/task-tutorial.5.in @@ -3133,6 +3133,7 @@ http://www.opensource.org/licenses/mit-license.php for more information. .SH SEE ALSO .BR task(1), +.BR tasksh(1), .BR taskrc(5), .BR task-faq(5), .BR task-color(5), diff --git a/doc/man/task.1.in b/doc/man/task.1.in index 6d8cb49c0..5ab034fa0 100644 --- a/doc/man/task.1.in +++ b/doc/man/task.1.in @@ -1036,6 +1036,7 @@ Taskwarrior is distributed under the MIT license. See http://www.opensource.org/licenses/mit-license.php for more information. .SH SEE ALSO +.BR tasksh(1), .BR taskrc(5), .BR task-tutorial(5), .BR task-faq(5), diff --git a/doc/man/taskrc.5.in b/doc/man/taskrc.5.in index f241b12e2..3c3ec2fce 100644 --- a/doc/man/taskrc.5.in +++ b/doc/man/taskrc.5.in @@ -1342,6 +1342,7 @@ http://www.opensource.org/licenses/mit-license.php for more information. .SH SEE ALSO .BR task(1), +.BR tasksh(1), .BR task-tutorial(5), .BR task-faq(5), .BR task-color(5), diff --git a/doc/man/tasksh.1 b/doc/man/tasksh.1 new file mode 100644 index 000000000..7e187b4e9 --- /dev/null +++ b/doc/man/tasksh.1 @@ -0,0 +1,185 @@ +.TH tasksh 1 2013-03-09 "task 2.3.0" "User Manuals" + +.SH NAME +tasksh \- Interactive taskwarrior shell + +.SH SYNOPSIS +.B tasksh [] +.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 \- 2012 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 + + +.TP +The official code repository at + + +.TP +You can contact the project by emailing + + +.SH REPORTING BUGS +.TP +Bugs in taskwarrior may be reported to the issue-tracker at + + diff --git a/doc/man/tasksh.1.in b/doc/man/tasksh.1.in new file mode 100644 index 000000000..ec32ff8c6 --- /dev/null +++ b/doc/man/tasksh.1.in @@ -0,0 +1,185 @@ +.TH tasksh 1 2013-03-09 "${PACKAGE_STRING}" "User Manuals" + +.SH NAME +tasksh \- Interactive taskwarrior shell + +.SH SYNOPSIS +.B tasksh [] +.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 \- 2012 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 + + +.TP +The official code repository at + + +.TP +You can contact the project by emailing + + +.SH REPORTING BUGS +.TP +Bugs in taskwarrior may be reported to the issue-tracker at + +