From owner-cvs-all Wed May 30 23:16:59 2001 Delivered-To: cvs-all@freebsd.org Received: from mail.ruhr.de (in-ruhr4.ruhr.de [212.23.134.2]) by hub.freebsd.org (Postfix) with SMTP id C6CDD37B424 for ; Wed, 30 May 2001 23:16:51 -0700 (PDT) (envelope-from ue@nathan.ruhr.de) Received: (qmail 25169 invoked by uid 10); 31 May 2001 06:16:49 -0000 Received: (from ue@localhost) by nathan.ruhr.de (8.11.3/8.11.2) id f4V6FF673577; Thu, 31 May 2001 08:15:15 +0200 (CEST) (envelope-from ue) Date: Thu, 31 May 2001 08:15:15 +0200 From: Udo Erdelhoff To: cvs-committers@FreeBSD.ORG, cvs-all@FreeBSD.ORG Subject: Re: Documenting sysctls (was: cvs commit: src/sbin/sysctl sysctl.8) Message-ID: <20010531081515.A73265@nathan.ruhr.de> Mail-Followup-To: cvs-committers@FreeBSD.ORG, cvs-all@FreeBSD.ORG References: <20010531003943.E78414@skriver.dk> <25323.991263026@axl.fw.uunet.co.za> <20010531151112.A26747@gsmx07.alcatel.com.au> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-md5; protocol="application/pgp-signature"; boundary="cNdxnHkX5QqsyA0e" Content-Disposition: inline User-Agent: Mutt/1.2.5i In-Reply-To: <20010531151112.A26747@gsmx07.alcatel.com.au>; from peter.jeremy@alcatel.com.au on Thu, May 31, 2001 at 03:11:12PM +1000 Sender: owner-cvs-all@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.ORG --cNdxnHkX5QqsyA0e Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable [cc-List trimmed] Hi, On Thu, May 31, 2001 at 03:11:12PM +1000, Peter Jeremy wrote: > Note that there is also provision for a description in the sysctl > definitions in the source code. This probably isn't the best place > for a detailed description, but would be good for a 1-line summary. and this summary should end with "see foo(9)" > I agree with Brooks Davis that it would be nice if sysctl(8) [or > whatever] at least had pointers to where other hierarchies were > described. I'd prefer a "sysctl(8) [or whatever]" that includes a complete list of the sysctls instead of only listing the hierarchies, just as Brooks proposed it. In other words, have: - net.inet.tcp.rfc1323 - net.inet.tcp.rfc1644 - net.inet.tcp.mssdflt - [...] Information about these sysctls can be found in tcp(4). Instead of - net.inet.tcp Information about this class of sysctls can be found in tcp(4). The former version has the obvious advantage that you can take a sysctl, drop it into the search function of your $MANPAGER and find the pointer (or the actual description) in one try. In the latter version, you'd have to cut your search string again and again until you get a match. Just my $0.02 /s/Udo --=20 Schnell und schluepfrig wie geoeltes Ferkel auf Crack --cNdxnHkX5QqsyA0e Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.0.4 (FreeBSD) Comment: For info see http://www.gnupg.org iQCVAwUBOxXhc0Poh1XnT6hxAQEioAQAvyhDew2PMcDDd2gACPX/g42gyZB431k3 uPfjURgWVrttTmMVsOTqZlmyY6xwjmakZzjcfA2mYWoodI+ju7DPgi0VCPjxxcsA 509hpXOVBorlU837Z50QBDkiIidTsNrDK+S1p2nTM6td5p5DrTro+HmN5sucKwLz GqUhXjsEiz4= =Wzcr -----END PGP SIGNATURE----- --cNdxnHkX5QqsyA0e-- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message