From baf73424c69a2aa19a4dbd317ca8b72d21c33c1b Mon Sep 17 00:00:00 2001 From: Ingo Schwarze Date: Sat, 30 Aug 2014 18:08:10 +0000 Subject: Introduce a man(1) -l option as an alias for mandoc -a. Basically, this does the same as man -l in Linux man-db. The point is that now all functionality of the combined tool is reachable from the man(1) command name: apropos = man -k, whatis = man -f, mandoc = man -cl. Originally suggested by Carsten dot Kunze at arcor dot de, current maintainer of the Heirloom Documentation Tools. While here, add various missing information to the usage() and to the manuals. --- mandoc.1 | 44 ++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 4 deletions(-) (limited to 'mandoc.1') diff --git a/mandoc.1 b/mandoc.1 index 1ec1a754..dea7d2bd 100644 --- a/mandoc.1 +++ b/mandoc.1 @@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.108 2014/08/22 04:52:55 schwarze Exp $ +.\" $Id: mandoc.1,v 1.109 2014/08/30 18:08:10 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons .\" Copyright (c) 2012, 2014 Ingo Schwarze @@ -15,7 +15,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: August 22 2014 $ +.Dd $Mdocdate: August 30 2014 $ .Dt MANDOC 1 .Os .Sh NAME @@ -23,7 +23,7 @@ .Nd format and display UNIX manuals .Sh SYNOPSIS .Nm mandoc -.Op Fl acV +.Op Fl acfklV .Sm off .Op Fl I Cm os Li = Ar name .Sm on @@ -51,7 +51,7 @@ and produces .Fl T Ns Cm ascii output. .Pp -The arguments are as follows: +The options are as follows: .Bl -tag -width Ds .It Fl a If the standard output is a terminal device and @@ -68,6 +68,14 @@ to paginate them. This is the default. It can be specified to override .Fl a . +.It Fl f +A synonym for +.Xr whatis 1 . +This overrides any earlier +.Fl k +and +.Fl l +options. .Sm off .It Fl I Cm os Li = Ar name .Sm on @@ -77,6 +85,22 @@ for the .Xr mdoc 7 .Sq \&Os macro. +.It Fl k +A synonym for +.Xr apropos 1 . +This overrides any earlier +.Fl f +and +.Fl l +options. +.It Fl l +A synonym for +.Fl a . +Also reverts any earlier +.Fl f +and +.Fl k +options. .It Fl m Ns Ar format Input format. See @@ -137,6 +161,18 @@ If multiple files are specified, .Nm will halt with the first failed parse. .El +.Pp +In +.Fl f +and +.Fl k +mode, +.Nm +also supports the options +.Fl CMmOSsw +described in the +.Xr apropos 1 +manual. .Ss Input Formats The .Nm -- cgit v1.2.3