usr/src/man/man1m/catman.1m

   1 .\"
   2 .\" This file and its contents are supplied under the terms of the
   3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   4 .\" You may only use this file in accordance with the terms of version
   5 .\" 1.0 of the CDDL.
   6 .\"
   7 .\" A full copy of the text of the CDDL should have accompanied this
   8 .\" source.  A copy of the CDDL is also available via the Internet at
   9 .\" http://www.illumos.org/license/CDDL.
  10 .\"
  11 .\"
  12 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
  13 .\"
  14 .Dd Jul 19, 2014
  15 .Dt CATMAN 1M
  16 .Os
  17 .Sh NAME
  18 .Nm catman
  19 .Nd generate
  20 .Nm whatis
  21 database files
  22 .Sh SYNOPSIS
  23 .Nm
  24 .Op Fl M Ar path
  25 .Op Fl w
  26 .Sh DESCRIPTION
  27 The
  28 .Nm
  29 utility generates a set of
  30 .Nm whatis
  31 database files suitable for use with
  32 .Xr apropos 1
  33 and
  34 .Xr whatis 1 .
  35 It is supplied for compatibility reasons.  The same databases can
  36 be generated using the
  37 .Fl w
  38 option with
  39 .Xr man 1 ,
  40 and that command should be used instead.
  41 .Sh OPTIONS
  42 .Bl -tag -width ".Fl d"
  43 .It Fl M Ar path
  44 Generate the
  45 .Nm whatis
  46 database files within the specified colon separated manual paths.
  47 Overrides the
  48 .Ev MANPATH
  49 environment variable.
  50 .It Fl w
  51 This option is present for backwards compatibility, and is ignored.
  52 .El
  53 .Sh ENVIRONMENT
  54 The following environment variables affect the execution of
  55 .Nm :
  56 .Bl -tag -width ".Ev MANPATH"
  57 .It Ev MANPATH
  58 Used to specify a colon seperated list of manual paths within
  59 which to generate
  60 .Nm whatis
  61 database files.
  62 .El
  63 .Sh EXIT STATUS
  64 .Ex -std
  65 .Sh INTERFACE STABILITY
  66 .Nm "Obsolete Committed" .
  67 .Sh CODE SET INDEPENDENCE
  68 Enabled.
  69 .Sh SEE ALSO
  70 .Xr apropos 1 ,
  71 .Xr man 1 ,
  72 .Xr whatis 1