-- Clarified documentation.

This commit is contained in:
dfs
1998-01-17 04:50:33 +00:00
parent 02a7023040
commit f2128d4cb6
7 changed files with 79 additions and 240 deletions
+34 -57
View File
@@ -1,51 +1,37 @@
$Id: README.UNIX,v 1.1 1998-01-15 02:50:14 dfs Exp $
$Id: README.UNIX,v 1.2 1998-01-17 04:50:34 dfs Exp $
REMIND version 3.0 for UNIX
REMIND is a sophisticated alarm/calendar program. Details are given
in the man page, "remind.1".
INSTALLING REMIND:
-----------------
1 - Read the file COPYRIGHT.
2- Before compiling the software, check to see if it includes patches.
These are files called patch.xx. If there are patches, apply them all
by typing:
2 - In the main Remind directory, type: sh ./configure
cat patch.* | patch
3 - Examine the file src/custom.h and modify it as needed.
3 - Examine the Makefile and change any parameters which need to be
changed for your system. As it stands, the Makefile is set up for a
Linux system.
4 - Examine the file config.h and adjust parameters as needed
5 - Examine lang.h and choose the language you want Remind to use.
4 - Examine lang.h and choose the language you want Remind to use.
(You can do this on the "make" command-line -- see "OTHER
LANGUAE SUPPORT.)
LANGUAGE SUPPORT.)
6 - Type 'make'
5 - Type 'make'
7 - Type 'sh test-rem' or 'make test' to run the acceptance test. Note
that the test script works only for the English version of Remind.
8 - Type 'make install' to install Remind, kall, rem and the man
pages.
6 - Type 'make install' (possibly as root)
The subdirectory "www" contains scripts for making a nice calendar
web server. See the files README and Makefile in that directory.
Two shell scripts, "remind-all.csh" and "remind-all.sh" are provided.
These allow automatic mailing of reminders to all users who create a
$HOME/.reminders file. These two scripts are equivalent; one is a
"sh" script and the other is a "csh" script. Pick the one you want to
use, and follow the instructions in the opening comments of the
script.
Two shell scripts, "scripts/remind-all.csh" and
"scripts/remind-all.sh" are provided. These allow automatic mailing of
reminders to all users who create a $HOME/.reminders file. These two
scripts are equivalent; one is a "sh" script and the other is a "csh"
script. Pick the one you want to use, and follow the instructions in
the opening comments of the script.
*** NOTE *** Please be aware that "remind-all.csh" and "remind-all.sh"
have been changed since version 03.00.05 of Remind. If you install
the new remind executable, make sure you switch over to the new
"remind-all" scripts.
A shell script called "rem" is provided for those who like to have
A shell script called "scripts/rem" is provided for those who like to have
'remind' assume a default reminders file. A man page for this script
is provided. You should examine the script to ensure that the defaults
are correct.
@@ -58,12 +44,12 @@ parameters. I like that behaviour so I can quickly get an idea of
what a program does without poring through the man page. And I think
I'll keep Remind that way. Sorry to all who dislike it. :-)
A shell script called "kall" is provided so you can kill your background
remind processes when you log out. See the man page. Note that kall
depends on the output of "ps", and may not be portable.
A shell script called "scripts/kall" is provided so you can kill your
background remind processes when you log out. See the man page. Note
that kall depends on the output of "ps", and may not be portable.
The file "defs.rem" has some sample Remind definitions and commands,
as well as U.S. and Jewish holidays.
The file "examples/defs.rem" has some sample Remind definitions and
commands, as well as U.S. and Jewish holidays.
OTHER LANGUAGE SUPPORT
@@ -74,10 +60,10 @@ instructions and error messages as well. See "french.h" for an
example of the latter.
To compile Remind for a non-english language, look at the constants
defined in "lang.h". Then, to compile Remind for Italian (as an
defined in "src/lang.h". Then, to compile Remind for Italian (as an
example), type:
make "CDEFS=-DLANG=ITALIAN"
make "LANGDEFS=-DLANG=ITALIAN"
If you add support for a non-English language, Remind will accept both the
English and non-English names of months and weekdays in an input script.
@@ -89,11 +75,13 @@ language, and should modify the substitution filter appropriately.
If you are truly diligent, you can translate usage and error messages
too.
Take a look at the files "english.h" and "german.h" if you want to add
support for your favourite language. If you do add another language
to Remind, please let me know! Here are the basic guidelines:
Take a look at the files "src/langs/english.h" and
"src/langs/german.h" if you want to add support for your favourite
language. If you do add another language to Remind, please let me
know! Here are the basic guidelines:
- Your language file should be called "lxxx.h", where lxxx is the first 8
- Your language file should be called "src/langs/lxxx.h", where lxxx
is the first 8
characters of the ENGLISH name of your language.
- Your language file should define L_LANGNAME to be the full English
@@ -117,26 +105,15 @@ Or use the following in your Remind script:
REM AT 17:00 RUN popup 'Time to go home.' &
This TCL script is a slightly modified version of one submitted by
Norman Walsh. TCL is available via FTP at ftp.uu.net in /languages/tcl.
This Tcl script is a slightly modified version of one submitted by
Norman Walsh.
-------------- Cut Here ---------- Cut Here ---------- Cut Here -------------
#!/usr/local/bin/wish -f
#!/usr/local/bin/wish
wm withdraw .
if { [ llength $argv ] == 1 } {
eval set msg $argv
} else {
eval set msg [ list $argv ]
}
after 15000 { destroy . ; exit }
tk_dialog .d { Message } $msg warning 0 { OK }
tk_dialog .d { Message } $argv warning 0 { OK }
destroy .
exit
-------------- Cut Here ---------- Cut Here ---------- Cut Here -------------