commit 1b6a24c893866a604d9b7bc425f9b23706f39912
parent 61be8f532818ac1c8d16e418d6e3124d10f82bd6
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Tue, 3 Aug 2021 19:22:50 +0200
man pages: add EXAMPLES section
Diffstat:
2 files changed, 16 insertions(+), 2 deletions(-)
diff --git a/stagit-index.1 b/stagit-index.1
@@ -1,4 +1,4 @@
-.Dd December 26, 2015
+.Dd August 2, 2021
.Dt STAGIT-INDEX 1
.Os
.Sh NAME
@@ -36,6 +36,11 @@ favicon image.
.It style.css
CSS stylesheet.
.El
+.Sh EXAMPLES
+.Bd -literal
+cd htmlroot
+stagit-index path/to/gitrepo1 path/to/gitrepo2 > index.html
+.Ed
.Sh SEE ALSO
.Xr stagit 1
.Sh AUTHORS
diff --git a/stagit.1 b/stagit.1
@@ -1,4 +1,4 @@
-.Dd July 27, 2021
+.Dd August 2, 2021
.Dt STAGIT 1
.Os
.Sh NAME
@@ -110,6 +110,15 @@ CSS stylesheet.
.El
.Sh EXIT STATUS
.Ex -std
+.Sh EXAMPLES
+.Bd -literal
+mkdir -p htmlroot/htmlrepo1 && cd htmlroot/htmlrepo1
+stagit path/to/gitrepo1
+# repeat for other repositories.
+.Ed
+.Pp
+To update the HTML files when the repository is changed a git post-receive hook
+can be used, see the file example_post-receive.sh for an example.
.Sh SEE ALSO
.Xr stagit-index 1
.Sh AUTHORS
