Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Jan Kratochvil <jan.kratochvil@redhat.com>
Cc: tromey@redhat.com, gdb-patches@sourceware.org
Subject: Re: [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1
Date: Fri, 05 Apr 2013 19:43:00 -0000	[thread overview]
Message-ID: <83r4ioessa.fsf@gnu.org> (raw)
In-Reply-To: <20130405153012.GA25225@host2.jankratochvil.net>

> 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?


  reply	other threads:[~2013-04-05 18:29 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-02-11 20:14 [patch+doc] New gdbinit.5 man page Jan Kratochvil
2013-02-12 16:11 ` Eli Zaretskii
2013-02-12 16:22   ` Jan Kratochvil
2013-02-12 21:20     ` Tom Tromey
2013-02-13 17:42       ` Eli Zaretskii
2013-02-19 16:28         ` Jan Kratochvil
2013-02-19 18:03           ` Eli Zaretskii
2013-02-20  8:44             ` Jan Kratochvil
2013-02-20 19:26               ` Eli Zaretskii
2013-04-04 22:09                 ` [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1 Jan Kratochvil
2013-04-05 11:47                   ` Eli Zaretskii
2013-04-05 13:03                     ` Jan Kratochvil
2013-04-05 13:03                       ` Eli Zaretskii
2013-04-05 17:50                         ` Jan Kratochvil
2013-04-05 16:33                           ` Jan Kratochvil
2013-04-05 18:13                           ` [doc patch] gdb.1: Add -p PID Jan Kratochvil
2013-04-05 18:40                             ` Eli Zaretskii
2013-04-06  9:01                               ` [commit] " Jan Kratochvil
2013-04-05 18:29                           ` [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1 Eli Zaretskii
2013-04-05 19:06                             ` Jan Kratochvil
2013-04-05 19:43                               ` Eli Zaretskii [this message]
2013-04-06  6:47                                 ` Jan Kratochvil
2013-04-06  6:54                                   ` Eli Zaretskii
2013-04-06  8:45                                     ` [commit] " Jan Kratochvil

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83r4ioessa.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=jan.kratochvil@redhat.com \
    --cc=tromey@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox