diff options
author | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2010-12-22 00:33:26 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2010-12-22 00:33:26 +0000 |
commit | 5bca8c87aa3b70e00f4b73e56faf7c15f88da7c4 (patch) | |
tree | 97fdb71c0778e95fa50467445c8be6b092b37c8b /usr.bin/mandoc/mandoc.1 | |
parent | 5cd3cede271315b76f2569e8a445433900fc0982 (diff) |
More small -Thtml improvements by kristaps@,
in particular, use <B>, <I> and <U> where appropriate.
Provide relative widths for header and footer lines.
Manuals: More concise short descriptions of output modes.
Correct a few places still talking about CSS2 to say CSS1.
Code examples should use .Dl, not .D1.
Diffstat (limited to 'usr.bin/mandoc/mandoc.1')
-rw-r--r-- | usr.bin/mandoc/mandoc.1 | 39 |
1 files changed, 15 insertions, 24 deletions
diff --git a/usr.bin/mandoc/mandoc.1 b/usr.bin/mandoc/mandoc.1 index dee2efc5c6d..ecd7c7f6b94 100644 --- a/usr.bin/mandoc/mandoc.1 +++ b/usr.bin/mandoc/mandoc.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mandoc.1,v 1.41 2010/12/19 09:22:35 schwarze Exp $ +.\" $OpenBSD: mandoc.1,v 1.42 2010/12/22 00:33:25 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> .\" @@ -14,7 +14,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: December 19 2010 $ +.Dd $Mdocdate: December 22 2010 $ .Dt MANDOC 1 .Os .Sh NAME @@ -159,13 +159,12 @@ utility accepts the following arguments, which correspond to output modes: .Bl -tag -width Ds .It Fl T Ns Cm ascii -Produce 7-bit ASCII output, backspace-encoded for bold and underline -styles. +Produce 7-bit ASCII output. This is the default. See .Sx ASCII Output . .It Fl T Ns Cm html -Produce strict HTML-4.01 output, with a sane default style. +Produce strict CSS1/HTML-4.01 output. See .Sx HTML Output . .It Fl T Ns Cm lint @@ -183,7 +182,7 @@ See .It Fl T Ns Cm tree Produce an indented parse tree. .It Fl T Ns Cm xhtml -Produce strict XHTML-1.0 output, with a sane default style. +Produce strict CSS1/XHTML-1.0 output. See .Sx XHTML Output . .El @@ -228,16 +227,14 @@ Output produced by .Fl T Ns Cm html conforms to HTML-4.01 strict. .Pp -Font styles and page structure are applied using CSS2. -By default, no font style is applied to any text, -although CSS2 is hard-coded to format -the basic structure of output. -.Pp The .Pa example.style.css -file documents the range of styles applied to output and, if used, will -cause rendered documents to appear as they do in -.Fl T Ns Cm ascii . +file documents style-sheet classes available for customising output. +If a style-sheet is not specified with +.Fl O Ns Ar style , +.Fl T Ns Cm html +defaults to simple output readable in any graphical or text-based web +browser. .Pp Special characters are rendered in decimal-encoded UTF-8. .Pp @@ -376,14 +373,14 @@ output mode implies .Sh EXAMPLES To page manuals to the terminal: .Pp -.D1 $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less -.D1 $ mandoc mandoc.1 mdoc.3 mdoc.7 | less +.Dl $ mandoc \-Wall,stop mandoc.1 2\*(Gt&1 | less +.Dl $ mandoc mandoc.1 mdoc.3 mdoc.7 | less .Pp To produce HTML manuals with .Ar style.css as the style-sheet: .Pp -.D1 $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html +.Dl $ mandoc \-Thtml -Ostyle=style.css mdoc.7 \*(Gt mdoc.7.html .Pp To check over a large set of manuals: .Pp @@ -391,7 +388,7 @@ To check over a large set of manuals: .Pp To produce a series of PostScript manuals for A4 paper: .Pp -.D1 $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps +.Dl $ mandoc \-Tps \-Opaper=a4 mdoc.7 man.7 \*(Gt manuals.ps .Sh DIAGNOSTICS Standard error messages reporting parsing errors are prefixed by .Pp @@ -565,12 +562,6 @@ and and cause them to forget the formatting of the prior next-line scope. .Pp The -.Sq i -macro in -.Fl m Ns Cm an -should italicise all subsequent text if a line argument is not provided. -This behaviour is not implemented. -The .Sq \(aq control character is an alias for the standard macro control character and does not emit a line-break as stipulated in GNU troff. |