Re: [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1

Jan Kratochvil
2013-04-05T19:43:08Z

On Fri, 05 Apr 2013 20:28:21 +0200, Eli Zaretskii wrote:
> It looks good in Info, but I didn't try the other formats.

It's all not that simple I really spent *a lot* of time trying a combination
which is acceptable for both info and man (+briefly checked PDF)

The man output can be tested with:
make gdb.1;nroff -man gdb.1|less -r

> @c man begin SYNOPSIS gdb
> @quotation
> gdb [@option{-help}] [@option{-nh}] [@option{-nx}] [@option{-q}] [@option{-batch}] [@option{-cd=}@var{dir}] [@option{-f}]@*
> @w{ }[@option{-b}@w{ }@var{bps}] [@option{-tty=}@var{dev}] [@option{-s} @var{symfile}] [@option{-e}@w{ }@var{prog}] [@option{-se}@w{ }@var{prog}]@*
> @w{ }[@option{-c}@w{ }@var{core}] [@option{-x}@w{ }@var{cmds}] [@option{-d}@w{ }@var{dir}] [@var{prog}|@var{core}|@var{procID}]@*
> @end quotation
> @c man end

./../../etc/texi2pod.pl:
@end quotation without @quotation at line 41625

One has to use:

------------------------------------------------------------------------------
@c man begin SYNOPSIS gdb
@quotation
gdb [@option{-help}] [@option{-nh}] [@option{-nx}] [@option{-q}] [@option{-batch}] [@option{-cd=}@var{dir}] [@option{-f}]@*
@w{ }[@option{-b}@w{ }@var{bps}] [@option{-tty=}@var{dev}] [@option{-s} @var{symfile}] [@option{-e}@w{ }@var{prog}] [@option{-se}@w{ }@var{prog}]@*
@w{ }[@option{-c}@w{ }@var{core}] [@option{-x}@w{ }@var{cmds}] [@option{-d}@w{ }@var{dir}] [@var{prog} [@var{core}]|@var{procID}]
@end quotation
@c man end
------------------------------------------------------------------------------

but then the man page is not right:

------------------------------------------------------------------------------
SYNOPSIS
gdb [-help] [-nh] [-nx] [-q] [-batch] [-cd=dir] [-f] [-b bps]
[-tty=dev] [-s symfile] [-e prog] [-se prog] [-c core] [-x cmds]
[-d dir] [prog [core]|procID]
------------------------------------------------------------------------------

> On second thought, this is even better, I think:
>
> @c man begin SYNOPSIS gdb
> @example
> gdb [-help] [-nx] [-q] [-batch] [-cd=@var{dir}] [-f] [-b bps] [-tty=@var{dev}]
> [-s @var{symfile}] [-e @var{prog}] [-se @var{prog}] [-c @var{core}] [-x @var{file}] [-ex @var{cmd}]
> [-d @var{dir}] [@var{prog}[@var{core}|@var{procID}]]
> @end example
> @c man end

Again the man output is unusable:

------------------------------------------------------------------------------
NAME
gdb - The GNU Debugger

SYNOPSIS
gdb [-help] [-nx] [-q] [-batch] [-cd= ] [-f] [-b bps] [-tty=<dev>]
[-s <symfile>] [-e <prog>] [-se <prog>] [-c <core>] [-x <file>] [-ex <cmd>]
[-d ] [<prog>[<core>|<procID>]]

DESCRIPTION
The purpose of a debugger such as GDB is to allow you to see what is
------------------------------------------------------------------------------

I find it relatively good this way (with some minor adjustments to do)::

------------------------------------------------------------------------------
@c man begin SYNOPSIS gdb
gdb [-help] [-nx] [-q] [-batch] [-cd=@var{dir}] [-f] [-b bps] [-tty=@var{dev}]
[-s @var{symfile}] [-e @var{prog}] [-se @var{prog}] [-c @var{core}] [-x @var{file}] [-ex @var{cmd}]
[-d @var{dir}] [@var{prog}[@var{core}|@var{procID}]]
@c man end
------------------------------------------------------------------------------
NAME
gdb - The GNU Debugger

SYNOPSIS
gdb [-help] [-nx] [-q] [-batch] [-cd=I ] [-f] [-b bps] [-tty=I<dev>]
[-s I<symfile>] [-e I<prog>] [-se I<prog>] [-c I<core>] [-x I<file>] [-ex I<cmd>]
[-d I ] [I<prog>[I<core>|I<procID>]]

DESCRIPTION
The purpose of a debugger such as GDB is to allow you to see what is
------------------------------------------------------------------------------

But I found the initial indentation of "gdb" one space right is too disturbing
in the man page.

Therefore do you find acceptable the initial form I posted?

------------------------------------------------------------------------------
@c man begin SYNOPSIS gdb
gdb [@option{-help}] [@option{-nh}] [@option{-nx}] [@option{-q}]
[@option{-batch}] [@option{-cd=}@var{dir}] [@option{-f}]
[@option{-b}@w{ }@var{bps}]
[@option{-tty=}@var{dev}] [@option{-s} @var{symfile}]
[@option{-e}@w{ }@var{prog}] [@option{-se}@w{ }@var{prog}]
[@option{-c}@w{ }@var{core}] [@option{-x}@w{ }@var{cmds}]
[@option{-d}@w{ }@var{dir}] [@var{prog} [@var{core}]|@var{procID}]
@c man end
------------------------------------------------------------------------------
gdb - The GNU Debugger

SYNOPSIS
gdb [-help] [-nh] [-nx] [-q] [-batch] [-cd=dir] [-f] [-b bps]
[-tty=dev] [-s symfile] [-e prog] [-se prog] [-c core] [-x cmds]
[-d dir] [prog|core|procID]

DESCRIPTION
The purpose of a debugger such as GDB is to allow you to see what is
------------------------------------------------------------------------------

Thanks,
Jan