From owner-freebsd-doc@FreeBSD.ORG Wed Aug 3 15:20:07 2005 Return-Path: X-Original-To: freebsd-doc@hub.freebsd.org Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 8FF0216A41F for ; Wed, 3 Aug 2005 15:20:07 +0000 (GMT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id 1D58343D58 for ; Wed, 3 Aug 2005 15:20:06 +0000 (GMT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.13.3/8.13.3) with ESMTP id j73FK5Rc026043 for ; Wed, 3 Aug 2005 15:20:06 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.13.3/8.13.1/Submit) id j73FK5t3026042; Wed, 3 Aug 2005 15:20:05 GMT (envelope-from gnats) Resent-Date: Wed, 3 Aug 2005 15:20:05 GMT Resent-Message-Id: <200508031520.j73FK5t3026042@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, garys@opusnet.com Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 9BB5016A41F for ; Wed, 3 Aug 2005 15:16:08 +0000 (GMT) (envelope-from garys@opusnet.com) Received: from opusnet.com (mail.opusnet.com [209.210.200.6]) by mx1.FreeBSD.org (Postfix) with ESMTP id 519D643D4C for ; Wed, 3 Aug 2005 15:16:08 +0000 (GMT) (envelope-from garys@opusnet.com) Received: from localhost.localhost [70.98.246.232] by opusnet.com with ESMTP (SMTPD32-8.05) id AFB458940146; Wed, 03 Aug 2005 08:16:04 -0700 Received: from localhost.localhost (localhost.localhost [127.0.0.1]) by localhost.localhost (8.13.3/8.13.3) with ESMTP id j73FHga3006755 for ; Wed, 3 Aug 2005 08:17:42 -0700 (PDT) (envelope-from garys@opusnet.com) Received: (from jojo@localhost) by localhost.localhost (8.13.3/8.13.3/Submit) id j73FHYat006754; Wed, 3 Aug 2005 08:17:34 -0700 (PDT) (envelope-from garys@opusnet.com) Message-Id: Date: Wed, 03 Aug 2005 08:17:34 -0700 From: "Gary W. Swearingen" To: FreeBSD-gnats-submit@FreeBSD.org Cc: Subject: docs/84519: [patch] mdoc(7) manpage needs more about AUTHORS X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: garys@opusnet.com List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 03 Aug 2005 15:20:07 -0000 >Number: 84519 >Category: docs >Synopsis: [patch] mdoc(7) manpage needs more about AUTHORS >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Wed Aug 03 15:20:05 GMT 2005 >Closed-Date: >Last-Modified: >Originator: Gary W. Swearingen >Release: FreeBSD 5.4-RELEASE i386 >Organization: none >Environment: n/a >Description: Many manpages name "authors" without indicating whether it applies to the manpage or the software. The mdoc manpage doesn't require it. Nor does it say that author's e-mail addresses should be inclosed in angle brackets, which seems to be a de facto standard. >How-To-Repeat: n/a >Fix: The bit about e-mail address quoting probably belongs in a manpage-wide discussion, but I didn't see a good place for it. --- mdoc..orig.7 Wed Aug 3 07:26:32 2005 +++ mdoc.7 Wed Aug 3 08:02:43 2005 @@ -2900,10 +2900,13 @@ . .It Li ".Sh AUTHORS" Credits should be placed here. -The +Use the .Ql .An -macro should be used to specify the name(s) of the person(s). -. +macro for names and the +.Ql .Aq +macro for e-mail addresses within optional contact information. +Explicitly indicate whether the person authored the initial manual page +or the software or whatever the person is being credited for. .It Li ".Sh BUGS" Blatant problems with the topic go here. .El >Release-Note: >Audit-Trail: >Unformatted: