doc/man/tasksh.1.in

   1 .TH tasksh 1 2017-05-10 "${PACKAGE_STRING}" "User Manuals"
   2
   3 .SH NAME
   4 tasksh \- Interactive taskwarrior shell
   5
   6 .SH SYNOPSIS
   7 .B tasksh
   8 .br
   9 .B tasksh --version
  10
  11 .SH DESCRIPTION
  12 Tasksh can be used to create a more immersive taskwarrior environment.
  13 Any task command you run outside the shell can also be run inside
  14 the shell, without the need to prefix every command with "task".
  15
  16 When built with libreadline, tasksh provides command editing and history.
  17
  18 Tasksh has an integrated 'review' command that leads you through an interactive
  19 review session.
  20
  21 Tasksh supports all recent versions of Taskwarrior.
  22
  23 .SH COMMANDS
  24 Tasksh supports the following commands.  All other commands are passed intact to
  25 Taskwarrior.
  26
  27 .TP
  28 .B diagnostics
  29 Displays settings pertinent to tasksh, for diagnosing problems.
  30
  31 .TP
  32 .B exec <commands>
  33 This command allows you to run shell commands from within Tasksh. This is ideal
  34 for accessing man pages such as this. The '!' command can be used in place of
  35 the 'exec' keyword. Once the command is run, control returns to Tasksh.
  36
  37 .TP
  38 .B exit/quit
  39 These commands cause tasksh to terminate, returning you to your system shell.
  40
  41 .TP
  42 .B help
  43 Shows a summary of commands, and how to obtain help.
  44
  45 .TP
  46 .B review [N]
  47 Begins an interactive review session, where you can mark tasks as reviewed,
  48 edit them using your text editor, provide modification commands, or skip them.
  49 You can terminate a review session at any time, and the next review session
  50 will resume at the right place.
  51
  52 To find tasks needing review, the '_reviewed' custom report is created and run,
  53 which filters tasks that have a missing 'reviewed' UDA date, or have not been
  54 reviewed for a week.
  55
  56 This means that if you run a review session to completion, there will be no
  57 need to review again for a week, and the review command will simply do nothing
  58 until then.
  59
  60 The one week review cycle is defined by the '_reviewed' custom report, which
  61 can be modified if you prefer a monthly review cycle.
  62
  63 If 'N' is provided, the session is limited to reviewing only N tasks.
  64
  65 Note: requires Taskwarrior 2.5.0 or later.
  66 For full details, see:
  67 <https://taskwarrior.org/docs/review.html>
  68
  69 .SH USAGE
  70 Here is an example tasksh session.
  71
  72 $ tasksh
  73 .br
  74 task> projects
  75 .br
  76
  77 .br
  78 Project Tasks Pri:None Pri:L Pri:M Pri:H
  79 .br
  80 ------- ----- -------- ----- ----- -----
  81 .br
  82             7        7     0     0     0
  83 .br
  84 home        2        2     0     0     0
  85 .br
  86 party       6        3     0     0     3
  87 .br
  88
  89 .br
  90 3 projects (15 tasks)
  91 .br
  92 task> tags
  93 .br
  94
  95 .br
  96 Tag  Count
  97 .br
  98 mall     2
  99 .br
 100
 101 .br
 102 1 tag (15 tasks)
 103 .br
 104 task> list
 105 .br
 106
 107 .br
 108 ID Project Pri Due        Active Age   Description
 109 .br
 110 ---------------------------------------------------------------------
 111 .br
 112  2 party   H   10/17/2015        2 hrs Select and book a venue
 113 .br
 114  5 party   H   10/22/2015        2 hrs Design invitations
 115 .br
 116  9 home        10/31/2015         1 hr Pay rent
 117 .br
 118  3 party                         2 hrs Mail invitations
 119 .br
 120  4 party                         2 hrs Select a caterer
 121 .br
 122  6 party                         2 hrs Print invitations
 123 .br
 124
 125 .br
 126  8 tasks
 127 .br
 128  task> quit
 129 .br
 130  $
 131 .br
 132
 133 .SH CONFIGURATION
 134 Tasksh piggybacks on Taskwarrior's .taskrc configuration file, and refers
 135 to settings there. If you use a non-standard location for your .task database
 136 , and .taskrc file, Tasksh will not find them unless you set the TASKDATA and
 137 TASKRC environment variables. See 'man taskrc' for more details.
 138
 139 The review command storeѕ a UDA ('reviewed') and report definition ('_reviewed').
 140
 141 .TP
 142 .B tasksh.autoclear=1
 143 If set to "1", causes each tasksh command to be preceded by a 'clear screen' and
 144 cursor reset. Default is "0".
 145
 146 .SH "CREDITS & COPYRIGHTS"
 147 Copyright (C) 2006 \- 2017 P. Beckingham, F. Hernandez.
 148
 149 This man page was originally written by Federico Hernandez.
 150
 151 Tasksh is distributed under the MIT license. See
 152 http://www.opensource.org/licenses/mit-license.php for more information.
 153
 154 .SH SEE ALSO
 155 .BR task(1),
 156
 157 For more information regarding tasksh, see the following:
 158
 159 .TP
 160 The official site at
 161 <http://taskwarrior.org/tools>
 162
 163 .TP
 164 The official code repository at
 165 <https://git.tasktools.org/scm/ex/tasksh.git>
 166
 167 .TP
 168 You can contact the project by emailing
 169 <support@tasktools.org>
 170
 171 .SH REPORTING BUGS
 172 .TP
 173 Bugs in tasksh may be reported to the issue-tracker at
 174 <http://bug.tasktools.org>
 175