File: README

package info (click to toggle)
splitdigest 2.4-2
  • links: PTS
  • area: main
  • in suites: potato
  • size: 144 kB
  • ctags: 135
  • sloc: ansic: 798; makefile: 104
file content (131 lines) | stat: -rw-r--r-- 4,875 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
splitdigest 2.4
Copyright (c) 1994-1998 by Christopher Heng. All rights reserved.
-----------------------------------------------------------------

$Id: README,v 2.6 1998/03/30 13:18:26 chris Released $

This program, its sources, documentation and binaries, are released under the
GNU General Public License. See the file COPYING for details. In addition,
you may not remove or alter any of the copyright notices and/or the conditions
for use and distribution.


Contents of this document
-------------------------
Introduction
If You Are Upgrading
Installation Instructions
Configuration
Acknowledgements
Contacting the Author


Introduction
------------
Splitdigest undigests a file which may contain one or more digest files
concatenated together. The result is that each of digest files is extracted
into its own file and placed into a form suitable for reading with a mail
user agent (such as "mail" or "elm"). Splitdigest can be easily extended to
handle a variety of digest files simultaneously simply by modifying its
configuration file. No recompilation is required.


If You Are Upgrading
--------------------

IMPORTANT: if you are upgrading from an earlier version, you must
read the CHANGES file, since there have been changes to the command
line options. The changes may affect your script files, if you use
a script to run splitdigest.

For example, the meaning of the -o option has been changed to conform
more closely to the usual meaning of -o in many Unix programs. The
original functionality of -o is now taken up by the new -d option.
This change also allows you to completely put splitdigest in a pipe.


Installation Instructions
-------------------------
The binaries are compiled for Linux. To install the binaries and the manual
page, simply type
	make install

This will install the pre-compiled binaries in /usr/local/bin, and the
manual page in /usr/man/man1. You will need the shared libraries
that come with libc 5 of Linux to use the binaries. If you find that
the binaries do not work with your setup, simply recompile everything.

To compile from the sources, just
	make clean
	make all

and when you are satisfied, install the new binaries and the manual page
with
	make install

You can modify a number of things in the Makefile itself (see below),
including the path of the default configuration file.
For example, to make splitdigest use a default configuration file
/usr/lib/splitdigest.config, you can simply
	make clean
	make DEFCONFIG=/usr/lib/splitdigest.config LIBDIR=/usr/lib all
	make install

The definitions in the Makefile supercedes those in the splitdigest.h file.
And of course, those on the command line takes precedence over all.


Configuration
-------------
The following can be changed/configured from the Makefile

DEFCONFIG	This specifies the default configuration file to use. You
                must specify a full path for this macro. This default file
                can be overridden at the command line with the -C option. If
                you change this value, you should also change the LIBDIR
                macro in order that the Makefile installs the configuration
                file into the correct directory. The default value for this
                macro is /usr/local/lib/splitdigest.config.
MAXCFTABLE	This macro specifies the maximum number of
		splitdigest.config records that splitdigest will be able to
		handle. The default value is 128.
SEPCHAR		Character which separates messages in a digest. Most
		digests use the '-' character.

Other configurable items in the Makefile:

BINDIR		The path to put the binary in. Default: /usr/local/bin.
MANDIR		The path to put the manual in. Default: /usr/local/man/man1.
LIBDIR		The path to put splitdigest.config in. (See DEFCONFIG above
		as well.) Default: /usr/local/lib.

If you are compiling splitdigest on a system other than Linux, you might
want to check out sysdep.h to see if you need to configure anything.


Acknowledgements
----------------
- Jelle Foks <jelle@flying.demon.nl> and Andreas Koppenhoefer
<koppenas@koppenas.infomatik.uni-stuttgart.de> for the help in
tracking down bugs and their suggestions for improving the
program.
- Oswald Maenner <maenner%sawfish@abelix.gud.siemens.co.at> for
his suggestion for improving splitdigest and his addition to
splitdigest.config.


Contacting the Author
---------------------
Please send bug reports to me at one of the following email address:
	cyfheng@singnet.com.sg
	ChristopherHeng@pobox.org.sg

You can check for the latest versions at
	http://www.singnet.com.sg/~cyfheng

Note that I make no warranties nor any promise to fix bugs or even reply to
you. You use the program and any output or information contained therein at
your own risk.

All trademarks, registered trademarks and what-have-you in this document are
owned by their respective owners (and stuff like that).