bcollet/socat
1
0
Fork 0
mirror of https://repo.or.cz/socat.git synced 2024-12-22 23:42:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixed a lot of typos in docu

Browse source
This commit is contained in:
Gerhard Rieger 2024-07-17 16:53:43 +02:00
parent ec0e1ca20c
commit 689b133817
4 changed files with 13 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGES
View file

@ -97,6 +97,10 @@ Testing:
test.sh: fixed ss determination; more DEFS 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 ####################### V 1.8.0.0
Security: Security:

2
doc/socat-multicast.html
View file

@ -40,7 +40,7 @@ requirements.
<p> <p>
All the following examples work bidirectionally except when otherwise noticed. All the following examples work bidirectionally except when otherwise noticed.
For "clients" we just use <tt>STDIO</tt>, and for "servers" we use <tt>EXEC:hostname</tt> which For "clients" we just use <tt>STDIO</tt>, and for "servers" we use <tt>EXEC:hostname</tt> 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 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 &lt; invocations). Port 6666 can be replaced with any other port (but for ports &lt;
1024 root privilege might be required). 1024 root privilege might be required).

4
doc/socat-openssltunnel.html
View file

@ -32,7 +32,7 @@ In this docu we only use self signed certificates for the sake of simplicity.
</p> </p>
<p>We assume that the server host is called <tt>server.domain.org</tt> and the <p>We assume that the server host is called <tt>server.domain.org</tt> and the
server process uses port 4433. To keep it simple, we use a very simple server server process uses port 4433. To keep it simple, we use a very simple server
funtionality that just echos data (<tt>echo</tt>), and <tt>stdio</tt> on the functionality that just echos data (<tt>echo</tt>), and <tt>stdio</tt> on the
client.</p> client.</p>
<h3>Generate a server certificate</h3> <h3>Generate a server certificate</h3>
@ -77,7 +77,7 @@ server.</p>
<p>Instead of using a tcp-listen (tcp-l) address, we use openssl-listen (ssl-l) <p>Instead of using a tcp-listen (tcp-l) address, we use openssl-listen (ssl-l)
for the server, <tt>cert=...</tt> tells the program to the file containing its for the server, <tt>cert=...</tt> tells the program to the file containing its
ceritificate and private key, and <tt>cafile=...</tt> points to the file certificate and private key, and <tt>cafile=...</tt> points to the file
containing the certificate of the peer; we trust clients only if they can proof 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):<p> that they have the related private key (OpenSSL handles this for us):<p>
<span class="shell">socat \ <span class="shell">socat \

12
doc/socat.yo
View file

@ -104,7 +104,7 @@ dit(bf(tt(-h | -?)))
types, and exit. types, and exit.
dit(bf(tt(-hh | -??))) dit(bf(tt(-hh | -??)))
Like -h, plus a list of the short names of all available address options. Some options are 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. implementation.
dit(bf(tt(-hhh | -???))) dit(bf(tt(-hhh | -???)))
Like -hh, plus a list of all available address option names. 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. Logs information about file descriptors before starting the transfer phase.
label(option_experimental)dit(bf(tt(--experimental))) label(option_experimental)dit(bf(tt(--experimental)))
New features that are not well tested or are subject to change in the future 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[<facility>]))) dit(bf(tt(-ly[<facility>])))
Writes messages to syslog instead of stderr; severity as defined with -d Writes messages to syslog instead of stderr; severity as defined with -d
option. With optional link(<facility>)(TYPE_FACILITY), the syslog type can option. With optional link(<facility>)(TYPE_FACILITY), the syslog type can
@ -755,7 +755,7 @@ label(ADDRESS_NAMED_PIPE)dit(bf(tt(PIPE:<filename>)))
See also: link(unnamed pipe)(ADDRESS_UNNAMED_PIPE) See also: link(unnamed pipe)(ADDRESS_UNNAMED_PIPE)
label(ADDRESS_UNNAMED_PIPE)dit(bf(tt(PIPE))) label(ADDRESS_UNNAMED_PIPE)dit(bf(tt(PIPE)))
Creates an unnamed pipe and uses it for reading and writing. It works as an 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() data.nl()
Note: When socat tries to write more bytes than the pipe can queue (Linux 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 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) See also: link(named pipe)(ADDRESS_NAMED_PIPE), link(SOCKETPAIR)(ADDRESS_SOCKETPAIR)
label(ADDRESS_SOCKETPAIR)dit(bf(tt(SOCKETPAIR))) label(ADDRESS_SOCKETPAIR)dit(bf(tt(SOCKETPAIR)))
Creates a socketpair and uses it for reading and writing. It works as an 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. data. The default socket type is datagram, so it keeps packet boundaries.
nl() nl()
Option groups: link(FD)(GROUP_FD) nl() Option groups: link(FD)(GROUP_FD) nl()
@ -2834,7 +2834,7 @@ label(OPTION_PROXYPORT)dit(bf(tt(proxyport=<TCP service>)))
label(OPTION_IGNORECR)dit(bf(tt(ignorecr))) label(OPTION_IGNORECR)dit(bf(tt(ignorecr)))
The HTTP protocol requires the use of CR+NL as line terminator. When a proxy 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. 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. to ignore CR in the answer. Nevertheless, socat sends CR+NL to the proxy.
label(OPTION_PROXY_AUTHORIZATION)dit(bf(tt(proxy-authorization=<username>:<password>))) label(OPTION_PROXY_AUTHORIZATION)dit(bf(tt(proxy-authorization=<username>:<password>)))
Provide "basic" authentication to the proxy server. The argument to the 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))) 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. 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[=<bool>]))) label(OPTION_IGNBRK)dit(bf(tt(ignbrk[=<bool>])))
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[=<bool>]))) label(OPTION_BRKINT)dit(bf(tt(brkint[=<bool>])))
label(OPTION_BS0)dit(bf(tt(bs0))) label(OPTION_BS0)dit(bf(tt(bs0)))
label(OPTION_BS1)dit(bf(tt(bs1))) label(OPTION_BS1)dit(bf(tt(bs1)))