Adding a man page and refering to it from other man pages

This commit is contained in:
Haitham Gad 2013-03-10 00:36:08 -05:00 committed by Paul Beckingham
parent a5f55bf2f4
commit 1ebc802a89
9 changed files with 377 additions and 1 deletions

View file

@ -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),

View file

@ -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),

View file

@ -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),

View file

@ -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),

View file

@ -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),

View file

@ -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),

185
doc/man/tasksh.1 Normal file
View file

@ -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 [<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 \- 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
<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>

185
doc/man/tasksh.1.in Normal file
View file

@ -0,0 +1,185 @@
.TH tasksh 1 2013-03-09 "${PACKAGE_STRING}" "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 \- 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
<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>