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

FreeBSD Man Pages

Man Page or Keyword Search:
Man Architecture
Apropos Keyword Search (all sections) Output format
home | help
FREEBSD-UPDATE.CONF(5)	  FreeBSD File Formats Manual	FREEBSD-UPDATE.CONF(5)

NAME
     freebsd-update.conf -- configuration file for freebsd-update(8)

DESCRIPTION
     The freebsd-update.conf file controls the behaviour of the
     freebsd-update(8) utility.	 The file contains lines consisting of a case-
     sensitive option name and zero or more parameters.	 Empty lines and any
     part of a line following a	`#' character are ignored.  Unless stated oth-
     erwise, specifying	an option multiple times is an error.

     The possible options and their meanings are as follows:

     KeyPrint		      The single parameter following this keyword is
			      the SHA256 hash of the RSA key which will	be
			      trusted to sign updates.

     ServerName		      The single parameter following this keyword is
			      the name of the server or	server pool from which
			      updates will be downloaded.

     Components		      The parameters following this keyword are	the
			      components or sub-components of FreeBSD which
			      will be updated.	The components are ``src''
			      (source code), ``world'' (non-kernel binaries),
			      and ``kernel''; the sub-components are the indi-
			      vidual distribution sets generated as part of
			      the release process (e.g., ``src/base'',
			      ``src/sys'', ``world/base'', ``world/catpages'',
			      ``kernel/smp'').	Note that prior	to
			      FreeBSD 6.1, the ``kernel'' component was	dis-
			      tributed as part of ``world/base''.

			      This option can be specified multiple times, and
			      the parameters accumulate.

     IgnorePaths	      The parameters following this keyword are	regu-
			      lar expressions; updates to paths	which start
			      with a string matching one of these regular
			      expressions will be ignored.

			      This option can be specified multiple times, and
			      the parameters accumulate.

     IDSIgnorePaths	      The parameters following this keyword are	regu-
			      lar expressions; paths which start with a	string
			      matching one of these regular expressions	will
			      be ignored by "freebsd-update IDS".

			      This option can be specified multiple times, and
			      the parameters accumulate.

     UpdateIfUnmodified	      The parameters following this keyword are	regu-
			      lar expressions; updates to paths	which start
			      with a string matching one of these regular
			      expressions will be ignored if the files have
			      been modified locally (unless they are merged --
			      see MergeChanges below).

			      This option can be specified multiple times, and
			      the parameters accumulate.

     MergeChanges	      The parameters following this keyword are	regu-
			      lar expressions; updates to paths	which start
			      with a string matching one of these regular
			      expressions will be merged with local modifica-
			      tions.

			      This option can be specified multiple times, and
			      the parameters accumulate.

     WorkDir		      The single parameter following this keyword is
			      the directory in which temporary files and down-
			      loaded updates will be stored.

     MailTo		      The single parameter following this keyword is
			      the address to which cron	output will be mailed.

     AllowAdd		      The single parameter following this keyword must
			      be ``yes'' or ``no'' and specifies whether
			      freebsd-update is	allowed	to create new files,
			      directories, and symlinks	if these are part of
			      updates downloaded.  Note	that freebsd-update
			      will not re-add files which have been deleted
			      from a FreeBSD installation unless those files
			      were previously added as part of an update.

     AllowDelete	      The single parameter following this keyword must
			      be ``yes'' or ``no'' and specifies whether
			      freebsd-update is	allowed	to delete files,
			      directories, and symlinks	as part	of updates
			      downloaded.

     KeepModifiedMetadata     The single parameter following this keyword must
			      be ``yes'' or ``no'' and specifies whether
			      freebsd-update should keep existing file owner-
			      ship, permissions, and flags when	installing
			      updates if these have been modified locally.

     StrictComponents	      The single parameter following this keyword must
			      be ``yes'' or ``no'' and specifies whether
			      freebsd-update should interpret the list of com-
			      ponents of FreeBSD specified via the Components
			      option strictly as a list	of components
			      installed	which should be	upgraded when the
			      upgrade command is used ("yes"), or merely as a
			      list of components which might be	installed, of
			      which freebsd-update should identify which in
			      fact are present ("no").

     BackupKernel	      The single parameter following this keyword must
			      be ``yes'' or ``no'' and specifies whether
			      freebsd-update will create a backup of the old
			      kernel before installing a new kernel.  This
			      backup kernel can	be used	to recover a system
			      where the	newly installed	kernel somehow did not
			      work.  Note that the backup kernel is not
			      reverted to its original state by	the
			      freebsd-update rollback command.

     BackupKernelDir	      This keyword sets	the directory which is used to
			      store a backup kernel, if	the BackupKernel fea-
			      ture is enabled.	If the directory already
			      exist, and it was	not created by freebsd-update,
			      the directory is skipped.	 In the	case of	the
			      primary directory	name not being usable, a num-
			      ber starting with	`1' is appended	to the direc-
			      tory name.  Like with the	primary	directory
			      name, the	constructed directory name is only
			      used if the path name does not exist, or if the
			      directory	was previously created by
			      freebsd-update.  If the constructed directory
			      still exist the appended number is incremented
			      with 1 and the directory search process
			      restarted.  Should the number increment go above
			      9, freebsd-update	will abort.

     BackupKernelSymbolFiles  The single parameter following this keyword must
			      be ``yes'' or ``no'' and specifies whether
			      freebsd-update will also backup kernel symbol
			      files, if	they exist.  The kernel	symbol files
			      takes up a lot of	disk space and are not needed
			      for recovery purposes.  If the symbol files are
			      needed, after recovering a system	using the
			      backup kernel, the freebsd-update	rollback com-
			      mand will	recreate the symbol files along	with
			      the old kernel.

FILES
     /etc/freebsd-update.conf  Default location	of the freebsd-update configu-
			       ration file.

SEE ALSO
     sha256(1),	freebsd-update(8)

AUTHORS
     Colin Percival <cperciva@FreeBSD.org>

FreeBSD				August 19, 2009			       FreeBSD

NAME | DESCRIPTION | FILES | SEE ALSO | AUTHORS

Want to link to this manual page? Use this URL:
<http://www.freebsd.org/cgi/man.cgi?query=freebsd-update.conf&sektion=5&manpath=FreeBSD+9.0-RELEASE>

home | help