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.
  26 .Pp
  27 The following files will be written:
  28 .Bl -tag -width Ds
  29 .It atom.xml
  30 Atom XML feed
  31 .It files.html
  32 List of files in the latest HEAD commit, linking to the file.
  33 .It log.html
  34 List of commits in order of most recent to old of the commits (top to bottom),
  35 each commit links to a page with a diff and diffstat of the commit.
  36 .It refs.html
  37 Lists references of the repository such as branches and tags.
  38 .El
  39 .Pp
  40 For each entry in HEAD a file will be written in the format:
  41 file/filepath.html. This file will contain the textual data of the file
  42 prefixed by line numbers. The file will have the string "Binary file"
  43 if the data is considered to be non-textual.
  44 .Pp
  45 For each commit a file will be written in the format:
  46 commit/commitid.html. This file will contain the diff and diffstat of the
  47 commit. It will write the string "Binary files differ" if the data is
  48 considered to be non-textual. Too large diffs will be suppressed and a string
  49 "Diff is too large, output suppressed" will be written.
  50 .Pp
  51 When a commit HTML file exists it won't be overwritten again, note that if
  52 you've changed
  53 .Nm
  54 or changed one of the metadata files of the repository it is recommended to
  55 recreate all the output files because it will contain old data. To do this
  56 remove the output directory and
  57 .Ar cachefile ,
  58 then recreate the files.
  59 .Pp
  60 The basename of the directory is used as the name. The suffix ".git" is
  61 removed from the basename, this is commonly used for "bare" repos.
  62 .Pp
  63 The content of the follow files specifies the metadata for each repository:
  64 .Bl -tag -width Ds
  65 .It .git/description or description (bare repo).
  66 description
  67 .It .git/owner or owner (bare repo).
  68 owner of repository
  69 .It .git/url or url (bare repo).
  70 primary clone url of the repository, for example: git://git.2f30.org/stagit
  71 .El
  72 .Pp
  73 When a README or LICENSE file exists in HEAD or a .gitmodules submodules file
  74 exists in HEAD a direct link in the menu is made.
  75 .Pp
  76 For changing the style of the page you can use the following files:
  77 .Bl -tag -width Ds
  78 .It logo.png
  79 32x32 logo.
  80 .It favicon.png
  81 favicon image.
  82 .It style.css
  83 CSS stylesheet.
  84 .El
  85 .Sh SEE ALSO
  86 .Xr stagit-index 1
  87 .Sh AUTHORS
  88 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org