TKREMIND(1) TKREMIND(1)
NAME
tkremind - graphical front-end to Remind calendar program
SYNOPSIS
tkremind [options] [read_file] [write_file]
DESCRIPTION
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(1,8) Tcl, and requires version(1,3,5) 8.0 (or higher). It
also requires a wish binary.
OPTIONS
TkRemind itself has no options. However, it passes certain options on
to Remind. The options it passes are -b, -g, -x, -i and -m. See the
Remind man(1,5,7) page for details about the options.
Read_file is the file(1,n) from which TkRemind reads reminders. It is in(1,8)
standard Remind format. Write_file is the file(1,n) 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(3,n) you want
to collect all of TkRemind's reminders in(1,8) one place. Suppose your main
file(1,n) is $HOME/.reminders and you want TkRemind to put its reminders in(1,8)
$HOME/.tkreminders. In $HOME/.reminders, include the line:
INCLUDE [getenv("HOME")]/.tkreminders
THE CALENDAR WINDOW
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(1,8) 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.
NAVIGATING
To change to the previous or next month, click the <- or -> button,
respectively. To change back to the current month, click Today. To go
to a specific month, click Go To Date.... This pops up a dialog(1,3,n) box
which allows you to select(2,7,2 select_tut) a month and enter a year. Once you've done
this, click Go to go to the date, or Cancel to cancel.
To exit(3,n,1 builtins) TkRemind, click Quit.
ADDING REMINDERS
To add a reminder, click button 1 in(1,8) any day number in(1,8) the calendar.
The Add Reminder... dialog(1,3,n) will pop up, with values preselected for the
day you clicked.
The dialog(1,3,n) has six basic groups of controls. The first three lines
select(2,7,2 select_tut) 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(1,8) the values using
pull-down menus.
The third control specifes how much advance notice you want (if(3,n) 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(1,8) the second
and third types of reminders.
The fifth control associates a time(1,2,n) with the reminder. You can also
specify advance notice, possibly repeating.
The sixth control specifies what Remind should do if(3,n) 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(1,n), click Add to reminder file(1,n).
To close(2,7,n) the dialog(1,3,n) without adding the reminder to the file(1,n), click Can-
cel. To preview the reminder, click Preview reminder. This pops up
the Preview reminder dialog(1,3,n) box.
PREVIEWING REMINDERS
The Preview reminder dialog(1,3,n) 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(2,5) to advanced features of Remind. You can also use it
simply to play around and discover(1,3,5) Remind's idioms for expressing dif-
ferent types of reminders.
PRINTING
To print the current month's calender, click Print... on the main cal-
endar window. This brings up the print dialog. Printing either pro-
duces a PostScript file(1,n) or sends PostScript to a UNIX command.
Select the print destination by choosing either To file: or To command:
in(1,8) the print dialog. Press Browse... to bring up a file(1,n) browser. In
the file(1,n) browser, you can enter a filename in(1,8) the text entry, double-
click on a filename in(1,8) the listbox, or double-click on a directory to
navigate the file(1,n) system. You can also type the first few characters
of a file(1,n) name in(1,8) 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(1,8) the
listbox. You can change the filter(1,3x,3x curs_util) and press enter to rescan the
directory.
Select the appropriate paper size and orientation. Activate Fill page
if(3,n) you want the calendar to fill the page. This should be the normal
case unless you have many reminders in(1,8) a particular day. (See the
Rem2PS documentation.)
Finally, click Print to print or Cancel to cancel. Note that during
printing, Remind is not called with the -itkremind=1 option, because it
is operated in(1,8) normal PostScript-producing mode.
EDITING REMINDERS
If you created a reminder with TkRemind, it will turn red as the mouse
cursor passes over it in(1,8) the calendar window. Click button-1 over the
reminder and you will be presented with a dialog(1,3,n) 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(1,3,n) 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(1,3,n) in(1,8) "ADDING REMINDERS."
Note that if(3,n) you edit a reminder (using Preview reminder), any edits
you made are not retained in(1,8) the dialog(1,3,n) box. You should not attempt to
edit such reminders; you have to retype them in(1,8) the Preview reminder
dialog.
If the reminder was not created with TkRemind, you can't edit it with
TkRemind.
BACKGROUND REMINDERS
If you create "timed" reminders, TkRemind will queue(1,3) them in(1,8) the back-
ground and pop up boxes as they are triggered. Additionally, if(3,n) 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(1,8) server mode,
described later.
OPTIONS
The final button on the calendar window, Options, lets you configure
certain aspects of TkRemind. The configuration options are:
Start up Iconified
If this is selected, TkRemind starts up iconified. Otherwise,
it starts up in(1,8) a normal window.
Show Today's Reminders on Startup
If this is selected, TkRemind shows a text window containing
reminders which would be issued by "remind -q -a -r" on startup,
and when the date changes at midnight.
Confirm Quit
If this is selected, you will be asked to confirm when you press
Quit. If not, TkRemind quits without prompting.
Automatically close(2,7,n) pop-up reminders after a minute
If this is selected, pop-up reminder boxes will be closed after
one minute has elapsed. Otherwise, they remain on your screen
forever until you explicitly dismiss them.
Beep terminal when popping up a reminder
If selected, TkRemind beeps the terminal bell when a queued
reminder pops up.
Deiconify calendar window when popping up a reminder
If selected, does what it says.
Run command when popping up a reminder
If this entry is not blank, the specified command is run when-
ever a background reminder pops up.
Feed popped-up reminder to command's standard input
If selected, feeds the text of the reminder to the command
described above.
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(1,8) $HOME/.tkremindrc, or Cancel to cancel any changes you
made.
ODDS AND ENDS
TkRemind performs some basic consistency checks when you add or preview
a reminder. However, if(3,n) you edit a reminder in(1,8) 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 TkRe-
mind's reminders in(1,8) a separate file.)
TkRemind does not check the body of the reminder in(1,8) any way. You can
use the normal Remind substitution sequences in(1,8) the body. Furthermore,
if(3,n) you use expression-pasting in(1,8) the body, TkRemind does not validate
the expressions.
When TkRemind invokes Remind, it supplies the option:
-itkremind=1
on the command line. So, in(1,8) your Remind file(1,n), you can include:
IF defined("tkremind")
# Then I'm probably being invoked by TkRemind
ENDIF
You can use this to activate certain reminders in(1,8) different ways for
TkRemind (for example).
TkRemind uses tags to keep track of reminders in(1,8) the script file. It
also places special comments in(1,8) the reminder file(1,n) to store additional
state. You can certainly mix "hand-crafted" reminders with reminders
created by TkRemind if(3,n) you are awared of the following rules and limi-
tations:
o Do not use the TAG keyword in(1,8) hand-crafted reminders.
o Do not edit lines starting with "# TKTAGnnn", "# TKEND", or any
lines in(1,8) between. You can move(3x,7,3x curs_move) such lines, but be careful to
move(3x,7,3x curs_move) them as a single block.
o Hand-crafted reminders cannot be edited with TkRemind, and for
hand-crafted timed reminders, you will not be presented with the
"Don't remind me again" option when they pop up.
SERVER MODE
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(1,8) server mode are:
EXIT Terminate the Remind process. EOF on standard input does the
same thing.
STATUS Return the number of queued reminders.
REREAD Re-read the reminder file(1,n)
The status lines written are as follows:
NOTE reminder time(1,2,n) tag
Signifies the beginning of a timed reminder whose trigger time(1,2,n)
is time(1,2,n) with tag tag. If the reminder has no tag, an asterisk
is supplied for tag. All lines following this line are the body
of the reminder, until the line NOTE endreminder is transmitted.
NOTE newdate
This line is emitted whenever Remind has detected a rollover of
the system date. The front-end program should redraw its calen-
dar or take whatever other action is needed.
NOTE reread
This line is emitted whenever the number of reminders in(1,8)
Remind's queue(1,3) changes because of a date rollover or a REREAD
command. The front-end should issue a STATUS command in(1,8)
response to this message.
NOTE queued n
This line is emitted in(1,8) response to a STATUS command. The num-
ber n is the number of reminders in(1,8) the queue.
AUTHOR
TkRemind is now supported by Roaring Penguin Software Inc.
(http://www.roaringpenguin.com)
TkRemind was written by David F. Skoll <dfs@roaringpenguin.com>.
TkRemind is Copyright 1996-1998 by David F. Skoll, Copyright 1999 by
Roaring Penguin Software Inc.
FILES
$HOME/.reminders -- default reminder file.
$HOME/.tkremindrc -- TkRemind saved options.
SEE ALSO
remind, rem2ps
4th Berkeley Distribution 15 February 1998 TKREMIND(1)