File: README

package info (click to toggle)
shhmsg 1.4.1-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 148 kB
  • ctags: 78
  • sloc: ansic: 319; makefile: 134; sh: 10
file content (94 lines) | stat: -rw-r--r-- 2,435 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
shhmsg - library for displaying messages.
=========================================

This is a set of functions for very simple message handling in
terminal based programs.  To use these in your own programs, include
shhmsg.h, and link with the library.  You should also call the
function msgSetName at startup, to indicate what program
identification should be used in the error messages.

Most functions accept printf-like variable arguments.


Overview of files
-----------------

What follows is a brief overview.  Please refer to the C source files
for detailed descriptions.  There are no manual pages yet, and
probably will never be, unless someone writes them for me.

errno.c
	Functions for displaying messages depending on the current
	errno-value.  

error.c
	Non-fatal (non-aborting) error message function.

fatal.c
	Fatal error message function.  Aborts the program.

message.c
	The function in this file works quite like printf, but it is
	possible to make this function silent by setting a flag.

progname.c
	For setting the name of the program.  This name is used in
	error messages, in the traditional Unix-ish way.

streams.c
	Handles the reassignment of streams, so that the functions can
	output to any user defined file stream.

verbose.c
	printf-like function that takes an additional parmeter
	specifying verbosity level of the message.  This lets the user
	filter less interresting messages.


Documentation
-------------

The file shhmsg.txt (contributed by Louis W. Erickson) describes the
use of the library.


Portability
-----------

The library has (more or less recently) been compiled and `tested' on
the following systems:

	IRIX Release 5.2 IP22
	GNU/Linux 2.4.17 with glibc 2.2.5
	SunOS Release 4.1.3_U1
	ULTRIX V4.4 (Rev.  69)

All compilations were done using GNU's gcc, and GNU's make.


Author
------

The program is written by

        Sverre H. Huseby        shh@thathost.com
        Lofthusvn. 11 B         http://shh.thathost.com/
        N-0587 Oslo
        Norway


License
-------

This program is released under the Artistic License:

  http://www.opensource.org/licenses/artistic-license.html

Comments (even as simple as "I use your program") are very welcome.
If you insist on paying something, please donate some money to an
organization that strives to make the world a better place for
everyone.

I don't like bugs, so please help me removing them by reporting
whatever you find!