From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Neil Jerram Newsgroups: gmane.lisp.guile.bugs Subject: Re: More missing options for guile/doc/guile.1 Date: Wed, 26 Jan 2011 21:49:02 +0000 Message-ID: <87wrlrqqsx.fsf@ossau.uklinux.net> References: <8CD818E9822F6DE-D0C-29CF8@Webmail-m115.sysops.aol.com> <8739otg977.fsf@ossau.uklinux.net> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: dough.gmane.org 1296078603 7886 80.91.229.12 (26 Jan 2011 21:50:03 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Wed, 26 Jan 2011 21:50:03 +0000 (UTC) Cc: bug-guile@gnu.org To: Andy Wingo Original-X-From: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Wed Jan 26 22:49:57 2011 Return-path: Envelope-to: guile-bugs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1PiDFS-0000yC-EZ for guile-bugs@m.gmane.org; Wed, 26 Jan 2011 22:49:54 +0100 Original-Received: from localhost ([127.0.0.1]:47548 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PiDFS-0005Fe-38 for guile-bugs@m.gmane.org; Wed, 26 Jan 2011 16:49:54 -0500 Original-Received: from [140.186.70.92] (port=50662 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PiDFM-0005E6-HC for bug-guile@gnu.org; Wed, 26 Jan 2011 16:49:49 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1PiDFL-0001rL-1W for bug-guile@gnu.org; Wed, 26 Jan 2011 16:49:48 -0500 Original-Received: from mail3.uklinux.net ([80.84.72.33]:45140) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1PiDFK-0001kB-TI for bug-guile@gnu.org; Wed, 26 Jan 2011 16:49:47 -0500 Original-Received: from arudy (unknown [78.145.31.137]) by mail3.uklinux.net (Postfix) with ESMTP id 90DEE1F66D6; Wed, 26 Jan 2011 21:49:05 +0000 (GMT) Original-Received: from neil-laptop (unknown [192.168.11.3]) by arudy (Postfix) with ESMTP id 9E95338013; Wed, 26 Jan 2011 21:49:03 +0000 (GMT) In-Reply-To: (Andy Wingo's message of "Wed, 26 Jan 2011 20:22:54 +0100") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/23.1 (gnu/linux) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4-2.6 X-BeenThere: bug-guile@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GUILE, GNU's Ubiquitous Extension Language" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Errors-To: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.bugs:5039 Archived-At: Andy Wingo writes: > On Sat 15 Jan 2011 22:15, Neil Jerram writes: > >> Mark Harig writes: >> >>> Here is a list of additional options that are not described >>> in the guile manual page: >> >> Thank you for pointing these out, and for suggesting suitable text. >> However, rather than applying these updates, I wonder if the OPTIONS >> section of guile.1 should instead be autogenerated from the `Invoking >> Guile' node of the manual? >> >> Andy/Ludo, any objection to that? > > I have no objection, no; and I'm sorry I didn't see this mail before > committing some other changes and asking for feedback. I'm a bit > behind, you see! No prob. > How do you see the man page? Should it be complete, or terse? I am > leaning towards the latter, to be honest... One reasonable answer would be: - complete as regards invocation options - because in practice, that's mostly what I use man pages for, and I imagine that's true for many people - otherwise in line with other GNU applications (such as in the ways that Mark pointed out) - obviously, pointing to the manual for the full documentation. But I'm not wedded to the first point here. I guess we could just say guile [OPTIONS] [SCRIPT] and then point to the manual for more details. More generally, I'd say the minimum requirements are just for the man page to have some kind of structural sense, not to say anything actively wrong, to point to the manual, and to conform to any GNU project reqts, such as about copying. Neil