From: schwarze Date: Sun, 14 Dec 2014 17:48:48 +0000 (+0000) Subject: minimally document -IOKTW; requested by naddy@ X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=6c18020a92a48bc0206b0c4cbd6f6e3e5c04b953;p=openbsd minimally document -IOKTW; requested by naddy@ --- diff --git a/usr.bin/mandoc/man.1 b/usr.bin/mandoc/man.1 index 5b153be553a..27edb27b428 100644 --- a/usr.bin/mandoc/man.1 +++ b/usr.bin/mandoc/man.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: man.1,v 1.5 2014/11/11 02:43:11 schwarze Exp $ +.\" $OpenBSD: man.1,v 1.6 2014/12/14 17:48:48 schwarze Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 .\" The Regents of the University of California. All rights reserved. @@ -31,7 +31,7 @@ .\" .\" @(#)man.1 8.2 (Berkeley) 1/2/94 .\" -.Dd $Mdocdate: November 11 2014 $ +.Dd $Mdocdate: December 14 2014 $ .Dt MAN 1 .Os .Sh NAME @@ -41,10 +41,15 @@ .Nm man .Op Fl acfhklVw .Op Fl C Ar file +.Op Fl I Cm os Ns = Ns Ar name +.Op Fl K Ar encoding .Op Fl M Ar path .Op Fl m Ar path +.Op Fl O Ar option Ns = Ns Ar value .Op Fl S Ar subsection .Op Fl s Ar section +.Op Fl T Ar output +.Op Fl W Ar level .Op Ar section .Ar name ... .Sh DESCRIPTION @@ -95,12 +100,31 @@ This overrides any earlier and .Fl l options. +.It Fl I Cm os Ns = Ns Ar name +Override the default operating system +.Ar name +for the +.Xr mdoc 7 +.Ic \&Os +macro. .It Fl h Display only the SYNOPSIS lines of the requested manual pages. Implies .Fl a and .Fl c . +.It Fl K Ar encoding +Specify the input encoding. +The supported +.Ar encoding +arguments are +.Cm us-ascii , +.Cm iso-8859-1 , +and +.Cm utf-8 . +By default, the encoding is automatically detected as described in the +.Xr mandoc 1 +manual. .It Fl k A synonym for .Xr apropos 1 . @@ -173,6 +197,11 @@ are specified by the line in the .Nm configuration file. +.It Fl O Ar option Ns = Ns Ar value +Comma-separated output options. +For each output format, the available options are described in the +.Xr mandoc 1 +manual. .It Fl S Ar subsection Restricts the directories that .Nm @@ -242,8 +271,44 @@ specifies the possible .Ar section values, and their search order. Additional sections may be specified. +.It Fl T Ar output +Select the output format. +The default is +.Cm locale . +The other output modes +.Cm ascii , +.Cm html , +.Cm lint , +.Cm man , +.Cm pdf , +.Cm ps , +.Cm tree , +and +.Cm utf8 +are described in the +.Xr mandoc 1 +manual. .It Fl V Print version and exit. +.It Fl W Ar level +Specify the minimum message +.Ar level +to be reported on the standard error output and to affect the exit status. +The +.Ar level +can be +.Cm warning , +.Cm error , +or +.Cm fatal . +The default is +.Cm fatal ; +.Cm all +is an alias for +.Cm warning . +See the +.Xr mandoc 1 +manual for details. .It Fl w List the pathnames of the manual pages which .Nm @@ -254,14 +319,6 @@ and combination. .El .Pp -The -.Nm -utility also supports the options -.Fl IKOTW -described in the -.Xr mandoc 1 -manual. -.Pp Guidelines for writing man pages can be found in .Xr mdoc 7 .