From nobody Wed Apr 20 08:04:12 2022 X-Original-To: freebsd-questions@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 7C8A011D061B; Wed, 20 Apr 2022 08:04:21 +0000 (UTC) (envelope-from yuri@aetern.org) Received: from out5-smtp.messagingengine.com (out5-smtp.messagingengine.com [66.111.4.29]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 4KjtVX4qCcz3L1C; Wed, 20 Apr 2022 08:04:20 +0000 (UTC) (envelope-from yuri@aetern.org) Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.nyi.internal (Postfix) with ESMTP id 6405A5C01FC; Wed, 20 Apr 2022 04:04:14 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute5.internal (MEProxy); Wed, 20 Apr 2022 04:04:14 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=aetern.org; h=cc :content-transfer-encoding:content-type:date:date:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:sender:subject:subject:to:to; s=fm3; t=1650441854; x= 1650528254; bh=53Cf+/VEnorkNNbMy8l2HmsMSIgI+oPye6748j/3YkY=; b=M 6+VfDP1X4EV9o5KN0FNthZ30wdc+eHhDwDk+jDlrzST6mSHIJg0ZCfQS8OnBPu7s EZgkZPULvhLKi1aKiCskty9No+VOamzw9m6Q1IY/QoP5haVC52aSJdeTEg/5BSg8 P+cHcvCDV5Xzzm1lLSCue7MEniQXpthAq8vwyhnkAOcUX2VanQ9+HBW0eAkS9b9d 7wnhnvjtz/am+9NBfIt55laRM8zYcI3LJuWdQXNb5JfkDg+g1Zm8F1zzi52Hrule BljXSqN0V4pWV9evlaO7Wo3SMJ2WuUXwIcKz3TEGb3kSY3RnDSY1n8I2g1wl4GZd brkkzk7+rC5HRBOz9HQWQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:date:from:from:in-reply-to:in-reply-to:message-id :mime-version:references:reply-to:sender:subject:subject:to:to :x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm1; t=1650441854; x=1650528254; bh=53Cf+/VEnorkNNbMy8l2HmsMSIgI +oPye6748j/3YkY=; b=bFhzNDutzY4ogZwepLsyFDV9d5AQqCZeng4kgrB/XVW5 SA4DrQw7MUp2iEo3+bx5eKN/XtEU72+CRg77nWjWkv+Oxr5cAZ0qdT4wZSO1vPHw NnYGRkvV6O/7HZVLwJn1L2c4P1Lgkjuw8LuFMwCPb6GjL4PXep258SPcTE8XLCWk vTQj1Qxj032SehFOQk/MytONmKCAE0E6fs23uCMFDPBhPjqYs/urD/gqI7aYdM8N 39VZbMmb/gcpZUzPe7r/35E+ZgRq1uIyG7kasCXSNzZ8I+fY8oyZpPZ/SEKkGSqD 831HF8c+WtZziWP1/PBES/oyd2stnCE06OEDbABEfA== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvvddrvddtgedguddvhecutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmd enucfjughrpefkffggfgfuvfhfhfgjtgfgsehtkeertddtfeejnecuhfhrohhmpegjuhhr ihcuoeihuhhrihesrggvthgvrhhnrdhorhhgqeenucggtffrrghtthgvrhhnpeekjedvje dtvddtgfeludelteduvefgjeejgeejvefhheduveekkeehvefguedvtdenucffohhmrghi nhepmhgrnhejrdhorhhgpdhfrhgvvggsshgurdhorhhgnecuvehluhhsthgvrhfuihiivg eptdenucfrrghrrghmpehmrghilhhfrhhomhephihurhhisegrvghtvghrnhdrohhrgh X-ME-Proxy: Received: by mail.messagingengine.com (Postfix) with ESMTPA; Wed, 20 Apr 2022 04:04:13 -0400 (EDT) Message-ID: Date: Wed, 20 Apr 2022 11:04:12 +0300 List-Id: User questions List-Archive: https://lists.freebsd.org/archives/freebsd-questions List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-freebsd-questions@freebsd.org X-BeenThere: freebsd-questions@freebsd.org MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101 Thunderbird/91.8.0 Subject: Re: Conventions for FreeBSD manual pages Content-Language: en-US To: Graham Perrin , FreeBSD questions , FreeBSD documentation project References: <3755196b-8803-ff72-364e-6b3b067f9702@gmail.com> From: Yuri In-Reply-To: <3755196b-8803-ff72-364e-6b3b067f9702@gmail.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Rspamd-Queue-Id: 4KjtVX4qCcz3L1C X-Spamd-Bar: ---- Authentication-Results: mx1.freebsd.org; dkim=pass header.d=aetern.org header.s=fm3 header.b="M 6+VfDP"; dkim=pass header.d=messagingengine.com header.s=fm1 header.b=bFhzNDut; dmarc=none; spf=pass (mx1.freebsd.org: domain of yuri@aetern.org designates 66.111.4.29 as permitted sender) smtp.mailfrom=yuri@aetern.org X-Spamd-Result: default: False [-4.46 / 15.00]; RCVD_VIA_SMTP_AUTH(0.00)[]; ARC_NA(0.00)[]; R_DKIM_ALLOW(-0.20)[aetern.org:s=fm3,messagingengine.com:s=fm1]; FREEFALL_USER(0.00)[yuri]; FROM_HAS_DN(0.00)[]; RCPT_COUNT_THREE(0.00)[3]; R_SPF_ALLOW(-0.20)[+ip4:66.111.4.29]; NEURAL_HAM_LONG(-1.00)[-1.000]; MIME_GOOD(-0.10)[text/plain]; DMARC_NA(0.00)[aetern.org]; NEURAL_HAM_MEDIUM(-0.88)[-0.884]; DWL_DNSWL_LOW(-1.00)[messagingengine.com:dkim]; RCVD_COUNT_THREE(0.00)[4]; TO_MATCH_ENVRCPT_SOME(0.00)[]; TO_DN_ALL(0.00)[]; DKIM_TRACE(0.00)[aetern.org:+,messagingengine.com:+]; NEURAL_HAM_SHORT(-0.97)[-0.972]; MLMMJ_DEST(0.00)[freebsd-doc,freebsd-questions]; FREEMAIL_TO(0.00)[gmail.com,freebsd.org]; FROM_EQ_ENVFROM(0.00)[]; MIME_TRACE(0.00)[0:+]; RCVD_TLS_LAST(0.00)[]; ASN(0.00)[asn:19151, ipnet:66.111.4.0/24, country:US]; MID_RHS_MATCH_FROM(0.00)[]; RCVD_IN_DNSWL_LOW(-0.10)[66.111.4.29:from] X-ThisMailContainsUnwantedMimeParts: N Graham Perrin wrote: > Please: does FreeBSD have anything like the Linux manual page for > conventions? > > > > I can't find one. See mdoc(7). > Background > ========== > > For years, I assumed that SEE ALSO sections were disorderly. > > For example: > > * expecting a–z (alphabetical order) > > * finding ne, sy, se, at et cetera (disorderly) under > > > > Today I discovered that there is, at least for Linux, a convention to sort: > > * first, by the section number (secondary) > > * second, by the name of the page, which appears first. > > I do see some logic to this, however – without first knowing the > convention – I never found it helpful. The apparent disorder was unhelpful. > > Whenever I look for a named thing, in a long string of names, with the > intention of clicking (a link): I expect alphabetical order, by name. I don't see a question here, so I'll just say that I find it helpful, different sections are there to describe completely different things (commands, functions, kernel modules, formats), so grouping by section makes a lot of sense to me.