diff options
Diffstat (limited to 'static/freebsd/man7/freebsd-base.7 3.html')
| -rw-r--r-- | static/freebsd/man7/freebsd-base.7 3.html | 236 |
1 files changed, 236 insertions, 0 deletions
diff --git a/static/freebsd/man7/freebsd-base.7 3.html b/static/freebsd/man7/freebsd-base.7 3.html new file mode 100644 index 00000000..eebb21cc --- /dev/null +++ b/static/freebsd/man7/freebsd-base.7 3.html @@ -0,0 +1,236 @@ +<table class="head"> + <tr> + <td class="head-ltitle">FREEBSD-BASE(7)</td> + <td class="head-vol">Miscellaneous Information Manual</td> + <td class="head-rtitle">FREEBSD-BASE(7)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">freebsd-base</code> — + <span class="Nd">base system packages</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <span class="Ux">FreeBSD</span> base system may be installed + as a set of <a class="Xr">pkg(8)</a> packages, which supersedes the + traditional method of installing using <a class="Xr">tar(1)</a> + archives.</p> +<p class="Pp">All base packages have names beginning with the string + “FreeBSD-”, and have an origin beginning with + “base/”. In the default system configuration, the repository + containing these packages is called “FreeBSD-base”, but any + name may be used. The repository name can be used with + <a class="Xr">pkg(8)</a> to restrict package operations to the base system + packages.</p> +<p class="Pp">Packages for all supported <span class="Ux">FreeBSD</span> + releases as well as active “STABLE” and + “CURRENT” branches are hosted on the Internet at + <a class="Lk" href="https://pkg.freebsd.org">https://pkg.freebsd.org</a>. + These packages are updated when new errata or security updates are released + (for supported release versions), or twice daily for development + branches.</p> +<p class="Pp">Alternatively, packages may be built from the system source tree + according to the instructions in <a class="Xr">build(7)</a>, allowing the + system to be updated from source code using packages.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="PACKAGE_ORGANISATION"><a class="permalink" href="#PACKAGE_ORGANISATION">PACKAGE + ORGANISATION</a></h1> +<p class="Pp">To allow customisation of the installed system, each package is + split into several subpackages which contain different components of the + package. For the package + <a class="permalink" href="#FreeBSD-foo"><b class="Sy" id="FreeBSD-foo">FreeBSD-foo</b></a>, + the following subpackages may be available:</p> +<p class="Pp"></p> +<dl class="Bl-tag Bl-compact"> + <dt id="Package"><a class="permalink" href="#Package"><b class="Sy">Package + name</b></a></dt> + <dd><a class="permalink" href="#Description"><b class="Sy" id="Description">Description</b></a></dd> + <dt>FreeBSD-foo</dt> + <dd>Base files for the package (typically executables)</dd> + <dt>FreeBSD-foo-lib</dt> + <dd>Native runtime libraries</dd> + <dt>FreeBSD-foo-lib32</dt> + <dd>32-bit compatibility runtime libraries</dd> + <dt>FreeBSD-foo-dev</dt> + <dd>Development files (headers and static libraries)</dd> + <dt>FreeBSD-foo-dev-lib32</dt> + <dd>32-bit development files</dd> + <dt>FreeBSD-foo-dbg</dt> + <dd>Debugging symbols</dd> + <dt id="WITH_MANSPLITPKG">FreeBSD-foo-man</dt> + <dd>Manual pages. Manual pages are only packaged separately if the + <a class="permalink" href="#WITH_MANSPLITPKG"><b class="Sy">WITH_MANSPLITPKG</b></a> + <a class="Xr">src.conf(5)</a> option was enabled when building the system, + which is not the default.</dd> +</dl> +<p class="Pp" id="dev">The exact set of available subpackages differs for each + individual package. For example, some packages may not provide any + development files, in which case the + <a class="permalink" href="#dev"><b class="Sy">-dev</b></a> subpackage is + not present.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="PACKAGE_SETS"><a class="permalink" href="#PACKAGE_SETS">PACKAGE + SETS</a></h1> +<p class="Pp">Package sets are meta-packages which do not contain any files + themselves, but depend on a selection of other packages, such that each + package set allows the complete set of packages for a supported workload to + be installed.</p> +<p class="Pp" id="FreeBSD-set-_name_">Package sets are provided as packages + named + <a class="permalink" href="#FreeBSD-set-_name_"><b class="Sy">FreeBSD-set-<name></b></a>. + The following package sets are available in the base system:</p> +<dl class="Bl-tag"> + <dt>minimal</dt> + <dd>The minimal set of packages required to bring up a multi-user + <span class="Ux">FreeBSD</span> system. This includes the core system, + along with packages required for hardware support (such as + <a class="Xr">devmatch(8)</a> and downloadable firmware), and basic + networking, including DHCP and IEEE Std 802.11™ wireless + networks.</dd> + <dt>minimal-jail</dt> + <dd>The equivalent of <b class="Sy">minimal</b> for systems running in a + <a class="Xr">jail(8)</a> environment. This set excludes hardware support + not typically required for jails.</dd> + <dt>devel</dt> + <dd>Development tools, including C/C++ compilers, the link loader, and other + tools such as <a class="Xr">ar(1)</a> and <a class="Xr">nm(1)</a>. This + set also includes native development files (headers and static libraries) + for all packages.</dd> + <dt>optional</dt> + <dd>Optional software which is not part of either the <b class="Sy">devel</b> + or <b class="Sy">minimal</b> sets.</dd> + <dt>optional-jail</dt> + <dd>The equivalent of <b class="Sy">optional</b> for systems running in a + <a class="Xr">jail(8)</a> environment. This set excludes system + functionality which typically does not work or is not useful in a + jail.</dd> + <dt>lib32</dt> + <dd>32-compatibility libraries, for running 32-bit applications on a 64-bit + host system. This set includes both runtime libraries and development + files.</dd> + <dt>base</dt> + <dd>The complete base system, excluding tests, the system source code, and + debugging symbols. Installing the <b class="Sy">base</b> set is equivalent + to installing <b class="Sy">minimal</b>, <b class="Sy">devel</b> and + <b class="Sy">optional</b>.</dd> + <dt id="base-jail">base-jail</dt> + <dd>The equivalent of <b class="Sy">base</b> for systems running in a + <a class="Xr">jail(8)</a> environment. This set excludes system + functionality which typically does not work or is not useful in a jail. + Installing the + <a class="permalink" href="#base-jail"><b class="Sy">base-jail</b></a> set + is equivalent to installing <b class="Sy">minimal-jail</b>, + <b class="Sy">devel</b> and + <a class="permalink" href="#optional-jail"><b class="Sy" id="optional-jail">optional-jail</b></a>.</dd> + <dt>src</dt> + <dd>The system source tree for the userland and kernel, installed in + <span class="Pa">/usr/src</span>.</dd> + <dt>tests</dt> + <dd>The system test suite, installed in + <span class="Pa">/usr/tests</span>.</dd> + <dt>kernels</dt> + <dd>All available system kernels.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> +<section class="Ss"> +<h2 class="Ss" id="Install_a_single_piece_of_userland"><a class="permalink" href="#Install_a_single_piece_of_userland">Install + a single piece of userland</a></h2> +<p class="Pp">Install the <a class="Xr">vi(1)</a> text editor on the running + system:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>pkg install FreeBSD-vi</pre> +</div> +</section> +<section class="Ss"> +<h2 class="Ss" id="Install_userland_to_a_jail"><a class="permalink" href="#Install_userland_to_a_jail">Install + userland to a jail</a></h2> +<p class="Pp">Install a new <a class="Xr">jail(8)</a> system using the + <b class="Sy">minimal-jail</b> package set:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>pkg -r /jails/myjail install FreeBSD-set-minimal-jail</pre> +</div> +</section> +<section class="Ss"> +<h2 class="Ss" id="Install_native_compilers"><a class="permalink" href="#Install_native_compilers">Install + native compilers</a></h2> +<p class="Pp">Install C/C++ compilers on the running system:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>pkg install FreeBSD-set-devel</pre> +</div> +</section> +<section class="Ss"> +<h2 class="Ss" id="Update_the_currently_running_system"><a class="permalink" href="#Update_the_currently_running_system">Update + the currently running system</a></h2> +<p class="Pp">Apply available updates to the running system:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>pkg upgrade -r FreeBSD-base</pre> +</div> +</section> +<section class="Ss"> +<h2 class="Ss" id="Install_cross_compilers"><a class="permalink" href="#Install_cross_compilers">Install + cross compilers</a></h2> +<p class="Pp">Install the development toolchain for FreeBSD/powerpc64le in an + alternate root (for example, to support cross-compiling software for a + different target than the host system):</p> +<div class="Bd Pp Bd-indent Li"> +<pre>pkg -r /ppcdev -oABI=FreeBSD:16:powerpc64le \ + install FreeBSD-set-devel</pre> +</div> +</section> +<section class="Ss"> +<h2 class="Ss" id="Unregister_a_currently_running_system"><a class="permalink" href="#Unregister_a_currently_running_system">Unregister + a currently running system</a></h2> +<p class="Pp">Systems managed through <a class="Xr">pkg(8)</a> can be + unregistered from the package manager — for example to upgrade + in-place via “make installworld”. See + <a class="Xr">build(7)</a>.</p> +<p class="Pp">To unregister the base system from the package manager:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>pkg unregister -fg 'FreeBSD-\*'</pre> +</div> +<p class="Pp">Then, disable the base system package repository. If a + configuration file was created in + <span class="Pa">/usr/local/etc/pkg/repos/</span> to enable base system + packages, remove it:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>rm /usr/local/etc/pkg/repos/FreeBSD-base.conf</pre> +</div> +<p class="Pp">Alternatively, if it is desired to keep it, edit the file and + change “<code class="Li">enabled:</code>” to + “<code class="Li">no</code>” to disable the entry.</p> +<p class="Pp" id="Warning"><a class="permalink" href="#Warning"><b class="Sy">Warning</b></a>: + This is a destructive action which will prevent updating the base system via + <a class="Xr">pkg(8)</a>.</p> +</section> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">build(7)</a>, <a class="Xr">pkg(8)</a>, + <a class="Xr">src.conf(5)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">Support for installing the base system as packages was introduced + in <span class="Ux">FreeBSD 15.0</span>. Earlier releases supported a subset + of this functionality. Support for unregistering an existing installation + appeared in pkg 2.5.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1> +<p class="Pp">Upgrading from a RELEASE to a STABLE or CURRENT branch requires + “<code class="Li">pkg upgrade -f</code>”.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">April 14, 2026</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |