-- 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
+6 -32
View File
@@ -1,4 +1,4 @@
$Id: README.AMIGA,v 1.1 1998-01-15 02:50:12 dfs Exp $ $Id: README.AMIGA,v 1.2 1998-01-17 04:50:33 dfs Exp $
REMIND version 3.0 for AmigaDOS REMIND version 3.0 for AmigaDOS
REMIND is a sophisticated alarm/calendar program. Details are given REMIND is a sophisticated alarm/calendar program. Details are given
@@ -6,7 +6,8 @@ in the man page, "remind.1".
1 - Read the file COPYRIGHT. 1 - Read the file COPYRIGHT.
2 - Examine the file config.h and adjust parameters as needed 2 - cd src; examine the files config.h and custom.h and adjust parameters
as needed
3 - If you are using SAS/C to compile Remind, type: 3 - If you are using SAS/C to compile Remind, type:
@@ -15,38 +16,11 @@ in the man page, "remind.1".
This will create remind, which is ready to be executed. This will create remind, which is ready to be executed.
The file "defs.rem" has some sample Remind definitions and commands,
as well as U.S. and Jewish holidays.
OTHER LANGUAGE SUPPORT
Remind has support for languages other than English. See the file
"lang.h" for details. The language support may vary - you can change
only the substitution filter, or you can translate all of the usage
instructions and error messages as well. See "french.h" for an example.
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.
However, you should not rely on this feature if you want to write portable
Remind scripts.
At a minimum, you should support month and day names in the foreign
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:
- Your language file should be called "lxxx.h", where lxxx is the first 8
characters of the ENGLISH name of your language.
- You should define L_LANGNAME to be the full English name of your language,
with the first letter capitalized and the rest lower-case.
[Please note: I CANNOT SUPPORT THE AMIGA VERSION!] [Please note: I CANNOT SUPPORT THE AMIGA VERSION!]
See README.UNIX for more info.
-- --
David F. Skoll <dfs@doe.carleton.ca> David F. Skoll <dfs@doe.carleton.ca>
986 Eiffel Avenue 986 Eiffel Avenue
+7 -39
View File
@@ -1,12 +1,16 @@
$Id: README.BCC,v 1.1 1998-01-15 02:50:13 dfs Exp $ $Id: README.BCC,v 1.2 1998-01-17 04:50:33 dfs Exp $
REMIND version 3.0 for Borland C++ REMIND version 3.0 for Borland C++
IMPORTANT NOTE: BCC SUPPORT MAY BE BROKEN. I DON'T CARE. I'M NOT
MAINTAINING IT ANY LONGER.
1 - Read the file COPYRIGHT. (This may be called COPYRIGH on your 1 - Read the file COPYRIGHT. (This may be called COPYRIGH on your
MS-DOS system.) MS-DOS system.)
2 - You must use the Borland C++ OS/2 or MSDOS/Windows compiler. 2 - You must use the Borland C++ OS/2 or MSDOS/Windows compiler.
3 - Examine the file config.h and adjust parameters as needed 3 - cd src; examine the files custom.h and config.h and adjust
parameters as needed
4 - Examine the file makefile.bcc and adjust parameters as needed. 4 - Examine the file makefile.bcc and adjust parameters as needed.
@@ -17,43 +21,7 @@ REMIND version 3.0 for Borland C++
This will make 'remind.exe' and 'rem2ps.exe' in the ..\os2-ex or ..\msdos-ex This will make 'remind.exe' and 'rem2ps.exe' in the ..\os2-ex or ..\msdos-ex
directories. directories.
The file "defs.rem" has some sample Remind definitions and commands, See README.UNIX for more info.
as well as U.S. and Jewish holidays.
NOTE that I do not have access to an OS/2 system, so support for this
system may not be as good as I'd like.
OS/2 support is courtesy of Russ Herman <rwh@gov.on.ca>, Norman Walsh
<norm@ora.com>, and Darrel Hankerson <hankedr@mail.auburn.edu>.
However, if you have problems, please contact me.
OTHER LANGUAGE SUPPORT
Remind has support for languages other than English. See the file
"lang.h" for details. The language support may vary - you can change
only the substitution filter, or you can translate all of the usage
instructions and error messages as well. See "french.h" for an
example of the latter.
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.
However, you should not rely on this feature if you want to write portable
Remind scripts.
At a minimum, you should support month and day names in the foreign
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:
- Your language file should be called "lxxx.h", where lxxx is the first 8
characters of the ENGLISH name of your language.
- You should define L_LANGNAME to be the full English name of your language,
with the first letter capitalized and the rest lower-case.
-- --
David F. Skoll <dfs@doe.carleton.ca> David F. Skoll <dfs@doe.carleton.ca>
+6 -30
View File
@@ -1,8 +1,8 @@
$Id: README.DOS,v 1.1 1998-01-15 02:50:13 dfs Exp $ $Id: README.DOS,v 1.2 1998-01-17 04:50:33 dfs Exp $
REMIND version 3.0 for MS-DOS REMIND version 3.0 for MS-DOS
IMPORTANT NOTE: I'm no longer officially supporting Remind under IMPORTANT NOTE: DOS SUPPORT MAY BE BROKEN. I DON'T CARE. I NO LONGER
DOS. It may very well work, but if it doesn't... you're on your own. MAINTAIN THE DOS VERSION.
REMIND is a sophisticated alarm/calendar program. Details are given REMIND is a sophisticated alarm/calendar program. Details are given
in the man page, "remind.1". in the man page, "remind.1".
@@ -10,7 +10,8 @@ in the man page, "remind.1".
1 - Read the file COPYRIGHT. (This may be called COPYRIGH on your 1 - Read the file COPYRIGHT. (This may be called COPYRIGH on your
MS-DOS system.) MS-DOS system.)
2 - Examine the file config.h and adjust parameters as needed 2 - cd src; examine the files custom.h and config.h and adjust parameters
as needed
3 - If you are using Turbo C to compile Remind, type: 3 - If you are using Turbo C to compile Remind, type:
@@ -25,32 +26,7 @@ This will create REMIND.EXE, which is ready to be executed.
The file "defs.rem" has some sample Remind definitions and commands, The file "defs.rem" has some sample Remind definitions and commands,
as well as U.S. and Jewish holidays. as well as U.S. and Jewish holidays.
OTHER LANGUAGE SUPPORT See README.UNIX for more info.
Remind has support for languages other than English. See the file
"lang.h" for details. The language support may vary - you can change
only the substitution filter, or you can translate all of the usage
instructions and error messages as well. See "french.h" for an example.
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.
However, you should not rely on this feature if you want to write portable
Remind scripts.
At a minimum, you should support month and day names in the foreign
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:
- Your language file should be called "lxxx.h", where lxxx is the first 8
characters of the ENGLISH name of your language.
- You should define L_LANGNAME to be the full English name of your language,
with the first letter capitalized and the rest lower-case.
-- --
David F. Skoll <dfs@doe.carleton.ca> David F. Skoll <dfs@doe.carleton.ca>
+5 -33
View File
@@ -1,4 +1,4 @@
$Id: README.OS2,v 1.1 1998-01-15 02:50:14 dfs Exp $ $Id: README.OS2,v 1.2 1998-01-17 04:50:34 dfs Exp $
REMIND version 3.0 for OS/2 REMIND version 3.0 for OS/2
This file contains instructions for compiling Remind under OS/2 with This file contains instructions for compiling Remind under OS/2 with
@@ -19,7 +19,8 @@ in the man page, "remind.1".
or emx/gcc. You must also have a decent version of 'make', such or emx/gcc. You must also have a decent version of 'make', such
as dmake or GNU make. as dmake or GNU make.
3 - Examine the file config.h and adjust parameters as needed 3 - Change to "src" directory and examine the files config.h and custom.h
and adjust parameters as needed.
4 - Examine the file Makefile.os2 and adjust parameters as needed. 4 - Examine the file Makefile.os2 and adjust parameters as needed.
@@ -33,9 +34,6 @@ to see a list of targets. For example,
will build a 32-bit emx version which runs under OS/2 2.x and DOS. will build a 32-bit emx version which runs under OS/2 2.x and DOS.
The file "defs.rem" has some sample Remind definitions and commands,
as well as U.S. and Jewish holidays.
NOTE that I do not have access to an OS/2 system, so support for this NOTE that I do not have access to an OS/2 system, so support for this
system may not be as good as I'd like. system may not be as good as I'd like.
@@ -43,34 +41,6 @@ OS/2 support is courtesy of Russ Herman <rwh@gov.on.ca>, Norman Walsh
<norm@ora.com>, and Darrel Hankerson <hankedr@mail.auburn.edu>. <norm@ora.com>, and Darrel Hankerson <hankedr@mail.auburn.edu>.
However, if you have problems, please contact me. However, if you have problems, please contact me.
OTHER LANGUAGE SUPPORT
Remind has support for languages other than English. See the file
"lang.h" for details. The language support may vary - you can change
only the substitution filter, or you can translate all of the usage
instructions and error messages as well. See "french.h" for an
example of the latter.
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.
However, you should not rely on this feature if you want to write portable
Remind scripts.
At a minimum, you should support month and day names in the foreign
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:
- Your language file should be called "lxxx.h", where lxxx is the first 8
characters of the ENGLISH name of your language.
- You should define L_LANGNAME to be the full English name of your language,
with the first letter capitalized and the rest lower-case.
RELEASE NOTES -- miscellaneous info that couldn't go anywhere else! RELEASE NOTES -- miscellaneous info that couldn't go anywhere else!
1. POPUP REMINDERS 1. POPUP REMINDERS
@@ -127,6 +97,8 @@ CLEANUP:
exit exit
-------------- Cut Here ---------- Cut Here ---------- Cut Here -------- -------------- Cut Here ---------- Cut Here ---------- Cut Here --------
See README.UNIX for some more information about Remind.
-- --
David F. Skoll <dfs@doe.carleton.ca> David F. Skoll <dfs@doe.carleton.ca>
986 Eiffel Avenue 986 Eiffel Avenue
+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 version 3.0 for UNIX
REMIND is a sophisticated alarm/calendar program. Details are given REMIND is a sophisticated alarm/calendar program. Details are given
in the man page, "remind.1". in the man page, "remind.1".
INSTALLING REMIND:
-----------------
1 - Read the file COPYRIGHT. 1 - Read the file COPYRIGHT.
2- Before compiling the software, check to see if it includes patches. 2 - In the main Remind directory, type: sh ./configure
These are files called patch.xx. If there are patches, apply them all
by typing:
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 4 - Examine lang.h and choose the language you want Remind to use.
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.
(You can do this on the "make" command-line -- see "OTHER (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 6 - Type 'make install' (possibly as root)
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.
The subdirectory "www" contains scripts for making a nice calendar The subdirectory "www" contains scripts for making a nice calendar
web server. See the files README and Makefile in that directory. web server. See the files README and Makefile in that directory.
Two shell scripts, "remind-all.csh" and "remind-all.sh" are provided. Two shell scripts, "scripts/remind-all.csh" and
These allow automatic mailing of reminders to all users who create a "scripts/remind-all.sh" are provided. These allow automatic mailing of
$HOME/.reminders file. These two scripts are equivalent; one is a reminders to all users who create a $HOME/.reminders file. These two
"sh" script and the other is a "csh" script. Pick the one you want to scripts are equivalent; one is a "sh" script and the other is a "csh"
use, and follow the instructions in the opening comments of the script. Pick the one you want to use, and follow the instructions in
script. the opening comments of the script.
*** NOTE *** Please be aware that "remind-all.csh" and "remind-all.sh" A shell script called "scripts/rem" is provided for those who like to have
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
'remind' assume a default reminders file. A man page for this script 'remind' assume a default reminders file. A man page for this script
is provided. You should examine the script to ensure that the defaults is provided. You should examine the script to ensure that the defaults
are correct. 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 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. :-) 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 A shell script called "scripts/kall" is provided so you can kill your
remind processes when you log out. See the man page. Note that kall background remind processes when you log out. See the man page. Note
depends on the output of "ps", and may not be portable. that kall depends on the output of "ps", and may not be portable.
The file "defs.rem" has some sample Remind definitions and commands, The file "examples/defs.rem" has some sample Remind definitions and
as well as U.S. and Jewish holidays. commands, as well as U.S. and Jewish holidays.
OTHER LANGUAGE SUPPORT OTHER LANGUAGE SUPPORT
@@ -74,10 +60,10 @@ instructions and error messages as well. See "french.h" for an
example of the latter. example of the latter.
To compile Remind for a non-english language, look at the constants 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: example), type:
make "CDEFS=-DLANG=ITALIAN" make "LANGDEFS=-DLANG=ITALIAN"
If you add support for a non-English language, Remind will accept both the 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. 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 If you are truly diligent, you can translate usage and error messages
too. too.
Take a look at the files "english.h" and "german.h" if you want to add Take a look at the files "src/langs/english.h" and
support for your favourite language. If you do add another language "src/langs/german.h" if you want to add support for your favourite
to Remind, please let me know! Here are the basic guidelines: 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. characters of the ENGLISH name of your language.
- Your language file should define L_LANGNAME to be the full English - 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.' & REM AT 17:00 RUN popup 'Time to go home.' &
This TCL script is a slightly modified version of one submitted by 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. Norman Walsh.
-------------- Cut Here ---------- Cut Here ---------- Cut Here ------------- -------------- Cut Here ---------- Cut Here ---------- Cut Here -------------
#!/usr/local/bin/wish -f #!/usr/local/bin/wish
wm withdraw . wm withdraw .
if { [ llength $argv ] == 1 } {
eval set msg $argv
} else {
eval set msg [ list $argv ]
}
after 15000 { destroy . ; exit } after 15000 { destroy . ; exit }
tk_dialog .d { Message } $argv warning 0 { OK }
tk_dialog .d { Message } $msg warning 0 { OK }
destroy . destroy .
exit exit
-------------- Cut Here ---------- Cut Here ---------- Cut Here ------------- -------------- Cut Here ---------- Cut Here ---------- Cut Here -------------
+4 -49
View File
@@ -1,4 +1,4 @@
$Id: README_QDOS,v 1.1 1998-01-15 02:50:14 dfs Exp $ $Id: README_QDOS,v 1.2 1998-01-17 04:50:34 dfs Exp $
REMIND version 3.0.18 for QDOS / SMSQ REMIND version 3.0.18 for QDOS / SMSQ
REMIND is a sophisticated alarm/calendar program. Details are given REMIND is a sophisticated alarm/calendar program. Details are given
@@ -8,13 +8,13 @@ in the documentation file, "remind_doc" (QUILL format).
1 - Read the file COPYRIGHT. 1 - Read the file COPYRIGHT.
2 - Do NOT redistribute Remind WITHOUT the sources! 2 - Change to the directory "src"
3 - Examine the Makefile and change any parameters which need to be 3 - Examine the Makefile and change any parameters which need to be
changed for your system. (The makefile for QDOS / SMSQ is changed for your system. (The makefile for QDOS / SMSQ is
makefile_QDOS). makefile_QDOS).
4 - Examine the file config_h and adjust parameters as needed 4 - Examine the files config_h and custom_h and adjust parameters as needed
5 - Examine lang_h and choose the language you want Remind to use. 5 - Examine lang_h and choose the language you want Remind to use.
There has no effort been put in making the language modules working There has no effort been put in making the language modules working
@@ -25,52 +25,7 @@ in the documentation file, "remind_doc" (QUILL format).
directory is the directory where the remind source files are directory is the directory where the remind source files are
placed. placed.
7 - There is an acceptance test for other systems. If you want to See README.UNIX for some more information about Remind.
test remind on your QDOS / SMSQ system execute the following
commands from your command line:
SETENV "TEST_GETENV=foo bar baz"
ex datad$&'remind';'-e -dxte test_rem 16 feb 1991 > test_out'
ex diff;'test_out test_cmp >test_diff'
Then check the output of diff. You will find lots of differences.
If there are other than differences in the filename
(supplied test-result: ./test.rem, QDOS result: test_rem) and
in the ostype (supplied: UNIX, QDOS: QDOS / SMSQ) Remind does
not work correctly.
The file "defs_rem" has some sample Remind definitions and commands,
as well as U.S. and Jewish holidays. You should delete the definitions
for ANSI colours as the QL does not support the ANSI standard.
OTHER LANGUAGE SUPPORT
Remind has support for languages other than English. See the file
"lang_h" for details. The language support may vary - you can change
only the substitution filter, or you can translate all of the usage
instructions and error messages as well. See "french_h" for an
example of the latter.
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.
However, you should not rely on this feature if you want to write portable
Remind scripts.
At a minimum, you should support month and day names in the foreign
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:
- Your language file should be called "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
name of your language, with the first letter capitalized and the rest
lower-case.
RELEASE NOTES -- miscellaneous info that couldn't go anywhere else! RELEASE NOTES -- miscellaneous info that couldn't go anywhere else!
+17
View File
@@ -11,6 +11,23 @@ CHANGES TO REMIND
- Completely reworked the PS/PSFILE mechanism to use the more - Completely reworked the PS/PSFILE mechanism to use the more
general SPECIAL mechanism for customizing output in REMIND back-ends. general SPECIAL mechanism for customizing output in REMIND back-ends.
+ MINOR ENHANCEMENTS
- Directory structure totally reorganized. Remind now uses an autoconf
"configure" script which should make life very pleasant for UNIX
people.
+ BUG FIXES
- Updated "finnish.h" to include proper URL and translation of all
error messages.
+ BUG INTRODUCTIONS
- The reorganization and use of "configure" probably breaks Remind
installation on non-UNIX platforms. Sorry. I can't fix it until
I hear back from non-UNIX maintainers.
* Version 3.0 Patch 17 * Version 3.0 Patch 17
+ MINOR ENHANCEMENTS + MINOR ENHANCEMENTS