Date: Sat, 28 Aug 1999 18:13:10 +0200 From: Jeroen Ruigrok/Asmodai <asmodai@wxs.nl> To: Mike Pritchard <mpp@mpp.pro-ns.net> Cc: freebsd-hackers@freebsd.org, freebsd-doc@freebsd.org, phantom@cris.net Subject: Re: Propose mdoc fix regarding ERRORS section Message-ID: <19990828181310.B46221@daemon.ninth-circle.org> In-Reply-To: <199908280729.CAA93164@mpp.pro-ns.net> References: <199908280729.CAA93164@mpp.pro-ns.net>
next in thread | previous in thread | raw e-mail | index | archive | help
* Mike Pritchard (mpp@mpp.pro-ns.net) [990828 11:44]: >>Category: docs >>Synopsis: src/lib/libc/sys/*.2 misc patch pack >- first column in most ERROR lists is too narrow. Normalize their width. > >Right now we have a problem with our on-line man pages. Most were >written when the length of errno's were only 6 - 8 characters long. >Now we have errno's that can be up to 15 characters long. Many >of our man pages have the following mdoc instruction (or something >similar) to ensure that the field width for the errno is appropriate: > >.Bl -tag -width EBADFXXX Most lists do actually. But you already know =) >.Bl -tag -width Er > >Which will reserve enough space for the errno name based on what >width the Er macro specifies. Right now it doesn't allocate enough >width to contain our largest errno's. > >I propose that we fix mdoc to allocate enough width when the second >form is specified, and then change all of the man pages to use that >format in the ERRORS section. I think using -width Er and setting the Er constant to a higher value might be the best thing. Offcourse we need to check all of the manpages in order whether they use -width EBLAHBLAH or -width Er. If you need help, please yell. -- Jeroen Ruigrok van der Werven asmodai(at)wxs.nl The BSD Programmer's Documentation Project <http://home.wxs.nl/~asmodai>; Network/Security Specialist BSD: Technical excellence at its best Fame is the perfume of heroic deeds. To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-hackers" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19990828181310.B46221>