--- name: "wyrdrc" section: "5" platform: "linux" package: "wyrd" version: "1.7.4-1+b1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/wyrdrc" --- # wyrdrc(5) the configuration textfile for the wyrd(1) console calendar application. ## Name wyrdrc - the configuration textfile for the [wyrd(1)](/wyrd/1.md) console calendar application. ## Synopsis **Wyrd Configuration File** 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 *Including Other Rcfiles*), and add or remove settings as desired. ``` ``` ## Documentation ``` 1 wyrdrc Syntax ``` 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 ( \\\\ ). ``` 2 Including Other Rcfiles ``` 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. ``` 3 Setting Configuration Variables ``` Syntax: set variable=value\_string A number of configuration variables can be set using this syntax; check the *Configuration Variables* description to see a list. The variables are unquoted, but the values should be quoted strings. ``` 4 Creating Key Bindings ``` 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 the section on *Calendar Operations*. 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: • "\"\ • "\"\ • "\"\ • "\"\ • "\"\ • "\"\ • "\"\ • "\"\ • "\"\ • "\"\ • "\"\ • "\"\ • "\"\ • "\"\ • "\" to "\" 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. ``` 5 Removing Key Bindings ``` 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. ``` 6 Setting the Color Scheme ``` 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 the section on *Colorable Objects*. 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. ``` 7 Configuration Variables ``` The following configuration variables may be set as described in the *Setting Configuration Variables* section: • remind\_command Determines the command used to execute Remind.\ • reminders\_file Controls which Remind file (or Remind directory) Wyrd will operate on. The default is ~/.reminders .\ • edit\_old\_command Controls the command used to edit a pre-existing reminder. The special strings '%file%' and '%line%' will be replaced with a filename to edit and a line number to navigate to within that file.\ • edit\_new\_command Controls the command used to edit a new reminder. The special character '%file%' will be replaced with a filename to edit. Ideally, this command should move the cursor to the last line of the file, where the new reminder template is created.\ • edit\_any\_command Controls the command used for editing a reminder file without selecting any particular reminder. The special character '%file%' will be replaced with a filename to edit.\ • pager\_command Controls the command used for viewing keybindings ('?'), calendar, and reminders {c, C, r, R}. Set this to "less -c" if you want [less(1)](/less/1.md) to repaint the screen by clearing it instead of scrolling.\ • default\_zoom Controls the default zoom level that Wyrd starts up with. This setting accepts an integer value of: • 0 for Hourly time increments\ • 1 for Half-Hourly time increments\ • 2 for Quarter-Hourly time increments. Any integer other than these 3 is invalid and will cause an error.\ • timed\_template Controls the format of the REM line created when editing a new timed reminder. The following string substitutions will be made: • '%monname%' - month name\ • '%mon%' - month number (1-12)\ • '%0mon%' - month number (01-12)\ • '%mday%' - day of the month (1-31)\ • '%0mday%' - day of the month (01-31)\ • '%year%' - year\ • '%hour%' - hour\ • '%min%' - minute\ • '%wdayname%' - weekday name\ • '%wday%' - weekday number.\ • untimed\_template Controls the format of the REM line created when editing a new untimed reminder. The substitution syntax is the same as for timed\_template.\ • templateN Controls the format of a generic user-defined REM line template; N may range from 0 to 9. The substitution syntax is the same as for timed\_template.\ • busy\_algorithm An integer value specifying which algorithm to use for measuring how busy the user is on a particular day. If busy\_algorithm="1", then Wyrd will simply count the total number of reminders triggered on that day. If busy\_algorithm="2", then Wyrd will count the number of hours of reminders that fall on that day. (Untimed reminders are assumed to occupy untimed\_duration minutes.)\ • untimed\_duration An integer value that specifies the assumed duration of an untimed reminder, in minutes. This is used only when computing the busy level with busy\_algorithm="2".\ • busy\_level1 An integer value specifying the maximum number of reminders in a day (with busy\_algorithm="1") or maximum hours of reminders in a day (with busy\_algorithm="2") which will be colored using the color scheme for calendar\_level1.\ • busy\_level2 Same as above, using the calendar\_level2 color scheme.\ • busy\_level3 Same as above, using the calendar\_level2 color scheme rendered in bold.\ • busy\_level4 Same as above, using the calendar\_level3 color scheme. Any day with more reminders than this will be rendered using the calendar\_level3 color scheme rendered in bold.\ • week\_starts\_monday A boolean value ("true" or "false") that determines the first day of the week.\ • schedule\_12\_hour A boolean value that determines whether the timed reminders window is drawn using 12- or 24-hour time.\ • selection\_12\_hour A boolean value that determines whether the selection information is drawn with 12- or 24-hour time.\ • status\_12\_hour A boolean value that determines whether the current time is drawn using a 12- or 24-hour clock.\ • description\_12\_hour A boolean value that determines whether reminder start and end times are drawn using 12- or 24-hour time in the description window. This value also controls the format of timestamps in the formatted calendars produced by view\_week and view\_month.\ • center\_cursor A boolean value that determines how the screen and cursor move during scrolling operations. When set to "true", the cursor is fixed in the center of the timed reminders window, and the schedule scrolls around it. When set to "false" (the default), the cursor will move up and down the schedule during scrolling operations.\ • goto\_big\_endian A boolean value that determines how the goto operation will parse dates. When set to "true", date specifiers should be in ISO 8601 (YYYYMMDD) format. When set to "false", date specifiers should be in European style DDMMYYYY format.\ • quick\_date\_US A boolean value that determines how the quick\_add operation will parse numeric dates with slashes, e.g. 6/1 (or 6/1/2006). When set to "true", the first number is a month and the second is the day of the month (June 1). When set to "false", these meanings of these two fields are switched (January 6).\ • number\_weeks A boolean value that determines whether or not weeks should be numbered within the month calendar window. Weeks are numbered according to the ISO 8601 standard. The ISO standard week begins on Monday, so to avoid confusion it is recommended that week\_starts\_monday be set to "true" when week numbering is enabled.\ • home\_sticky A boolean value that determines whether or not the cursor should "stick" to the "home" position. When this option is set to "true", then after pressing the \ key the cursor will automatically follow the current date and time. The effect is cancelled by pressing any of the navigation keys.\ • advance\_warning A boolean value that determines whether or not Wyrd should display advance warning of reminders. When set to "true", Wyrd will invoke Remind in a mode that generates advance warning of reminders as specified in the reminder file.\ • untimed\_window\_width An integer value that determines the target width of the month-calendar window and the untimed reminders window. The allowable range is 34 to ($COLUMNS - 40) characters, and Wyrd will silently disregard any setting outside this range.\ • untimed\_bold A boolean value that determines whether or not Wyrd should render untimed reminders using a bold font.\ • reminder\_colors Render reminders in color (auto/true/false) needs ccc support in termcap: tput ccc && echo supported auto will fallback to default colors. For maximum usefulness, busy\_level1 \< busy\_level2 \< busy\_level3 \< busy\_level4. ``` 8 Calendar Operations ``` Every Wyrd operation can be made available to the interface using the syntax described in the section on *Creating Key Bindings*. The following is a list of every available operation. • scroll\_up move the cursor up one element\ • scroll\_down move the cursor down one element\ • next\_day jump ahead one day\ • previous\_day jump backward one day\ • next\_week jump ahead one week\ • previous\_week jump backward one week\ • next\_month jump ahead one month\ • previous\_month jump backward one month\ • home jump to the current date and time\ • goto begin entering a date specifier to jump to\ • zoom zoom in on the day schedule view (this operation is cyclic)\ • edit edit the selected reminder\ • edit\_any edit a reminder file, without selecting any particular reminder\ • scroll\_description\_up scroll the description window contents up (when possible)\ • scroll\_description\_down scroll the description window contents down (when possible)\ • quick\_add add a "quick reminder"\ • new\_timed create a new timed reminder\ • new\_timed\_dialog same as previous, with a reminder file selection dialog\ • new\_untimed create a new untimed reminder\ • new\_untimed\_dialog same as previous, with a reminder file selection dialog\ • new\_templateN create a new user-defined reminder using templateN, where N may range from 0 to 9\ • new\_templateN\_dialog same as previous, with a reminder file selection dialog\ • copy copy a reminder to Wyrd's clipboard\ • cut delete a reminder and copy it to Wyrd's clipboard\ • paste paste a reminder from Wyrd's clipboard into the schedule\ • paste\_dialog same as previous, with a reminder file selection dialog\ • switch\_window switch between the day schedule window on the left, and the untimed reminder window on the right\ • begin\_search begin entering a search string\ • search\_next search for the next occurrence of the search string\ • next\_reminder jump to the next reminder (The next\_reminder operation locates reminders at the point they occur; if advance\_warning is enabled, next\_reminder will skip over any displayed warnings of an event.)\ • view\_remind view the output of remind for the selected date\ • view\_remind\_all view the output of remind for the selected date, triggering all non-expired reminders\ • view\_week view Remind's formatted calendar for the week that contains the selected date (the in-calendar timestamp formats are determined by the value of description\_12\_hour)\ • view\_month view Remind's formatted calendar for the month that contains the selected date (the in-calendar timestamp formats are determined by the value of description\_12\_hour)\ • refresh refresh the display\ • quit exit Wyrd\ • entry\_complete signal completion of search string entry or date specifier\ • entry\_backspace delete the last character of the search string or date specifier\ • entry\_cancel cancel entry of a search string or date specifier ``` 9 Colorable Objects ``` Each of Wyrd's on-screen elements may be colored by the color scheme of your choice, using the syntax defined in the section on *Setting the Color Scheme*. The following is a list of all colorable objects. • help the help bar at the top of the screen\ • timed\_default an empty timeslot in the day-schedule window\ • timed\_current the current time in the day-schedule window (if it is visible)\ • timed\_reminder1 a nonempty timeslot in the day-schedule window, indented to level 1\ • timed\_reminder2 a nonempty timeslot in the day-schedule window, indented to level 2\ • timed\_reminder3 a nonempty timeslot in the day-schedule window, indented to level 3\ • timed\_reminder4 a nonempty timeslot in the day-schedule window, indented to level 4\ • untimed\_reminder an entry in the untimed reminders window\ • timed\_date the vertical date strip at the left side of the screen\ • selection\_info the line providing date/time for the current selection\ • description the reminder description window\ • status the bottom bar providing current date and time\ • calendar\_labels the month and weekday labels in the calendar window\ • calendar\_level1 calendar days with low activity\ • calendar\_level2 calendar days with medium activity\ • calendar\_level3 calendar days with high activity\ • calendar\_today the current day in the calendar window (if it is visible)\ • left\_divider the vertical line to the left of the timed reminders window\ • right\_divider the vertical and horizontal lines to the right of the timed reminders window ``` See Also ``` [wyrd(1)](/wyrd/1.md), [wyrd(7)](/wyrd/7.md), [remind(1)](/remind/1.md) ``` Author ``` This manpage is written by Paul J. Pelzl \. ``` ```