Date: Tue, 29 Aug 2023 10:53:08 GMT From: Fernando =?utf-8?Q?Apestegu=C3=ADa?= <fernape@FreeBSD.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: git: 15f84d81a3 - main - [fdp-primer]: Mention textproc/vale in man pages test section Message-ID: <202308291053.37TAr8GB007684@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch main has been updated by fernape: URL: https://cgit.FreeBSD.org/doc/commit/?id=15f84d81a3d7b8c05b5aefc820288329886f3f0a commit 15f84d81a3d7b8c05b5aefc820288329886f3f0a Author: Fernando Apesteguía <fernape@FreeBSD.org> AuthorDate: 2023-08-28 06:59:57 +0000 Commit: Fernando Apesteguía <fernape@FreeBSD.org> 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]
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202308291053.37TAr8GB007684>