6 .Nd static git page generator
14 writes HTML pages for the repository
16 to the current directory.
18 The options are as follows:
21 Cache the entries of the log page up to the point of
25 will store the last commit id and the entries in the HTML table.
26 It is up to the user to make sure the state of the
28 is in sync with the history of the repository.
30 Write a maximum number of
32 to the log.html file only.
33 However the commit files are written as usual.
40 cannot be used at the same time.
42 The following files will be written:
47 List of files in the latest tree, linking to the file.
49 List of commits in reverse chronological applied commit order, each commit
50 links to a page with a diffstat and diff of the commit.
52 Lists references of the repository such as branches and tags.
55 For each entry in HEAD a file will be written in the format:
57 This file will contain the textual data of the file prefixed by line numbers.
58 The file will have the string "Binary file" if the data is considered to be
61 For each commit a file will be written in the format:
63 This file will contain the diffstat and diff of the commit.
64 It will write the string "Binary files differ" if the data is considered to
66 Too large diffs will be suppressed and a string
67 "Diff is too large, output suppressed" will be written.
69 When a commit HTML file exists it won't be overwritten again, note that if
72 or changed one of the metadata files of the repository it is recommended to
73 recreate all the output files because it will contain old data.
74 To do this remove the output directory and
76 then recreate the files.
78 The basename of the directory is used as the repository name.
79 The suffix ".git" is removed from the basename, this suffix is commonly used
82 The content of the follow files specifies the metadata for each repository:
84 .It .git/description or description (bare repo).
86 .It .git/owner or owner (bare repo).
88 .It .git/url or url (bare repo).
89 primary clone url of the repository, for example: git://git.2f30.org/stagit
92 When a README or LICENSE file exists in HEAD or a .gitmodules submodules file
93 exists in HEAD a direct link in the menu is made.
95 For changing the style of the page you can use the following files:
107 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
108 .An Armaan Bhojwani Aq Mt me@armaanb.net