sgw | Static git web (fork of stagit) |
| download: https://git.y1.nz/archives/sgw.tar.gz | |
| README | Files | Log | Refs | LICENSE |
sgw.1
1 .Dd August 2, 2021
2 .Dt SGW 1
3 .Os
4 .Sh NAME
5 .Nm sgw
6 .Nd static git webpage generator
7 .Sh SYNOPSIS
8 .Nm
9 .Op Fl i
10 .Op Fl p
11 .Op Fl o Ar outdir
12 .Op Fl b Ar baseurl
13 .Op Fl c Ar category
14 .Ar repo
15 .Op Ar repo2 ...
16 .Sh DESCRIPTION
17 .Nm
18 writes a webpage consisting of index and repository
19 pages for bare repositories located at
20 .Ar repo ,
21 .Ar repo2 ,
22 etc. Non-bare repositories can also be used, but will be labelled
23 as "untitled" wherever their name would have appeared. Its options
24 are as follows:
25 .Bl -tag -width Ds
26 .It Fl i
27 If present, generate an index page. The exact file this page is
28 saved to is defined by config.h at compile time. The index page
29 lists the specified repositories, sorted by most-to-least recent
30 commit in HEAD.
31 .It Fl p
32 If present, generate the specified repositories' pages.
33 .It Fl o Ar outdir
34 Write all output files under the
35 .Ar outdir
36 directory. The exact destinations of the files are determined by
37 the paths specified in config.h at compile time.
38 .It Fl b Ar baseurl
39 Links within the generated webpages include this path, to allow
40 the webpage to be served from the
41 .Ar baseurl
42 subdirectory.
43 .It Fl c Ar category
44 This argument may only be used with
45 .Ar i ,
46 and may be used multiple times. It allows the specification
47 of category headings, displayed on the index page. The
48 repositories are shown on the index page under the most recently
49 specified category. Each category is sorted independently.
50 .El
51 .Pp
52 The program will return with a failing status if neither of
53 .Fl i
54 and
55 .Fl p
56 are specified, or if no repositories are selected.
57 .Pp
58 .Nm
59 will do nothing to attempt to clean up the output it has produced
60 if it fails after writing files.
61 .Pp
62 It does not remove any files from its output directories and
63 does not make changes to any of the input repositories.
64 .Pp
65 It will not, however, indicate any kind of warning before
66 overwriting the files it has been configured to write its
67 output into.
68 .El
69 .Sh EXIT STATUS
70 .Ex -std
71 .Sh SEE ALSO
72 .Xr git 1
73 .Xr
74 .Sh AUTHORS
75 .An Emma Weaver Aq Mt emma@y1.nz
76 .An Based heavily on work by Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.