stagit

Fork of stagit used for this site
git clone git://git.garbash.com/alex/stagit
Log | Files | Refs | README | LICENSE

stagit-index.1 (1201B)


      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 Fl r
     10 .Op Ar repodir...
     11 .Sh DESCRIPTION
     12 .Nm
     13 will create an index HTML page for the repositories specified and writes
     14 the HTML data to stdout.
     15 The repos in the index are in the same order as the arguments
     16 .Ar repodir
     17 specified.
     18 .Pp
     19 The basename of the directory is used as the repository name
     20 unless
     21 .Fl r
     22 is given,
     23 in which case the full path is used to allow subdirectories in the index.
     24 The suffix ".git" is removed from the basename, this suffix is commonly used
     25 for "bare" repos.
     26 .Pp
     27 The content of the follow files specifies the meta data for each repository:
     28 .Bl -tag -width Ds
     29 .It .git/description or description (bare repos).
     30 description
     31 .It .git/owner or owner (bare repo).
     32 owner of repository
     33 .El
     34 .Pp
     35 For changing the style of the page you can use the following files:
     36 .Bl -tag -width Ds
     37 .It favicon.png
     38 favicon image.
     39 .It logo.png
     40 32x32 logo.
     41 .It style.css
     42 CSS stylesheet.
     43 .El
     44 .Sh EXAMPLES
     45 .Bd -literal
     46 cd htmlroot
     47 stagit-index path/to/gitrepo1 path/to/gitrepo2 > index.html
     48 .Ed
     49 .Sh SEE ALSO
     50 .Xr stagit 1
     51 .Sh AUTHORS
     52 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org