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

FreeBSD Manual Pages

  
 
  

home | help
GITUP()				     LOCAL			       GITUP()

NAME
       gitup --	A minimalist, dependency-free program to clone/pull git	repos-
       itories.

SYNOPSIS
       gitup  section  [-ckrV]	[-h  commit  checksum] [-t tag]	[-u pack file]
	     [-v verbosity] [-w	commit checksum]

DESCRIPTION
       gitup is	a minimalist, dependency-free program used to  clone  or  syn-
       chronize	 a local copy of a git repository.  It is not intended to be a
       full-featured replacement for the devel/git port, but  rather,  is  in-
       tended  to  provide a convenient	way for	users to update	FreeBSD	source
       files without having to install devel/git (and all of its  related  de-
       pendencies) and without the substantial disk overhead that normally ac-
       company local git repositories.

OPTIONS
       Configuration  options  are stored in /usr/local/etc/gitup.conf and are
       grouped into commonly used sections (additional custom sections can  be
       added to	this file).  The following command line	options	can be used to
       override	the default and/or section values:

       -c	   Force gitup to clone	the repository.

       -h	   The	"have" commit checksum of the repository to use.  Only
		   needed when importing a pack	file generated by the official
		   git client.

       -k	   Save	a copy of the pack data.

       -r	   Repair the local repository,	replacing any files  that  are
		   missing or have been	modified.

       -t	   Fetch the commit referenced by the specified	tag.

       -u	   Skip	 the  download	of the pack data and use the specified
		   file	instead.

       -v	   How verbose the output should be (0 = no output, 1  =  show
		   only	names of the updated files/folders, 2 =	also show com-
		   mands  sent to the server and additional debugging informa-
		   tion).

       -V	   Display the version number and exit.

       -w	   The "want" commit checksum of the repository	to retrieve.

FILES
       /usr/local/etc/gitup.conf  Default location of the gitup	 configuration
				  file.

       /var/db/gitup		  Default  location  where  gitup  stores  its
				  lists	of known files.	 The files stored here
				  are used during subsequent  runs  to	recon-
				  struct  the  local repository	state and con-
				  firm that the	local tree is intact.

CAVEATS
       Because gitup neither uses nor updates the .git folder,	it  is	not  a
       drop-in	replacement for	the official git client.  gitup	should only be
       used on repositories originally cloned with the official	git client  if
       there is	no intention to	ever use the official git client on that local
       repository again.

       To  keep	its footprint as small as possible, gitup does not retain pack
       files downloaded	from the repository (unless explicitly	instructed  to
       do so) and does not use a saved pack file (unless explicitly instructed
       to  do  so).   gitup  relies  on	the known remote files lists stored in
       /var/db/gitup and the current state of the local	repository  to	recon-
       struct data that	would normally be stored in the	pack file.  Discrepan-
       cies  in	 the local repository will be flagged as errors	and gitup will
       attempt to any restore any missing or modified files from  the  server,
       returning the local repository to a clean state.

EXAMPLES
       Using the configuration options for commonly used repositories/branches
       stored  in  /usr/local/etc/gitup.conf, to clone/pull a copy of the most
       recent revision of stable/12:

	     gitup stable

       To    retrieve	 a     copy	of     freebsd-ports	 at	commit
       0123456789abcdef0123456789abcdef01234567:

	     gitup ports -w 0123456789abcdef0123456789abcdef01234567

SEE ALSO
       gitup.conf(5)

AUTHORS
       John Mehr <jmehr@umn.edu> is the	author of gitup	and this man page.

GNU			       December	5, 2020			       GITUP()

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | FILES | CAVEATS | EXAMPLES | SEE ALSO | AUTHORS

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

home | help