Minor tidying and typo correction.
authormdw <mdw>
Fri, 30 Jul 1999 06:50:24 +0000 (06:50 +0000)
committermdw <mdw>
Fri, 30 Jul 1999 06:50:24 +0000 (06:50 +0000)
13 files changed:
man/base64.3
man/conn.3
man/crc32.3
man/dspool.3
man/dstr.3
man/exc.3
man/lock.3
man/mdwopt.3
man/sel.3
man/str.3
man/sub.3
man/sym.3
man/url.3

index 12079d8..f05f3a6 100644 (file)
@@ -7,7 +7,7 @@ base64 \- conversion to and from base64 encoding
 .\" @base64_init
 .SH SYNOPSIS
 .nf
 .\" @base64_init
 .SH SYNOPSIS
 .nf
-.B "#include <mLib/base64.h>
+.B "#include <mLib/base64.h>"
 
 .BI "void base64_encode(base64_ctx *" ctx ,
 .BI "                   const void *" p ", size_t " sz ,
 
 .BI "void base64_encode(base64_ctx *" ctx ,
 .BI "                   const void *" p ", size_t " sz ,
@@ -65,7 +65,7 @@ member is a pointer to a null-terminated string which is used to
 separate the output lines.  The default indent string contains only a
 newline character.  The
 .B maxline
 separate the output lines.  The default indent string contains only a
 newline character.  The
 .B maxline
-member gives the maxmimum length of line that
+member gives the maximum length of line that
 .B base64_encode
 is allowed to produce.  If this is not a multiple of 4, it is rounded
 up to the next highest multiple of four before use.  A value of zero
 .B base64_encode
 is allowed to produce.  If this is not a multiple of 4, it is rounded
 up to the next highest multiple of four before use.  A value of zero
index ca4eaa9..663fc1e 100644 (file)
@@ -6,7 +6,7 @@
 conn \- selector for nonblocking connections
 .SH SYNOPSIS
 .nf
 conn \- selector for nonblocking connections
 .SH SYNOPSIS
 .nf
-.B "#include <mLib/conn.h>
+.B "#include <mLib/conn.h>"
 
 .BI "void conn_init(conn *" c ", sel_state *" s ", int " fd ,
 .BI "               struct sockaddr *" dst ", int " dsz ,
 
 .BI "void conn_init(conn *" c ", sel_state *" s ", int " fd ,
 .BI "               struct sockaddr *" dst ", int " dsz ,
index 3b91764..3d2dead 100644 (file)
@@ -1,4 +1,12 @@
 .\" -*-nroff-*-
 .\" -*-nroff-*-
+.ie t \{\
+.  ds ss \s8\u
+.  ds se \d\s0
+.\}
+.el \{\
+.  ds ss ^
+.  ds se
+.\}
 .TH crc32 3 "8 May 1999" "mLib"
 .SH NAME
 crc32 \- calculate 32-bit CRC
 .TH crc32 3 "8 May 1999" "mLib"
 .SH NAME
 crc32 \- calculate 32-bit CRC
@@ -41,8 +49,8 @@ a given block in a way which doesn't change its (unknown) CRC.
 .PP
 The exact behaviour of the CRC is beyond the scope of this manual;
 suffice to say that the result is, in some suitable representation, the
 .PP
 The exact behaviour of the CRC is beyond the scope of this manual;
 suffice to say that the result is, in some suitable representation, the
-remainder after division in the finite field GF(2^32) of the block by a
-carefully chosen polynomial of order 32.
+remainder after division in the finite field GF(2\*(ss32\*(se) of the
+block by a carefully chosen polynomial of order 32.
 .SH "RETURN VALUE"
 The return value is the 32-bit CRC of the input block.
 .SH "SEE ALSO"
 .SH "RETURN VALUE"
 The return value is the 32-bit CRC of the input block.
 .SH "SEE ALSO"
index 562cd79..bdf24a9 100644 (file)
@@ -24,14 +24,14 @@ dspool \- pools of preallocated dynamic strings
 .\"
 .SH SYNOPSIS
 .nf
 .\"
 .SH SYNOPSIS
 .nf
-.B "#include <mLib/dspool.h>
+.B "#include <mLib/dspool.h>"
 
 .BI "void dspool_create(dspool *" p ", size_t " isz );
 .BI "void dspool_destroy(dspool *" p );
 .BI "dstr *dspool_get(dspool *" p );
 .BI "void dspool_put(dspool *" p ", dstr *" d );
 
 
 .BI "void dspool_create(dspool *" p ", size_t " isz );
 .BI "void dspool_destroy(dspool *" p );
 .BI "dstr *dspool_get(dspool *" p );
 .BI "void dspool_put(dspool *" p ", dstr *" d );
 
-.BI "dstr *DSGET(dspool *" p ", d );
+.BI "void DSGET(dspool *" p ", " d );
 .BI "void DSPUT(dspool *" p ", dstr *" d );
 .fi
 .SH DESCRIPTION
 .BI "void DSPUT(dspool *" p ", dstr *" d );
 .fi
 .SH DESCRIPTION
@@ -46,7 +46,7 @@ A pool is created by the function
 It is passed the address of a pool structure
 .I p
 and the initial size
 It is passed the address of a pool structure
 .I p
 and the initial size
-.I izs
+.I isz
 to allocate for new dynamic strings obtained from the pool.  A newly
 created pool contains no strings.  Once a pool is no longer required,
 the function
 to allocate for new dynamic strings obtained from the pool.  A newly
 created pool contains no strings.  Once a pool is no longer required,
 the function
index f0b2a32..2ef8300 100644 (file)
@@ -62,7 +62,7 @@ dstr \- a simple dynamic string type
 .BI "void dstr_putz(dstr *" d );
 .BI "void dstr_puts(dstr *" d ", const char *" s );
 .BI "int dstr_vputf(dstr *" d ", va_list " ap );
 .BI "void dstr_putz(dstr *" d );
 .BI "void dstr_puts(dstr *" d ", const char *" s );
 .BI "int dstr_vputf(dstr *" d ", va_list " ap );
-.BI "int dstr_putf(dstr *" d ", ...);
+.BI "int dstr_putf(dstr *" d ", ...);"
 .BI "void dstr_putd(dstr *" d ", const dstr *" p );
 .BI "void dstr_putm(dstr *" d ", const void *" p ", size_t " sz );
 .BI "int dstr_putline(dstr *" d ", FILE *" fp );
 .BI "void dstr_putd(dstr *" d ", const dstr *" p );
 .BI "void dstr_putm(dstr *" d ", const void *" p ", size_t " sz );
 .BI "int dstr_putline(dstr *" d ", FILE *" fp );
@@ -150,9 +150,9 @@ is a null pointer.
 At all times,
 .BI sz " >= " len\fR.
 .PP
 At all times,
 .BI sz " >= " len\fR.
 .PP
-Note that there is no equaivalent of the standard C distinction between
+Note that there is no equivalent of the standard C distinction between
 the empty string (a pointer to an array of characters whose first
 the empty string (a pointer to an array of characters whose first
-element is zero) and the nonexistant string (a null pointer).  Any
+element is zero) and the nonexistent string (a null pointer).  Any
 .B dstr
 whose
 .B len
 .B dstr
 whose
 .B len
@@ -197,12 +197,12 @@ The
 function empties a string
 .I without
 deallocating any memory.  Therefore appending more characters is quick,
 function empties a string
 .I without
 deallocating any memory.  Therefore appending more characters is quick,
-beause the old buffer is still there and doesn't need to be allocated.
+because the old buffer is still there and doesn't need to be allocated.
 Calling
 .VS
 dstr_reset(d);
 .VE
 Calling
 .VS
 dstr_reset(d);
 .VE
-is equivalent to directly assinging
+is equivalent to directly assigning
 .VS
 d->len = 0;
 .VE
 .VS
 d->len = 0;
 .VE
@@ -254,7 +254,7 @@ The function
 `trims' a string's buffer so that it's just large enough for the string
 contents and a null terminating byte.  This might raise an exception due
 to lack of memory.  (There are two possible ways this might happen.
 `trims' a string's buffer so that it's just large enough for the string
 contents and a null terminating byte.  This might raise an exception due
 to lack of memory.  (There are two possible ways this might happen.
-Firstly, the underlying allocator might just be braindamaged enough to
+Firstly, the underlying allocator might just be brain-damaged enough to
 fail on reducing a block's size.  Secondly, tidying an empty string with no
 buffer allocated for it causes allocation of a buffer large enough for
 the terminating null byte.)
 fail on reducing a block's size.  Secondly, tidying an empty string with no
 buffer allocated for it causes allocation of a buffer large enough for
 the terminating null byte.)
@@ -320,7 +320,7 @@ because the former has to do most of its work itself.  In particular,
 .B dstr_putf
 doesn't (and probably never will) understand the
 .RB ` n$ '
 .B dstr_putf
 doesn't (and probably never will) understand the
 .RB ` n$ '
-positional paramter notation accepted by many Unix C libraries.  There
+positional parameter notation accepted by many Unix C libraries.  There
 is no macro equivalent of
 .BR dstr_putf .
 .PP
 is no macro equivalent of
 .BR dstr_putf .
 .PP
@@ -383,7 +383,7 @@ The macro
 .B DWRITE
 is equivalent.
 .SH "SECURITY CONSIDERATIONS"
 .B DWRITE
 is equivalent.
 .SH "SECURITY CONSIDERATIONS"
-The implemenetation of the
+The implementation of the
 .B dstr
 functions is designed to do string handling in security-critical
 programs.  However, there may be bugs in the code somewhere.  In
 .B dstr
 functions is designed to do string handling in security-critical
 programs.  However, there may be bugs in the code somewhere.  In
index 99b2905..452d177 100644 (file)
--- a/man/exc.3
+++ b/man/exc.3
@@ -20,7 +20,7 @@ exc \- exception handling for C programs
 .\" @THROW
 .\" @RETHROW
 .\"
 .\" @THROW
 .\" @RETHROW
 .\"
-.\" @exc_encaught
+.\" @exc_uncaught
 .\"
 .\" @EXC_PAIR
 .\" @EXC_ALLOC
 .\"
 .\" @EXC_PAIR
 .\" @EXC_ALLOC
@@ -30,7 +30,7 @@ exc \- exception handling for C programs
 .\" @EXC_ALLOCS
 .\"
 .SH SYNOPSIS
 .\" @EXC_ALLOCS
 .\"
 .SH SYNOPSIS
-.B "#include <mLib/exc.h>
+.B "#include <mLib/exc.h>"
 .sp 1
 .B TRY
 .I statement
 .sp 1
 .B TRY
 .I statement
@@ -254,7 +254,7 @@ the signal number.
 String data.  Signals a miscellaneous failure.  The data is a pointer to
 an explanatory string.
 .SH BUGS
 String data.  Signals a miscellaneous failure.  The data is a pointer to
 an explanatory string.
 .SH BUGS
-The call to an exception handler is acheived using
+The call to an exception handler is achieved using
 .BR longjmp (3).
 Therefore all the caveats about
 .B longjmp
 .BR longjmp (3).
 Therefore all the caveats about
 .B longjmp
index 7d7d298..0d1caeb 100644 (file)
@@ -5,7 +5,7 @@ lock \- oversimplified file locking interface
 .\" @lock_file
 .SH SYNOPSIS
 .nf
 .\" @lock_file
 .SH SYNOPSIS
 .nf
-.B "#include <mLib/lock.h>
+.B "#include <mLib/lock.h>"
 
 .BI "int lock_file(int " fd ", unsigned " how );
 .fi
 
 .BI "int lock_file(int " fd ", unsigned " how );
 .fi
index 693d0a8..daa2c84 100644 (file)
@@ -249,7 +249,7 @@ A pointer to an argument is stored in the
 .B arg
 member of the data block; a null pointer is stored if there was no
 argument.  If a negated option was found, the option character is
 .B arg
 member of the data block; a null pointer is stored if there was no
 argument.  If a negated option was found, the option character is
-returned ORred with
+returned ORed with
 .B OPTF_NEGATED
 (bit 8 set).
 .SS "Long option parsing"
 .B OPTF_NEGATED
 (bit 8 set).
 .SS "Long option parsing"
index e55de84..1452347 100644 (file)
--- a/man/sel.3
+++ b/man/sel.3
@@ -178,7 +178,7 @@ which multiplexor it's associated with.  A newly initialized file
 selector is not added to its multiplexor: this must be done explicitly.
 .PP
 The handler function for a file multiplexor is passed three arguments:
 selector is not added to its multiplexor: this must be done explicitly.
 .PP
 The handler function for a file multiplexor is passed three arguments:
-the file descriptor for the file, a mode argument which descibes the
+the file descriptor for the file, a mode argument which describes the
 file's new condition, and the pointer argument set up at initialization
 time.
 .PP
 file's new condition, and the pointer argument set up at initialization
 time.
 .PP
index 969f021..4ac61d1 100644 (file)
--- a/man/str.3
+++ b/man/str.3
@@ -63,7 +63,7 @@ and so on.  If there aren't enough words in the string, the remaining
 array elements are filled with null pointers.
 .TP
 .I c
 array elements are filled with null pointers.
 .TP
 .I c
-The maxmimum number of words to extract; also, the number of elements in
+The maximum number of words to extract; also, the number of elements in
 the array
 .IR v .
 .TP
 the array
 .IR v .
 .TP
index ad27a14..94bf1ad 100644 (file)
--- a/man/sub.3
+++ b/man/sub.3
@@ -94,7 +94,7 @@ Similarly, the block can be freed by saying
 .VS
 DESTROY(p)
 .VE
 .VS
 DESTROY(p)
 .VE
-rather than the more cubersome
+rather than the more cumbersome
 .VS
 sub_free(p, sizeof(*p));
 .VE
 .VS
 sub_free(p, sizeof(*p));
 .VE
index 96d2e6a..c495ab3 100644 (file)
--- a/man/sym.3
+++ b/man/sym.3
@@ -84,7 +84,7 @@ passing it to the function
 After initialization, the table contains no entries.
 .PP
 Initializing a symbol table involves allocating some memory.  If this
 After initialization, the table contains no entries.
 .PP
 Initializing a symbol table involves allocating some memory.  If this
-allocation failes, an
+allocation fails, an
 .B EXC_NOMEM
 exception is raised.
 .PP
 .B EXC_NOMEM
 exception is raised.
 .PP
index e322e83..570623d 100644 (file)
--- a/man/url.3
+++ b/man/url.3
@@ -20,7 +20,7 @@ url \- manipulation of form-urlencoded strings
 .\" @url_dec
 .SH SYNOPSIS
 .nf
 .\" @url_dec
 .SH SYNOPSIS
 .nf
-.B "#include <mLib/url.h>
+.B "#include <mLib/url.h>"
 
 .BI "void url_initenc(url_ectx *" ctx );
 .BI "void url_enc(url_ectx *" ctx ", dstr *" d ,
 
 .BI "void url_initenc(url_ectx *" ctx );
 .BI "void url_enc(url_ectx *" ctx ", dstr *" d ,