doc for ioctl options

This commit is contained in:
Gerhard Rieger 2008-05-02 21:17:05 +02:00
parent 2c2508fc62
commit 52be3b085e
1 changed files with 21 additions and 2 deletions

View File

@ -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 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 will explicitely kill the sub process. With this option, it will just close
the file descriptors. the file descriptors.
label(OPTION_IOCTL_VOID)dit(bf(tt(ioctl-void=<request>)))
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=<reqeust>:<value>)))
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=<reqeust>:<value>)))
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=<reqeust>:<value>)))
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(<dalan>)(TYPE_DATA) form.
label(OPTION_IOCTL_STRING)dit(bf(tt(ioctl-string=<reqeust>:<value>)))
Calls tt(ioctl()) with the request value as second argument and a pointer to
the given string as third argument.
link(<dalan>)(TYPE_DATA) form.
enddit() enddit()
startdit()enddit()nl() 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 A string specifying a program name and its arguments, separated by single
spaces. spaces.
label(TYPE_DATA)dit(data) label(TYPE_DATA)dit(data)
A raw data specification following em(dalan) syntax. The only documented A raw data specification following em(dalan) syntax. Currently the only
form is a string starting with 'x' followed by an even number of hex digits. 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) label(TYPE_DIRECTORY)dit(directory)
A string with usual unix() directory name semantics. A string with usual unix() directory name semantics.
label(TYPE_FACILITY)dit(facility) label(TYPE_FACILITY)dit(facility)