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

NAME

6       taskopenrc - Configuration file for the taskopen(1) command
7
8

SYNOPSIS

10       ~/.taskopenrc
11       taskopen -c /path/to/taskopenrc
12
13

DESCRIPTION

15       taskopen   obtains   its   configuration   data   from  a  file  called
16       ~/.taskopenrc in the user's home directory.
17
18       Each line in the taskopenrc file is either an assignment, a comment  or
19       empty.
20
21       An  assignment consists of a variable name and a value separated by the
22       equal sign ("="):
23
24              <variable name>=<value>
25
26       where the variable name is one of the names below.
27
28       A hash mark ("#") can be used to mark the beginning of a comment line.
29
30

CONFIGURATION VARIABLES

32       Valid variable names and their default values are:
33
34
35   General configuration
36       BROWSER=xdg-open$FILE&>/dev/null
37              The executable which will be used to open URIs.
38
39
40       EDITOR=vim
41              Your preferred editor.
42
43
44       FILE_CMD=xdg-open
45              Command to be used for opening non-text files.
46
47
48       TASKBIN=task
49              The path to your taskwarrior binary.
50
51
52       PATH_EXT=/usr/share/taskopen/scripts
53              The given path(s) will be prepended to taskopen's PATH variable.
54              The default value depends on the installation path.
55
56
57       DEBUG=0
58              Set  this to '1' if you want to enable additional debugging out‐
59              put.
60
61
62   Notes files
63       NOTES_FOLDER=$HOME/tasknotes/
64              The directory in which the Notes files will be stored.
65
66
67       NOTES_EXT=.txt
68              The file extension used for Notes files.
69
70
71       NOTES_FILE
72              This sets the actual path of the Notes files. The string  "UUID"
73              will  be  replaced  with  the task's UUID. If not set, the value
74              will  be  assembled  by  taking  NOTES_FOLDER   and   NOTES_EXT:
75              ${NOTES_FOLDER}UUID${NOTES_EXT}
76
77
78       NOTES_CMD
79              Sets  the command that will be executed to open a Notes file. If
80              not set, the value  will  be  assembled  by  taking  EDITOR  and
81              NOTES_FILE: ${EDITOR} "${NOTES_FILE}".
82
83
84       NOTES_REGEX=Notes
85              The  regular expression which identifies an annotation as a link
86              to the Notes file.
87
88
89   Default arguments
90       DEFAULT_FILTER=status.is:pending
91              The default taskwarrior filter  that  will  be  applied  to  all
92              queries. Can be deactivated by using the -a or -A switches.
93
94
95       DEFAULT_SORT
96              Specify  the  default  sorting which may be overridden by the -s
97              option.
98
99
100       DEFAULT-i=ls -la
101              Default command for the -i parameter which allows using -i with‐
102              out an argument.
103
104
105       DEFAULT-x
106              Default command for the -x parameter which allows using -x with‐
107              out an argument.
108
109
110   Classification
111       BROWSER_REGEX=www|http
112              The regular expression which identifies annotations openable  by
113              BROWSER.
114
115
116       FILE_REGEX="\.|\/|~"
117              The regular expression that identifies file paths in annotations
118              which will be opened by EDITOR or xdg-open.
119
120
121       TEXT_REGEX
122              This regular  expression  identifies  annotations  that  can  be
123              edited  in  raw mode (see '-r'). If set and no other regular ex‐
124              pression matches the annotation, the EDITOR will be  invoked  to
125              edit the annotation.
126
127
128       CUSTOM1_REGEX
129              The  regular  expression that identifies annotations openable by
130              CUSTOM1_CMD.
131
132
133       CUSTOM1_CMD
134              The command with which annotations matching  CUSTOM1_REGEX  will
135              be  opened.  You  may  use  the following environment variables:
136              $FILE, $UUID, $ID, $LABEL, $ANNOTATION and $LAST_MATCH.  By  De‐
137              fault,  the  value of $FILE will be appended to the command. See
138              taskopen(1) for further details.
139
140
141       CUSTOM[0-9]+_REGEX
142              see CUSTOM1_REGEX
143
144
145       CUSTOM[0-9]+_CMD
146              see CUSTOM1_CMD
147
148
149
150       NO_ANNOTATION_HOOK
151              Execute an arbitrary script if there is no annotation found. The
152              corresponding  taskwarrior IDs will be passed as arguments, e.g.
153              "attach.sh 21 42"
154
155
156       TASK_ATTRIBUTES
157              Add arbitrary taskwarrior attributes (comma separated)  as  sort
158              keys  and environment variables for use within user commands. In
159              order to prevent name conflicts, the corresponding sort keys are
160              preceded  by  "task_"  (e.g.  "task_project"). Environment vari‐
161              ables are additionally in upper case (e.g. TASK_PROJECT).
162
163

EXAMPLES

165   Using different file extensions for Notes files
166       NOTES_REGEX="Notes.(.*)"
167       NOTES_CMD="editnote   /path/to/tasknotes/$UUID.$LAST_MATCH   "$TASK_DE‐
168       SCRIPTION" $UUID"
169       NO_ANNOTATION_HOOK=addnote
170       TASK_ATTRIBUTES=description
171
172
173   Using the notes.vim plugin for Notes files
174       NOTES_FOLDER=$HOME/Notes/vimnotes
175       NOTES_EXT=""
176       NOTES_CMD="vim -c ":Note $UUID""
177
178
179              The   notes.vim   plugin   can   be  found  at  <http://peterod
180              ding.com/code/vim/notes/>
181
182
183   Link to mutt emails
184       CUSTOM1_REGEX=Message-[iI][dD]:|message:
185       CUSTOM1_CMD="echo "$FILE" | muttjump"
186
187
188              Thanks to Jostein Berntsen, the old bash version of taskopen had
189              support  for  linking to your emails by using mutt. This feature
190              can still be enabled  by  setting  the  CUSTOM1_REGEX  and  CUS‐
191              TOM1_CMD  appropriately, given that taskopen's PATH contains the
192              path to the corresponding helper scripts (see PATH_EXT).
193
194              Taskopen then uses muttjump to open the mutt mailboxes  natively
195              or  in  a screen window (very quick and effective). The muttjump
196              can be found at <https://github.com/weisslj/muttjump>
197
198
199   Integrating user-defined attributes (UDAs)
200       TASK_ATTRIBUTES=url,costs
201       CUSTOM1_REGEX=URL
202       CUSTOM1_CMD="xdg-open $TASK_URL"
203       DEFAULT_SORT="task_costs-,id+"
204
205
206              You can make taskopen agnostic to any taskwarrior attributes  by
207              adding  them  to TASK_ATTRIBUTES.  This enables the use of these
208              attributes within user commands (see taskopen (1))  or  as  sort
209              keys.
210
211

CREDITS & COPYRIGHTS

213       Copyright (C) 2010 - 2020, J. Schlatow
214
215       Taskopen  is  distributed  under  the  GNU  General Public License. See
216       http://www.opensource.org/licenses/gpl-2.0.php for more information.
217
218

SEE ALSO

220       taskopen(1)
221
222       For more information regarding taskopen, see the following:
223
224
225       The official site at
226              <https://github.com/ValiValpas/taskopen/>
227
228
229       The official code repository at
230              <git://github.com/ValiValpas/taskopen.git>
231
232

REPORTING BUGS

234       Bugs in taskopen may be reported to the issue-tracker at
235              <https://github.com/ValiValpas/taskopen/issues>
236
237
238
239taskopen v1.1.5                   2020-02-04                     taskopenrc(5)
Impressum