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