From 52be3b085e1834c8fd426036e903010c06e98028 Mon Sep 17 00:00:00 2001 From: Gerhard Rieger Date: Fri, 2 May 2008 21:17:05 +0200 Subject: [PATCH] doc for ioctl options --- doc/socat.yo | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/doc/socat.yo b/doc/socat.yo index 4befd5b..556aaeb 100644 --- a/doc/socat.yo +++ b/doc/socat.yo @@ -1264,6 +1264,24 @@ label(OPTION_END_CLOSE)dit(bf(tt(end-close))) Similarly, when an address of type EXEC or SYSTEM is ended, socat usually will explicitely kill the sub process. With this option, it will just close the file descriptors. +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=:))) + 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=:))) + 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=:))) + 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=:))) + Calls tt(ioctl()) with the request value as second argument and a pointer to + the given string as third argument. + link()(TYPE_DATA) form. enddit() startdit()enddit()nl() @@ -2413,8 +2431,9 @@ label(TYPE_COMMAND_LINE)dit(command-line) A string specifying a program name and its arguments, separated by single spaces. label(TYPE_DATA)dit(data) - A raw data specification following em(dalan) syntax. The only documented - form is a string starting with 'x' followed by an even number of hex digits. + A raw data specification following em(dalan) syntax. Currently the only + valid form is a string starting with 'x' followed by an even number of hex + digits, specifying a sequence of bytes. label(TYPE_DIRECTORY)dit(directory) A string with usual unix() directory name semantics. label(TYPE_FACILITY)dit(facility)