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

minor corrections in docu

Browse source
This commit is contained in:
Gerhard Rieger 2012-07-21 15:49:41 +02:00
parent 27eb0a30b6
commit 13f830a533
3 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGES
View file

@ -22,7 +22,7 @@ corrections:
docu mentions option so-bindtodev but correct name is so-bindtodevice. docu mentions option so-bindtodev but correct name is so-bindtodevice.
Thanks to Jim Zimmerman for reporting. Thanks to Jim Zimmerman for reporting.
minor corrections in doc minor corrections in doc (2x)
####################### V 2.0.0-b7: ####################### V 2.0.0-b7:

18
doc/socat.yo
View file

@ -10,7 +10,7 @@ def(Filan)(0)(bf(Filan))
def(procan)(0)(bf(procan)) def(procan)(0)(bf(procan))
def(Procan)(0)(bf(Procan)) def(Procan)(0)(bf(Procan))
manpage(socat)(1)(Apr 2009)()() manpage(socat)(1)(Apr 2012)()()
whenhtml( whenhtml(
label(CONTENTS) label(CONTENTS)
@ -586,7 +586,7 @@ label(ADDRESS_OPENSSL_LISTEN)dit(bf(tt(OPENSSL-LISTEN:<port>)))
link(TCP)(ADDRESS_TCP_CONNECT) link(TCP)(ADDRESS_TCP_CONNECT)
label(ADDRESS_NAMED_PIPE)dit(bf(tt(PIPE:<filename>))) label(ADDRESS_NAMED_PIPE)dit(bf(tt(PIPE:<filename>)))
If link(<filename>)(TYPE_FILENAME) already exists, it is opened. If link(<filename>)(TYPE_FILENAME) already exists, it is opened.
If is does not exist, a named pipe is created and opened. Beginning with If it does not exist, a named pipe is created and opened. Beginning with
socat() version 1.4.3, the named pipe is removed when the address is closed socat() version 1.4.3, the named pipe is removed when the address is closed
(but see option link(unlink-close)(OPTION_UNLINK_CLOSE)nl() (but see option link(unlink-close)(OPTION_UNLINK_CLOSE)nl()
Note: When a pipe is used for both reading and writing, it works Note: When a pipe is used for both reading and writing, it works
@ -1561,22 +1561,22 @@ label(OPTION_NULL_EOF)dit(bf(tt(null-eof)))
Normally socat() will ignore empty (zero size payload) packets arriving on Normally socat() will ignore empty (zero size payload) packets arriving on
datagram sockets, so it survives port scans. With this option socat() datagram sockets, so it survives port scans. With this option socat()
interprets empty datagram packets as EOF indicator (see interprets empty datagram packets as EOF indicator (see
link(shut-null)(OPTION_SHUT_NULL). link(shut-null)(OPTION_SHUT_NULL)).
label(OPTION_IOCTL_VOID)dit(bf(tt(ioctl-void=<request>))) label(OPTION_IOCTL_VOID)dit(bf(tt(ioctl-void=<request>)))
Calls tt(ioctl()) with the request value as second argument and NULL as Calls tt(ioctl()) with the request value as second argument and NULL as
third argument. This option allows to utilize ioctls that are not third argument. This option allows to utilize ioctls that are not
explicitely implemented in socat. explicitely implemented in socat.
label(OPTION_IOCTL_INT)dit(bf(tt(ioctl-int=<reqeust>:<value>))) label(OPTION_IOCTL_INT)dit(bf(tt(ioctl-int=<request>:<value>)))
Calls tt(ioctl()) with the request value as second argument and the integer Calls tt(ioctl()) with the request value as second argument and the integer
value as third argument. value as third argument.
label(OPTION_IOCTL_INTP)dit(bf(tt(ioctl-intp=<reqeust>:<value>))) label(OPTION_IOCTL_INTP)dit(bf(tt(ioctl-intp=<request>:<value>)))
Calls tt(ioctl()) with the request value as second argument and a pointer to Calls tt(ioctl()) with the request value as second argument and a pointer to
the integer value as third argument. the integer value as third argument.
label(OPTION_IOCTL_BIN)dit(bf(tt(ioctl-bin=<reqeust>:<value>))) label(OPTION_IOCTL_BIN)dit(bf(tt(ioctl-bin=<request>:<value>)))
Calls tt(ioctl()) with the request value as second argument and a pointer to Calls tt(ioctl()) with the request value as second argument and a pointer to
the given data value as third argument. This data must be specified in the given data value as third argument. This data must be specified in
link(<dalan>)(TYPE_DATA) form. link(<dalan>)(TYPE_DATA) form.
label(OPTION_IOCTL_STRING)dit(bf(tt(ioctl-string=<reqeust>:<value>))) label(OPTION_IOCTL_STRING)dit(bf(tt(ioctl-string=<request>:<value>)))
Calls tt(ioctl()) with the request value as second argument and a pointer to Calls tt(ioctl()) with the request value as second argument and a pointer to
the given string as third argument. the given string as third argument.
link(<dalan>)(TYPE_DATA) form. link(<dalan>)(TYPE_DATA) form.
@ -3186,9 +3186,9 @@ prompts.
label(EXAMPLE_ADDRESS_PTY) label(EXAMPLE_ADDRESS_PTY)
label(EXAMPLE_OPTION_SYMBOLIC_LINK) label(EXAMPLE_OPTION_SYMBOLIC_LINK)
label(EXAMPLE_OPTION_WAITSLAVE) label(EXAMPLE_OPTION_WAIT_SLAVE)
label(EXAMPLE_OPTION_NONBLOCK) label(EXAMPLE_OPTION_NONBLOCK)
(bf(tt(socat PTY,link=$HOME/dev/vmodem0,raw,echo=0,waitslave EXEC:'"ssh modemserver.us.org socat - /dev/ttyS0,nonblock,raw,echo=0"'))) (bf(tt(socat PTY,link=$HOME/dev/vmodem0,raw,echo=0,wait-slave EXEC:'"ssh modemserver.us.org socat - /dev/ttyS0,nonblock,raw,echo=0"')))
generates a pseudo terminal generates a pseudo terminal
device (link(PTY)(ADDRESS_PTY)) on the client that can be reached under the device (link(PTY)(ADDRESS_PTY)) on the client that can be reached under the

4
doc/xio.help
View file

@ -823,7 +823,7 @@ Option group: FD
Phase: LATE Phase: LATE
Platforms: all Platforms: all
This option changes the mode (permissions) of a file descriptor with fchown() This option changes the mode (permissions) of a file descriptor with fchmod()
in the last phase of address processing. in the last phase of address processing.
@ -1481,7 +1481,7 @@ Phase: PREOPEN
Platforms: all Platforms: all
This option changes the mode (permissions) of an already existing filesystem This option changes the mode (permissions) of an already existing filesystem
entry with chown() before the file is opened or after the UNIX domain socket is entry with chmod() before the file is opened or after the UNIX domain socket is
bound, but before it listens/connects. bound, but before it listens/connects.