stagit.1

   1 .Dd May 1, 2016
   2 .Dt STAGIT 1
   3 .Os
   4 .Sh NAME
   5 .Nm stagit
   6 .Nd static git page generator
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Op Fl c Ar cachefile
  10 .Ar repodir
  11 .Sh DESCRIPTION
  12 .Nm
  13 writes HTML pages for the repository
  14 .Ar repodir
  15 to the current directory.
  16 .Pp
  17 Optionally the
  18 .Fl c Ar cachefile
  19 option can be used to cache the entries of the log page up to the point of
  20 the last commit. The
  21 .Ar cachefile
  22 will store the last commit id and the entries in the HTML table. It is up
  23 to the user to make sure the state of the
  24 .Ar cachefile
  25 is in sync with the history of the repository, for example a
  26 git push \-\-force can screw this up.
  27 .Pp
  28 The following files will be written:
  29 .Bl -tag -width Ds
  30 .It atom.xml
  31 Atom XML feed
  32 .It files.html
  33 List of files in the latest HEAD commit, linking to the file.
  34 .It log.html
  35 List of commits in order of most recent to old of the commits (top to bottom),
  36 each commit links to a page with a diff and diffstat of the commit.
  37 .It refs.html
  38 Lists references of the repository such as branches and tags.
  39 .El
  40 .Pp
  41 For each file in HEAD a file will be written in the format:
  42 file/filepath.html. This file will contain the textual data of the file
  43 prefixed by line numbers. The file will have the string "binary file"
  44 if the data is considered to be non-textual.
  45 .Pp
  46 For each commit a file will be written in the format:
  47 commit/commitid.html . This file will contain the diff and diffstat of the
  48 commit. It will write the string "binary files differ" if the data is
  49 considered to be non-textual.
  50 .Pp
  51 The basename of the directory is used as the name. The suffix ".git" is
  52 removed from the basename, this is commonly used for "bare" repos.
  53 .Pp
  54 The content of the follow files specifies the meta data for each repository:
  55 .Bl -tag -width Ds
  56 .It .git/description or description (bare repo).
  57 description
  58 .It .git/owner or owner (bare repo).
  59 owner of repository
  60 .It .git/url or url (bare repo).
  61 primary clone url of the repository, for example: git://git.2f30.org/stagit
  62 .El
  63 .Pp
  64 For changing the style of the page you can use the following files:
  65 .Bl -tag -width Ds
  66 .It logo.png
  67 32x32 logo.
  68 .It favicon.png
  69 favicon image.
  70 .It style.css
  71 CSS stylesheet.
  72 .El
  73 .Sh SEE ALSO
  74 .Xr stagit-index 1
  75 .Sh AUTHORS
  76 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org