stagit-gopher

static git page generator for gopher (mirror)
git clone git://git.2f30.org/stagit-gopher.git
Log | Files | Refs | README | LICENSE

stagit-gopher.1 (2874B)


      1 .Dd February 6, 2019
      2 .Dt STAGIT-GOPHER 1
      3 .Os
      4 .Sh NAME
      5 .Nm stagit-gopher
      6 .Nd static git Gopher index generator
      7 .Sh SYNOPSIS
      8 .Nm
      9 .Op Fl b Ar baseprefix
     10 .Op Fl c Ar cachefile
     11 .Op Fl l Ar commits
     12 .Ar repodir
     13 .Sh DESCRIPTION
     14 .Nm
     15 writes Gopher indexes for the repository
     16 .Ar repodir
     17 to the current directory.
     18 .Pp
     19 The options are as follows:
     20 .Bl -tag -width Ds
     21 .It Fl b Ar baseprefix
     22 Use base prefix as the root.
     23 By default this is "".
     24 .It Fl c Ar cachefile
     25 Cache the entries of the log index up to the point of
     26 the last commit.
     27 The
     28 .Ar cachefile
     29 will store the last commit id and the entries in the Gopher index.
     30 It is up to the user to make sure the state of the
     31 .Ar cachefile
     32 is in sync with the history of the repository.
     33 .It Fl l Ar commits
     34 Write a maximum number of
     35 .Ar commits
     36 to the log.gph file only.
     37 However the commit files are written as usual.
     38 .El
     39 .Pp
     40 The options
     41 .Fl c
     42 and
     43 .Fl l
     44 cannot be used at the same time.
     45 .Pp
     46 The following files will be written:
     47 .Bl -tag -width Ds
     48 .It atom.xml
     49 Atom XML feed
     50 .It files.gph
     51 List of files in the latest tree, linking to the file.
     52 .It log.gph
     53 List of commits in reverse chronological applied commit order, each commit
     54 links to a page with a diffstat and diff of the commit.
     55 .It refs.gph
     56 Lists references of the repository such as branches and tags.
     57 .El
     58 .Pp
     59 For each entry in HEAD a file will be written in the format:
     60 file/filepath.gph.
     61 This file will contain the textual data of the file prefixed by line numbers.
     62 The file will have the string "Binary file" if the data is considered to be
     63 non-textual.
     64 .Pp
     65 For each commit a file will be written in the format:
     66 commit/commitid.gph.
     67 This file will contain the diffstat and diff of the commit.
     68 It will write the string "Binary files differ" if the data is considered to
     69 be non-textual.
     70 Too large diffs will be suppressed and a string
     71 "Diff is too large, output suppressed" will be written.
     72 .Pp
     73 When a Gopher commit file exists it won't be overwritten again, note that if
     74 you've changed
     75 .Nm
     76 or changed one of the metadata files of the repository it is recommended to
     77 recreate all the output files because it will contain old data.
     78 To do this remove the output directory and
     79 .Ar cachefile ,
     80 then recreate the files.
     81 .Pp
     82 The basename of the directory is used as the repository name.
     83 The suffix ".git" is removed from the basename, this suffix is commonly used
     84 for "bare" repos.
     85 .Pp
     86 The content of the follow files specifies the metadata for each repository:
     87 .Bl -tag -width Ds
     88 .It .git/description or description (bare repo).
     89 description
     90 .It .git/url or url (bare repo).
     91 primary clone url of the repository, for example: git://git.2f30.org/stagit
     92 .El
     93 .Pp
     94 When a README or LICENSE file exists in HEAD or a .gitmodules submodules file
     95 exists in HEAD a direct link in the index is made.
     96 .Sh SEE ALSO
     97 .Xr stagit-gopher-index 1
     98 .Sh AUTHORS
     99 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org