diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2019-01-01 03:45:29 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2019-01-01 03:45:29 +0000 |
commit | 764c6e0eaa4bc8bbdcd7ae1925b0f5ffc626a4d6 (patch) | |
tree | 1fa549248b1227dd081ee1288f9aecc7ae4df1d5 | |
parent | b4da4d806672905d2bb69ab97b839080b2f4c7f3 (diff) | |
download | mandoc-764c6e0eaa4bc8bbdcd7ae1925b0f5ffc626a4d6.tar.gz |
Now that .nf and .fi are implemented in the roff(7) parser and formatters
rather than in the man(7) parser and formatters, document them in the
roff(7) manual, where they belong, rather than in the man(7) manual.
Mention that they imply an output line break, and mention which macros
imply these requests.
-rw-r--r-- | man.7 | 29 | ||||
-rw-r--r-- | roff.7 | 45 |
2 files changed, 43 insertions, 31 deletions
@@ -1,7 +1,7 @@ .\" $Id$ .\" .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> -.\" Copyright (c) 2011-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org> +.\" Copyright (c) 2011-2015,2017,2018,2019 Ingo Schwarze <schwarze@openbsd.org> .\" Copyright (c) 2017 Anthony Bentley <bentley@openbsd.org> .\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org> .\" @@ -101,7 +101,6 @@ but can be found in the alphabetical reference below. .It Sx IP Ta indented paragraph: Op Ar head Op Ar width .It Sx TP Ta tagged paragraph: Op Ar width .It Sx PD Ta set vertical paragraph distance: Op Ar height -.It Sx fi , nf Ta fill mode and no-fill mode (no arguments) .It Sx in Ta additional indent: Op Ar width .El .Ss Physical markup @@ -163,14 +162,18 @@ request. This is a non-standard GNU extension. In .Xr mandoc 1 , -it does the same as -.Sx \&fi . +it does the same as the +.Xr roff 7 +.Sx \&fi +request (switch to fill mode). .Ss \&EX This is a non-standard GNU extension. In .Xr mandoc 1 , -it does the same as -.Sx \&nf . +it does the same as the +.Xr roff 7 +.Ic \&nf +request (switch to no-fill mode). .Ss \&HP Begin a paragraph whose initial output line is left-justified, but subsequent output lines are indented, with the following syntax: @@ -459,9 +462,6 @@ link description to be shown End a synopsis block started with .Sx \&SY . This is a non-standard GNU extension. -.Ss \&fi -End literal mode started with -.Sx \&nf . .Ss \&in Indent relative to the current indentation: .Pp @@ -472,15 +472,6 @@ If is signed, the new offset is relative. Otherwise, it is absolute. This value is reset upon the next paragraph, section, or sub-section. -.Ss \&nf -Begin literal mode: all subsequent free-form lines have their end of -line boundaries preserved. -May be ended by -.Sx \&fi . -Literal mode is implicitly ended by -.Sx \&SH -or -.Sx \&SS . .Sh MACRO SYNTAX The .Nm @@ -531,9 +522,7 @@ The syntax is as follows: .It Sx \&SM Ta n Ta next-line Ta \& .It Sx \&TH Ta >1, <6 Ta current Ta \& .It Sx \&UC Ta <=1 Ta current Ta \& -.It Sx \&fi Ta 0 Ta current Ta Xr roff 7 .It Sx \&in Ta 1 Ta current Ta Xr roff 7 -.It Sx \&nf Ta 0 Ta current Ta Xr roff 7 .El .Ss Block Macros Block macros comprise a head and body. @@ -1,7 +1,7 @@ .\" $Id$ .\" .\" Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> -.\" Copyright (c) 2010-2018 Ingo Schwarze <schwarze@openbsd.org> +.\" Copyright (c) 2010-2019 Ingo Schwarze <schwarze@openbsd.org> .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -908,11 +908,23 @@ This is a Heirloom extension and currently ignored. Enable or disable an OpenType feature. This is a Heirloom extension and currently ignored. .It Ic \&fi -Switch to fill mode. -See -.Xr man 7 . -Ignored in -.Xr mdoc 7 . +Break the output line and switch to fill mode, +which is active by default but can be ended with the +.Ic \&nf +request. +In fill mode, input from subsequent input lines is added to +the same output line until the next word no longer fits, +at which point the output line is broken. +This request is implied by the +.Xr mdoc 7 +.Ic \&Sh +macro and by the +.Xr man 7 +.Ic \&SH , +.Ic \&SS , +and +.Ic \&EE +macros. .It Ic \&fkern Ar font minkern Control the use of kerning tables for a font. This is a Heirloom extension and currently ignored. @@ -1347,11 +1359,22 @@ Declare the need for the specified minimum vertical space before the next trap or the bottom of the page. Currently ignored. .It Ic \&nf -Switch to no-fill mode. -See -.Xr man 7 . -Ignored by -.Xr mdoc 7 . +Break the output line and switch to no-fill mode. +Subsequent input lines are kept together on the same output line +even when exceeding the right margin, +and line breaks in subsequent input cause output line breaks. +This request is implied by the +.Xr mdoc 7 +.Ic \&Bd Fl unfilled +and +.Ic \&Bd Fl literal +macros and by the +.Xr man 7 +.Ic \&EX +macro. +The +.Ic \&fi +request switches back to the default fill mode. .It Ic \&nh Turn off automatic hyphenation mode. Currently ignored. |