gitman

Export manpages from git repositories
git clone git://jacobedwards.org/gitman
Log | Files | Refs | README | LICENSE

gitman.1 (1829B)

      1 ./"
      2 ./" Copyright (c) 2025 Jacob R. Edwards <jacob@jacobedwards.org>
      3 ./"
      4 ./" Permission to use, copy, modify, and distribute this software for any
      5 ./" purpose with or without fee is hereby granted, provided that the above
      6 ./" copyright notice and this permission notice appear in all copies.
      7 ./"
      8 ./" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIE
      9 ./" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     10 ./" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     11 ./" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     12 ./" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     13 ./" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     14 ./" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     15 ./"
     16 .Dd October 26, 2025
     17 .Dt GITMAN 1
     18 .Os
     19 .Sh NAME
     20 .Nm gitman
     21 .Nd Export manpages from git repositories
     22 .Sh SYNOPSIS
     23 .Nm
     24 .Op Fl d Ar dir
     25 .Op Ar repo ...
     26 .Sh DESCRIPTION
     27 The
     28 .Nm
     29 utility writes manpages found in the given git repositories (or
     30 .Ev GIT_DIR
     31 if none are specified) to the prefix
     32 directory, then updates it's
     33 .Pa mandoc.db
     34 with
     35 .Xr makewhatis 8 .
     36 .Pp
     37 The options are described below:
     38 .Bl -tag -width Ds
     39 .It Fl d Ar dir
     40 Set the export directory for manpages. Defaults to the contents of
     41 .Pa /etc/gitman ,
     42 or the current working directory if it doesn't exist.
     43 .El
     44 .Sh FILES
     45 .Bl -tag -width Ds
     46 .It Pa /etc/gitman
     47 The default export directory if
     48 .Fl d
     49 isn't specified.
     50 .El
     51 .Sh EXIT STATUS
     52 .Ex -std
     53 .Sh EXAMPLES
     54 .Pp
     55 Write the manpages 
     56 from the repositories under
     57 .Pa ~/git/
     58 to
     59 .Pa /var/www/man/main
     60 along with a
     61 .Xr makewhatis 8
     62 database:
     63 .Pp
     64 .Dl $ gitman -d /var/www/man/main ~/git/*
     65 .Sh SEE ALSO
     66 .Xr git-ls-tree 1 ,
     67 .Xr git-show 1 ,
     68 .Xr makewhatis 8
     69 .Sh AUTHORS
     70 .An Jacob R. Edwards Aq Mt jacob@jacobedwards.org