vitrc.5 3.97 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
.TH vitrc 5 "" "" "User Manuals"

.SH NAME
vitrc \- Configuration file for the vit(1) command

.SH SYNOPSIS
.B $HOME/.vitrc

.SH DESCRIPTION
.B VIT
obtains its configuration data from a file called
.I .vitrc
\&. This file must be located in the user's home directory.

Except for comments (lines starting with "#"), currently the only acceptable
16 17 18 19 20 21 22 23 24
commands in .vitrc are
.B map
commands and
.B set
commands.

.SS MAP COMMANDS
.B map
commands take the form
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

.RS
map <KEY>=<KEY-SEQUENCE>
.RE

where:
.RS
.TP
<KEY>
should represent a key or combination of keys, such as "a" or a <KEY-CODE> as
listed below.

.P
and
.P
<KEY-SEQUENCE>
is a sequence of <KEY>s to emulate. The result should be the same as if these
keys were pressed manually by the user.

<KEY-CODE>s are strings that represent keys. The following may be used:
.br
Function keys: <F1> <F2> <F3> <F4> <F5> <F6> <F7> <F8> <F9> <F10> <F11> <F12>

Navigation keys: <Home> <End> <PageUp> <PageDown> <Up> <Down> <Right> <Left>

Editing keys: <Insert> <Del> <Backspace> <Space> <Tab> <Return>

Modifier combinations: \\ca for Ctrl + "a" combination.

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
.SS SET COMMANDS
.B set
commands take the form

.RS
set <VAR NAME>=<VAR VAL>
.RE

where valid variable names (<VAR NAME>) and their acceptable values (<VAR VAL>)
are listed below. Note that the default value is listed immediately after the
variable name.

.TP
.B burndown=no
When set to "yes", VIT will display the time until convergence in the upper
left corner. It is set to "no" by default because it requires extra time to
obtain (from running 'task burndown' in the background. This variable was
essentially set to "yes" for VIT versions 1.2 and below.

.TP
.B confirmation=yes
When set to "yes" (default), VIT will ask for confirmation before marking a task as
done, deleting a task, or quitting VIT. Set to "no" to disable the prompts.

.TP
.B wait=yes
When set to "no", VIT will not show output of the task command after
modifications to a task are made.  By default, VIT will show the output of the
task command and wait for enter.

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
.SH EXAMPLES
.SS EXTERNAL COMMANDS
Note that for many of the examples, you need to have the appropriate extension
installed and in your PATH. Recall that after :! a 'w' means that VIT should
"wait". This allows another command to take over (e.g. Vim when you're editing
a task) and for you to see the output of a command. After :! a 'r' means that
VIT should reread your list of tasks. This should be used when your external
command changes the task data.

.TP
.B map \\\\cn=:!wr tasknote %TASKID<Return>
When Ctrl + n is pressed, runs the command 'tasknote <ID>', where <ID> is the
ID of the task that is currently selected in VIT.

.TP
99
.B map c=:! task %TASKID rc.defaultwidth:200 | grep -o -P -m 1 "(ftp|http)s?://\\\\S*" | tr -d '\n' | xsel -b<Return>
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
Copies the first link it finds to the clipboard.

.TP
.B map Z=:!rw echo "Changing due date\n"; task %TASKID modify due:$(read -p "How many days? " DAYS; echo $DAYS)days<Return>
Asks you for input and then changes the due date of the selected task to NOW plus that many days.

.TP
.B map <Left>=:!wr task $(task _get %TASKID.parent) edit<Return>
When the left arrow key is pressed, edits the parent of a recurring task
(do not use on non-recurring task).

.SS INTERNAL COMMANDS
.TP
.B map Q=
Disables whatever the Q key is bound to internally in VIT, which is a quick quit.


.SH "CREDITS & COPYRIGHTS"
.PP
Copyright (C) 2012 - 2013, Steve Rader
.br
121
Copyright (C) 2013 - 2018, Scott Kostyshak
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139


VIT is distributed under GNU General Public License version 3 or (at your
option) any later version. See
http://www.gnu.org/licenses/ for more information.

.SH SEE ALSO
.BR vit(1)
.BR taskrc(1)

For more information regarding VIT, see the following:

.TP
The official site at
<http://tasktools.org/projects/vit.html>

.TP
The official code repository at
140
<https://git.tasktools.org/EX/vit.git>
141 142 143 144 145 146 147 148 149 150

.TP
You can contact the project by emailing
<support@taskwarrior.org>

.SH REPORTING BUGS
.TP
Bugs in VIT may be reported to the issue-tracker at
<http://taskwarrior.org>