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