From 40f6fa29e135c57786c0bbc6762dccec6e280af2 Mon Sep 17 00:00:00 2001 From: Gerhard Rieger Date: Fri, 12 Aug 2016 16:35:32 +0200 Subject: [PATCH] Corrected source of socat man page to correctly show man references --- CHANGES | 4 ++++ doc/socat.yo | 44 ++++++++++++++++++++++---------------------- 2 files changed, 26 insertions(+), 22 deletions(-) diff --git a/CHANGES b/CHANGES index 12f63be..654b889 100644 --- a/CHANGES +++ b/CHANGES @@ -88,6 +88,10 @@ testing: A few corrections in test.sh +docu: + Corrected source of socat man page to correctly show man references + like socket(2); removed obseolete entries from See Also + legal: Added contributors to copyright notices. Suggested by Matt Braithwaite. diff --git a/doc/socat.yo b/doc/socat.yo index 6bd7135..717f0c0 100644 --- a/doc/socat.yo +++ b/doc/socat.yo @@ -698,7 +698,7 @@ label(ADDRESS_SCTP6_LISTEN)dit(bf(tt(SCTP6-LISTEN:))) Option groups: link(FD)(GROUP_FD),link(SOCKET)(GROUP_SOCKET),link(LISTEN)(GROUP_LISTEN),link(CHILD)(GROUP_CHILD),link(RANGE)(GROUP_RANGE),link(IP6)(GROUP_IP6),link(SCTP)(GROUP_SCTP),link(RETRY)(GROUP_RETRY) nl() label(ADDRESS_SOCKET_CONNECT)dit(bf(tt(SOCKET-CONNECT:::))) Creates a stream socket using the first and second given socket parameters - and tt(SOCK_STREAM) (see man socket\(2)) and connects to the remote-address. + and tt(SOCK_STREAM) (see man NOEXPAND(socket(2))) and connects to the remote-address. The two socket parameters have to be specified by link(int)(TYPE_INT) numbers. Consult your OS documentation and include files to find the appropriate values. The remote-address must be the link(data)(TYPE_DATA) @@ -722,7 +722,7 @@ label(ADDRESS_SOCKET_CONNECT)dit(bf(tt(SOCKET-CONNECT::::::))) Creates a datagram socket using the first three given socket parameters (see - man socket\(2)) and sends outgoing data to the remote-address. The three + man NOEXPAND(socket(2))) and sends outgoing data to the remote-address. The three socket parameters have to be specified by link(int)(TYPE_INT) numbers. Consult your OS documentation and include files to find the appropriate values. The remote-address must be the link(data)(TYPE_DATA) @@ -747,7 +747,7 @@ label(ADDRESS_SOCKET_DATAGRAM)dit(bf(tt(SOCKET-DATAGRAM:::::))) Creates a stream socket using the first and second given socket parameters - and tt(SOCK_STREAM) (see man socket\(2)) and waits for incoming connections + and tt(SOCK_STREAM) (see man NOEXPAND(socket(2))) and waits for incoming connections on local-address. The two socket parameters have to be specified by link(int)(TYPE_INT) numbers. Consult your OS documentation and include files to find the appropriate values. The local-address must be the @@ -770,7 +770,7 @@ label(ADDRESS_SOCKET_LISTEN)dit(bf(tt(SOCKET-LISTEN::::::))) - Creates a socket using the three given socket parameters (see man socket\(2)) + Creates a socket using the three given socket parameters (see man NOEXPAND(socket(2))) and binds it to . Receives arriving data. The three parameters have to be specified by link(int)(TYPE_INT) numbers. Consult your OS documentation and include files to find the appropriate values. The @@ -791,7 +791,7 @@ label(ADDRESS_SOCKET_RECV)dit(bf(tt(SOCKET-RECV:::::::))) - Creates a socket using the three given socket parameters (see man socket\(2)) + Creates a socket using the three given socket parameters (see man NOEXPAND(socket(2))) and binds it to . Receives arriving data and sends replies back to the sender. The first three parameters have to be specified as link(int)(TYPE_INT) numbers. Consult your OS documentation and include files @@ -815,7 +815,7 @@ label(ADDRESS_SOCKET_RECVFROM)dit(bf(tt(SOCKET-RECVFROM::::::))) Creates a socket using the three given socket parameters (see man - socket\(2)). Sends outgoing data to the given address and receives replies. + NOEXPAND(socket(2))). Sends outgoing data to the given address and receives replies. The three parameters have to be specified as link(int)(TYPE_INT) numbers. Consult your OS documentation and include files to find the appropriate values. The remote-address must be the link(data)(TYPE_DATA) @@ -1503,10 +1503,10 @@ label(OPTION_SHUT_NONE)dit(bf(tt(shut-none))) connection to not do anything. label(OPTION_SHUT_DOWN)dit(bf(tt(shut-down))) Changes the (address dependent) method of shutting down the write part of a - connection to tt(shutdown\(fd, SHUT_WR)). Is only useful with sockets. + connection to tt(NOEXPAND(shutdown(fd, SHUT_WR))). Is only useful with sockets. label(OPTION_SHUT_CLOSE)dit(bf(tt(shut-close))) Changes the (address dependent) method of shutting down the write part of a - connection to tt(close\(fd)). + connection to tt(NOEXPAND(close(fd))). label(OPTION_SHUT_NULL)dit(bf(tt(shut-null))) When one address indicates EOF, socat() will send a zero sized packet to the write channel of the other address to transfer the EOF condition. This is @@ -1754,7 +1754,7 @@ label(OPTION_NOECHO)dit(bf(tt(noecho=))) The prompt is defined as the text that was output to the readline address after the lastest newline character and before an input character was typed. The pattern is a regular expression, e.g. - "^[Pp]assword:.*$" or "([Uu]ser:|[Pp]assword:)". See regex\(7) for details. + "^[Pp]assword:.*$" or "([Uu]ser:|[Pp]assword:)". See NOEXPAND(regex(7)) for details. (link(example)(EXAMPLE_OPTION_NOECHO)) label(OPTION_PROMPT)dit(bf(tt(prompt=))) Passes the string as prompt to the readline function. readline prints this @@ -1935,7 +1935,7 @@ label(OPTION_SETSOCKOPT_INT)dit(bf(tt(setsockopt-int=::) set. For the actual numbers you might have to look up the appropriate include files of your system. The 4th tt(setsockopt()) parameter, tt(value) [link(int)(TYPE_INT)], is passed to the function per pointer, and for the - length parameter sizeof\(int) is taken implicitely. + length parameter NOEXPAND(sizeof(int)) is taken implicitely. label(OPTION_SETSOCKOPT_BIN)dit(bf(tt(setsockopt-bin=::))) Like tt(setsockopt-int), but must be provided in link(dalan)(TYPE_DATA) format and specifies an arbitrary sequence of bytes; @@ -2057,7 +2057,7 @@ label(OPTION_RES_DEFNAMES)dit(bf(tt(res-defnames))) label(OPTION_RES_STAYOPEN)dit(bf(tt(res-stayopen))) label(OPTION_RES_DNSRCH)dit(bf(tt(res-dnsrch))) These options set the corresponding resolver (name resolution) option flags. - Append "=0" to clear a default option. See man resolver\(5) for more + Append "=0" to clear a default option. See man NOEXPAND(resolver(5)) for more information on these options. Note: these options are valid only for the address they are applied to. @@ -2164,7 +2164,7 @@ label(OPTION_TCP_CONN_ABORT_THRESHOLD)dit(bf(tt(conn-abort-threshold= label(SEEALSO) manpageseealso() -COMMENT(procan\(1), filan\(1), ) -nc\(1), netcat6\(1), sock\(1), rinetd\(8), cage\(1), socks.conf\(5), openssl\(1), -stunnel\(8), pty\(1), rlwrap\(1), setsid\(1) +COMMENT(NOEXPAND(procan(1)), NOEXPAND(filan(1)), ) +NOEXPAND(nc(1)), NOEXPAND(rinetd(8)), NOEXPAND(openssl(1)), +NOEXPAND(stunnel(8)), NOEXPAND(rlwrap(1)), NOEXPAND(setsid(1)) Socat() home page lurl(http://www.dest-unreach.org/socat/)