From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 18078 invoked by alias); 5 Apr 2013 19:43:08 -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 18068 invoked by uid 89); 5 Apr 2013 19:43:07 -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,TW_YM 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 19:43:04 +0000 Received: from int-mx09.intmail.prod.int.phx2.redhat.com (int-mx09.intmail.prod.int.phx2.redhat.com [10.5.11.22]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id r35Jh29s028147 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Fri, 5 Apr 2013 15:43:02 -0400 Received: from host2.jankratochvil.net (ovpn-116-44.ams2.redhat.com [10.36.116.44]) by int-mx09.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id r35JguIk002709 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NO); Fri, 5 Apr 2013 15:42:58 -0400 Date: Sat, 06 Apr 2013 06:47:00 -0000 From: Jan Kratochvil To: Eli Zaretskii Cc: tromey@redhat.com, gdb-patches@sourceware.org Subject: Re: [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1 Message-ID: <20130405194255.GA7927@host2.jankratochvil.net> References: <20130220084353.GA801@host2.jankratochvil.net> <83fw0qokfw.fsf@gnu.org> <20130404160915.GA11966@host2.jankratochvil.net> <83sj36fcxb.fsf@gnu.org> <20130404171439.GA20464@host2.jankratochvil.net> <83obduf9ny.fsf@gnu.org> <20130405150101.GA15883@host2.jankratochvil.net> <83wqshdmsk.fsf@gnu.org> <20130405153012.GA25225@host2.jankratochvil.net> <83r4ioessa.fsf@gnu.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <83r4ioessa.fsf@gnu.org> User-Agent: Mutt/1.5.21 (2010-09-15) X-IsSubscribed: yes X-SW-Source: 2013-04/txt/msg00144.txt.bz2 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=] [-s ] [-e ] [-se ] [-c ] [-x ] [-ex ] [-d ] [[|]] 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] [-s I] [-e I] [-se I] [-c I] [-x I] [-ex I] [-d I] [I[I|I]] 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