diff options
author | Kristaps Dzonsons <kristaps@bsd.lv> | 2009-07-27 12:35:53 +0000 |
---|---|---|
committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2009-07-27 12:35:53 +0000 |
commit | 1d1eaff780bcc4af2a8048cec63b5e2bedf16337 (patch) | |
tree | e51cc762e959ecd330ec4dae90f87c89d38f58f7 /man.7 | |
parent | 61fb396c8d05a2962048d0555165f4958be68c85 (diff) | |
download | mandoc-1d1eaff780bcc4af2a8048cec63b5e2bedf16337.tar.gz |
Clarified special chars/predefined chars in mandoc_char.7.
Cleaned up escape section in man.7, mdoc.7.
Cleaned up function names in term.c.
Diffstat (limited to 'man.7')
-rw-r--r-- | man.7 | 41 |
1 files changed, 22 insertions, 19 deletions
@@ -70,17 +70,16 @@ documents; if encountered at the end of a word, it ensures that the subsequent word isn't off-set by whitespace. .\" SUB-SECTION .Ss Comments -Anything following a -.Sq \e" -delimiter is considered a comment (unless the -.Sq \e -itself has been escaped) and is ignored to the end of line. -Furthermore, a macro line with only a control character -.Sq \. , -optionally followed by whitespace, is ignored. +Text following a +.Sq \e" , +whether in a macro or free-form text line, is ignored to the end of +line. A macro line with only a control character and comment escape, +.Sq \&.\e" , +is also ignored. .\" SUB-SECTION .Ss Special Characters -Special character sequences begin with the escape character +Special characters may occur in both macro and free-form lines. +Sequences begin with the escape character .Sq \e followed by either an open-parenthesis .Sq \&( @@ -88,17 +87,21 @@ for two-character sequences; an open-bracket .Sq \&[ for n-character sequences (terminated at a close-bracket .Sq \&] ) ; -or a single one-character sequence. -.Pp -Characters may alternatively be escaped by a slash-asterisk, -.Sq \e* , -with the same combinations as described above. -.Pp -Terms may also be text-decorated using the +or a single one-character sequence. See +.Xr mandoc_char 7 +for a complete list. Examples include +.Sq \e(em +.Pq em-dash +and +.Sq \ee +.Pq back-slash . +.\" SUB-SECTION---------------------- +.Ss Text Decoration +Terms may be text-decorated using the .Sq \ef -escape followed by a text-decoration letter: B (bold), I, (italic), or P -and R (Roman, or reset). -.\" SUB-SECTION +escape followed by an indicator: B (bold), I, (italic), or P and R +(Roman, or reset). +.\" SUB-SECTION---------------------- .Ss Whitespace Unless specifically escaped, consecutive blocks of whitespace are pruned from input. These are later re-added, if applicable, by a front-end |