summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2011-08-17 22:20:14 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2011-08-17 22:20:14 +0000
commit875de15d071895a5554d4bd5e94530ba31d86713 (patch)
tree497610b787cd0d28cbd6b35076ccdf5440d9c5b5
parent589937ee94d5fbd2c8d9eb497231c8423483520e (diff)
downloadmandoc-875de15d071895a5554d4bd5e94530ba31d86713.tar.gz
Add example of comments in man.7 and mdoc.7.
-rw-r--r--man.78
-rw-r--r--mdoc.712
2 files changed, 18 insertions, 2 deletions
diff --git a/man.7 b/man.7
index d7286227..29cee9dc 100644
--- a/man.7
+++ b/man.7
@@ -72,6 +72,14 @@ Furthermore,
macro lines with only a control character and optional trailing
whitespace are
stripped from input.
+.Pp
+Examples:
+.Bd -literal -offset indent -compact
+\&.\e\*q This is a comment line.
+\&.\e\*q The next line is ignored:
+\&.
+\&.Em Emphasis \e\*q This is also a comment.
+.Ed
.Ss Special Characters
Special characters are used to encode special glyphs and are rendered
differently across output media.
diff --git a/mdoc.7 b/mdoc.7
index d7eaee80..77e675fa 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -73,6 +73,14 @@ Furthermore,
macro lines with only a control character and optional trailing
whitespace are
stripped from input.
+.Pp
+Examples:
+.Bd -literal -offset indent -compact
+\&.\e\*q This is a comment line.
+\&.\e\*q The next line is ignored:
+\&.
+\&.Em Emphasis \e\*q This is also a comment.
+.Ed
.Ss Special Characters
Special characters are used to encode special glyphs and are rendered
differently across output media.
@@ -260,9 +268,9 @@ Examples:
.It \&.Bl -tag -width 2i
two-inch tagged list indentation
.Pq see Sx \&Bl
-.It \&.br 2v
+.It \&.sp 2v
two vertical spaces
-.Pq see Sx \&br
+.Pq see Sx \&sp
.El
.Ss Sentence Spacing
Sentences should terminate at the end of an input line.