6 .Nd static git page generator
13 writes HTML pages for the repository
15 to the current directory.
19 option can be used to cache the entries of the log page up to the point of
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
25 is in sync with the history of the repository.
27 The following files will be written:
32 List of files in the latest HEAD commit, linking to the file.
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.
37 Lists references of the repository such as branches and tags.
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.
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.
51 When a commit HTML file exists it won't be overwritten again, note that if
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
58 then recreate the files.
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.
63 The content of the follow files specifies the metadata for each repository:
65 .It .git/description or description (bare repo).
67 .It .git/owner or owner (bare repo).
69 .It .git/url or url (bare repo).
70 primary clone url of the repository, for example: git://git.2f30.org/stagit
73 For changing the style of the page you can use the following files:
85 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org