man pages: add EXAMPLES section

This commit is contained in:
Hiltjo Posthuma 2021-08-03 19:22:50 +02:00 committed by xfnw
parent d3fac5f244
commit d106bcdc97
2 changed files with 16 additions and 2 deletions

View 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

View File

@ -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