contrib/mdocml/catman.8

   1 .\"     $Id: catman.8,v 1.5 2011/12/25 19:35:44 kristaps Exp $
   2 .\"
   3 .\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd $Mdocdate: December 25 2011 $
  18 .Dt CATMAN 8
  19 .Os
  20 .Sh NAME
  21 .Nm catman
  22 .Nd update a man.cgi manpage cache
  23 .Sh SYNOPSIS
  24 .Nm catman
  25 .Op Fl fv
  26 .Op Fl C Ar file
  27 .Op Fl M Ar manpath
  28 .Op Fl m Ar manpath
  29 .Op Fl o Ar path
  30 .Sh DESCRIPTION
  31 The
  32 .Nm
  33 utility updates cached manpages for a jailed
  34 .Xr man.cgi 7 .
  35 .Pp
  36 By default,
  37 .Nm
  38 searches for
  39 .Xr mandocdb 8
  40 databases in the default paths stipulated by
  41 .Xr man 1
  42 and updates the cache in
  43 .Pa /var/www/cache/man.cgi .
  44 .Pp
  45 Its arguments are as follows:
  46 .Bl -tag -width Ds
  47 .It Fl f
  48 Force an update to all files.
  49 .It Fl v
  50 Print each file being updated.
  51 .It Fl C Ar file
  52 Specify an alternative configuration
  53 .Ar file
  54 in
  55 .Xr man.conf 5
  56 format.
  57 .It Fl M Ar manpath
  58 Use the colon-separated path instead of the default list of paths
  59 searched for
  60 .Xr mandocdb 8
  61 databases.
  62 Invalid paths, or paths without manual databases, are ignored.
  63 .It Fl m Ar manpath
  64 Prepend the colon-separated paths to the list of paths searched
  65 for
  66 .Xr mandocdb 8
  67 databases.
  68 Invalid paths, or paths without manual databases, are ignored.
  69 .It Fl o Ar path
  70 Update into the directory tree under
  71 .Ar path .
  72 .El
  73 .Pp
  74 Cache updates occur when a
  75 .Xr mandocdb 8
  76 database is older than the cached copy unless
  77 .Fl f
  78 is specified, in which case files are always considered out of date.
  79 Cached manual pages are only updated if older than the master copy.
  80 .Sh ENVIRONMENT
  81 .Bl -tag -width Ds
  82 .It Ev MANPATH
  83 Colon-separated paths modifying the default list of paths searched for
  84 manual databases.
  85 Invalid paths, or paths without manual databases, are ignored.
  86 Overridden by
  87 .Fl M .
  88 If
  89 .Ev MANPATH
  90 begins with a
  91 .Sq \&: ,
  92 it is appended to the default list;
  93 else if it ends with
  94 .Sq \&: ,
  95 it is prepended to the default list; else if it contains
  96 .Sq \&:: ,
  97 the default list is inserted between the colons.
  98 If none of these conditions are met, it overrides the default list.
  99 .El
 100 .Sh EXIT STATUS
 101 .Ex -std
 102 .Sh SEE ALSO
 103 .Xr mandoc 1 ,
 104 .Xr man.cgi 7 ,
 105 .Xr mandocdb 8
 106 .Sh AUTHORS
 107 The
 108 .Nm
 109 utility was written by
 110 .An Kristaps Dzonsons ,
 111 .Mt kristaps@bsd.lv .