From 7a185eebbd73ab7de273a1ff24f67dfab4401f5c Mon Sep 17 00:00:00 2001 From: Gerhard Rieger Date: Sun, 3 Jan 2010 23:00:44 +0100 Subject: [PATCH] minor corrections in docu --- CHANGES | 3 +++ doc/socat.yo | 16 ++++++++-------- doc/xio.help | 4 ++-- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/CHANGES b/CHANGES index 8ce1617..24a0a81 100644 --- a/CHANGES +++ b/CHANGES @@ -1,4 +1,7 @@ +corrections: + minor corrections in docu + ####################### V 1.7.1.1: corrections: diff --git a/doc/socat.yo b/doc/socat.yo index c8aaf90..e6466dc 100644 --- a/doc/socat.yo +++ b/doc/socat.yo @@ -536,7 +536,7 @@ label(ADDRESS_OPENSSL_LISTEN)dit(bf(tt(OPENSSL-LISTEN:))) link(TCP)(ADDRESS_TCP_CONNECT) label(ADDRESS_NAMED_PIPE)dit(bf(tt(PIPE:))) If link()(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 (but see option link(unlink-close)(OPTION_UNLINK_CLOSE)nl() Note: When a pipe is used for both reading and writing, it works @@ -1494,22 +1494,22 @@ label(OPTION_NULL_EOF)dit(bf(tt(null-eof))) Normally socat() will ignore empty (zero size payload) packets arriving on datagram sockets, so it survives port scans. With this option socat() 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=))) Calls tt(ioctl()) with the request value as second argument and NULL as third argument. This option allows to utilize ioctls that are not explicitely implemented in socat. -label(OPTION_IOCTL_INT)dit(bf(tt(ioctl-int=:))) +label(OPTION_IOCTL_INT)dit(bf(tt(ioctl-int=:))) Calls tt(ioctl()) with the request value as second argument and the integer value as third argument. -label(OPTION_IOCTL_INTP)dit(bf(tt(ioctl-intp=:))) +label(OPTION_IOCTL_INTP)dit(bf(tt(ioctl-intp=:))) Calls tt(ioctl()) with the request value as second argument and a pointer to the integer value as third argument. -label(OPTION_IOCTL_BIN)dit(bf(tt(ioctl-bin=:))) +label(OPTION_IOCTL_BIN)dit(bf(tt(ioctl-bin=:))) 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 link()(TYPE_DATA) form. -label(OPTION_IOCTL_STRING)dit(bf(tt(ioctl-string=:))) +label(OPTION_IOCTL_STRING)dit(bf(tt(ioctl-string=:))) Calls tt(ioctl()) with the request value as second argument and a pointer to the given string as third argument. link()(TYPE_DATA) form. @@ -3100,9 +3100,9 @@ prompts. label(EXAMPLE_ADDRESS_PTY) label(EXAMPLE_OPTION_SYMBOLIC_LINK) -label(EXAMPLE_OPTION_WAITSLAVE) +label(EXAMPLE_OPTION_WAIT_SLAVE) 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 device (link(PTY)(ADDRESS_PTY)) on the client that can be reached under the diff --git a/doc/xio.help b/doc/xio.help index c1ac403..a767b42 100644 --- a/doc/xio.help +++ b/doc/xio.help @@ -823,7 +823,7 @@ Option group: FD Phase: LATE 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. @@ -1481,7 +1481,7 @@ Phase: PREOPEN Platforms: all 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.