diff options
Diffstat (limited to 'documentation/content/en/books/fdp-primer/manual-pages/_index.adoc')
-rw-r--r-- | documentation/content/en/books/fdp-primer/manual-pages/_index.adoc | 51 |
1 files changed, 43 insertions, 8 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 36b078781c..cc6490b5fd 100644 --- a/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc +++ b/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc @@ -1,9 +1,12 @@ --- -title: Chapter 10. Manual Pages -prev: books/fdp-primer/po-translations +title: Chapter 11. Manual Pages +prev: books/fdp-primer/weblate next: books/fdp-primer/writing-style description: How to work with the FreeBSD Manual Pages tags: ["manual pages", "introduction", "guide", "reference"] +showBookMenu: true +weight: 11 +path: "/books/fdp-primer/manual-pages/" --- [[manual-pages]] @@ -14,15 +17,35 @@ tags: ["manual pages", "introduction", "guide", "reference"] :icons: font :sectnums: :sectnumlevels: 6 +:sectnumoffset: 11 +:partnums: :source-highlighter: rouge :experimental: -:skip-front-matter: -:xrefstyle: basic -:relfileprefix: ../ -:outfilesuffix: -:sectnumoffset: 10 +:images-path: books/fdp-primer/ + +ifdef::env-beastie[] +ifdef::backend-html5[] +:imagesdir: ../../../../images/{images-path} +endif::[] +ifndef::book[] +include::shared/authors.adoc[] +include::shared/mirrors.adoc[] +include::shared/releases.adoc[] +include::shared/attributes/attributes-{{% lang %}}.adoc[] +include::shared/{{% lang %}}/teams.adoc[] +include::shared/{{% lang %}}/mailing-lists.adoc[] +include::shared/{{% lang %}}/urls.adoc[] +toc::[] +endif::[] +ifdef::backend-pdf,backend-epub3[] +include::../../../../../shared/asciidoctor.adoc[] +endif::[] +endif::[] +ifndef::env-beastie[] toc::[] +include::../../../../../shared/asciidoctor.adoc[] +endif::[] [[manual-pages-introduction]] == Introduction @@ -249,7 +272,7 @@ A trivial example shows the minimal requirements, a serious example shows actual Include the BSD license:: Include the BSD license on new manual pages. -The preferred license is available from the link:{committers-guide}[Committer's Guide]. +The preferred license is available from the extref:{committers-guide}[Committer's Guide]. [[manual-pages-markup-tricks]] === Markup Tricks @@ -478,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] |