man pages: add EXAMPLES section
| 2 files changed, 16 insertions(+), 2 deletions(-) | |||
|---|---|---|---|
| M | stagit-index.1 | +6 | -1 |
| M | stagit.1 | +10 | -1 |
1@@ -1,4 +1,4 @@
2-.Dd December 26, 2015
3+.Dd August 2, 2021
4 .Dt STAGIT-INDEX 1
5 .Os
6 .Sh NAME
7@@ -36,6 +36,11 @@ favicon image.
8 .It style.css
9 CSS stylesheet.
10 .El
11+.Sh EXAMPLES
12+.Bd -literal
13+cd htmlroot
14+stagit-index path/to/gitrepo1 path/to/gitrepo2 > index.html
15+.Ed
16 .Sh SEE ALSO
17 .Xr stagit 1
18 .Sh AUTHORS
1@@ -1,4 +1,4 @@
2-.Dd July 27, 2021
3+.Dd August 2, 2021
4 .Dt STAGIT 1
5 .Os
6 .Sh NAME
7@@ -110,6 +110,15 @@ CSS stylesheet.
8 .El
9 .Sh EXIT STATUS
10 .Ex -std
11+.Sh EXAMPLES
12+.Bd -literal
13+mkdir -p htmlroot/htmlrepo1 && cd htmlroot/htmlrepo1
14+stagit path/to/gitrepo1
15+# repeat for other repositories.
16+.Ed
17+.Pp
18+To update the HTML files when the repository is changed a git post-receive hook
19+can be used, see the file example_post-receive.sh for an example.
20 .Sh SEE ALSO
21 .Xr stagit-index 1
22 .Sh AUTHORS