man pages: add EXAMPLES section
This commit is contained in:
parent
d3fac5f244
commit
d106bcdc97
|
@ -1,4 +1,4 @@
|
||||||
.Dd December 26, 2015
|
.Dd August 2, 2021
|
||||||
.Dt STAGIT-INDEX 1
|
.Dt STAGIT-INDEX 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -36,6 +36,11 @@ favicon image.
|
||||||
.It style.css
|
.It style.css
|
||||||
CSS stylesheet.
|
CSS stylesheet.
|
||||||
.El
|
.El
|
||||||
|
.Sh EXAMPLES
|
||||||
|
.Bd -literal
|
||||||
|
cd htmlroot
|
||||||
|
stagit-index path/to/gitrepo1 path/to/gitrepo2 > index.html
|
||||||
|
.Ed
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr stagit 1
|
.Xr stagit 1
|
||||||
.Sh AUTHORS
|
.Sh AUTHORS
|
||||||
|
|
11
stagit.1
11
stagit.1
|
@ -1,4 +1,4 @@
|
||||||
.Dd July 27, 2021
|
.Dd August 2, 2021
|
||||||
.Dt STAGIT 1
|
.Dt STAGIT 1
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
|
@ -110,6 +110,15 @@ CSS stylesheet.
|
||||||
.El
|
.El
|
||||||
.Sh EXIT STATUS
|
.Sh EXIT STATUS
|
||||||
.Ex -std
|
.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
|
.Sh SEE ALSO
|
||||||
.Xr stagit-index 1
|
.Xr stagit-index 1
|
||||||
.Sh AUTHORS
|
.Sh AUTHORS
|
||||||
|
|
Loading…
Reference in a new issue