GothenburgBitFactory/taskshell
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskshell.git synced 2025-07-30 13:33:27 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: Updated man page with new features

Browse source
This commit is contained in:
Paul Beckingham 2016-09-05 09:20:04 -04:00
parent 96554e913f
commit e9fcf89e69
1 changed files with 31 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

46
doc/man/tasksh.1.in
View file

@ -9,12 +9,15 @@ tasksh \- Interactive taskwarrior shell
.B tasksh --version .B tasksh --version
.SH DESCRIPTION .SH DESCRIPTION
The tasksh program can be used to create a more immersive taskwarrior Tasksh can be used to create a more immersive taskwarrior environment.
environment. Any task command you run outside the shell can also be run inside Any task command you run outside the shell can also be run inside
the shell, without the need to prefix every command with "task". the shell, without the need to prefix every command with "task".
When built with libreadline, tasksh provides command editing and history. When built with libreadline, tasksh provides command editing and history.
Tasksh has an integrated 'review' command that leads you through an interactive
review session.
Tasksh supports all recent versions of Taskwarrior. Tasksh supports all recent versions of Taskwarrior.
.SH COMMANDS .SH COMMANDS
@ -25,24 +28,38 @@ Taskwarrior.
.B diagnostics .B diagnostics
Displays settings pertinent to tasksh, for diagnosing problems. Displays settings pertinent to tasksh, for diagnosing problems.
.TP
.B exec <commands>
This command allows you to run shell commands from within Tasksh. This is ideal
for accessing man pages such as this. The '!' command can be used in place of
the 'exec' keyword. Once the command is run, control returns to Tasksh.
.TP .TP
.B exit/quit .B exit/quit
These commands cause tasksh to terminate, returning you to your system shell. These commands cause tasksh to terminate, returning you to your system shell.
.TP .TP
.B help .B help
Shows how to obtain help. Shows a summary of commands, and how to obtain help.
.TP .TP
.B review [N] .B review [N]
Begins an interactive review session, where you can mark tasks as reviewed, 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 edit them using your text editor, provide modification commands, or skip them.
session at any time. You can terminate a review session at any time, and the next review session
Finds your pending and waiting tasks that need to be reviewed. By default this will resume at the right place.
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, To find tasks needing review, the '_reviewed' custom report is created and run,
a subsequent 'review' command will find no tasks to review, until a week has which filters tasks that have a missing 'reviewed' UDA date, or have not been
elapsed. reviewed for a week.
This means that if you run a review session to completion, there will be no
need to review again for a week, and the review command will simply do nothing
until then.
The one week review cycle is defined by the '_reviewed' custom report, which
can be modified if you prefer a monthly review cycle.
If 'N' is provided, the session is limited to reviewing only N tasks. If 'N' is provided, the session is limited to reviewing only N tasks.
Note: requires Taskwarrior 2.5.0 or later. Note: requires Taskwarrior 2.5.0 or later.
@ -114,11 +131,10 @@ ID Project Pri Due Active Age Description
.br .br
.SH CONFIGURATION .SH CONFIGURATION
Tasksh piggybacks on Taskwarrior's .taskrc configuration file, and stores Tasksh piggybacks on Taskwarrior's .taskrc configuration file, and refers
several settings there. If you use a non-standard location for your .task to settings there. If you use a non-standard location for your .task database
database, and .taskrc file, Tasksh will not find them unless you set the , and .taskrc file, Tasksh will not find them unless you set the TASKDATA and
TASKDATA and TASKRC environment variables. See 'man taskrc' for more TASKRC environment variables. See 'man taskrc' for more details.
details.
The review command storeѕ a UDA ('reviewed') and report definition ('_reviewed'). The review command storeѕ a UDA ('reviewed') and report definition ('_reviewed').