1WYRDRC(5) configuration file for the Wyrd calendar application WYRDRC(5)
2
6 wyrdrc is the configuration textfile for the wyrd(1) console calendar
7 application.
8
10 CAUTION: while this manpage should be suitable as a quick reference, it
11 may be subject to miscellaneous shortcomings in typesetting. The defin‐
12 itive documentation is the user manual provided with Wyrd in PDF for‐
13 mat.
14 Wyrd reads a run-configuration textfile (generally /etc/wyrdrc or
16 /usr/local/etc/wyrdrc) to determine key bindings, color schemes, and
17 many other settings. You can create a personalized configuration file
18 in $HOME/.wyrdrc, and select settings that match your usage patterns.
19 The recommended procedure is to ``include'' the wyrdrc file provided
20 with Wyrd (see INCLUDING OTHER RCFILES), and add or remove settings as
21 desired.
22
24 You may notice that the wyrdrc syntax is similar to the syntax used in
25 the configuration file for the Mutt email client (muttrc).
26 Within the wyrdrc file, strings should be enclosed in double quotes
28 ("). A double quote character inside a string may be represented by \"
29 . The backslash character must be represented by doubling it (\\).
30 INCLUDING OTHER RCFILES
32 Syntax: include filename_string
33 This syntax can be used to include one run-configuration file within
34 another. This command could be used to load the default wyrdrc file
35 (probably found in /etc/wyrdrc or /usr/local/etc/wyrdrc) within your
36 personalized rcfile, ~/.wyrdrc . The filename string should be
37 enclosed in quotes.
38 SETTING CONFIGURATION VARIABLES
40 Syntax: set variable=value_string
41 A number of configuration variables can be set using this syntax; check
42 the CONFIGURATION VARIABLES description to see a list. The variables
43 are unquoted, but the values should be quoted strings.
44 CREATING KEY BINDINGS
46 Syntax: bind key_identifier operation
47 This command will bind a keypress to execute a calendar operation. The
48 various operations, which should not be enclosed in quotes, may be
49 found in the section on CALENDAR OPERATIONS. Key identifiers may be
50 specified by strings that represent a single keypress, for example "m"
51 (quotes included). The key may be prefixed with "\\C" or "\\M" to rep‐
52 resent Control or Meta (Alt) modifiers, respectively; note that the
53 backslash must be doubled. A number of special keys lack single-charac‐
54 ter representations, so the following strings may be used to represent
55 them:
56 * "<esc>"
58 * "<tab>"
60 * "<enter>"
62 * "<return>"
64 * "<insert>"
66 * "<home>"
68 * "<end>"
70 * "<pageup>"
72 * "<pagedown>"
74 * "<space>"
76 * "<left>"
78 * "<right>"
80 * "<up>"
82 * "<down>"
84 * "<f1>" to "<f12>"
86 Due to differences between various terminal emulators, this key identi‐
88 fier syntax may not be adequate to describe every keypress. As a work‐
89 around, Wyrd will also accept key identifiers in octal notation. As an
90 example, you could use \024 (do not enclose it in quotes) to represent
91 Ctrl-T.
92 Multiple keys may be bound to the same operation, if desired.
94 REMOVING KEY BINDINGS
96 Syntax: unbind key_identifier
97 This command will remove all bindings associated with the key identi‐
98 fier. The key identifiers should be defined using the syntax described
99 in the previous section.
100 SETTING THE COLOR SCHEME
102 Syntax: color object foreground background
103 This command will apply the specified foreground and background colors
104 to the appropriate object. A list of colorable objects is provided in
105 the section on COLORABLE OBJECTS. Wyrd will recognize the following
106 color keywords: black, red, green, yellow, blue, magenta, cyan, white,
107 default. The default keyword allows you to choose the default fore‐
108 ground or background colors. If you use default for your background
109 color, this will access the transparent background on terminal emula‐
110 tors which support it.
111
113 The following configuration variables may be set as described in the
114 SETTING CONFIGURATION VARIABLES section.
115 * remind_command
117 Determines the command used to execute Remind.
118 * reminders_file
120 Controls which Remind file (or Remind directory) Wyrd will oper‐
121 ate on. The default is ~/.reminders .
122 * edit_old_command
124 Controls the command used to edit a pre-existing reminder. The
125 special strings '%file%' and '%line%' will be replaced with a
126 filename to edit and a line number to navigate to within that
127 file.
128 * edit_new_command
130 Controls the command used to edit a new reminder. The special
131 character '%file%' will be replaced with a filename to edit.
132 Ideally, this command should move the cursor to the last line of
133 the file, where the new reminder template is created.
134 * edit_any_command
136 Controls the command used for editing a reminder file without
137 selecting any particular reminder. The special character
138 '%file%' will be replaced with a filename to edit.
139 * timed_template
141 Controls the format of the REM line created when editing a new
142 timed reminder. The following string substitutions will be made:
143 '%monname%' - month name, '%mon%' - month number, '%mday%' - day
144 of the month, '%year%' - year, '%hour%' - hour, '%min%' -
145 minute, '%wdayname%' - weekday name, '%wday%' - weekday number.
146 * untimed_template
148 Controls the format of the REM line created when editing a new
149 untimed reminder. The substitution syntax is the same as for
150 timed_template.
151 * templateN
153 Controls the format of a generic user-defined REM line template;
154 N may range from 0 to 9. The substitution syntax is the same as
155 for timed_template.
156 * busy_algorithm
158 An integer value specifying which algorithm to use for measuring
159 how busy the user is on a particular day. If busy_algorithm="1",
160 then Wyrd will simply count the total number of reminders trig‐
161 gered on that day. If busy_algorithm="2", then Wyrd will count
162 the number of hours of reminders that fall on that day. (Untimed
163 reminders are assumed to occupy untimed_duration minutes.)
164 * untimed_duration
166 An integer value that specifies the assumed duration of an
167 untimed reminder, in minutes. This is used only when computing
168 the busy level with busy_algorithm="2".
169 * busy_level1
171 An integer value specifying the maximum number of reminders in a
172 day (with busy_algorithm="1") or maximum hours of reminders in a
173 day (with busy_algorithm="2") which will be colored using the
174 color scheme for calendar_level1.
175 * busy_level2
177 Same as above, using the calendar_level2 color scheme.
178 * busy_level3
180 Same as above, using the calendar_level2 color scheme rendered
181 in bold.
182 * busy_level4
184 Same as above, using the calendar_level3 color scheme. Any day
185 with more reminders than this will be rendered using the calen‐
186 dar_level3 color scheme rendered in bold.
187 * week_starts_monday
189 A boolean value ("true" or "false") that determines the first
190 day of the week.
191 * schedule_12_hour
193 A boolean value that determines whether the timed reminders win‐
194 dow is drawn using 12- or 24-hour time.
195 * selection_12_hour
197 A boolean value that determines whether the selection informa‐
198 tion is drawn with 12- or 24-hour time.
199 * status_12_hour
201 A boolean value that determines whether the current time is
202 drawn using a 12- or 24-hour clock.
203 * description_12_hour
205 A boolean value that determines whether reminder start and end
206 times are drawn using 12- or 24-hour time in the description
207 window. This value also controls the format of timestamps in the
208 formatted calendars produced by view_week and view_month.
209 * center_cursor
211 A boolean value that determines how the screen and cursor move
212 during scrolling operations. When set to "true", the cursor is
213 fixed in the center of the timed reminders window, and the
214 schedule scrolls around it. When set to "false" (the default),
215 the cursor will move up and down the schedule during scrolling
216 operations.
217 * goto_big_endian
219 A boolean value that determines how the the goto operation will
220 parse dates. When set to "true", date specifiers should be in
221 ISO 8601 (YYYYMMDD) format. When set to "false", date specifiers
222 should be in European style DDMMYYYY format.
223 * quick_date_US
225 A boolean value that determines how the quick_add operation will
226 parse numeric dates with slashes, e.g. 6/1 (or 6/1/2006). When
227 set to "true", the first number is a month and the second is the
228 day of the month (June 1). When set to "false", these meanings
229 of these two fields are switched (January 6).
230 * number_weeks
232 A boolean value that determines whether or not weeks should be
233 numbered within the month calendar window. Weeks are numbered
234 according to the ISO 8601 standard. The ISO standard week begins
235 on Monday, so to avoid confusion it is recommended that
236 week_starts_monday be set to "true" when week numbering is
237 enabled.
238 * home_sticky
240 A boolean value that determines whether or not the cursor should
241 "stick" to the "home" position. When this option is set to
242 "true", then after pressing the <home> key the cursor will auto‐
243 matically follow the current date and time. The effect is can‐
244 celled by pressing any of the navigation keys.
245 * untimed_window_width
247 An integer value that determines the target width of the
248 month-calendar window and the untimed reminders window. The
249 allowable range is 34 to ($COLUMNS - 40) characters, and Wyrd
250 will silently disregard any setting outside this range.
251 * advance_warning
253 A boolean value that determines whether or not Wyrd should dis‐
254 play advance warning of reminders. When set to "true", Wyrd will
255 invoke Remind in a mode that generates advance warning of
256 reminders as specified in the reminder file.
257 * untimed_bold
259 A boolean value that determines whether or not Wyrd should ren‐
260 der untimed reminders using a bold font.
261 For maximum usefulness, busy_level1 < busy_level2 < busy_level3 <
263 busy_level4.
264
266 Every Wyrd operation can be made available to the interface using the
267 syntax described in the section on CREATING KEY BINDINGS. The follow‐
268 ing is a list of every available operation.
269 * scroll_up
271 move the cursor up one element
272 * scroll_down
274 move the cursor down one element
275 * next_day
277 jump ahead one day
278 * previous_day
280 jump backward one day
281 * next_week
283 jump ahead one week
284 * previous_week
286 jump backward one week
287 * next_month
289 jump ahead one month
290 * previous_month
292 jump backward one month
293 * home
295 jump to the current date and time
296 * goto
298 begin entering a date specifier to jump to
299 * zoom
301 zoom in on the day schedule view (this operation is cyclic)
302 * edit
304 edit the selected reminder
305 * edit_any
307 edit a reminder file, without selecting any particular reminder
308 * scroll_description_up
310 scroll the description window contents up (when possible)
311 * scroll_description_down
313 scroll the description window contents down (when possible)
314 * quick_add
316 add a ``quick reminder''
317 * new_timed
319 create a new timed reminder
320 * new_timed_dialog
322 same as previous, with a reminder file selection dialog
323 * new_untimed
325 create a new untimed reminder
326 * new_untimed_dialog
328 same as previous, with a reminder file selection dialog
329 * new_templateN
331 create a new user-defined reminder using templateN, where N may
332 range from 0 to 9
333 * new_templateN_dialog
335 same as previous, with a reminder file selection dialog
336 * copy
338 copy a reminder to Wyrd's clipboard
339 * cut
341 delete a reminder and copy it to Wyrd's clipboard
342 * paste
344 paste a reminder from Wyrd's clipboard into the schedule
345 * paste_dialog
347 same as previous, with a reminder file selection dialog
348 * switch_window
350 switch between the day schedule window on the left, and the
351 untimed reminder window on the right
352 * begin_search
354 begin entering a search string
355 * search_next
357 search for the next occurrence of the search string
358 * next_reminder
360 jump to the next reminder
361 * view_remind
363 view the output of remind for the selected date
364 * view_remind_all
366 view the output of remind for the selected date, triggering all
367 non-expired reminders
368 * view_week
370 view Remind's formatted calendar for the week that contains the
371 selected date (the in-calendar timestamp formats are determined
372 by the value of description_12_hour)
373 * view_month
375 view Remind's formatted calendar for the month that contains the
376 selected date (the in-calendar timestamp formats are determined
377 by the value of description_12_hour)
378 * refresh
380 refresh the display
381 * quit
383 exit Wyrd
384 * entry_complete
386 signal completion of search string entry or date specifier
387 * entry_backspace
389 delete the last character of the search string or date specifier
390 * entry_cancel
392 cancel entry of a search string or date specifier
393
395 Each of Wyrd's on-screen elements may be colored by the color scheme of
396 your choice, using the syntax defined in the section on SETTING THE
397 COLOR SCHEME. The following is a list of all colorable objects.
398 * help
400 the help bar at the top of the screen
401 * timed_default
403 an empty timeslot in the day-schedule window
404 * timed_current
406 the current time in the day-schedule window (if it is visible)
407 * timed_reminder1
409 a nonempty timeslot in the day-schedule window, indented to
410 level 1
411 * timed_reminder2
413 a nonempty timeslot in the day-schedule window, indented to
414 level 2
415 * timed_reminder3
417 a nonempty timeslot in the day-schedule window, indented to
418 level 3
419 * timed_reminder4
421 a nonempty timeslot in the day-schedule window, indented to
422 level 4
423 * untimed_reminder
425 an entry in the untimed reminders window
426 * timed_date
428 the vertical date strip at the left side of the screen
429 * selection_info
431 the line providing date/time for the current selection
432 * description
434 the reminder description window
435 * status
437 the bottom bar providing current date and time
438 * calendar_labels
440 the month and weekday labels in the calendar window
441 * calendar_level1
443 calendar days with low activity
444 * calendar_level2
446 calendar days with medium activity
447 * calendar_level3
449 calendar days with high activity
450 * calendar_today
452 the current day in the calendar window (if it is visible)
453 * left_divider
455 the vertical line to the left of the timed reminders window
456 * right_divider
458 the vertical and horizontal lines to the right of the timed
459 reminders window
460
462 Wyrd author: Paul Pelzl <pelzlpj@gmail.com>
463 Wyrd website: http://pessimization.com/software/wyrd
464 Wyrd project page (bug reports, code repository, etc.): http://launch‐
465 pad.net/wyrd
466
468 ``Wyrd is a concept in ancient Anglo-saxon and Nordic cultures roughly
469 corresponding to fate or personal destiny.'' -- Wikipedia
470
472 wyrd(1), remind(1)
473
475 This manpage is written by Paul J. Pelzl <pelzlpj@gmail.com>.
476configuration file for the Wyrd c2a3leOncdtaorbearpp2l0i1c0ation WYRDRC(5)