Fixed a couple of typos

This commit is contained in:
Gerhard Rieger 2019-03-03 15:08:41 +01:00
parent 710c54a254
commit ad2484f49f
3 changed files with 14 additions and 16 deletions

View file

@ -59,6 +59,10 @@ Corrections:
merged in Socat invocation merged in Socat invocation
Test: SOCCAT_OPT_HINT Test: SOCCAT_OPT_HINT
Fixed some docu typos.
Thanks to Travis Wellman, Thomas <tjps636>, Dan Kenigsberg,
Julian Zinn, and Simon Matter
Porting: Porting:
OpenSSL functions TLS1_client_method() and similar are OpenSSL functions TLS1_client_method() and similar are
deprecated. Socat now uses recommended TLS_client_method(). The old deprecated. Socat now uses recommended TLS_client_method(). The old
@ -135,7 +139,7 @@ corrections:
Socat did not use option ipv6-join-group. Socat did not use option ipv6-join-group.
Test: USE_IPV6_JOIN_GROUP Test: USE_IPV6_JOIN_GROUP
Thanks to Linux Lüssing for sending a patch. Thanks to Linus Lüssing for sending a patch.
UDP-LISTEN did not honor the max-children option. UDP-LISTEN did not honor the max-children option.
Test: UDP4MAXCHILDREN UDP6MAXCHILDREN Test: UDP4MAXCHILDREN UDP6MAXCHILDREN

View file

@ -507,7 +507,7 @@ label(ADDRESS_OPENSSL_CONNECT)dit(bf(tt(OPENSSL:<host>:<port>)))
Useful options: Useful options:
link(cipher)(OPTION_OPENSSL_CIPHERLIST), link(cipher)(OPTION_OPENSSL_CIPHERLIST),
link(verify)(OPTION_OPENSSL_VERIFY), link(verify)(OPTION_OPENSSL_VERIFY),
link(commonname)(OPTION_OPENSSL_COMMONNAME) link(commonname)(OPTION_OPENSSL_COMMONNAME),
link(cafile)(OPTION_OPENSSL_CAFILE), link(cafile)(OPTION_OPENSSL_CAFILE),
link(capath)(OPTION_OPENSSL_CAPATH), link(capath)(OPTION_OPENSSL_CAPATH),
link(certificate)(OPTION_OPENSSL_CERTIFICATE), link(certificate)(OPTION_OPENSSL_CERTIFICATE),
@ -535,7 +535,7 @@ label(ADDRESS_OPENSSL_LISTEN)dit(bf(tt(OPENSSL-LISTEN:<port>)))
link(pf)(OPTION_PROTOCOL_FAMILY), link(pf)(OPTION_PROTOCOL_FAMILY),
link(cipher)(OPTION_OPENSSL_CIPHERLIST), link(cipher)(OPTION_OPENSSL_CIPHERLIST),
link(verify)(OPTION_OPENSSL_VERIFY), link(verify)(OPTION_OPENSSL_VERIFY),
link(commonname)(OPTION_OPENSSL_COMMONNAME) link(commonname)(OPTION_OPENSSL_COMMONNAME),
link(cafile)(OPTION_OPENSSL_CAFILE), link(cafile)(OPTION_OPENSSL_CAFILE),
link(capath)(OPTION_OPENSSL_CAPATH), link(capath)(OPTION_OPENSSL_CAPATH),
link(certificate)(OPTION_OPENSSL_CERTIFICATE), link(certificate)(OPTION_OPENSSL_CERTIFICATE),
@ -632,7 +632,7 @@ label(ADDRESS_READLINE)dit(bf(tt(READLINE)))
label(ADDRESS_SCTP_CONNECT)dit(bf(tt(SCTP-CONNECT:<host>:<port>))) label(ADDRESS_SCTP_CONNECT)dit(bf(tt(SCTP-CONNECT:<host>:<port>)))
Establishes an SCTP stream connection to the specified <host> [link(IP Establishes an SCTP stream connection to the specified <host> [link(IP
address)(TYPE_IP_ADDRESS)] and <port> [link(TCP service)(TYPE_TCP_SERVICE)] address)(TYPE_IP_ADDRESS)] and <port> [link(TCP service)(TYPE_TCP_SERVICE)]
using TCP/IP version 4 or 6 depending on address specification, name using IP version 4 or 6 depending on address specification, name
resolution, or option link(pf)(OPTION_PROTOCOL_FAMILY).nl() resolution, or option link(pf)(OPTION_PROTOCOL_FAMILY).nl()
Option groups: link(FD)(GROUP_FD),link(SOCKET)(GROUP_SOCKET),link(IP4)(GROUP_IP4),link(IP6)(GROUP_IP6),link(SCTP)(GROUP_SCTP),link(CHILD)(GROUP_CHILD),link(RETRY)(GROUP_RETRY) nl() Option groups: link(FD)(GROUP_FD),link(SOCKET)(GROUP_SOCKET),link(IP4)(GROUP_IP4),link(IP6)(GROUP_IP6),link(SCTP)(GROUP_SCTP),link(CHILD)(GROUP_CHILD),link(RETRY)(GROUP_RETRY) nl()
Useful options: Useful options:
@ -659,8 +659,8 @@ label(ADDRESS_SCTP6_CONNECT)dit(bf(tt(SCTP6-CONNECT:<host>:<port>)))
Like link(SCTP-CONNECT)(ADDRESS_SCTP_CONNECT), but only supports IPv6 protocol.nl() Like link(SCTP-CONNECT)(ADDRESS_SCTP_CONNECT), but only supports IPv6 protocol.nl()
Option groups: link(FD)(GROUP_FD),link(SOCKET)(GROUP_SOCKET),link(IP6)(GROUP_IP6),link(SCTP)(GROUP_SCTP),link(CHILD)(GROUP_CHILD),link(RETRY)(GROUP_RETRY) nl() Option groups: link(FD)(GROUP_FD),link(SOCKET)(GROUP_SOCKET),link(IP6)(GROUP_IP6),link(SCTP)(GROUP_SCTP),link(CHILD)(GROUP_CHILD),link(RETRY)(GROUP_RETRY) nl()
label(ADDRESS_SCTP_LISTEN)dit(bf(tt(SCTP-LISTEN:<port>))) label(ADDRESS_SCTP_LISTEN)dit(bf(tt(SCTP-LISTEN:<port>)))
Listens on <port> [link(TCP service)(TYPE_TCP_SERVICE)] and accepts a Listens on <port> [link(TCP service)(TYPE_TCP_SERVICE)] and accepts an
TCP/IP connection. The IP version is 4 or the one specified with SCTP connection. The IP version is 4 or the one specified with
address option link(pf)(OPTION_PROTOCOL_FAMILY), socat option address option link(pf)(OPTION_PROTOCOL_FAMILY), socat option
(link(-4)(option_4), link(-6)(option_6)), or environment variable link(SOCAT_DEFAULT_LISTEN_IP)(ENV_SOCAT_DEFAULT_LISTEN_IP). (link(-4)(option_4), link(-6)(option_6)), or environment variable link(SOCAT_DEFAULT_LISTEN_IP)(ENV_SOCAT_DEFAULT_LISTEN_IP).
Note that opening Note that opening
@ -1284,7 +1284,7 @@ dit(bf(tt(ABSTRACT-RECV:<string>)))
dit(bf(tt(ABSTRACT-CLIENT:<string>))) dit(bf(tt(ABSTRACT-CLIENT:<string>)))
The ABSTRACT addresses are almost identical to the related UNIX addresses The ABSTRACT addresses are almost identical to the related UNIX addresses
except that they do not address file system based sockets but an alternate except that they do not address file system based sockets but an alternate
unixdomain() address space. To archieve this the socket address strings are unixdomain() address space. To achieve this the socket address strings are
prefixed with "\0" internally. This feature is available (only?) on Linux. prefixed with "\0" internally. This feature is available (only?) on Linux.
Option groups are the same as with the related UNIX addresses, except that Option groups are the same as with the related UNIX addresses, except that
the ABSTRACT addresses are not member of the NAMED group. the ABSTRACT addresses are not member of the NAMED group.
@ -1758,7 +1758,7 @@ label(OPTION_PROMPT)dit(bf(tt(prompt=<string>)))
Passes the string as prompt to the readline function. readline prints this Passes the string as prompt to the readline function. readline prints this
prompt when stepping through the history. If this string matches a constant prompt when stepping through the history. If this string matches a constant
prompt issued by an interactive program on the other socat address, prompt issued by an interactive program on the other socat address,
consistent look and feel can be archieved. consistent look and feel can be achieved.
enddit() enddit()
startdit()enddit()nl() startdit()enddit()nl()
@ -2678,7 +2678,7 @@ label(OPTION_OPENSSL_EGD)dit(bf(tt(egd=<filename>)))
label(OPTION_OPENSSL_PSEUDO)dit(bf(tt(pseudo))) label(OPTION_OPENSSL_PSEUDO)dit(bf(tt(pseudo)))
On systems where openssl cannot find an entropy source and where no entropy On systems where openssl cannot find an entropy source and where no entropy
gathering daemon can be utilized, this option activates a mechanism for gathering daemon can be utilized, this option activates a mechanism for
providing pseudo entropy. This is archieved by taking the current time in providing pseudo entropy. This is achieved by taking the current time in
microseconds for feeding the libc pseudo random number generator with an microseconds for feeding the libc pseudo random number generator with an
initial value. openssl is then feeded with output from NOEXPAND(random()) calls.nl() initial value. openssl is then feeded with output from NOEXPAND(random()) calls.nl()
NOTE:This mechanism is not sufficient for generation of secure keys! NOTE:This mechanism is not sufficient for generation of secure keys!
@ -2934,7 +2934,7 @@ installs a simple TCP port forwarder. With
link(TCP4-LISTEN)(ADDRESS_TCP4_LISTEN) it listens on local port "www" until a link(TCP4-LISTEN)(ADDRESS_TCP4_LISTEN) it listens on local port "www" until a
connection comes in, accepts it, then connects to the remote host connection comes in, accepts it, then connects to the remote host
(link(TCP4)(ADDRESS_TCP4_CONNECT)) and starts data transfer. It will not accept (link(TCP4)(ADDRESS_TCP4_CONNECT)) and starts data transfer. It will not accept
a econd connection. a second connection.
label(EXAMPLE_OPTION_BIND_TCP4) label(EXAMPLE_OPTION_BIND_TCP4)
label(EXAMPLE_OPTION_REUSEADDR) label(EXAMPLE_OPTION_REUSEADDR)

View file

@ -664,9 +664,6 @@ enum e_optcode {
OPT_SO_RCVBUF_LATE, OPT_SO_RCVBUF_LATE,
#ifdef SO_RCVLOWAT #ifdef SO_RCVLOWAT
OPT_SO_RCVLOWAT, OPT_SO_RCVLOWAT,
#endif
#ifdef SO_RCVTIMEO
OPT_SO_RCVTIMEO,
#endif #endif
OPT_SO_REUSEADDR, OPT_SO_REUSEADDR,
#ifdef SO_REUSEPORT #ifdef SO_REUSEPORT
@ -685,9 +682,6 @@ enum e_optcode {
OPT_SO_SNDBUF_LATE, OPT_SO_SNDBUF_LATE,
#ifdef SO_SNDLOWAT #ifdef SO_SNDLOWAT
OPT_SO_SNDLOWAT, OPT_SO_SNDLOWAT,
#endif
#ifdef SO_SNDTIMEO
OPT_SO_SNDTIMEO,
#endif #endif
OPT_SO_TIMESTAMP, /* Linux */ OPT_SO_TIMESTAMP, /* Linux */
OPT_SO_TYPE, OPT_SO_TYPE,