| TKREMIND(1) | VERSION 04.02.03 | TKREMIND(1) |
tkremind - graphical front-end to Remind calendar program
tkremind [options] [read_file] [write_file] [config_file]
TkRemind is a graphical front-end to the Remind program. It provides a friendly graphical interface which allows you to view your calendar and add reminders without learning the syntax of Remind. Although not all of Remind's features are available with TkRemind, TkRemind gives you an opportunity to edit the reminder commands which it creates. This allows you to learn Remind's syntax and then add extra features as you become a more sophisticated Remind programmer.
TkRemind is written in Tcl, and requires version 8.5 (or higher) as well as the tcllib extension. It also requires a wish binary. If you are using Tcl/Tk 8.5, you may also need either the Img or the tkpng extension to handle PNG images.
TkRemind itself has no command-line options. However, it passes certain options on to Remind. The options it passes are -b, -g, -x, -i and -m. See the Remind man page for details about the options. Note that TkRemind will respect the -m and -b1 options and adjust its appearance accordingly.
Read_file is the file from which TkRemind reads reminders. It is in standard Remind format. Write_file is the file to which TkRemind writes reminders which you add using the GUI. If Read_file is omitted, it defaults to $HOME/.reminders. If Write_file is omitted, it defaults to Read_file.
You may wish to have a different Write_file from Read_file if you want to collect all of TkRemind's reminders in one place. Suppose your main file is $HOME/.reminders and you want TkRemind to put its reminders in $HOME/.tkreminders. In $HOME/.reminders, include the line:
INCLUDE [getenv("HOME")]/.tkreminders
Config_file is the file in which TkRemind stores its options. If it is omitted, it defaults to $HOME/.config/tkremindrc.
If $HOME/.reminders is a directory, then TkRemind defaults to reading $HOME/.reminders and writing new reminders to $HOME/.reminders/100-tkremind.rem. If you want to keep your reminders in a directory $HOME/.reminders, you should create that directory before starting TkRemind.
When you start TkRemind, it displays a calendar for the current month, with today's date highlighted. Reminders are filled into each box on the calendar. If a box contains many reminders, you can scroll it up and down by dragging mouse button 2 in the box. Note that there is no specific indication of an over-full box; you'll just have to notice that the box appears completely full.
To change to the previous or next month, click the <- or -> button, respectively. You can also use the left/right arrow keys or PageUp/PageDown to navigate.
To change back to the current month, click Today or press the Home key. To go to a specific month, click Go To Date.... This pops up a dialog box which allows you to select a month and enter a year. Once you've done this, click Go to go to the date, or Cancel to cancel.
To exit TkRemind, click Quit.
To add a reminder, click button 1 in any day number in the calendar. The Add Reminder... dialog will pop up, with values preselected for the day you clicked.
The dialog has six basic groups of controls. The first three lines select one of three types of reminders. Choose the type of reminder with the radio buttons, and choose the values of the days, months, and years by selecting values from pull-down menus. The pull-down menus appear when you click the raised value buttons.
The next control specifies an expiry date for the reminder. Select the check button to enable an expiry date, and fill in the values using pull-down menus.
The third control specifies how much advance notice you want (if any), and whether or not weekends and holidays are counted when computing advance notice.
The fourth control specifies which days Remind considers as part of the weekend. This can affect the interpretation of "weekday" in the second and third types of reminders.
The fifth control associates a time with the reminder. You can also specify advance notice, possibly repeating.
The sixth control specifies what Remind should do if a reminder falls on a holiday or weekend.
Enter the body of the reminder into the Body: text entry.
To add the reminder to the reminder file, click Add to reminder file. To close the dialog without adding the reminder to the file, click Cancel. To preview the reminder, click Preview reminder. This pops up the Preview reminder dialog box.
The Preview reminder dialog box is an excellent way to learn Remind. It displays the Remind command which realizes the reminder you entered using the Add Reminder... dialog. You can edit the reminder, thereby gaining access to advanced features of Remind. You can also use it simply to play around and discover Remind's idioms for expressing different types of reminders.
To print the current month's calendar, click Print... on the main calendar window. This brings up the print dialog. Printing either produces a PostScript file or sends PostScript to a UNIX command. (If you have rem2pdf installed, you can choose to produce PDF output rather than PostScript.)
Select the print destination by choosing either To file: or To command: in the print dialog. Press Browse... to bring up a file browser. In the file browser, you can enter a filename in the text entry, double-click on a filename in the listbox, or double-click on a directory to navigate the file system. You can also type the first few characters of a file name in the text entry box and press space to complete the name to the first matching entry.
The Match: box contains a filename wildcard which filters files in the listbox. You can change the filter and press enter to rescan the directory.
Select the appropriate paper size and orientation. Activate Fill page if you want the calendar to fill the page. This should be the normal case unless you have many reminders in a particular day. (See the Rem2PS or rem2pdf documentation.)
Finally, click Print to print or Cancel to cancel. Note that during printing, Remind is called with the -itkremind=1 option and also an additional -itkprint=1 option. If you are producing PDF output, then the option -itkpdf=1 is also supplied to Remind.
If you created a reminder with TkRemind, it will turn red as the mouse cursor passes over it in the calendar window. Click button-1 over the reminder and you will be presented with a dialog window whose state is identical to the one used to create the reminder. At this point, you can change the reminder by editing the dialog entries and selecting Replace reminder. You can delete the reminder entirely by selecting Delete reminder. The remaining buttons, Preview reminder and Cancel operate identically to the dialog in "ADDING REMINDERS."
Note that if you edit a reminder (using Preview reminder), any edits you made are not retained in the dialog box. You should not attempt to edit such reminders; you have to retype them in the Preview reminder dialog.
If the reminder was not created with TkRemind, you can't edit it with TkRemind.
If you have set the "text editor" option correctly, right-clicking on a reminder will bring up a text editor on the file containing the reminder. The cursor will be positioned on the line that generated the reminder. In addition, if you have a reminder that is editable with an editor but was not created using TkRemind, it will be underlined when you move the cursor over it, and you can edit it in a text editor by either left- or right-clicking on the reminder.
If there are any errors in your reminder file, the "Queue..." button changes to "Errors...". Click on "Errors..." to see the Remind error output. Click "OK" to close the error window; this makes the button in the main TkRemind window to revert to "Queue..."
If you create "timed" reminders, TkRemind will queue them in the background and pop up boxes as they are triggered. Additionally, if you created the reminder using TkRemind, you will be given the option of "turning off" the reminder for the rest of the day. TkRemind achieves queueing of background reminders by running Remind in server mode, described later.
The final button on the calendar window, Options, lets you configure certain aspects of TkRemind. The configuration options are:
Once you've configured the options the way you like them, press Apply Options to put them into effect, Save Options to put them into effect and save them in $HOME/.config/tkremindrc, or Cancel to cancel any changes you made.
TkRemind's main window includes the following keyboard shortcuts:
If you are running TkRemind on Linux and have the inotifywait program installed (part of the inotify-tools or similar package), then TkRemind redraws the calendar window immediately if $HOME/.reminders changes (or, if it is a directory, any files in that directory change.)
This lets TkRemind react immediately to hand-edited reminders or to reminder files that are imported from another calendar system (for example, you may have a cron job that periodically imports your Google Calendar entries into Remind format.)
TkRemind performs some basic consistency checks when you add or preview a reminder. However, if you edit a reminder in the previewer, TkRemind does not check the edited reminder. You can produce illegal reminders which may cause problems. (This is one good reason to isolate TkRemind's reminders in a separate file.)
TkRemind does not check the body of the reminder in any way. You can use the normal Remind substitution sequences in the body. Furthermore, if you use expression-pasting in the body, TkRemind does not validate the expressions.
When TkRemind invokes Remind, it supplies the option:
-itkremind=1
on the command line. So, in your Remind file, you can include:
IF defined("tkremind")
# Then I'm probably being invoked by TkRemind
ENDIF
You can use this to activate certain reminders in different ways for TkRemind (for example).
TkRemind uses tags to keep track of reminders in the script file. You can certainly mix "hand-crafted" reminders with reminders created by TkRemind if you are aware of the following rules and limitations:
However, rather than mixing hand-edited files with TkRemind-generated ones, it is better to make $HOME/.reminders a directory and keep your hand-edited files in a separate *.rem file than TkRemind's 100-tkremind.rem file.
Remind has a special mode for interacting with programs like TkRemind. This mode is called server mode and is selected by supplying the -z0 option to Remind.
In server mode, Remind operates similar to daemon mode, except it reads commands (one per line) from standard input and writes status lines to standard output.
The commands accepted in server mode are:
The status lines written are as follows:
TkRemind was written by Dianne Skoll <dianne@skoll.ca>
TkRemind is Copyright 1996-2023 by Dianne Skoll.
$HOME/.reminders -- default reminder file or directory.
$HOME/.config/tkremindrc -- TkRemind saved options.
https://dianne.skoll.ca/projects/remind/
remind, rem2ps, rem2pdf, rem2html
| 2023-02-10 | 4th Berkeley Distribution |