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 .Ar repo
14 .Op Ar repo2 Op ...
15 .Sh DESCRIPTION
16 .Nm
17 writes a webpage consisting of index and repository
18 pages for bare repositories located at
19 .Ar repo ,
20 .Ar repo2 ,
21 etc. Non-bare repositories can also be used, but will be labelled
22 as "untitled" wherever their name would have appeared. Its options
23 are as follows:
24 .Bl -tag -width Ds
25 .It Fl i
26 If present, generate an index page. The exact file this page is
27 saved to is defined by config.h at compile time.
28 .It Fl p
29 If present, generate the specified repositories' pages.
30 .It Fl o Ar outdir
31 Write all output files under the
32 .Ar outdir
33 directory. The exact destinations of the files are determined by
34 the paths specified in config.h at compile time.
35 .It Fl b Ar baseurl
36 Links within the generated webpages include this path, to allow
37 the webpage to be served from the
38 .Ar baseurl
39 subdirectory.
40 .El
41 .Pp
42 The program will return with a failing status if neither of
43 .Fl i
44 and
45 .Fl p
46 are specified, or if no repositories are selected.
47 .Pp
48 .Nm
49 will do nothing to attempt to clean up the output it has produced
50 if it fails after writing files.
51 .Pp
52 It does not remove any files from its output directories and
53 does not make changes to any of the input repositories.
54 .Pp
55 It will not, however, indicate any kind of warning before
56 overwriting the files it has been configured to write its
57 output into.
58 .El
59 .Sh EXIT STATUS
60 .Ex -std
61 .Sh SEE ALSO
62 .Xr git 1
63 .Xr
64 .Sh AUTHORS
65 .An Emma Weaver Aq Mt emma@y1.nz
66 .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.