catman.8

   1 .\"     $Id: catman.8,v 1.1 2011/11/26 19:54:13 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: November 26 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 M Ar manpath
  27 .Op Fl m Ar manpath
  28 .Op Fl o Ar path
  29 .Sh DESCRIPTION
  30 The
  31 .Nm
  32 utility updates cached manpages for a jailed man.cgi.
  33 Its arguments are as follows:
  34 .Bl -tag -width Ds
  35 .It Fl f
  36 Force an update to all files.
  37 .It Fl v
  38 Print each file being updated.
  39 .It Fl M Ar manpath
  40 Use the colon-separated path instead of the default list of paths
  41 searched for
  42 .Xr mandocdb 8
  43 databases.
  44 Invalid paths, or paths without manual databases, are ignored.
  45 .It Fl m Ar manpath
  46 Append the colon-separated paths to the list of paths searched
  47 for
  48 .Xr mandocdb 8
  49 databases.
  50 Invalid paths, or paths without manual databases, are ignored.
  51 .It Fl o Ar path
  52 Update into the directory tree under
  53 .Ar path .
  54 .El
  55 .Pp
  56 By default,
  57 .Nm
  58 searches for
  59 .Xr mandocdb 8
  60 databases in the default paths stipulated by
  61 .Xr man 1
  62 and updates the cache in
  63 .Pa /var/www/cache/man.cgi .
  64 .Pp
  65 An update occurs when a
  66 .Xr mandocdb 8
  67 database is older than the cached copy.
  68 Cached manual pages are only updated if older than the master copy.
  69 If
  70 .Fl f
  71 is specified, all files are updated.
  72 .Sh EXIT STATUS
  73 .Ex -std
  74 .Sh SEE ALSO
  75 .Xr mandoc 1 ,
  76 .Xr mandocdb 8
  77 .Sh AUTHORS
  78 The
  79 .Nm
  80 utility was written by
  81 .An Kristaps Dzonsons ,
  82 .Mt kristaps@bsd.lv .