summaryrefslogtreecommitdiffstats
path: root/share/man/man7
diff options
context:
space:
mode:
authorschwarze <schwarze@openbsd.org>2017-02-05 21:39:54 +0000
committerschwarze <schwarze@openbsd.org>2017-02-05 21:39:54 +0000
commit5c0b1c3931febc93329d980f32e699b808c7f13a (patch)
treeadddde74c1f90c347e9ef2289088b82a1f4fb060 /share/man/man7
parentWrap .St content in a <span class="St">. (diff)
downloadwireguard-openbsd-5c0b1c3931febc93329d980f32e699b808c7f13a.tar.xz
wireguard-openbsd-5c0b1c3931febc93329d980f32e699b808c7f13a.zip
document hyphenation
Diffstat (limited to 'share/man/man7')
-rw-r--r--share/man/man7/mandoc_char.728
1 files changed, 26 insertions, 2 deletions
diff --git a/share/man/man7/mandoc_char.7 b/share/man/man7/mandoc_char.7
index a94f55323e8..e65213adfe8 100644
--- a/share/man/man7/mandoc_char.7
+++ b/share/man/man7/mandoc_char.7
@@ -1,4 +1,4 @@
-.\" $OpenBSD: mandoc_char.7,v 1.27 2015/09/01 01:19:46 bentley Exp $
+.\" $OpenBSD: mandoc_char.7,v 1.28 2017/02/05 21:39:54 schwarze Exp $
.\"
.\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org>
.\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
@@ -16,7 +16,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: September 1 2015 $
+.Dd $Mdocdate: February 5 2017 $
.Dt MANDOC_CHAR 7
.Os
.Sh NAME
@@ -62,6 +62,30 @@ blue-eyed
lorry-driver
.Ed
.Pp
+If a word on a text input line contains a hyphen, a formatter may decide
+to insert an output line break after the hyphen if that helps filling
+the current output line, but the whole word would overflow the line.
+If it is important that the word is not broken across lines in this
+way, a zero-width space
+.Pq Sq \e&
+can be inserted before or after the hyphen.
+While
+.Xr mandoc 1
+never breaks the output line after hyphens adjacent to a zero-width
+space, after any of the other dash- or hyphen-like characters
+represented by escape sequences, or after hyphens inside words in
+macro arguments, other software may not respect these rules and may
+break the line even in such cases.
+.Pp
+Some
+.Xr roff 7
+implementations contains dictionaries allowing to break the line
+at syllable boundaries even inside words that contain no hyphens.
+Such automatic hyphenation is not supported by
+.Xr mandoc 1 ,
+which only breaks the line at whitespace, and inside words only
+after existing hyphens.
+.Pp
The mathematical minus sign is used for negative numbers or subtraction.
It should be written as
.Sq \e(mi :