taskshell/doc/man/tasksh.1.in
2015-05-25 13:04:45 -04:00

131 lines
2.4 KiB
Groff

.TH tasksh 1 2014-12-21 "${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 taskwarrior
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".
When built with libreadline, tasksh provides command editing and history.
Tasksh supports all recent versions of Taskwarrior.
.SH COMMANDS
Tasksh supports the following commands. All other commands are passed intact to
Taskwarrior.
.TP
.B exit/quit/Ctrl-D
These commands cause tasksh to terminate.
.TP
.B diagnostics
Displays settings pertinent to tasksh.
.TP
.B review
Begins an interactive review session.
.SH USAGE
Here is an example tasksh session.
$ tasksh
.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
.SH "CREDITS & COPYRIGHTS"
Copyright (C) 2006 \- 2015 P. Beckingham, F. Hernandez.
This man page was originally written by Federico Hernandez.
Tasksh is distributed under the MIT license. See
http://www.opensource.org/licenses/mit-license.php for more information.
.SH SEE ALSO
.BR task(1),
For more information regarding tasksh, see the following:
.TP
The official site at
<http://taskwarrior.org/tools>
.TP
The official code repository at
<https://git.tasktools.org/scm/ex/tasksh.git>
.TP
You can contact the project by emailing
<support@tasktools.org>
.SH REPORTING BUGS
.TP
Bugs in tasksh may be reported to the issue-tracker at
<http://bug.tasktools.org>