1WYRD(1) a console calendar application WYRD(1)
2
6 wyrd is a text-based front-end to remind(1), a sophisticated calendar
7 and alarm program.
8
10 wyrd [OPTIONS] [FILE]
11
13 Open the calendar and display reminders defined in FILE (and any
14 included reminder files). The default reminder file is ~/.reminders.
15 (The FILE may also be a directory containing files with a .rem exten‐
16 sion.)
17
19 --version
20 Display version information and exit.
21 --help
23 Display usage information.
24 --add EVENT
26 Add given event to reminders file and exit.
27 --a EVENT
29 Add given event to reminders file and exit.
30
32 CAUTION: while this manpage should be suitable as a quick reference, it
33 may be subject to miscellaneous shortcomings in typesetting. The defin‐
34 itive documentation is the user manual provided with Wyrd in PDF or
35 HTML format.
36 This section describes how to use Wyrd in its default configuration.
38 After familiarizing yourself with the basic operations as outlined in
39 this section, you may wish to consult the wyrdrc(5) manpage to see how
40 Wyrd can be configured to better fit your needs.
41 OVERVIEW
43 Before attemping to use Wyrd, learn how to use Remind. Wyrd makes no
44 attempt to hide the details of Remind programming from the user.
45 At the top of the window is a short (incomplete) list of keybindings.
47 The left window displays a scrollable timetable view, with reminders
49 highlighted in various colors. If the DURATION specifier is used for a
50 reminder, the highlighted area is rendered with an appropriate size.
51 Overlapping reminders are rendered using one of four different indenta‐
52 tion levels so that all reminders are at least partially visible. If
53 the current time is visible in this window, it is highlighted in red.
54 The upper right window displays a month calendar, with the color of
56 each day representing the number of reminders it contains. The colors
57 range across shades of white to blue to magenta as the number of
58 reminders increases. The selected date is highlighted in cyan; if the
59 current date is visible, it is highlighted in red.
60 The lower right window displays a list of the untimed reminders falling
62 on the selected date.
63 The bottom window displays the full text of the MSG for the reminder or
65 reminders that are currently selected.
66 NAVIGATION
68 ────────────────────────────────────────────────────────────────────────────────────────────────────────
69 Action Keypress
70 ────────────────────────────────────────────────────────────────────────────────────────────────────────
71 scroll up and down the schedule <up>, <down> or k, j
72 jump back or forward by a day <pageup>, <pagedown> or 4, 6 or <, > or H, L
73 jump back or forward by a week 8, 2 or [, ] or K, J
74 jump back or forward by a month {, }
75 jump to current date and time <home>
76 jump to the next reminder <tab>
77 switch between schedule and untimed reminders window <left>, <right> or h, l
78 zoom in on the schedule z
79 scroll the description window up and down d, D
80 ────────────────────────────────────────────────────────────────────────────────────────────────────────
81 Notice that if you have a numeric keypad, the {4, 6, 8, 2} keys will
83 let you move directionally in the month calendar view at the
84 upper-right of the screen. Similarly, {H, J, K, L} will cause direc‐
85 tional calendar movement using the standard mapping from vi(1).
86 In addition to the hotkeys provided above, Wyrd lets you jump immedi‐
88 ately to a desired date by pressing 'g', entering in a date specifier,
89 and then pressing <return>. Any of the following date specifiers may be
90 used:
91 * 8 digits representing year, month, and day: YYYYMMDD
93 * 4 digits representing month and day (of current year): MMDD
95 * 2 digits representing day (of current month and year): DD
97 (The date specifier format may be changed to DDMMYYYY; consult the sec‐
99 tion on CONFIGURATION VARIABLES. )
100 EDITING REMINDERS
102 Note: By default, Wyrd is configured to modify your reminder files
103 using the text editor specified by the $EDITOR environment variable.
104 (This configuration has been tested successfully with a number of com‐
105 mon settings for $EDITOR, including 'vim', 'emacs', and 'nano'.) If you
106 wish to use a different editor, see the wyrdrc(5) manpage.
107 If you select a timeslot in the schedule view, then hit 't', you will
109 begin creating a new timed reminder. Wyrd will open up your reminder
110 file in your favorite editor and move the cursor to the end of the
111 file, where a new reminder template has been created. The template has
112 the selected date and time filled in, so in many cases you will only
113 need to fill in a MSG value.
114 Similarly, hitting 'u' will begin creating an untimed reminder. 'w'
116 will create a weekly timed reminder, and 'W' will create a weekly
117 untimed reminder; 'm' will create a monthly timed reminder, and 'M'
118 will create a monthly untimed reminder.
119 'T' and 'U' also create timed and untimed reminders (respectively), but
121 first will provide a selection dialog for you to choose which reminder
122 file you want to add this reminder to. The set of reminder files is
123 determined by scanning the INCLUDE lines in your default reminder file.
124 (If you use a reminder directory, then all *.rem files in that direc‐
125 tory will be available along with all INCLUDEd files.)
126 If you select a reminder (either timed or untimed) and hit <return>,
128 you will begin editing that reminder. Wyrd will open up the appropriate
129 reminders file in your editor and move the cursor to the corresponding
130 REM line.
131 If you select a timeslot that contains multiple overlapping reminders,
133 Wyrd will provide a dialog that allows you to select the desired
134 reminder.
135 If you hit <enter> on a blank timeslot, Wyrd will begin creating a new
137 timed or untimed reminder (depending on whether the timed or the
138 untimed window is selected).
139 Finally, pressing 'e' will open the reminder file in your editor with‐
141 out attempting to select any particular reminder.
142 QUICK REMINDERS
144 Wyrd offers an additional mode for entering simple reminders quickly.
145 Press 'q', and you will be prompted for an event description. Simply
146 enter a description for the event using natural language, then press
147 <return>. Examples:
148 * meeting with Bob tomorrow at 11
150 * drop off package at 3pm
152 * wednesday 10am-11:30 go grocery shopping
154 * Board game night 20:15 next Fri
156 * 7/4 independence day
158 * 7/4/2007 independence day (next year)
160 * independence day (next year) on 2007-07-04
162 If your event description can be understood, Wyrd will immediately cre‐
164 ate the reminder and scroll the display to its location.
165 Currently the quick reminder mode tends to favor USA English conven‐
167 tions, as generalizing the natural language parser would require some
168 work.
169 Wyrd also allows you to use the "quick reminder" syntax to create new
171 reminders from the command line, using the -a or --add options. For
172 example,
173 wyrd --add "dinner with neighbors tomorrow at 7pm"
174 would create a new reminder for tomorrow evening. When used in this
176 mode, Wyrd exits silently with error code 0 if the reminder was suc‐
177 cessfully created. If the reminder could not be created (e.g. if the
178 reminder syntax could not be parsed), Wyrd prints an error message and
179 exits with a nonzero error code.
180 CUTTING AND PASTING REMINDERS
182 Reminders can be easily duplicated or rescheduled through the use of
183 Wyrd's cutting and pasting features.
184 Selecting a reminder and pressing 'X' will cut that reminder: the cor‐
186 rdsponding REM line is deleted from your reminders file, and the
187 reminder is copied to Wyrd's clipboard. To copy a reminder without
188 deleting it, use 'y' instead.
189 To paste a reminder from the clipboard back into your schedule, just
191 move the cursor to the desired date/time and press 'p'. Wyrd will
192 append a new REM line to the end of your reminders file, and open the
193 file with your editor. The REM line will be configured to trigger on
194 the selected date. If the copied reminder was timed, then the pasted
195 reminder will be set to trigger at the selected time using the original
196 DURATION setting. (Additional Remind settings such as delta and tdelta
197 are not preserved by copy-and-paste.)
198 If you wish to paste a reminder into a non-default reminders file, use
200 'P'. This will spawn a selection dialog where you can choose the file
201 that will hold the new reminder.
202 WARNING: Cutting a reminder will delete only the single REM command
204 responsible for triggering it. If you are using more complicated Remind
205 scripting techniques to generate a particular reminder, then the cut
206 operation may not do what you want.
207 VIEWING REMINDERS
209 Aside from viewing reminders as they fall in the schedule, you can
210 press 'r' to view all reminders triggered on the selected date in a
211 less(1) window. Similarly, 'R' will view all reminders triggered on or
212 after the selected date (all non-expired reminders are triggered).
213 If you want to get a more global view of your schedule, Wyrd will also
215 let you view Remind's formatted calendar output in a less(1) window.
216 Pressing 'c' will view a one-week calendar that contains the selected
217 date, while pressing 'C' will view a one-month calendar containing the
218 selected date.
219 SEARCHING FOR REMINDERS
221 Wyrd allows you to search for reminders with MSG values that match a
222 search string. Press '/' to start entering a (case insensitive) regular
223 expression. After the expression has been entered, press <return> and
224 Wyrd will locate the next reminder that matches the regexp. Press 'n'
225 to repeat the same search. Entry of a search string may be cancelled
226 with <esc>.
227 The regular expression syntax is Emacs-compatible.
229 Note: Sorry, there is no "search backward" function. The search func‐
231 tion requires the use of "remind -n", which operates only forward in
232 time. For the same reason, there is a command to jump forward to the
233 next reminder, but no command to jump backward to the previous
234 reminder.
235 OTHER COMMANDS
237 A list of all keybindings may be viewed by pressing '?'. You can exit
238 Wyrd by pressing 'Q'. If the screen is corrupted for some reason, hit
239 'Ctrl-L' to refresh the display.
240 ALARM STRATEGIES
242 You may wish to generate some sort of alarm when a reminder is trig‐
243 gered. Wyrd does not offer any special alarm functionality, because
244 Remind can handle the job already. Check the Remind manpage and con‐
245 sider how the -k option could be used to generate alarms with the aid
246 of external programs. For example, the following command will generate
247 a popup window using gxmessage(1) whenever a timed reminder is trig‐
248 gered:
249 remind -z -k'gxmessage -title "reminder" &' ~/.reminders &
250 (A sensible way to start this alarm command is to place it in
252 {.xinitrc} so that it launches when the X server is started.) If you
253 want some advance warning (say, 15 minutes), you can cause Remind to
254 trigger early by setting a tdelta in the AT clause:
255 REM Nov 27 2005 AT 14:30 +15 MSG Do something
256 Alternatively, if you want to generate alarms only for specific
259 reminders, consider using Remind's RUN command. This process could be
260 easily automated by using the templateN configuration variables
261 described in the wyrdrc(5) manpage.
262 MISCELLANEOUS
264 Remind's TAG specifier may be used to cause Wyrd to give special treat‐
265 ment to certain reminders. If a reminder line includes the clause "TAG
266 noweight", then Wyrd will not give that reminder any weight when deter‐
267 mining the ``busy level'' colorations applied to the month calendar. If
268 a reminder line includes the clause "TAG nodisplay", then Wyrd will
269 neither display that reminder nor give it any weight when determining
270 the month calendar colorations. The tag parameters are case insensi‐
271 tive.
272 WARNING: These tag parameters are not guaranteed to interact well with
274 other Remind front-ends such as tkremind.
275
277 * Wyrd fills in sensible defaults for the fields of a REM state‐
278 ment, but you will inevitably need to make some small edits to
279 achieve the behavior you want. If you use Vim, you can make your
280 life easier by installing the Vim-Latex Suite and then modifying
281 your ~/.wyrdrc to use REM templates like this:
282 set timed_template="REM %monname% %mday% %year% <++>AT %hour%:%min%<++>
284 DURATION 1:00<++> MSG %\"<++>%\" %b"
285 set untimed_template="REM %monname% %mday% %year% <++>MSG %\"<++>%\"
286 %b"
287 With this change, hitting Ctrl-J inside Vim (in insert mode) will cause
289 your cursor to jump directly to the <++> markers, enabling you to
290 quickly add any desired Remind delta and message parameters.
291
293 Wyrd is Free Software; you can redistribute it and/or modify it under
294 the terms of the GNU General Public License (GPL), Version 2, as pub‐
295 lished by the Free Software Foundation. You should have received a copy
296 of the GPL along with this program, in the file 'COPYING'.
297
299 Thanks, of course, to David Skoll for writing such a powerful reminder
300 system. Thanks also to Nicolas George, who wrote the OCaml curses
301 bindings used within Wyrd.
302
304 Wyrd author: Paul Pelzl <pelzlpj@gmail.com>
305 Wyrd website: http://pessimization.com/software/wyrd
306 Wyrd project page (bug reports, code repository, etc.): http://launch‐
307 pad.net/wyrd
308
310 ``Wyrd is a concept in ancient Anglo-saxon and Nordic cultures roughly
311 corresponding to fate or personal destiny.'' -- Wikipedia
312
314 wyrdrc(5), remind(1)
315a console calendar application 23 October 2010 WYRD(1)