wyrdrc man page

wyrdrc is the configuration textfile for the wyrd(1) console calendar application.

Introduction

CAUTION: while this manpage should be suitable as a quick reference, it may  be subject to miscellaneous shortcomings in typesetting. The definitive  documentation is the user manual provided with Wyrd in PDF format.

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.

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  (\\).

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.

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.

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:

  • "<esc>"
  • "<tab>"
  • "<enter>"
  • "<return>"
  • "<insert>"
  • "<home>"
  • "<end>"
  • "<pageup>"
  • "<pagedown>"
  • "<space>"
  • "<left>"
  • "<right>"
  • "<up>"
  • "<down>"
  • "<f1>" to "<f12>"

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.

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.

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.

Configuration Variables

The following configuration variables may be set as described in the SETTING  Configuration Variables section.

For maximum usefulness, busy_level1 < busy_level2 <  busy_level3 < busy_level4.

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.

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.

Contact Info

Wyrd author: Paul Pelzl <pelzlpj@gmail.com>
Wyrd website: http://pessimization.com/software/wyrd
Wyrd project page (bug reports, code repository, etc.): http://launchpad.net/wyrd

Miscellaneous

“Wyrd is a concept in ancient Anglo-saxon and Nordic cultures roughly  corresponding to fate or personal destiny.” -- Wikipedia

See Also

wyrd(1), remind(1)

Author

This manpage is written by Paul J. Pelzl <pelzlpj@gmail.com>.

Referenced By

wyrd(1).

23 October 2010 configuration file for the Wyrd calendar application