git: 15f84d81a3 - main - [fdp-primer]: Mention textproc/vale in man pages test section

Fernando Apesteguía <[email protected]>
Newsgroups gmane.os.freebsd.devel.cvs.doc
Message-ID <[email protected]>
The branch main has been updated by fernape:

URL: https://cgit.FreeBSD.org/doc/commit/?id=15f84d81a3d7b8c05b5aefc820288329886f3f0a

commit 15f84d81a3d7b8c05b5aefc820288329886f3f0a
Author:     Fernando Apesteguía <[email protected]>
AuthorDate: 2023-08-28 06:59:57 +0000
Commit:     Fernando Apesteguía <[email protected]>
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]
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.