From nobody Tue Aug 29 10:53:08 2023 X-Original-To: dev-commits-doc-all@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 4RZkmP2Zggz4rfh1 for ; Tue, 29 Aug 2023 10:53:09 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (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-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4RZkmN73zVz4gW9; Tue, 29 Aug 2023 10:53:08 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1693306389; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=fA2iiujJi7g++CPoAwXSeM4u808lfM0bC87Cl67EsHY=; b=ld0aQ9EuHh/F7+Rc8rKONeNnqRiExSuRuFKWywtwFGrZLa+NHriFipG7d50+8VROdYvknb 78Unw5NhLj3IzR2eHmg3SPHlCRFF9xSyNb8l1a5zB1fHwovvQsxZ/QhcqTMuOSZTwABLMt ckvB1Pqia+izKwe4/zKWH0DXXSh61lRFNj3XnHekAUuTxy63TkxxVvc4twQfwQpjhMq7/q y04FBmDUvhQkhEsdcmHtcY/6Kbtn/uHfVxFxKroa5icQCW0jy7r07AL3PhXAH58UgO+oYS HDtT3iCpzDOkaqLzrQGgmBxhEJ5crhdhFbLB6aLNlsKvI5atXIGpe0WV9/8aCw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1693306389; a=rsa-sha256; cv=none; b=SUnUhahN1fm5EEjVkf0TCbMaaO+xsd1MZ0E/BomJ0Jyyw+jf4g0odcj7hUBvOm/hM3W7mp fIs/z2AU8QYIBaRuSg931muhErET2vhsEYGqSAYc6Sp7msndDocrSRKPmdzDna7OD7ooxY +LX9vR9eIFlHXgFuE6g6Ykpl0aNopCkXbz5FZ1gyeB9jwu7m1+TxeBgwFhlTst63e1aecf g/qFmXyvDnjsrTk5IrkCBse9Mb6KhPGgbZm58ij0O/o1lNY0vdbZ2SaZG9QT+K2DXXkxPl QnBXGgrU3hfJ5Xs1uIXPYRfrN6EJuA40E5KBdxtzcbywPUhCu7ZGqQ4o4/5EHw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1693306389; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=fA2iiujJi7g++CPoAwXSeM4u808lfM0bC87Cl67EsHY=; b=lHKxRLolt74a5V3AZT63YKUaBUzCmMW1Cy1Ygu658oi9QjEhNL82K0L1n0OoY6lcaOyAI1 JHy6Ad4ZoJFr0xVbMiSrzov+KZmBTb4kB6G8s0mxcAaheVkKhAiCwNSzZCBfWNFVesKnTF zO00kNA7k2q0z5u9g26l4A1EUX8H5/yNyEcsZVsleBrrO7ZGvxiUeKOp8d5GREbMAGPKUv Tsy/PyeTQ1d52zF4IyP/Hoxw7Av5V3XT7XaczsbIGrZBxE2uvJqS1IDHKNqswkFzhc6sdw ysshjcY22IcHKcY6bToRS2LOnFUVoLLDcE5YaW2C2Qw/JE0DLu43dJOVEDShYg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (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 mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4RZkmN68XVzp0b; Tue, 29 Aug 2023 10:53:08 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 37TAr8UG007687; Tue, 29 Aug 2023 10:53:08 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 37TAr8GB007684; Tue, 29 Aug 2023 10:53:08 GMT (envelope-from git) Date: Tue, 29 Aug 2023 10:53:08 GMT Message-Id: <202308291053.37TAr8GB007684@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Fernando =?utf-8?Q?Apestegu=C3=ADa?= Subject: git: 15f84d81a3 - main - [fdp-primer]: Mention textproc/vale in man pages test section List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: fernape X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 15f84d81a3d7b8c05b5aefc820288329886f3f0a Auto-Submitted: auto-generated The branch main has been updated by fernape: URL: https://cgit.FreeBSD.org/doc/commit/?id=15f84d81a3d7b8c05b5aefc820288329886f3f0a commit 15f84d81a3d7b8c05b5aefc820288329886f3f0a Author: Fernando Apesteguía AuthorDate: 2023-08-28 06:59:57 +0000 Commit: Fernando Apesteguía CommitDate: 2023-08-29 10:52:23 +0000 [fdp-primer]: Mention textproc/vale in man pages test section textproc/vale can be used to check syntax for manual pages. --- .../content/en/books/fdp-primer/manual-pages/_index.adoc | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc b/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc index 206704c902..4b6d9d77c1 100644 --- a/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc +++ b/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc @@ -501,6 +501,18 @@ Use package:textproc/igor[] to proofread the manual page: % igor ./mynewmanpage.8 .... +Another useful tool is package:textproc/vale[]. +It does not support the man:mdoc[7] syntax but the rendered manual page can be +read from standard input: + +[source,shell] +.... +% man ls | vale +.... + +package:textproc/vale[] is highly configurable. +It is advised to read its documentation. + Use man:man[1] to check the final result of your changes: [source,shell]