From owner-freebsd-doc Wed May 29 14:48:24 2002 Delivered-To: freebsd-doc@freebsd.org Received: from mailsrv.otenet.gr (mailsrv.otenet.gr [195.170.0.5]) by hub.freebsd.org (Postfix) with ESMTP id 46DED37B40C; Wed, 29 May 2002 14:47:56 -0700 (PDT) Received: from hades.hell.gr (patr530-b137.otenet.gr [212.205.244.145]) by mailsrv.otenet.gr (8.12.3/8.12.3) with ESMTP id g4TLlq0j025089; Thu, 30 May 2002 00:47:53 +0300 (EEST) Received: from hades.hell.gr (hades [127.0.0.1]) by hades.hell.gr (8.12.3/8.12.3) with ESMTP id g4TLlpQb067571; Thu, 30 May 2002 00:47:51 +0300 (EEST) (envelope-from keramida@freebsd.org) Received: (from charon@localhost) by hades.hell.gr (8.12.3/8.12.3/Submit) id g4TLloNY067570; Thu, 30 May 2002 00:47:50 +0300 (EEST) (envelope-from keramida@freebsd.org) Date: Thu, 30 May 2002 00:47:47 +0300 From: Giorgos Keramidas To: Tom Rhodes Cc: freebsd-doc@freebsd.org Subject: (man page || manpage) => manual page Message-ID: <20020529214746.GA67346@hades.hell.gr> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org Hello there, Nice to see someone has taken it upon himself to finish the job I left in the middle (by completing only the articles/ part) a while ago. > config file with the appropriate entries. See the > - stl(4) man page and the appropriate section of the > + stl(4) manual page and the appropriate section of the When &man.xxx.y; references are being made I prefer the style that Jeroen suggested to me a long time ago. Instead of writing: "see the foo(n) manpage" You can simply use "see foo(n)", since it should be apparent that this is a reference to a manual page. Repeating in every such place that it "is a manual page" is a bit of an overkill. > would generate such a set of context diffs for the given > - source file or directory hierarchy. See the man page for > + source file or directory hierarchy. See the manual page for > &man.diff.1; for more details. Another example of a case where dropping "manpage" altogether gives actually more aesthetically pleasing results. Compare the text above with the following: See diff(1) for more details. > This chapter was written by &a.murray; with selections from a > - variety of sources including the intro(4) man page by > + variety of sources including the intro(4) manual page by > &a.joerg;. I guess this can safely be replaced with &man.intro.4;. > - handbook, the man page or from the ppp.conf.sample file. > + handbook, the manual page or from the ppp.conf.sample file. Now that I see this... You might want after you've done the manpage changes to wrap ppp.conf.sample in tags. Or I'll do it, but in a few days, to avoid making you merge stuff again and again. > Additional encoding options can be found by consulting the > - lame man page. > + lame manual page. Since `lame' is used in IRC to denote 'silly', 'idiot', or similar, you will probably want to change this part. Make it something like: by consulting lame 1 . This emulates the functionality of &man.lame.1;. You can even make this a local entity in the file that references the manpage, by adding to the element the proper stuff: [ ] and then using &man.lame.1; as usual. > -in your ppp configuration file (refer to the man page for details). > +in your ppp configuration file (refer to the manual page for details). I would make the manpage reference more explicit here, and use &man.ppp.1; in the parenthesized text: ... (refer to &man.ppp.1; for details). Well, that's all. I hope it hasn't started to get annoying yet ;) - Giorgos To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message