git: e7c0fed0de - main - books/fdp-primer/manual-pages: Add callouts
Danilo G. Baio
dbaio at FreeBSD.org
Sat Aug 14 14:12:40 UTC 2021
The branch main has been updated by dbaio:
URL: https://cgit.FreeBSD.org/doc/commit/?id=e7c0fed0dea039b5ed6b87fd9129d7db989cf6e0
commit e7c0fed0dea039b5ed6b87fd9129d7db989cf6e0
Author: Danilo G. Baio <dbaio at FreeBSD.org>
AuthorDate: 2021-08-14 13:57:12 +0000
Commit: Danilo G. Baio <dbaio at FreeBSD.org>
CommitDate: 2021-08-14 13:57:12 +0000
books/fdp-primer/manual-pages: Add callouts
Callouts markup was missed when converting this document to
Hugo/Asciidoctor.
---
.../en/books/fdp-primer/manual-pages/_index.adoc | 36 +++++++++++-----------
1 file changed, 18 insertions(+), 18 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 2d2052a805..36b078781c 100644
--- a/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc
@@ -156,18 +156,18 @@ For example, consider this portion of the man:ls[1] manual page:
[.programlisting]
....
-.Dd December 1, 2015
+.Dd December 1, 2015 <.>
.Dt LS 1
-.Sh NAME
+.Sh NAME <.>
.Nm ls
.Nd list directory contents
-.Sh SYNOPSIS
-.Nm
-.Op Fl -libxo
-.Op Fl ABCFGHILPRSTUWZabcdfghiklmnopqrstuwxy1,
-.Op Fl D Ar format
-.Op Ar
-.Sh DESCRIPTION
+.Sh SYNOPSIS <.>
+.Nm <.>
+.Op Fl -libxo <.>
+.Op Fl ABCFGHILPRSTUWZabcdfghiklmnopqrstuwxy1, <.>
+.Op Fl D Ar format <.>
+.Op Ar <.>
+.Sh DESCRIPTION <.>
For each operand that names a
.Ar file
of a type other than
@@ -184,22 +184,22 @@ within that directory, as well as any requested, associated
information.
....
-A _Document date_ and _Document title_ are defined.
-A _Section header_ for the NAME section is defined.
+<.> A _Document date_ and _Document title_ are defined.
+<.> A _Section header_ for the NAME section is defined.
Then the _Name_ of the command and a one-line _Name description_ are defined.
-The SYNOPSIS section begins.
+<.> The SYNOPSIS section begins.
This section describes the command-line options and arguments accepted.
-_Name_ (`.Nm`) has already been defined, and repeating it here just displays the defined value in the text.
-An _Optional_ _Flag_ called `-libxo` is shown.
+<.> _Name_ (`.Nm`) has already been defined, and repeating it here just displays the defined value in the text.
+<.> An _Optional_ _Flag_ called `-libxo` is shown.
The `Fl` macro adds a dash to the beginning of flags, so this appears in the manual page as `--libxo`.
-A long list of optional single-character flags are shown.
-An optional `-D` flag is defined.
+<.> A long list of optional single-character flags are shown.
+<.> An optional `-D` flag is defined.
If the `-D` flag is given, it must be followed by an _Argument_.
The argument is a _format_, a string that tells man:ls[1] what to display and how to display it.
Details on the format string are given later in the manual page.
-A final optional argument is defined.
+<.> A final optional argument is defined.
Since no name is specified for the argument, the default of `file ...` is used.
-The _Section header_ for the DESCRIPTION section is defined.
+<.> The _Section header_ for the DESCRIPTION section is defined.
When rendered with the command `man ls`, the result displayed on the screen looks like this:
More information about the dev-commits-doc-all
mailing list