From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 26224 invoked by alias); 5 Apr 2013 18:13:27 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 26211 invoked by uid 89); 5 Apr 2013 18:13:26 -0000 X-Spam-SWARE-Status: No, score=-7.5 required=5.0 tests=AWL,BAYES_00,KHOP_RCVD_UNTRUST,RCVD_IN_DNSWL_HI,RCVD_IN_HOSTKARMA_W,RP_MATCHES_RCVD,SPF_HELO_PASS autolearn=ham version=3.3.1 Received: from mx1.redhat.com (HELO mx1.redhat.com) (209.132.183.28) by sourceware.org (qpsmtpd/0.84/v0.84-167-ge50287c) with ESMTP; Fri, 05 Apr 2013 18:13:23 +0000 Received: from int-mx11.intmail.prod.int.phx2.redhat.com (int-mx11.intmail.prod.int.phx2.redhat.com [10.5.11.24]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id r35IDLj3019456 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Fri, 5 Apr 2013 14:13:21 -0400 Received: from host2.jankratochvil.net (ovpn-116-44.ams2.redhat.com [10.36.116.44]) by int-mx11.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id r35IDGZk019344 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NO) for ; Fri, 5 Apr 2013 14:13:19 -0400 Date: Fri, 05 Apr 2013 19:33:00 -0000 From: Jan Kratochvil To: gdb-patches@sourceware.org Subject: [doc patch] gdbserver.1: Document all the options and --multi Message-ID: <20130405181316.GA3675@host2.jankratochvil.net> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.5.21 (2010-09-15) X-IsSubscribed: yes X-SW-Source: 2013-04/txt/msg00136.txt.bz2 Hi Eli, patch is dependent on the pending patch: Re: [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1 http://sourceware.org/ml/gdb-patches/2013-04/msg00120.html Message-ID: <20130405150101.GA15883@host2.jankratochvil.net> gdbserver man page was missing various parts. The text I usually took from their existing gdb.texinfo description although I tried to make them more brief for the man page. Thanks, Jan gdb/doc/ 2013-04-05 Jan Kratochvil * gdb.texinfo (gdbserver man): Rename tty to comm. Swap --attach parameters order. Remove "On some targets" for --attach. Document the --multi parameter and extended-remote command. Document all the options. diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index 2f9c68a..6263dab 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -41864,9 +41864,11 @@ Richard M. Stallman and Roland H. Pesch, July 1991. @c man title gdbserver Remote Server for the GNU Debugger @format @c man begin SYNOPSIS gdbserver -gdbserver @var{tty} @var{prog} [@var{args}@dots{}] +gdbserver @var{comm} @var{prog} [@var{args}@dots{}] -gdbserver @var{tty} --attach @var{PID} +gdbserver --attach @var{comm} @var{pid} + +gdbserver --multi @var{comm} @c man end @end format @@ -41926,16 +41928,25 @@ ports on the target system. This same port number must be used in the host you chose a port number that conflicts with another service, @command{gdbserver} will print an error message and exit. -On some targets, @command{gdbserver} can also attach to running programs. +@command{gdbserver} can also attach to running programs. This is accomplished via the @option{--attach} argument. The syntax is: @smallexample -target> gdbserver @var{comm} --attach @var{pid} +target> gdbserver --attach @var{comm} @var{pid} @end smallexample @var{pid} is the process ID of a currently running process. It isn't necessary to point @command{gdbserver} at a binary for the running process. +To start @code{gdbserver} without supplying an initial command to run +or process ID to attach, use the @option{--multi} command line option. +In such case you should connect using @kbd{target extended-remote} to start +the program you want to debug. + +@smallexample +target> gdbserver --multi @var{comm} +@end smallexample + @ifclear man @subheading Usage (host side) @end ifclear @@ -41948,7 +41959,8 @@ You need an unstripped copy of the target program on your host system, since would, with the target program as the first argument. (You may need to use the @option{--baud} option if the serial line is running at anything except 9600 baud.) That is @code{gdb TARGET-PROG}, or @code{gdb --baud BAUD TARGET-PROG}. After that, the only -new command you need to know about is @code{target remote}. It's argument is either +new command you need to know about is @code{target remote} +(or @code{target extended-remote}. It's argument is either a device name (usually a serial device, like @file{/dev/ttyb}), or a @code{HOST:PORT} descriptor. For example: @@ -41975,12 +41987,112 @@ you previously started up @command{gdbserver} with the same port number. Note t TCP connections, you must start up @command{gdbserver} prior to using the `target remote' command, otherwise you may get an error that looks something like `Connection refused'. + +@command{gdbserver} can also debug multiple inferiors at once, +described in +@ifset man +the @value{GDBN} manual in node @code{Inferiors and Programs} +-- shell command @code{info -f gdb -n 'Inferiors and Programs'}. +@end ifset +@ifclear man +@ref{Inferiors and Programs}. +@end ifclear +In such case use the @code{extended-remote} @value{GDBN} command variant: + +@smallexample +(gdb) target extended-remote the-target:2345 +@end smallexample + +The @command{gdbserver} option @option{--multi} may or may not be used in such +case. @c man end @c man begin OPTIONS gdbserver -You have to supply the name of the program to debug -and the tty to communicate on; the remote @value{GDBN} will do everything else. -Any remaining arguments will be passed to the program verbatim. +The three mode of executing @command{gdbserver} has the following three modes +of execution. + +The @var{comm} parameter always specifies how to communicate with @value{GDBN}, +users typically use local TCP port 1234 specified as a @code{:1234} string. + +@table @env + +@item gdbserver @var{comm} @var{prog} [@var{args}@dots{}] +You have to supply how to communicate with @value{GDBN} (typically local TCP +port @code{:1234}) and the name of the program to debug; the remote +@value{GDBN} will do everything else. Any remaining arguments will be passed +to the program verbatim. + +@item gdbserver --attach @var{comm} @var{pid} +You have to supply how to communicate with @value{GDBN} (typically local TCP +port @code{:1234}) and @var{pid} of a running program; @value{GDBN} will do +everything else. + +@item gdbserver --multi @var{comm} +You have to supply how to communicate with @value{GDBN} (typically local TCP +port @code{:1234}); @value{GDBN} can then instruct @command{gdbserver} which +command(s) to run. + +@end table + +In each of the modes one may specify these options: + +@table @env + +@item --help +List all options, with brief explanations. + +@item --version +This option causes @command{gdbserver} to print its version number and exit. + +@item --attach +@command{gdbserver} will attach to a running program. The syntax is: + +@smallexample +target> gdbserver --attach @var{comm} @var{pid} +@end smallexample + +@var{pid} is the process ID of a currently running process. It isn't +necessary to point @command{gdbserver} at a binary for the running process. + +@item --multi +To start @code{gdbserver} without supplying an initial command to run +or process ID to attach, use this command line option. +Then you can connect using @kbd{target extended-remote} and start +the program you want to debug. The syntax is: + +@smallexample +target> gdbserver --multi @var{comm} +@end smallexample + +@item --debug +Enable @code{gdbserver} to display extra status information about the debugging +process. +This option is intended for @code{gdbserver} development and for bug reports to +the developers. + +@item --remote-debug +Enable @code{gdbserver} to display remote protocol debug output. +This option is intended for @code{gdbserver} development and for bug reports to +the developers. + +@item --wrapper +Specify a wrapper to launch programs +for debugging. The option should be followed by the name of the +wrapper, then any command-line arguments to pass to the wrapper, then +@kbd{--} indicating the end of the wrapper arguments. + +@item --once +By default, @command{gdbserver} keeps the listening TCP port open, so that +additional connections are possible. However, if you start @code{gdbserver} +with the @option{--once} option, it will stop listening for any further +connection attempts after connecting to the first @value{GDBN} session. + +@c --disable-packet is not documented for users. + +@c --disable-randomization and --no-disable-randomization are superseded by +@c QDisableRandomization. + +@end table @c man end @c man begin SEEALSO gdbserver