man pages: add EXAMPLES section - stagit-gopher - A git gopher frontend. (mirro… | |
git clone git://bitreich.org/stagit-gopher/ git://enlrupgkhuxnvlhsf6lc3fziv5h2h… | |
Log | |
Files | |
Refs | |
Tags | |
README | |
LICENSE | |
--- | |
commit 9d738c87ca291d354f215c45469a6ba983474f73 | |
parent a69ad4ac2fcece441b9e216377318cb31fb65577 | |
Author: Hiltjo Posthuma <[email protected]> | |
Date: Tue, 3 Aug 2021 19:23:14 +0200 | |
man pages: add EXAMPLES section | |
Diffstat: | |
M stagit-gopher-index.1 | 7 ++++++- | |
M stagit-gopher.1 | 11 ++++++++++- | |
2 files changed, 16 insertions(+), 2 deletions(-) | |
--- | |
diff --git a/stagit-gopher-index.1 b/stagit-gopher-index.1 | |
@@ -1,4 +1,4 @@ | |
-.Dd May 18, 2021 | |
+.Dd August 2, 2021 | |
.Dt STAGIT-GOPHER-INDEX 1 | |
.Os | |
.Sh NAME | |
@@ -32,6 +32,11 @@ The content of the follow files specifies the meta data for … | |
.It .git/description or description (bare repos). | |
description | |
.El | |
+.Sh EXAMPLES | |
+.Bd -literal | |
+cd gphroot | |
+stagit-gopher-index path/to/gitrepo1 path/to/gitrepo2 > index.gph | |
+.Ed | |
.Sh SEE ALSO | |
.Xr stagit-gopher 1 | |
.Sh AUTHORS | |
diff --git a/stagit-gopher.1 b/stagit-gopher.1 | |
@@ -1,4 +1,4 @@ | |
-.Dd July 27, 2021 | |
+.Dd August 2, 2021 | |
.Dt STAGIT-GOPHER 1 | |
.Os | |
.Sh NAME | |
@@ -104,6 +104,15 @@ When a README or LICENSE file exists in HEAD or a .gitmodu… | |
exists in HEAD a direct link in the index is made. | |
.Sh EXIT STATUS | |
.Ex -std | |
+.Sh EXAMPLES | |
+.Bd -literal | |
+mkdir -p gphroot/gphrepo1 && cd gphroot/gphrepo1 | |
+stagit-gopher path/to/gitrepo1 | |
+# repeat for other repositories. | |
+.Ed | |
+.Pp | |
+To update the gph 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-gopher-index 1 | |
.Sh AUTHORS |