summaryrefslogtreecommitdiff
path: root/office/remind/README
diff options
context:
space:
mode:
Diffstat (limited to 'office/remind/README')
-rw-r--r--office/remind/README35
1 files changed, 35 insertions, 0 deletions
diff --git a/office/remind/README b/office/remind/README
new file mode 100644
index 0000000000..88cfb6ffb9
--- /dev/null
+++ b/office/remind/README
@@ -0,0 +1,35 @@
+Remind is a sophisticated command-line calendar and alarm program
+with a sophisticated scripting language and intelligent handling of
+exceptions and holidays.
+
+There are several options to pass to this script at compile-time.
+Some of these options can be changed at run-time through SET
+commands, while others (language, date/time separators, character
+set, and the -u option) must be chosen at compile-time. Pass these
+using `VAR=value ./remind.SlackBuild`:
+LANGUAGE=LANG (default: ENGLISH), set the language. See the SlackBuild
+for possible language options.
+
+LAT_DEG=# (default: 45), set the latitudinal degrees
+LAT_MIN=# (default: 24), set the latitudinal minutes
+LAT_SEC=# (default: 0), set the latitudinal seconds
+LON_DEG=# (default: 75), set the longitudinal degrees
+LON_MIN=# (default: 39), set the longitudinal minutes
+LON_SEC=# (default: 0), set the longitudinal seconds
+LOCATION=location (default: Ottawa), set the location string
+See the SlackBuild for more information on these variables.
+
+DEFAULT_PAGE=Letter|A4 (default: Letter), set the default page size
+DATESEP=-|/ (default: -), set the date separator character
+TIMESEP=:|. (default: :), set the time separator character
+
+CHARSET=ASCII|ISOLATIN1|ISOLATIN2|IBMEXTENDED|IBM852
+(default: ISOLATIN1), set the character set to use
+
+WANTU=yes|no (default: yes), enable/disable the -u option (which
+runs remind with the uid and gid of the specified name)
+
+There are a number of graphical front-ends to remind. tkremind is
+included, but requires tcllib (available from SlackBuilds.org) as
+a run-time requirement. Using remind via the command-line (or via
+other front-ends) does not require tcllib.