Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
STAGIT(1)		  BSD General Commands Manual		     STAGIT(1)

NAME
     stagit -- static git page generator

SYNOPSIS
     stagit [-c	cachefile] repodir

DESCRIPTION
     stagit writes HTML	pages for the repository repodir to the	current	direc-
     tory.

     Optionally	the -c cachefile option	can be used to cache the entries of
     the log page up to	the point of the last commit. The cachefile will store
     the last commit id	and the	entries	in the HTML table. It is up to the
     user to make sure the state of the	cachefile is in	sync with the history
     of	the repository.

     The following files will be written:

     atom.xml
	     Atom XML feed

     files.html
	     List of files in the latest HEAD commit, linking to the file.

     log.html
	     List of commits in	order of most recent to	old of the commits
	     (top to bottom), each commit links	to a page with a diff and
	     diffstat of the commit.

     refs.html
	     Lists references of the repository	such as	branches and tags.

     For each entry in HEAD a file will	be written in the format:
     file/filepath.html. 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.

     For each commit a file will be written in the format: commit/commi-
     tid.html. This file will contain the diff and diffstat 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.

     When a commit HTML	file exists it won't be	overwritten again, note	that
     if	you've changed stagit or changed one of	the metadata files of the
     repository	it is recommended to recreate all the output files because it
     will contain old data. To do this remove the output directory and
     cachefile,	then recreate the files.

     The basename of the directory is used as the name.	The suffix ".git" is
     removed from the basename,	this is	commonly used for "bare" repos.

     The content of the	follow files specifies the metadata for	each reposi-
     tory:

     .git/description or description (bare repo).
	     description

     .git/owner	or owner (bare repo).
	     owner of repository

     .git/url or url (bare repo).
	     primary clone url of the repository, for example:
	     git://git.2f30.org/stagit

     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.

     For changing the style of the page	you can	use the	following files:

     logo.png
	     32x32 logo.

     favicon.png
	     favicon image.

     style.css
	     CSS stylesheet.

SEE ALSO
     stagit-index(1)

AUTHORS
     Hiltjo Posthuma <hiltjo@codemadness.org>

BSD				  May 1, 2016				   BSD

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | AUTHORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=stagit&sektion=1&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help