stagit-index.1 (1097B) - raw

      1 .Dd August 2, 2021
      2 .Dt STAGIT-INDEX 1
      3 .Os
      4 .Sh NAME
      5 .Nm stagit-index
      6 .Nd static git index page generator
      7 .Sh SYNOPSIS
      8 .Nm
      9 .Op Ar repodir...
     10 .Sh DESCRIPTION
     11 .Nm
     12 will create an index HTML page for the repositories specified and writes
     13 the HTML data to stdout.
     14 The repos in the index are in the same order as the arguments
     15 .Ar repodir
     16 specified.
     17 .Pp
     18 The basename of the directory is used as the repository name.
     19 The suffix ".git" is removed from the basename, this suffix is commonly used
     20 for "bare" repos.
     21 .Pp
     22 The content of the follow files specifies the meta data for each repository:
     23 .Bl -tag -width Ds
     24 .It .git/description or description (bare repos).
     25 description
     26 .It .git/owner or owner (bare repo).
     27 owner of repository
     28 .El
     29 .Pp
     30 For changing the style of the page you can use the following files:
     31 .Bl -tag -width Ds
     32 .It favicon.ico
     33 favicon image.
     34 .It logo.svg
     35 square logo.
     36 .It style.css
     37 CSS stylesheet.
     38 .El
     39 .Sh EXAMPLES
     40 .Bd -literal
     41 cd htmlroot
     42 stagit-index path/to/gitrepo1 path/to/gitrepo2 > index.html
     43 .Ed
     44 .Sh SEE ALSO
     45 .Xr stagit 1
     46 .Sh AUTHORS
     47 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org