From 15f84d81a3d7b8c05b5aefc820288329886f3f0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fernando=20Apestegu=C3=ADa?= <fernape@FreeBSD.org> Date: Mon, 28 Aug 2023 08:59:57 +0200 Subject: [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] -- cgit v1.2.3