man pages: add EXAMPLES section
authorHiltjo Posthuma <hiltjo@codemadness.org>
Tue, 3 Aug 2021 17:22:50 +0000 (19:22 +0200)
committerHiltjo Posthuma <hiltjo@codemadness.org>
Tue, 3 Aug 2021 17:22:50 +0000 (19:22 +0200)
stagit-index.1
stagit.1

index b4787a8b2c4cf2a6829391d56fb7de06bfad6861..720941d008eb58e1cec02da3204573b7d39a2315 100644 (file)
@@ -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
index 8b43a655296fdc9dc8b0e7ff6d3319d218b0fea5..6585f65526bd3492f35ced2a30c008faaf79224e 100644 (file)
--- 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