Adapt manpages for Gopher - stagit-gopher - A git gopher frontend. (mirror) | |
git clone git://bitreich.org/stagit-gopher/ git://enlrupgkhuxnvlhsf6lc3fziv5h2h… | |
Log | |
Files | |
Refs | |
Tags | |
README | |
LICENSE | |
--- | |
commit 5db7d13ef03d44b2da93fb09a1e1d1149333f8e5 | |
parent d97002d21462133dbd3b0f37732a62b2f5f4a529 | |
Author: Quentin Rameau <[email protected]> | |
Date: Fri, 16 Jun 2017 11:27:28 +0200 | |
Adapt manpages for Gopher | |
Diffstat: | |
M stagit-gopher-index.1 | 20 +++++--------------- | |
M stagit-gopher.1 | 28 ++++++++++++++-------------- | |
2 files changed, 19 insertions(+), 29 deletions(-) | |
--- | |
diff --git a/stagit-gopher-index.1 b/stagit-gopher-index.1 | |
@@ -1,16 +1,16 @@ | |
.Dd December 26, 2015 | |
-.Dt STAGIT-INDEX 1 | |
+.Dt STAGIT-GOPHER-INDEX 1 | |
.Os | |
.Sh NAME | |
-.Nm stagit-index | |
-.Nd static git index page generator | |
+.Nm stagit-gopher-index | |
+.Nd static git Gopher index generator | |
.Sh SYNOPSIS | |
.Nm | |
.Op Ar repodir... | |
.Sh DESCRIPTION | |
.Nm | |
-will create an index HTML page for the repositories specified and writes | |
-the HTML data to stdout. | |
+will create a Gopher index for the repositories specified and writes | |
+the Gopher data to stdout. | |
The repos in the index are in the same order as the arguments | |
.Ar repodir | |
specified. | |
@@ -24,16 +24,6 @@ The content of the follow files specifies the meta data for … | |
.It .git/description or description (bare repos). | |
description | |
.El | |
-.Pp | |
-For changing the style of the page you can use the following files: | |
-.Bl -tag -width Ds | |
-.It favicon.png | |
-favicon image. | |
-.It logo.png | |
-32x32 logo. | |
-.It style.css | |
-CSS stylesheet. | |
-.El | |
.Sh SEE ALSO | |
.Xr stagit-gopher 1 | |
.Sh AUTHORS | |
diff --git a/stagit-gopher.1 b/stagit-gopher.1 | |
@@ -1,27 +1,27 @@ | |
.Dd May 1, 2016 | |
-.Dt STAGIT 1 | |
+.Dt STAGIT-GOPHER 1 | |
.Os | |
.Sh NAME | |
-.Nm stagit | |
-.Nd static git page generator | |
+.Nm stagit-gopher | |
+.Nd static git Gopher index generator | |
.Sh SYNOPSIS | |
.Nm | |
.Op Fl c Ar cachefile | |
.Ar repodir | |
.Sh DESCRIPTION | |
.Nm | |
-writes HTML pages for the repository | |
+writes Gopher indexes for the repository | |
.Ar repodir | |
to the current directory. | |
.Pp | |
The options are as follows: | |
.Bl -tag -width Ds | |
.It Fl c Ar cachefile | |
-Cache the entries of the log page up to the point of | |
+Cache the entries of the log index up to the point of | |
the last commit. | |
The | |
.Ar cachefile | |
-will store the last commit id and the entries in the HTML table. | |
+will store the last commit id and the entries in the Gopher index. | |
It is up to the user to make sure the state of the | |
.Ar cachefile | |
is in sync with the history of the repository. | |
@@ -31,30 +31,30 @@ The following files will be written: | |
.Bl -tag -width Ds | |
.It atom.xml | |
Atom XML feed | |
-.It files.html | |
+.It files.gph | |
List of files in the latest tree, linking to the file. | |
-.It log.html | |
+.It log.gph | |
List of commits in order of most recent to old of the commits (top to bottom), | |
-each commit links to a page with a diffstat and diff of the commit. | |
-.It refs.html | |
+each commit links to an index with a diffstat and diff of the commit. | |
+.It refs.gph | |
Lists references of the repository such as branches and tags. | |
.El | |
.Pp | |
For each entry in HEAD a file will be written in the format: | |
-file/filepath.html. | |
+file/filepath.gph. | |
This file will contain the textual data of the file prefixed by line numbers. | |
The file will have the string "Binary file" if the data is considered to be | |
non-textual. | |
.Pp | |
For each commit a file will be written in the format: | |
-commit/commitid.html. | |
+commit/commitid.gph. | |
This file will contain the diffstat and diff of the commit. | |
It will write the string "Binary files differ" if the data is considered to | |
be non-textual. | |
Too large diffs will be suppressed and a string | |
"Diff is too large, output suppressed" will be written. | |
.Pp | |
-When a commit HTML file exists it won't be overwritten again, note that if | |
+When a Gopher commit file exists it won't be overwritten again, note that if | |
you've changed | |
.Nm | |
or changed one of the metadata files of the repository it is recommended to | |
@@ -76,7 +76,7 @@ primary clone url of the repository, for example: git://git.2… | |
.El | |
.Pp | |
When a README or LICENSE file exists in HEAD or a .gitmodules submodules file | |
-exists in HEAD a direct link in the menu is made. | |
+exists in HEAD a direct link in the index is made. | |
.Sh SEE ALSO | |
.Xr stagit-gopher-index 1 | |
.Sh AUTHORS |