aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFernando Apesteguía <fernape@FreeBSD.org>2023-08-28 06:59:57 +0000
committerFernando Apesteguía <fernape@FreeBSD.org>2023-08-29 10:52:23 +0000
commit15f84d81a3d7b8c05b5aefc820288329886f3f0a (patch)
tree53cc97943a749ce7f27ea855a61cf0c752b0f5c1
parent0887638f8d36d207755ba00ac7a083890fe92221 (diff)
downloaddoc-15f84d81a3.tar.gz
doc-15f84d81a3.zip
[fdp-primer]: Mention textproc/vale in man pages test section
textproc/vale can be used to check syntax for manual pages.
-rw-r--r--documentation/content/en/books/fdp-primer/manual-pages/_index.adoc12
1 files changed, 12 insertions, 0 deletions
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]