mirror of
https://github.com/GothenburgBitFactory/taskshell.git
synced 2025-06-26 10:54:29 +02:00
152 lines
3.4 KiB
Groff
152 lines
3.4 KiB
Groff
.TH tasksh 1 2014-12-21 "${PACKAGE_STRING}" "User Manuals"
|
|
|
|
.SH NAME
|
|
tasksh \- Interactive taskwarrior shell
|
|
|
|
.SH SYNOPSIS
|
|
.B tasksh
|
|
.br
|
|
.B tasksh --version
|
|
|
|
.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 diagnostics
|
|
Displays settings pertinent to tasksh, for diagnosing problems.
|
|
|
|
.TP
|
|
.B exit/quit
|
|
These commands cause tasksh to terminate, returning you to your system shell.
|
|
|
|
.TP
|
|
.B help
|
|
Shows how to obtain help.
|
|
|
|
.TP
|
|
.B review [N]
|
|
Begins an interactive review session, where you can mark tasks as reviewed,
|
|
modify them using your text editor, or skip them. You can terminate a review
|
|
session at any time.
|
|
Finds your pending and waiting tasks that need to be reviewed. By default this
|
|
means any task with a missing 'reviewed' date, or with a 'reviewed' date that
|
|
is older than a week. This means if you run the 'review' command to completion,
|
|
a subsequent 'review' command will find no tasks to review, until a week has
|
|
elapsed.
|
|
If 'N' is provided, the session is limited to reviewing only N tasks.
|
|
|
|
Note: requires Taskwarrior 2.5.0 or later.
|
|
For full details, see:
|
|
<https://taskwarrior.org/docs/review.html>
|
|
|
|
.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/2015 2 hrs Select and book a venue
|
|
.br
|
|
5 party H 10/22/2015 2 hrs Design invitations
|
|
.br
|
|
9 home 10/31/2015 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 CONFIGURATION
|
|
Tasksh piggybacks on Taskwarrior's .taskrc configuration file, and stores
|
|
several settings there. If you use a non-standard location for your .task
|
|
database, and .taskrc file, Tasksh will not find them unless you set the
|
|
TASKDATA and TASKRC environment variables. See 'man taskrc' for more
|
|
details.
|
|
|
|
.SH "CREDITS & COPYRIGHTS"
|
|
Copyright (C) 2006 \- 2016 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>
|
|
|