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

FreeBSD Manual Pages

  
 
  

home | help
GITUP.CONF(5)()			     LOCAL		       GITUP.CONF(5)()

NAME
       gitup.conf -- Configuration file	for gitup(1).

DESCRIPTION
       The  gitup.conf	file stores configuration options and controls the be-
       havior of gitup(1).

       This file contains an arbitrary number of sections, each	of  which  can
       be  passed as the first command line argument to	gitup(1).  Within each
       section,	individual parameters are stored as key/value pairs.

       Lines beginning with a '#' are ignored.

       Additional, user	defined	sections can be	added to gitup.conf as needed.

       When gitup(1) is	run, the options in the	defaults section are  assigned
       first,  followed	 by  the options in the	desired	section	(each of which
       will supersede any previously assigned default values), followed	lastly
       by any command line options.

OPTIONS
       The following options are currently supported by	gitup.conf and can  be
       added to	any section:

       host		 The hostname/IP address of the	server.

       port		 The port on the server	to connect to.

       proxy_host	 The  hostname/IP  address of the proxy	server (if re-
			 quired).

       proxy_port	 The port on the proxy server to connect  to  (if  re-
			 quired).

       proxy_username	 The  username of the account used to access the proxy
			 server	(if required).

       proxy_password	 The password of the account used to access the	 proxy
			 server	(if required).

       source_address	 The source IP address on the local machine to use.

       repository_path	 The repository	path to	use.

       branch		 The repository	branch to use.

       target_directory	 The local directory to	store your copy	of the reposi-
			 tory.

       ignores		 An  array  of	files  and/or directories in the local
			 tree (augmenting the  contents	 of  the  repository's
			 .gitignore file) which	are ignored only when deleting
			 files.	 Any changes to	upstream files in these	direc-
			 tories	 will  be pulled down and merged.  Regular ex-
			 pressions are supported.

       low_memory	 Low memory mode reduces memory	usage by storing  tem-
			 porary	object data to disk.

       verbosity	 How  much of the transfer details to display.	0 = no
			 output, 1 = show only names of	the updated files, 2 =
			 also show commands sent to the	server and  additional
			 debugging information.

       work_directory	 The  location	to  load/save  the  known remote files
			 list.

EXAMPLES
       With the	following configuration	options	defined	in gitup.conf

       {
	   "defaults" :	{
	       "host"		: "github.com",
	       "port"		: "443",
	       "verbosity"	: "1",
	       "work_directory"	: "/var/db/gitup",
	   },

	   "ports" : {
	       "repository_path"  : "/freebsd/freebsd-ports.git",
	       "branch"		  : "master",
	       "target_directory" : "/usr/ports",
	       "ignores"	  : [
		   "/distfiles",
		   "/packages",
	       ],
	   },
       }

       Executing:

	     gitup ports

       from the	command	line would result in a copy of the  freebsd-ports/mas-
       ter branch downloaded to	/usr/ports.  If	/usr/ports does	not exist, the
       repository is cloned.  If it does exist and /var/db/gitup/ports exists,
       the  latest commit to the repository is pulled down and the contents of
       /usr/ports/distfiles and	/usr/ports/packages are	ignored	when  removing
       stale files and directories.

FILES
       /usr/local/etc/gitup.conf  Default  location of the gitup.conf configu-
				  ration file.

SEE ALSO
       gitup(1)

AUTHORS
       John Mehr <jmehr@umn.edu>

FreeBSD	14.3		       December	5, 2021		       GITUP.CONF(5)()

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

home | help