Typo fixes.

[mLib] / man / conn.3

diff --git a/man/conn.3 b/man/conn.3
index 60c951008b45c3763608ba5d0d27d4dbce87f1ad..5a12b7ae8dbbd636c81085e14a200de8c8b11097 100644 (file)
--- a/man/conn.3
+++ b/man/conn.3
@@ -1,10 +1,12 @@
 .\" -*-nroff-*-
 .\" -*-nroff-*-

-.TH conn 3mLib "23 May 1999" mLib
+.TH conn 3 "23 May 1999" mLib
+.\" @conn_init
+.\" @conn_kill

 .SH NAME
 conn \- selector for nonblocking connections
 .SH SYNOPSIS
 .nf
 .SH NAME
 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 ,


@@ -26,33 +28,33 @@ selector must be initialized.  This requires a call to
 .B conn_init
 with a fairly large number of arguments:
 .TP
 .B conn_init
 with a fairly large number of arguments:
 .TP

-.I c
+.BI "conn *" c

 Pointer to
 .B conn
 object which needs to be initialized.
 .TP
 Pointer to
 .B conn
 object which needs to be initialized.
 .TP

-.I s
+.BI "sel_state *" s

 Pointer to a multiplexor object (type
 .BR sel_state )
 to which this selector should be attached.  See
 Pointer to a multiplexor object (type
 .BR sel_state )
 to which this selector should be attached.  See

-.BR sel (3mLib)
+.BR sel (3)

 for more details about multiplexors, and how this whole system works.
 .TP
 for more details about multiplexors, and how this whole system works.
 .TP

-.I fd
+.BI "int " fd

 File descriptor for the socket you want to connect.  This becomes the
 `property' of the
 .B conn
 selector until the connection attempt finishes.  For example, if there's
 an error, the descriptor will be closed.
 .TP
 File descriptor for the socket you want to connect.  This becomes the
 `property' of the
 .B conn
 selector until the connection attempt finishes.  For example, if there's
 an error, the descriptor will be closed.
 .TP

-.I dst
+.BI "struct sockaddr *" dst

 Pointer to destination socket address for the connection.  Make sure
 that the address has the right family.
 .TP
 Pointer to destination socket address for the connection.  Make sure
 that the address has the right family.
 .TP

-.I dsz 
+.BI "int " dsz 

 Size of the destination socket address.
 .TP
 Size of the destination socket address.
 .TP

-.I func
+.BI "void (*" func ")(int " fd ", void *" p )

 A function to call when the connection is complete.  It is passed the
 file descriptor of the connected socket, and the pointer passed
 to
 A function to call when the connection is complete.  It is passed the
 file descriptor of the connected socket, and the pointer passed
 to


@@ -64,7 +66,7 @@ passed, and the global
 .B errno
 value is set appropriately.
 .TP
 .B errno
 value is set appropriately.
 .TP

-.I p
+.BI "void *" p

 An arbitrary pointer whose value is passed to the handler function when
 the connection finishes.
 .PP
 An arbitrary pointer whose value is passed to the handler function when
 the connection finishes.
 .PP


@@ -72,5 +74,9 @@ If you want to cancel the connection attempt before it finishes, call
 .B conn_kill
 with the address of the selector.  The file descriptor is closed, and
 the selector becomes safe to be discarded.
 .B conn_kill
 with the address of the selector.  The file descriptor is closed, and
 the selector becomes safe to be discarded.

+.SH "SEE ALSO"
+.BR connect (2),
+.BR sel (3),
+.BR mLib (3).

 .SH AUTHOR
 Mark Wooding, <mdw@nsict.org>
 .SH AUTHOR
 Mark Wooding, <mdw@nsict.org>