stagit.1

   1 .Dd December 26, 2015
   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 Ar repodir
  10 .Sh DESCRIPTION
  11 .Nm
  12 writes HTML pages for the repository
  13 .Ar repodir
  14 to the current directory. The following files will be written:
  15 .Bl -tag -width Ds
  16 .It atom.xml
  17 Atom XML feed
  18 .It files.html
  19 List of files in the latest HEAD commit, linking to the file.
  20 .It log.html
  21 List of commits in order of most recent to old of the commits (top to bottom),
  22 each commit links to a page with a diff and diffstat of the commit.
  23 .It refs.html
  24 Lists references of the repository such as branches and tags.
  25 .El
  26 .Pp
  27 For each file in HEAD a file will be written in the format:
  28 file/filepath.html. This file will contain the textual data of the file
  29 prefixed by line numbers. The file will have the string "binary file"
  30 if the data is considered to be non-textual.
  31 .Pp
  32 For each commit a file will be written in the format:
  33 commit/commitid.html . This file will contain the diff and diffstat of the
  34 commit. It will write the string "binary files differ" if the data is
  35 considered to be non-textual.
  36 .Pp
  37 The basename of the directory is used as the name. The suffix ".git" is
  38 removed from the basename, this is commonly used for "bare" repos.
  39 .Pp
  40 The content of the follow files specifies the meta data for each repository:
  41 .Bl -tag -width Ds
  42 .It .git/description or description (bare repo).
  43 description
  44 .It .git/owner or owner (bare repo).
  45 owner of repository
  46 .It .git/url or url (bare repo).
  47 primary clone url of the repository, for example: git://git.2f30.org/stagit
  48 .El
  49 .Pp
  50 For changing the style of the page you can use the following files:
  51 .Bl -tag -width Ds
  52 .It logo.png
  53 32x32 logo.
  54 .It favicon.png
  55 favicon image.
  56 .It style.css
  57 CSS stylesheet.
  58 .El
  59 .Sh SEE ALSO
  60 .Xr stagit-index 1
  61 .Sh AUTHORS
  62 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org