From 689b133817afadcdb28289c0a0d7ed8d74aa903b Mon Sep 17 00:00:00 2001 From: Gerhard Rieger Date: Wed, 17 Jul 2024 16:53:43 +0200 Subject: [PATCH] Fixed a lot of typos in docu --- CHANGES | 4 ++++ doc/socat-multicast.html | 2 +- doc/socat-openssltunnel.html | 4 ++-- doc/socat.yo | 12 ++++++------ 4 files changed, 13 insertions(+), 9 deletions(-) diff --git a/CHANGES b/CHANGES index 99f8d4c..2bcf3ef 100644 --- a/CHANGES +++ b/CHANGES @@ -97,6 +97,10 @@ Testing: test.sh: fixed ss determination; more DEFS +Documentation: + Fixed a lot of typos. + Thanks to Solomon Victorino for sending the patch. + ####################### V 1.8.0.0 Security: diff --git a/doc/socat-multicast.html b/doc/socat-multicast.html index 5077088..5e4b824 100644 --- a/doc/socat-multicast.html +++ b/doc/socat-multicast.html @@ -40,7 +40,7 @@ requirements.

All the following examples work bidirectionally except when otherwise noticed. For "clients" we just use STDIO, and for "servers" we use EXEC:hostname which -ingores its input but shows us which host the reply comes from. Replace these +ignores its input but shows us which host the reply comes from. Replace these socat addresses with what is appropriate for your needs (e.g. shell script invocations). Port 6666 can be replaced with any other port (but for ports < 1024 root privilege might be required). diff --git a/doc/socat-openssltunnel.html b/doc/socat-openssltunnel.html index d4965a4..fcc4334 100644 --- a/doc/socat-openssltunnel.html +++ b/doc/socat-openssltunnel.html @@ -32,7 +32,7 @@ In this docu we only use self signed certificates for the sake of simplicity.

We assume that the server host is called server.domain.org and the server process uses port 4433. To keep it simple, we use a very simple server -funtionality that just echos data (echo), and stdio on the +functionality that just echos data (echo), and stdio on the client.

Generate a server certificate

@@ -77,7 +77,7 @@ server.

Instead of using a tcp-listen (tcp-l) address, we use openssl-listen (ssl-l) for the server, cert=... tells the program to the file containing its -ceritificate and private key, and cafile=... points to the file +certificate and private key, and cafile=... points to the file containing the certificate of the peer; we trust clients only if they can proof that they have the related private key (OpenSSL handles this for us):

socat \ diff --git a/doc/socat.yo b/doc/socat.yo index fc2ff83..231b17c 100644 --- a/doc/socat.yo +++ b/doc/socat.yo @@ -104,7 +104,7 @@ dit(bf(tt(-h | -?))) types, and exit. dit(bf(tt(-hh | -??))) Like -h, plus a list of the short names of all available address options. Some options are - platform dependend, so this output is helpful for checking the particular + platform dependent, so this output is helpful for checking the particular implementation. dit(bf(tt(-hhh | -???))) Like -hh, plus a list of all available address option names. @@ -123,7 +123,7 @@ dit(bf(tt(-D))) Logs information about file descriptors before starting the transfer phase. label(option_experimental)dit(bf(tt(--experimental))) New features that are not well tested or are subject to change in the future - must me explicitely enabled using this option. + must be explicitly enabled using this option. dit(bf(tt(-ly[]))) Writes messages to syslog instead of stderr; severity as defined with -d option. With optional link()(TYPE_FACILITY), the syslog type can @@ -755,7 +755,7 @@ label(ADDRESS_NAMED_PIPE)dit(bf(tt(PIPE:))) See also: link(unnamed pipe)(ADDRESS_UNNAMED_PIPE) label(ADDRESS_UNNAMED_PIPE)dit(bf(tt(PIPE))) Creates an unnamed pipe and uses it for reading and writing. It works as an - echo, because everything written to it appeares immediately as read + echo, because everything written to it appears immediately as read data.nl() Note: When socat tries to write more bytes than the pipe can queue (Linux 2.4: 2048 bytes), socat might block. Consider, e.g., using @@ -764,7 +764,7 @@ label(ADDRESS_UNNAMED_PIPE)dit(bf(tt(PIPE))) See also: link(named pipe)(ADDRESS_NAMED_PIPE), link(SOCKETPAIR)(ADDRESS_SOCKETPAIR) label(ADDRESS_SOCKETPAIR)dit(bf(tt(SOCKETPAIR))) Creates a socketpair and uses it for reading and writing. It works as an - echo, because everything written to it appeares immediately as read + echo, because everything written to it appears immediately as read data. The default socket type is datagram, so it keeps packet boundaries. nl() Option groups: link(FD)(GROUP_FD) nl() @@ -2834,7 +2834,7 @@ label(OPTION_PROXYPORT)dit(bf(tt(proxyport=))) label(OPTION_IGNORECR)dit(bf(tt(ignorecr))) The HTTP protocol requires the use of CR+NL as line terminator. When a proxy server violates this standard, socat might not understand its answer. - This option directs socat to interprete NL as line terminator and + This option directs socat to interpret NL as line terminator and to ignore CR in the answer. Nevertheless, socat sends CR+NL to the proxy. label(OPTION_PROXY_AUTHORIZATION)dit(bf(tt(proxy-authorization=:))) Provide "basic" authentication to the proxy server. The argument to the @@ -3063,7 +3063,7 @@ label(OPTION_TERMIOS_RAWER)dit(bf(tt(rawer))) label(OPTION_TERMIOS_CFMAKERAW)dit(bf(tt(cfmakeraw))) Sets raw mode by invoking tt(cfmakeraw()) or by simulating this call. This option implicitly turns off echo. label(OPTION_IGNBRK)dit(bf(tt(ignbrk[=]))) - Ignores or interpretes the BREAK character (e.g., ^C) + Ignores or interprets the BREAK character (e.g., ^C) label(OPTION_BRKINT)dit(bf(tt(brkint[=]))) label(OPTION_BS0)dit(bf(tt(bs0))) label(OPTION_BS1)dit(bf(tt(bs1)))