Wyrd v1.4 User ManualPaul J. PelzlApril 28, 2007 |
Wyrd is a text-based front-end to Remind, a sophisticated calendar and alarm program available from Roaring Penguin Software, Inc. Wyrd serves two purposes:
Wyrd also requires only a fraction of the resources of most calendar programs available today.
This section describes how to install Wyrd by compiling from source. Volunteers have pre-packaged Wyrd for several popular operating systems, so you may be able to save yourself some time by installing from those packages. Please check the Wyrd website for up-to-date package information.
Wyrd is designed to be portable to most Unix-like operating systems, including GNU/Linux, *BSD, and Mac OS X. Before installing Wyrd, your system must have the following software installed:
Wyrd may be compiled by executing the following at the root of the source tree:
./configure make
After compiling, become root and execute
make install
to complete the installation process. The make command here should correspond to GNU make; on some systems (particularly *BSD), you may need to use gmake.
If your ncurses library was built with wide character support, Wyrd can be configured to render UTF-8 encoded reminders. To enable this option, use the command
./configure --enable-utf8
when configuring the sources.
This section describes how to use Wyrd in its default configuration. After familiarizing yourself with the basic operations as outlined in this section, you may wish to consult Section 4 to see how Wyrd can be configured to better fit your needs.
Before attemping to use Wyrd, learn how to use Remind. Wyrd makes no attempt to hide the details of Remind programming from the user. Aside from reading the Remind manpage, you may get some useful pointers by reading Mike Harris's article on 43 folders or David Skoll's writeup on Linux Journal. The 43 Folders Wiki also has a nice section on Remind.
You can launch Wyrd using the default reminder file by executing wyrd. If desired, a different reminder file may be selected by executing wyrd <filename>.
At the top of the window is a short (incomplete) list of keybindings.
The left window displays a scrollable timetable view, with reminders highlighted in various colors. If the DURATION specifier is used for a reminder, the highlighted area is rendered with an appropriate size. Overlapping reminders are rendered using one of four different indentation levels so that all reminders are at least partially visible. If the current time is visible in this window, it is highlighted in red.
The upper right window displays a month calendar, with the color of each day representing the number of reminders it contains. The colors range across shades of white to blue to magenta as the number of reminders increases. The selected date is highlighted in cyan; if the current date is visible, it is highlighted in red.
The lower right window displays a list of the untimed reminders falling on the selected date.
The bottom window displays the full text of the MSG for the reminder or reminders that are currently selected.
| Action | Keypress |
| scroll up and down the schedule | <up>, <down> or k, j |
| jump back or forward by a day | <pageup>, <pagedown> or 4, 6 or <, > or H, L |
| jump back or forward by a week | 8, 2 or [, ] or K, J |
| jump back or forward by a month | {, } |
| jump to current date and time | <home> |
| jump to the next reminder | <tab> |
| switch between schedule and untimed reminders window | <left>, <right> or h, l |
| zoom in on the schedule | z |
| scroll the description window up and down | d, D |
Notice that if you have a numeric keypad, the {4, 6, 8, 2} keys will let you move directionally in the month calendar view at the upper-right of the screen. Similarly, {H, J, K, L} will cause directional calendar movement using the standard mapping from vi(1).
In addition to the hotkeys provided above, Wyrd lets you jump immediately to a desired date by pressing 'g', entering in a date specifier, and then pressing <return>. Any of the following date specifiers may be used:
(The date specifier format may be changed to DDMMYYYY; consult Section 4.2. )
Note: By default, Wyrd is configured to modify your reminder files using the text editor specified by the $EDITOR environment variable. (This configuration has been tested successfully with a number of common settings for $EDITOR, including 'vim', 'emacs', and 'nano'.) If you wish to use a different editor, see Section 4.
If you select a timeslot in the schedule view, then hit 't', you will begin creating a new timed reminder. Wyrd will open up your reminder file in your favorite editor and move the cursor to the end of the file, where a new reminder template has been created. The template has the selected date and time filled in, so in many cases you will only need to fill in a MSG value.
Similarly, hitting 'u' will begin creating an untimed reminder. 'w' will create a weekly timed reminder, and 'W' will create a weekly untimed reminder; 'm' will create a monthly timed reminder, and 'M' will create a monthly untimed reminder.
'T' and 'U' also create timed and untimed reminders (respectively), but first will provide a selection dialog for you to choose which reminder file you want to add this reminder to. The set of reminder files is determined by scanning the INCLUDE lines in your default reminder file.
If you select a reminder (either timed or untimed) and hit <return>, you will begin editing that reminder. Wyrd will open up the appropriate reminders file in your editor and move the cursor to the corresponding REM line.
If you select a timeslot that contains multiple overlapping reminders, Wyrd will provide a dialog that allows you to select the desired reminder.
If you hit <enter> on a blank timeslot, Wyrd will begin creating a new timed or untimed reminder (depending on whether the timed or the untimed window is selected).
Finally, pressing 'e' will open the reminder file in your editor without attempting to select any particular reminder.
Wyrd offers an additional mode for entering simple reminders quickly. Press 'q', and you will be prompted for an event description. Simply enter a description for the event using natural language, then press <return>. Examples:
If your event description can be understood, Wyrd will immediately create the reminder and scroll the display to its location.
Currently the quick reminder mode tends to favor USA English conventions, as generalizing the natural language parser would require some work.
Wyrd also allows you to use the "quick reminder" syntax to create new reminders from the command line, using the -a or –add options. For example,
wyrd --add "dinner with neighbors tomorrow at 7pm"
would create a new reminder for tomorrow evening. When used in this mode, Wyrd exits silently with error code 0 if the reminder was successfully created. If the reminder could not be created (e.g. if the reminder syntax could not be parsed), Wyrd prints an error message and exits with a nonzero error code.
Reminders can be easily duplicated or rescheduled through the use of Wyrd's cutting and pasting features.
Selecting a reminder and pressing 'X' will cut that reminder: the corrdsponding REM line is deleted from your reminders file, and the reminder is copied to Wyrd's clipboard. To copy a reminder without deleting it, use 'y' instead.
To paste a reminder from the clipboard back into your schedule, just move the cursor to the desired date/time and press 'p'. Wyrd will append a new REM line to the end of your reminders file, and open the file with your editor. The REM line will be configured to trigger on the selected date. If the copied reminder was timed, then the pasted reminder will be set to trigger at the selected time using the original DURATION setting. (Additional Remind settings such as delta and tdelta are not preserved by copy-and-paste.)
If you wish to paste a reminder into a non-default reminders file, use 'P'. This will spawn a selection dialog where you can choose the file that will hold the new reminder.
WARNING: Cutting a reminder will delete only the single REM command responsible for triggering it. If you are using more complicated Remind scripting techniques to generate a particular reminder, then the cut operation may not do what you want.
Aside from viewing reminders as they fall in the schedule, you can press 'r' to view all reminders triggered on the selected date in a less(1) window. Similarly, 'R' will view all reminders triggered on or after the selected date (all non-expired reminders are triggered).
If you want to get a more global view of your schedule, Wyrd will also let you view Remind's formatted calendar output in a less(1) window. Pressing 'c' will view a one-week calendar that contains the selected date, while pressing 'C' will view a one-month calendar containing the selected date.
Wyrd allows you to search for reminders with MSG values that match a search string. Press '/' to start entering a (case insensitive) regular expression. After the expression has been entered, press <return> and Wyrd will locate the next reminder that matches the regexp. Press 'n' to repeat the same search. Entry of a search string may be cancelled with <esc>.
The regular expression syntax is Emacs-compatible.
Note: Sorry, there is no "search backward" function. The search function requires the use of "remind -n", which operates only forward in time. For the same reason, there is a command to jump forward to the next reminder, but no command to jump backward to the previous reminder.
A list of all keybindings may be viewed by pressing '?'. You can exit Wyrd by pressing 'Q'. If the screen is corrupted for some reason, hit 'Ctrl-L' to refresh the display.
You may wish to generate some sort of alarm when a reminder is triggered. Wyrd does not offer any special alarm functionality, because Remind can handle the job already. Check the Remind manpage and consider how the -k option could be used to generate alarms with the aid of external programs. For example, the following command will generate a popup window using gxmessage(1) whenever a timed reminder is triggered:
remind -z -k'gxmessage -title "reminder" %s &' ~/.reminders &
(A sensible way to start this alarm command is to place it in ~.xinitrc so that it launches when the X server is started.) If you want some advance warning (say, 15 minutes), you can cause Remind to trigger early by setting a tdelta in the AT clause:
REM Nov 27 2005 AT 14:30 +15 MSG Do something
Alternatively, if you want to generate alarms only for specific reminders, consider using Remind's RUN command. This process could be easily automated by using the templateN configuration variables described in Section 4.
Remind's TAG specifier may be used to cause Wyrd to give special treatment to certain reminders. If a reminder line includes the clause "TAG noweight", then Wyrd will not give that reminder any weight when determining the “busy level” colorations applied to the month calendar. If a reminder line includes the clause "TAG nodisplay", then Wyrd will neither display that reminder nor give it any weight when determining the month calendar colorations. The tag parameters are case insensitive.
WARNING: These tag parameters are not guaranteed to interact well with other Remind front-ends such as tkremind.
Wyrd reads a run-configuration textfile (generally /etc/wyrdrc or /usr/local/etc/wyrdrc) to determine key bindings, color schemes, and many other settings. You can create a personalized configuration file in $HOME/.wyrdrc, and select settings that match your usage patterns. The recommended procedure is to “include” the wyrdrc file provided with Wyrd (see Section 4.1.1), and add or remove settings as desired.
You may notice that the wyrdrc syntax is similar to the syntax used in the configuration file for the Mutt email client (muttrc).
Within the wyrdrc file, strings should be enclosed in double quotes ("). A double quote character inside a string may be represented by \" . The backslash character must be represented by doubling it (\\).
Syntax: include filename_string
This syntax can be used to include one run-configuration file within another.
This command could be used to load the default wyrdrc file (probably
found in /etc/wyrdrc or /usr/local/etc/wyrdrc) within your
personalized rcfile,
~/.wyrdrc.
The filename string should be enclosed in quotes.
Syntax: set variable=value_string
A number of configuration variables can be set using this syntax; check
Section 4.2
to see a list. The variables are unquoted, but the values should be quoted strings.
Syntax: bind key_identifier operation
This command will bind a keypress to execute a calendar operation.
The various operations, which should not be enclosed in quotes,
may be found in
Section 4.3.
Key identifiers may be specified by strings that represent a single keypress,
for example "m" (quotes included). The key may be prefixed with
"\\C" or "\\M"
to represent Control or Meta (Alt) modifiers, respectively; note that the
backslash must be doubled. A number of special keys lack single-character
representations, so the following strings may be used to represent them:
Due to differences between various terminal emulators, this key identifier syntax may not be adequate to describe every keypress. As a workaround, Wyrd will also accept key identifiers in octal notation. As an example, you could use \024 (do not enclose it in quotes) to represent Ctrl-T.
Multiple keys may be bound to the same operation, if desired.
Syntax: unbind key_identifier
This command will remove all bindings associated with the key identifier. The
key identifiers should be defined using the syntax described in the previous
section.
Syntax: color object foreground background
This command will apply the specified foreground and background colors to the
appropriate object. A list of colorable objects is provided in
Section 4.4.
Wyrd will recognize the following color keywords: black, red, green, yellow,
blue, magenta, cyan, white, default. The default keyword allows you to
choose the default foreground or background colors. If you use
default for your background color, this will access the transparent
background on terminal emulators which support it.
The following configuration variables may be set as described in Section 4.1.2:
For maximum usefulness, busy_level1 < busy_level2 < busy_level3 < busy_level4.
Every Wyrd operation can be made available to the interface using the syntax described in Section 4.1.3. The following is a list of every available operation.
Each of Wyrd's on-screen elements may be colored by the color scheme of your choice, using the syntax defined in Section 4.1.5. The following is a list of all colorable objects.
set timed_template="REM %monname% %mday% %year% <++>AT %hour%:%min%<++> DURATION 1:00<++> MSG %\"<++>%\" %b"
set untimed_template="REM %monname% %mday% %year% <++>MSG %\"<++>%\" %b"
With this change, hitting Ctrl-J inside Vim (in insert mode) will cause your cursor to jump directly to the <++> markers, enabling you to quickly add any desired Remind delta and message parameters.
Wyrd is Free Software; you can redistribute it and/or modify it under the terms of the GNU General Public License (GPL), Version 2, as published by the Free Software Foundation. You should have received a copy of the GPL along with this program, in the file 'COPYING'.
Thanks, of course, to David Skoll for writing such a powerful reminder system. Thanks also to Nicolas George, who wrote the OCaml curses bindings used within Wyrd.
Wyrd author: Paul Pelzl <pelzlpj@eecs.umich.edu>
Wyrd website: http://www.eecs.umich.edu/~pelzlpj/wyrd
Feel free to contact me if you have bugs, feature requests, patches, etc. I would also welcome volunteers interested in packaging Wyrd for various platforms.
Wyrd is developed with the aid of the excellent
Bazaar VCS. Interested developers are advised to track Wyrd development via my public
repository:
http://www.eecs.umich.edu/~pelzlpj/wyrd/bzr-repo/
Primary development may be found on branch wyrd-1.4-dev .
“Wyrd is a concept in ancient Anglo-saxon and Nordic cultures roughly corresponding to fate.” – Wikipedia
This document was translated from LATEX by HEVEA.