This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Jan Kratochvil <jan dot kratochvil at redhat dot com>
- Cc: tromey at redhat dot com, gdb-patches at sourceware dot org
- Date: Fri, 05 Apr 2013 21:28:21 +0300
- Subject: Re: [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1
- References: <20130219162741 dot GA4493 at host2 dot jankratochvil dot net> <838v6kp4gu dot fsf at gnu dot org> <20130220084353 dot GA801 at host2 dot jankratochvil dot net> <83fw0qokfw dot fsf at gnu dot org> <20130404160915 dot GA11966 at host2 dot jankratochvil dot net> <83sj36fcxb dot fsf at gnu dot org> <20130404171439 dot GA20464 at host2 dot jankratochvil dot net> <83obduf9ny dot fsf at gnu dot org> <20130405150101 dot GA15883 at host2 dot jankratochvil dot net> <83wqshdmsk dot fsf at gnu dot org> <20130405153012 dot GA25225 at host2 dot jankratochvil dot net>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> Date: Fri, 5 Apr 2013 17:30:12 +0200
> From: Jan Kratochvil <jan.kratochvil@redhat.com>
> Cc: tromey@redhat.com, gdb-patches@sourceware.org
>
> On Fri, 05 Apr 2013 17:23:07 +0200, Eli Zaretskii wrote:
> > > On Thu, 04 Apr 2013 20:11:29 +0200, Eli Zaretskii wrote:
> > > > > +@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
> [...]
> > No, of course not. But if you use @verbatim..@end verbatim around
> > this block, you can simply format the text exactly as you want it in
> > the produced formats, and makeinfo will not fill or reindent that
> > text.
>
> But with @verbatim I cannot use various highlighting with the @option or @var
> keywords. I want the highlighting both for info and for man.
>
> And putting @verbatim into it as is the info viewer then displays:
>
> File: gdb.info, Node: gdb man, Next: gdbserver man, Up: Man Pages
>
> gdb man
> =======
>
> gdb [@option{-help}] [@option{-nh}] [@option{-nx}] [@option{-q}]
> [@option{-batch}] [@option{-cd=}@var{dir}] [@option{-f}]
> [@option{-b}@w{ }@var{bps}]
> ...
Right, forgot about that, sorry. How about this:
@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
It looks good in Info, but I didn't try the other formats.
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
WDYT?