diff options
| author | Øyvind Harboe <oyvind.harboe@zylin.com> | 2010-09-27 22:55:30 +0200 |
|---|---|---|
| committer | Øyvind Harboe <oyvind.harboe@zylin.com> | 2010-10-01 10:26:10 +0200 |
| commit | 96a56ba086ec94e577e4b3562010710abb2087c6 (patch) | |
| tree | 77a87937ea11f785bd44a5f5ca974c3a84f274e2 /doc | |
| parent | 50d5441e2a615fb2c44b41a777e4373901f7a2e6 (diff) | |
| download | openocd_libswd-96a56ba086ec94e577e4b3562010710abb2087c6.tar.gz openocd_libswd-96a56ba086ec94e577e4b3562010710abb2087c6.tar.bz2 openocd_libswd-96a56ba086ec94e577e4b3562010710abb2087c6.tar.xz openocd_libswd-96a56ba086ec94e577e4b3562010710abb2087c6.zip | |
pipes: add documentation for pipes
Stick with the name "gdb_port" even if this command
can be used for other things(disable, named pipes,
anonymous stdin/out pipe). "port" is correct for
probably more than 90% of use cases, if not more.
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/openocd.texi | 27 |
1 files changed, 22 insertions, 5 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi index 77a0ad3b..5387082d 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -1910,12 +1910,29 @@ use the command line @option{-pipe} option. @deffn {Command} gdb_port [number] @cindex GDB server -Specify or query the first port used for incoming GDB connections. -The GDB port for the -first target will be gdb_port, the second target will listen on gdb_port + 1, and so on. +Normally gdb listens to a TCP/IP port, but GDB can also +communicate via pipes(stdin/out or named pipes). The name +"gdb_port" stuck because it covers probably more than 90% of +the normal use cases. + +No arguments reports GDB port. "pipe" means listen to stdin +output to stdout, an integer is base port number, "disable" +disables the gdb server. + +When using "pipe", also use log_output to redirect the log +output to a file so as not to flood the stdin/out pipes. + +The -p/--pipe option is deprecated and a warning is printed +as it is equivalent to passing in -c "gdb_port pipe; log_output openocd.log". + +Any other string is interpreted as named pipe to listen to. +Output pipe is the same name as input pipe, but with 'o' appended, +e.g. /var/gdb, /var/gdbo. + +The GDB port for the first target will be the base port, the +second target will listen on gdb_port + 1, and so on. When not specified during the configuration stage, the port @var{number} defaults to 3333. -When specified as zero, GDB remote access ports are not activated. @end deffn @deffn {Command} tcl_port [number] @@ -1925,7 +1942,7 @@ output from the Tcl engine. Intended as a machine interface. When not specified during the configuration stage, the port @var{number} defaults to 6666. -When specified as zero, this port is not activated. + @end deffn @deffn {Command} telnet_port [number] |