Browse Source

even more man pages

master
Felix von Leitner 21 years ago
parent
commit
24082dca3f
  1. 17
      socket/socket_mcttl4.3
  2. 29
      socket/socket_tcp.3
  3. 26
      socket/socket_tcp4.3
  4. 6
      socket/socket_tcp6.3
  5. 26
      socket/socket_udp4.3
  6. 26
      socket/socket_udp6.3

17
socket/socket_mcttl4.3

@ -0,0 +1,17 @@
.TH socket_mcttl4 3
.SH NAME
socket_mcttl4 \- set multicast ttl
.SH SYNTAX
.B #include <socket.h>
int \fBsocket_mcttl4\fP(int \fIs\fR,char \fITTL\fR);
.SH DESCRIPTION
socket_mcttl4 sets the TTL of outgoing multicast packets on the socket
\fIs\fR. Each router decrements the packet TTL by one and discards the
packet if the TTL reaches zero. Setting the TTL to 1, for example, will
limit the packet propagation to the LAN.
If something goes wrong, socket_mcttl4 returns -1, setting errno
appropriately.
.SH "SEE ALSO"
socket_mcttl6(3), socket_mcjoin4(3), socket_mcleave4(3)

29
socket/socket_tcp.3

@ -1,29 +0,0 @@
.TH socket_tcp 3
.SH NAME
socket_tcp \- create a non-blocking TCP/IP stream socket
.SH SYNTAX
.B #include <socket.h>
int \fBsocket_tcp\fP();
.SH DESCRIPTION
socket_tcp creates a non-blocking TCP/IP stream socket and returns a
file descriptor pointing to that socket. If something goes wrong,
socket_tcp returns -1, setting errno appropriately, without allocating
any resources.
.SH EXAMPLE
#include <socket.h>
int \fIs\fR;
char \fIip\fR[4];
uint16 \fIp\fR;
\fIs\fR = socket_tcp();
socket_bind4(s,ip,p);
socket_connect4(s,ip,p);
.SH BUGS
It is called socket_tcp instead of socket_tcp4 to be compatible with DJ
Bernstein's original implementation.
.SH "SEE ALSO"
socket_bind4(3), socket_bind6(3)

26
socket/socket_tcp4.3

@ -0,0 +1,26 @@
.TH socket_tcp4 3
.SH NAME
socket_tcp4 \- create a non-blocking TCP/IP stream socket
.SH SYNTAX
.B #include <socket.h>
int \fBsocket_tcp4\fP();
.SH DESCRIPTION
socket_tcp4 creates a non-blocking TCP/IP stream socket and returns a
file descriptor pointing to that socket. If something goes wrong,
socket_tcp4 returns -1, setting errno appropriately, without allocating
any resources.
.SH EXAMPLE
#include <socket.h>
int \fIs\fR;
char \fIip\fR[4];
uint16 \fIp\fR;
\fIs\fR = socket_tcp4();
socket_bind4(s,ip,p);
socket_connect4(s,ip,p);
.SH "SEE ALSO"
socket_bind4(3), socket_bind6(3)

6
socket/socket_tcp6.3

@ -1,14 +1,14 @@
.TH socket_tcp6 3
.SH NAME
socket_tcp \- create a non-blocking IPv6 TCP/IP stream socket
socket_tcp6 \- create a non-blocking IPv6 TCP/IP stream socket
.SH SYNTAX
.B #include <socket.h>
int \fBsocket_tcp6\fP();
.SH DESCRIPTION
socket_tcp creates a non-blocking IPv6 TCP/IP stream socket and returns a
socket_tcp6 creates a non-blocking IPv6 TCP/IP stream socket and returns a
file descriptor pointing to that socket. If something goes wrong,
socket_tcp returns -1, setting errno appropriately, without allocating
socket_tcp6 returns -1, setting errno appropriately, without allocating
any resources.
.SH EXAMPLE

26
socket/socket_udp4.3

@ -0,0 +1,26 @@
.TH socket_udp4 3
.SH NAME
socket_udp4 \- create a non-blocking UDP/IP datagram socket
.SH SYNTAX
.B #include <socket.h>
int \fBsocket_udp4\fP();
.SH DESCRIPTION
socket_udp4 creates a non-blocking UDP/IP datagram socket and returns a
file descriptor pointing to that socket. If something goes wrong,
socket_udp4 returns -1, setting errno appropriately, without allocating
any resources.
.SH EXAMPLE
#include <socket.h>
int \fIs\fR;
char \fIip\fR[4];
uint16 \fIp\fR;
\fIs\fR = socket_udp4();
socket_bind4(s,ip,p);
socket_connect4(s,ip,p);
.SH "SEE ALSO"
socket_bind4(3), socket_bind6(3)

26
socket/socket_udp6.3

@ -0,0 +1,26 @@
.TH socket_udp6 3
.SH NAME
socket_udp6 \- create a non-blocking IPv6 UDP/IP datagram socket
.SH SYNTAX
.B #include <socket.h>
int \fBsocket_udp6\fP();
.SH DESCRIPTION
socket_udp6 creates a non-blocking UDP/IP datagram socket and returns a
file descriptor pointing to that socket. If something goes wrong,
socket_udp6 returns -1, setting errno appropriately, without allocating
any resources.
.SH EXAMPLE
#include <socket.h>
int \fIs\fR;
char \fIip\fR[16];
uint16 \fIp\fR;
\fIs\fR = socket_udp6();
socket_bind6(s,ip,p);
socket_connect6(s,ip,p);
.SH "SEE ALSO"
socket_bind4(3), socket_bind6(3)
Loading…
Cancel
Save