From 484eed5d07c30d877e93e18bbab95f1ffbddaa24 Mon Sep 17 00:00:00 2001 From: mdw Date: Wed, 28 Jul 1999 22:23:08 +0000 Subject: [PATCH] Add lots of references to manual pages, and fix a typo. --- man/mLib.3 | 60 ++++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 34 insertions(+), 26 deletions(-) diff --git a/man/mLib.3 b/man/mLib.3 index 43a95a2..e467d26 100644 --- a/man/mLib.3 +++ b/man/mLib.3 @@ -6,7 +6,7 @@ mLib \- library of miscellaneous utilities .SH DESCRIPTION The .B mLib -library is a mixed back of things which the author finds useful in large +library is a mixed bag of things which the author finds useful in large numbers of programs. As a result, its structure is somewhat arbitrary, and it's accreted extra bits over time rather than actually being designed as a whole. In the author's opinion this isn't too much of a @@ -23,7 +23,7 @@ module would be put in .BR . +.BR .h> . .PP This description is a bit abstract, and .BR mLib , @@ -34,12 +34,12 @@ The rest of this section describes the various chunks and layers. .SS "Exception handling" Right at the bottom, there's a fairly primitive exception handling system. It's provided by the -.B exc +.BR exc (3) module, and stands alone. It's used mainly by the memory allocation modules to raise exceptions when there's no more memory to be had. .SS "Memory allocation" The -.B alloc +.BR alloc (3) module provides simple veneers onto traditional memory allocation functions like .BR malloc (3) @@ -53,7 +53,7 @@ being defined in the library) which raise exceptions when there's not enough memory left. .PP The -.B sub +.BR sub (3) module handles efficient allocation of small blocks. It allocates memory in relatively big chunks and divides the chunks up into small blocks before returning them. It keeps lists of differently-sized @@ -66,30 +66,30 @@ module (not yet documented) is a simple memory allocation tracker. It can be handy when trying to fix memory leaks. .SS "String handling" The -.B str +.BR str (3) module provides some trivial string-manipulation functions which tend to be useful quite often. .PP The -.B dstr +.BR dstr (3) module implements a dynamic string data type. It works quite quickly and well, and is handy in security-sensitive programs, to prevent buffer-overflows. Dynamic strings are used occasionally through the rest of the library, mainly as output arguments. .PP The -.B dspool +.BR dspool (3) module implements a `pool' of dynamic strings which saves lots of allocation and deallocation when a piece of code has high string turnover. .SS "Program identification and error reporting" The -.B quis +.BR quis (3) module remembers the name of the program and supplies it when asked. It's used in error messages and similar things. .PP The -.B report +.BR report (3) module emits standard Unixy error messages. It provides functions .B moan and @@ -104,7 +104,7 @@ verbosity levels. It needs improving to be able to cope with outputting to the system log. .SS "Other data types" The -.B sym +.BR sym (3) module implements a rather good extending hash table. Keys and values can be arbitrary data. .PP @@ -114,87 +114,94 @@ module (not yet documented) implements unbounded sparse arrays. It needs rewriting. .SS "Miscellaneous utilities" The -.B crc32 +.BR crc32 (3) module calculates CRC values for strings. It's used by the symbol table manager as a hash function. .PP The -.B lock +.BR lock (3) module does POSIX .BR fcntl (2)-style locking with a timeout. .PP The -.B env +.BR env (3) module manipulates environment variables stored in a hashtable, and converts between the hashtable and the standard array representation of a process environment. .PP The -.B fdflags +.BR fdflags (3) module manipulates file descriptor flags in a fairly painless way. .PP The -.B lbuf +.BR lbuf (3) module implements a `line buffer', which is an object that emits completed lines of text from an incoming asynchronous data stream. It's remarkably handy in programs that want to read lines from pipes and sockets can't block while waiting for a line-end to arrive. .PP The -.B tv +.BR tv (3) module provides some macros and functions for playing with -.B "struct timeval" +.BR "struct timeval" . .PP The -.B bits +.BR bits (3) module defines some types and macros for playing with words as chunks of bits. There are portable rotate and shift macros (harder than you'd think), and macros to do loading and storing in known-endian formats. values. .PP The -.B mdwopt +.BR mdwopt (3) module implements a fairly serious options parser compatible with the GNU options parser. .PP The -.B testrig +.BR testrig (3) module provides a generic structure for reading test vectors from files and running them through functions. I mainly use it for testing cryptographic transformations of various kinds. .SS "Encoding and decoding" The -.B base64 +.BR base64 (3) module does base64 encoding and decoding, as defined in RFC2045. Base64 encodes arbitrary binary data in a reliable way which is resistant to character-set transformations and other mail transport bogosity. .PP The -.B url +.BR url (3) module does urlencoding and decoding, as defined in RFC1866. Urlencoding encodes arbitrary (but mostly text-like) name/value pairs as a text string containing no whitespace. .SS "Multiplexed I/O" The -.B sel +.BR sel (3) module provides a basis for doing nonblocking I/O in Unix systems. It provides types and functions for receiving events when files are ready for reading or writing, and when timers expire. .PP The -.B conn +.BR conn (3) module implements nonblocking network connections in a way which fits in with the .B sel system. It makes nonblocking connects pretty much trivial. .PP The -.B selbuf +.BR selbuf (3) module attaches to the .B sel system and sends an event when lines of text arrive on a file. It's useful when reading text from a network connection. +.PP +The +.BR sig (3) +module introduces signal handling into the multiplexed I/O world. +Signals are queued until dispatched through the normal +.B sel +mechanism. .SH "SEE ALSO" .BR alloc (3), .BR base64 (3), @@ -213,6 +220,7 @@ useful when reading text from a network connection. .BR report (3), .BR sel (3), .BR selbuf (3), +.BR sig (3), .BR str (3), .BR sub (3), .BR sym (3), -- 2.11.0