istagit-gopher.1 - stagit-gopher - A git gopher frontend. (mirror) Err bitreich.org 70 hgit clone git://bitreich.org/stagit-gopher/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/stagit-gopher/ URL:git://bitreich.org/stagit-gopher/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/stagit-gopher/ bitreich.org 70 1Log /scm/stagit-gopher/log.gph bitreich.org 70 1Files /scm/stagit-gopher/files.gph bitreich.org 70 1Refs /scm/stagit-gopher/refs.gph bitreich.org 70 1Tags /scm/stagit-gopher/tag bitreich.org 70 1README /scm/stagit-gopher/file/README.gph bitreich.org 70 1LICENSE /scm/stagit-gopher/file/LICENSE.gph bitreich.org 70 i--- Err bitreich.org 70 istagit-gopher.1 (3493B) Err bitreich.org 70 i--- Err bitreich.org 70 i 1 .Dd August 2, 2021 Err bitreich.org 70 i 2 .Dt STAGIT-GOPHER 1 Err bitreich.org 70 i 3 .Os Err bitreich.org 70 i 4 .Sh NAME Err bitreich.org 70 i 5 .Nm stagit-gopher Err bitreich.org 70 i 6 .Nd static git Gopher index generator Err bitreich.org 70 i 7 .Sh SYNOPSIS Err bitreich.org 70 i 8 .Nm Err bitreich.org 70 i 9 .Op Fl b Ar baseprefix Err bitreich.org 70 i 10 .Op Fl c Ar cachefile Err bitreich.org 70 i 11 .Op Fl l Ar commits Err bitreich.org 70 i 12 .Op Fl u Ar baseurl Err bitreich.org 70 i 13 .Ar repodir Err bitreich.org 70 i 14 .Sh DESCRIPTION Err bitreich.org 70 i 15 .Nm Err bitreich.org 70 i 16 writes Gopher indexes for the repository Err bitreich.org 70 i 17 .Ar repodir Err bitreich.org 70 i 18 to the current directory. Err bitreich.org 70 i 19 .Pp Err bitreich.org 70 i 20 The options are as follows: Err bitreich.org 70 i 21 .Bl -tag -width Ds Err bitreich.org 70 i 22 .It Fl b Ar baseprefix Err bitreich.org 70 i 23 Use base prefix as the root. Err bitreich.org 70 i 24 By default this is "". Err bitreich.org 70 i 25 .It Fl c Ar cachefile Err bitreich.org 70 i 26 Cache the entries of the log index up to the point of Err bitreich.org 70 i 27 the last commit. Err bitreich.org 70 i 28 The Err bitreich.org 70 i 29 .Ar cachefile Err bitreich.org 70 i 30 will store the last commit id and the entries in the Gopher index. Err bitreich.org 70 i 31 It is up to the user to make sure the state of the Err bitreich.org 70 i 32 .Ar cachefile Err bitreich.org 70 i 33 is in sync with the history of the repository. Err bitreich.org 70 i 34 .It Fl l Ar commits Err bitreich.org 70 i 35 Write a maximum number of Err bitreich.org 70 i 36 .Ar commits Err bitreich.org 70 i 37 to the log.gph file only. Err bitreich.org 70 i 38 However the commit files are written as usual. Err bitreich.org 70 i 39 .It Fl u Ar baseurl Err bitreich.org 70 i 40 Base URL to make links in the Atom feeds absolute. Err bitreich.org 70 i 41 Does not use the prefix from the -b option. Err bitreich.org 70 i 42 It should include the gopher type. Err bitreich.org 70 i 43 For example: "gopher://codemadness.org/1/git/stagit-gopher/". Err bitreich.org 70 i 44 .El Err bitreich.org 70 i 45 .Pp Err bitreich.org 70 i 46 The options Err bitreich.org 70 i 47 .Fl c Err bitreich.org 70 i 48 and Err bitreich.org 70 i 49 .Fl l Err bitreich.org 70 i 50 cannot be used at the same time. Err bitreich.org 70 i 51 .Pp Err bitreich.org 70 i 52 The following files will be written: Err bitreich.org 70 i 53 .Bl -tag -width Ds Err bitreich.org 70 i 54 .It atom.xml Err bitreich.org 70 i 55 Atom XML feed of the last 100 commits. Err bitreich.org 70 i 56 .It tags.xml Err bitreich.org 70 i 57 Atom XML feed of the tags. Err bitreich.org 70 i 58 .It files.gph Err bitreich.org 70 i 59 List of files in the latest tree, linking to the file. Err bitreich.org 70 i 60 .It log.gph Err bitreich.org 70 i 61 List of commits in reverse chronological applied commit order, each commit Err bitreich.org 70 i 62 links to a page with a diffstat and diff of the commit. Err bitreich.org 70 i 63 .It refs.gph Err bitreich.org 70 i 64 Lists references of the repository such as branches and tags. Err bitreich.org 70 i 65 .El Err bitreich.org 70 i 66 .Pp Err bitreich.org 70 i 67 For each entry in HEAD a file will be written in the format: Err bitreich.org 70 i 68 file/filepath.gph. Err bitreich.org 70 i 69 This file will contain the textual data of the file prefixed by line numbers. Err bitreich.org 70 i 70 The file will have the string "Binary file" if the data is considered to be Err bitreich.org 70 i 71 non-textual. Err bitreich.org 70 i 72 .Pp Err bitreich.org 70 i 73 For each commit a file will be written in the format: Err bitreich.org 70 i 74 commit/commitid.gph. Err bitreich.org 70 i 75 This file will contain the diffstat and diff of the commit. Err bitreich.org 70 i 76 It will write the string "Binary files differ" if the data is considered to Err bitreich.org 70 i 77 be non-textual. Err bitreich.org 70 i 78 Too large diffs will be suppressed and a string Err bitreich.org 70 i 79 "Diff is too large, output suppressed" will be written. Err bitreich.org 70 i 80 .Pp Err bitreich.org 70 i 81 When a Gopher commit file exists it won't be overwritten again, note that if Err bitreich.org 70 i 82 you've changed Err bitreich.org 70 i 83 .Nm Err bitreich.org 70 i 84 or changed one of the metadata files of the repository it is recommended to Err bitreich.org 70 i 85 recreate all the output files because it will contain old data. Err bitreich.org 70 i 86 To do this remove the output directory and Err bitreich.org 70 i 87 .Ar cachefile , Err bitreich.org 70 i 88 then recreate the files. Err bitreich.org 70 i 89 .Pp Err bitreich.org 70 i 90 The basename of the directory is used as the repository name. Err bitreich.org 70 i 91 The suffix ".git" is removed from the basename, this suffix is commonly used Err bitreich.org 70 i 92 for "bare" repos. Err bitreich.org 70 i 93 .Pp Err bitreich.org 70 i 94 The content of the follow files specifies the metadata for each repository: Err bitreich.org 70 i 95 .Bl -tag -width Ds Err bitreich.org 70 i 96 .It .git/description or description (bare repo). Err bitreich.org 70 i 97 description Err bitreich.org 70 i 98 .It .git/url or url (bare repo). Err bitreich.org 70 i 99 primary clone URL of the repository, for example: Err bitreich.org 70 i 100 git://git.codemadness.org/stagit Err bitreich.org 70 i 101 .El Err bitreich.org 70 i 102 .Pp Err bitreich.org 70 i 103 When a README or LICENSE file exists in HEAD or a .gitmodules submodules file Err bitreich.org 70 i 104 exists in HEAD a direct link in the index is made. Err bitreich.org 70 i 105 .Sh EXIT STATUS Err bitreich.org 70 i 106 .Ex -std Err bitreich.org 70 i 107 .Sh EXAMPLES Err bitreich.org 70 i 108 .Bd -literal Err bitreich.org 70 i 109 mkdir -p gphroot/gphrepo1 && cd gphroot/gphrepo1 Err bitreich.org 70 i 110 stagit-gopher path/to/gitrepo1 Err bitreich.org 70 i 111 # repeat for other repositories. Err bitreich.org 70 i 112 .Ed Err bitreich.org 70 i 113 .Pp Err bitreich.org 70 i 114 To update the gph files when the repository is changed a git post-receive hook Err bitreich.org 70 i 115 can be used, see the file example_post-receive.sh for an example. Err bitreich.org 70 i 116 .Sh SEE ALSO Err bitreich.org 70 i 117 .Xr stagit-gopher-index 1 Err bitreich.org 70 i 118 .Sh AUTHORS Err bitreich.org 70 i 119 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org Err bitreich.org 70 .