1vitrc(5)                         User Manuals                         vitrc(5)
2
3
4

NAME

6       vitrc - Configuration file for the vit(1) command
7
8

SYNOPSIS

10       $HOME/.vitrc
11
12

DESCRIPTION

14       VIT  obtains  its  configuration  data from a file called .vitrc . This
15       file must be located in the user's home directory.
16
17       Except for comments (lines  starting  with  "#"),  currently  the  only
18       acceptable commands in .vitrc are map commands and set commands.
19
20
21   MAP COMMANDS
22       map commands take the form
23
24              map <KEY>=<KEY-SEQUENCE>
25
26       where:
27
28              <KEY>  should  represent  a  key or combination of keys, such as
29                     "a" or a <KEY-CODE> as listed below.
30
31
32              and
33
34              <KEY-SEQUENCE> is a sequence of <KEY>s to  emulate.  The  result
35              should be the same as if these keys were pressed manually by the
36              user.
37
38              <KEY-CODE>s are strings that represent keys. The  following  may
39              be used:
40              Function  keys:  <F1>  <F2>  <F3>  <F4> <F5> <F6> <F7> <F8> <F9>
41              <F10> <F11> <F12>
42
43              Navigation keys: <Home> <End> <PageUp>  <PageDown>  <Up>  <Down>
44              <Right> <Left>
45
46              Editing keys: <Insert> <Del> <Backspace> <Space> <Tab> <Return>
47
48              Modifier combinations: \ca for Ctrl + "a" combination.
49
50
51   SET COMMANDS
52       set commands take the form
53
54              set <VAR NAME>=<VAR VAL>
55
56       where  valid  variable  names  (<VAR NAME>) and their acceptable values
57       (<VAR VAL>) are listed below. Note that the  default  value  is  listed
58       immediately after the variable name.
59
60
61       burndown=no
62              When  set  to "yes", VIT will display the time until convergence
63              in the upper left corner. It is set to "no" by  default  because
64              it  requires  extra time to obtain (from running 'task burndown'
65              in the background. This variable was essentially  set  to  "yes"
66              for VIT versions 1.2 and below.
67
68
69       confirmation=yes
70              When  set  to  "yes"  (default),  VIT  will ask for confirmation
71              before marking a task as done, deleting a task, or quitting VIT.
72              Set to "no" to disable the prompts.
73
74
75       wait=yes
76              When  set  to "no", VIT will not show output of the task command
77              after modifications to a task are made.  By  default,  VIT  will
78              show the output of the task command and wait for enter.
79
80

EXAMPLES

82   EXTERNAL COMMANDS
83       Note  that  for  many of the examples, you need to have the appropriate
84       extension installed and in your PATH. Recall that after :! a 'w'  means
85       that  VIT should "wait". This allows another command to take over (e.g.
86       Vim when you're editing a task) and for you to see the output of a com‐
87       mand.  After  :! a 'r' means that VIT should reread your list of tasks.
88       This should be used when your external command changes the task data.
89
90
91       map \cn=:!wr tasknote %TASKID<Return>
92              When Ctrl + n is pressed,  runs  the  command  'tasknote  <ID>',
93              where  <ID>  is the ID of the task that is currently selected in
94              VIT.
95
96
97       map  c=:!  task  %TASKID  rc.defaultwidth:200  |  grep  -o  -P   -m   1
98       (ftp|http)s?://\S* | tr -d '0 | xsel -b<Return>
99              Copies the first link it finds to the clipboard.
100
101
102       map  Z=:!rw  echo Changing due date0; task %TASKID modify due:$(read -p
103       How many days?  DAYS; echo $DAYS)days<Return>
104              Asks you for input and then changes the due date of the selected
105              task to NOW plus that many days.
106
107
108       map <Left>=:!wr task $(task _get %TASKID.parent) edit<Return>
109              When the left arrow key is pressed, edits the parent of a recur‐
110              ring task (do not use on non-recurring task).
111
112
113   INTERNAL COMMANDS
114       map Q= Disables whatever the Q key is bound to internally in VIT, which
115              is a quick quit.
116
117
118

CREDITS & COPYRIGHTS

120       Copyright (C) 2012 - 2013, Steve Rader
121       Copyright (C) 2013 - 2018, Scott Kostyshak
122
123
124       VIT  is  distributed  under GNU General Public License version 3 or (at
125       your option) any later version.  See  http://www.gnu.org/licenses/  for
126       more information.
127
128

SEE ALSO

130       vit(1) taskrc(1)
131
132       For more information regarding VIT, see the following:
133
134
135       The official site at
136              <http://tasktools.org/projects/vit.html>
137
138
139       The official code repository at
140              <https://git.tasktools.org/EX/vit.git>
141
142
143       You can contact the project by emailing
144              <support@taskwarrior.org>
145
146

REPORTING BUGS

148       Bugs in VIT may be reported to the issue-tracker at
149              <http://taskwarrior.org>
150
151
152
153
154                                                                      vitrc(5)
Impressum