FreeBSD

https://docs.freebsd.org
Admin
FreeBSD is an operating system used to power modern servers, desktops, and embedded platforms.
Tokens:1,894,547
Snippets:16,129
Trust Score:9.9
Update:4 days ago
Show doc for...
Tokens:
Raw
### Start virtual machine in installation mode

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Launch the virtual machine using the installation ISO to begin the OS setup.

```shell
# sh /usr/share/examples/bhyve/vmrun.sh -c 1 -m 1024M -t tap0 -d guest.img \
     -i -I FreeBSD-14.0-RELEASE-amd64-bootonly.iso guestname
```

--------------------------------

### Install directory tree with COPYTREE_SHARE

Source: https://docs.freebsd.org/en/books/porters-handbook/makefiles

Example of installing the contents of an examples directory from the vendor distfile to the port's examples location.

```makefile
post-install:
	${MKDIR} ${STAGEDIR}${EXAMPLESDIR}
	(cd ${WRKSRC}/examples && ${COPYTREE_SHARE} . ${STAGEDIR}${EXAMPLESDIR})
```

--------------------------------

### Example output for pkg install

Source: https://docs.freebsd.org/en/books/handbook/ports

Shows the expected output when installing a package, including the list of dependencies to be installed.

```text
Updating FreeBSD repository catalogue...
FreeBSD repository is up to date.
All repositories are up to date.
The following 9 package(s) will be affected (of 0 checked):

New packages to be INSTALLED:
        ca_root_nss: 3.83
        curl: 7.86.0
        gettext-runtime: 0.21
        indexinfo: 0.3.1
        libidn2: 2.3.3
        libnghttp2: 1.48.0
        libpsl: 0.21.1_4
        libssh2: 1.10.0.3
        libunistring: 1.0

Number of packages to be installed: 9

The process will require 11 MiB more space.
3 MiB to be downloaded

Proceed with this action? [y/N]
```

--------------------------------

### Install and Run gammastep

Source: https://docs.freebsd.org/en/books/accessibility/colors

Install and start the gammastep utility.

```shell
# pkg install gammastep
```

```shell
% gammastep &
```

--------------------------------

### Example output for pkg info

Source: https://docs.freebsd.org/en/books/handbook/ports

Shows the list of installed packages and their descriptions.

```text
ca_root_nss-3.83               Root certificate bundle from the Mozilla Project
curl-7.86.0                    Command line tool and library for transferring data with URLs
gettext-runtime-0.21.1         GNU gettext runtime libraries and programs
indexinfo-0.3.1                Utility to regenerate the GNU info page index
libidn2-2.3.3                  Implementation of IDNA2008 internationalized domain names
libnghttp2-1.48.0              HTTP/2.0 C Library
libpsl-0.21.1_6                C library to handle the Public Suffix List
libssh2-1.10.0.3               Library implementing the SSH2 protocol
libunistring-1.0               Unicode string library
pkg-1.18.4                     Package manager
```

--------------------------------

### Custom NanoBSD Configuration File Example

Source: https://docs.freebsd.org/en/articles/nanobsd

A complete configuration file example for building a custom NanoBSD image, defining build, install, and world options, as well as custom commands.

```shell
NANO_NAME=custom
NANO_SRC=/usr/src
NANO_KERNEL=MYKERNEL
NANO_IMAGES=2

CONF_BUILD='
WITHOUT_KLDLOAD=YES
WITHOUT_NETGRAPH=YES
WITHOUT_PAM=YES
'

CONF_INSTALL='
WITHOUT_ACPI=YES
WITHOUT_BLUETOOTH=YES
WITHOUT_FORTRAN=YES
WITHOUT_HTML=YES
WITHOUT_LPR=YES
WITHOUT_MAN=YES
WITHOUT_SENDMAIL=YES
WITHOUT_SHAREDOCS=YES
WITHOUT_EXAMPLES=YES
WITHOUT_INSTALLLIB=YES
WITHOUT_CALENDAR=YES
WITHOUT_MISC=YES
WITHOUT_SHARE=YES
'

CONF_WORLD='
WITHOUT_BIND=YES
WITHOUT_MODULES=YES
WITHOUT_KERBEROS=YES
WITHOUT_GAMES=YES
WITHOUT_RESCUE=YES
WITHOUT_LOCALES=YES
WITHOUT_SYSCONS=YES
WITHOUT_INFO=YES
'

FlashDevice SanDisk 1G

cust_nobeastie() (
	touch ${NANO_WORLDDIR}/boot/loader.conf
	echo "beastie_disable=\"YES\"" >> ${NANO_WORLDDIR}/boot/loader.conf
)

customize_cmd cust_comconsole
customize_cmd cust_install_files
customize_cmd cust_allow_ssh_root
customize_cmd cust_nobeastie
```

--------------------------------

### Start virtual machine from disk

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Launch the installed virtual machine from the virtual disk image.

```shell
# sh /usr/share/examples/bhyve/vmrun.sh -c 4 -m 1024M -t tap0 -d guest.img guestname
```

--------------------------------

### Define INFO files for installation

Source: https://docs.freebsd.org/en/books/porters-handbook/makefiles

Example of listing GNU info files in the INFO variable, relative to PREFIX/INFO_PATH.

```makefile
INFO=	gcc34/cpp gcc34/cppinternals gcc34/g77 ...
```

--------------------------------

### Define post-install targets with options helpers

Source: https://docs.freebsd.org/en/books/porters-handbook/order

Example showing the ordering of post-install targets, placing the main target before optional ones and keeping -on before -off.

```makefile
post-install:
	# install generic bits

post-install-DOCS-on:
	# Install documentation

post-install-X11-on:
	# Install X11 related bits

post-install-X11-off:
	# Install bits that should be there if X11 is disabled
```

--------------------------------

### SSH host key generation output

Source: https://docs.freebsd.org/en/books/handbook/bsdinstall

Example output shown when sshd is enabled during installation, displaying the generation of RSA and DSA host keys with fingerprints and randomart images, followed by the starting of sshd.

```text
Generating public/private rsa1 key pair.
Your identification has been saved in /etc/ssh/ssh_host_key.
Your public key has been saved in /etc/ssh/ssh_host_key.pub.
The key fingerprint is:
10:a0:f5:af:93:ae:a3:1a:b2:bb:3c:35:d9:5a:b3:f3 root@machine3.example.com
The key's randomart image is:
+--[RSA1 1024]----+
|    o..          |
|   o . .         |
|  .   o          |
|       o         |
|    o   S        |
|   + + o         |
|o . + *          |
|o+ ..+ .         |
|==o..o+E         |
+-----------------+
Generating public/private dsa key pair.
Your identification has been saved in /etc/ssh/ssh_host_dsa_key.
Your public key has been saved in /etc/ssh/ssh_host_dsa_key.pub.
The key fingerprint is:
7e:1c:ce:dc:8a:3a:18:13:5b:34:b5:cf:d9:d1:47:b2 root@machine3.example.com
The key's randomart image is:
+--[ DSA 1024]----+
|       ..     . .|
|      o  .   . + |
|     . ..   . E .|
|    . .  o o . . |
|     +  S = .    |
|    +  . = o     |
|     +  . * .    |
|    . .  o .     |
|      .o. .      |
+-----------------+
Starting sshd.
```

--------------------------------

### Install a port using make

Source: https://docs.freebsd.org/en/books/handbook/ports

Navigate to the port directory and run make install to fetch, extract, patch, configure, build, and install the software.

```bash
# cd /usr/ports/sysutils/lsof
# make install
```

--------------------------------

### Install UEFI Firmware and Start UEFI Guest

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Install the required firmware package and start a bhyve UEFI guest with specific device configurations.

```shell
# pkg -j bhyve install bhyve-firmware
```

```shell
# bhyve -A -c 4 -D -H -m 2G \
        -s 0,hostbridge \
        -s 1,lpc \
        -s 2,virtio-net,tap100 \
        -s 3,virtio-blk,/dev/zvol/zroot/vms/bhyvevm0 \
	-s 4,ahci-cd,/vms/FreeBSD-14.0-RELEASE-amd64-bootonly.iso \
        -s 31,fbuf,tcp=127.0.0.1:5900,w=1024,h=800,tablet \
        -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \
        -l com1,/dev/nmdbbhyve0A \
        bhyvevm0
```

--------------------------------

### Start QEMU with monitor enabled

Source: https://docs.freebsd.org/en/books/handbook/virtualization

Example script to launch a QEMU virtual machine with the monitor interface enabled via stdio.

```shell
# left VM script.
/usr/local/bin/qemu-system-x86_64  -monitor stdio \
  -cpu qemu64 \
  -vga std \
  -m 4096 \
  -smp 4   \
  -cdrom ../ISO/fbsd.iso \
  -boot order=cd,menu=on \
  -blockdev driver=file,aio=threads,node-name=imgleft,filename=../VM/left.qcow2 \
  -blockdev driver=qcow2,node-name=drive0,file=imgleft \
  -device virtio-blk-pci,drive=drive0,bootindex=1  \
  -netdev tap,id=nd0,ifname=tap0,script=no,downscript=no,br=bridge0 \
  -device e1000,netdev=nd0,mac=02:20:6c:65:66:74 \
  -name "left"
```

--------------------------------

### Enter documentation directory

Source: https://docs.freebsd.org/en/books/fdp-primer/weblate

Navigate to the documentation directory to prepare for building.

```bash
% cd documentation
```

--------------------------------

### Install and Run redshift

Source: https://docs.freebsd.org/en/books/accessibility/colors

Install and start the redshift utility.

```shell
# pkg install redshift
```

```shell
% redshift &
```

--------------------------------

### USE_LXQT Example

Source: https://docs.freebsd.org/en/books/porters-handbook/special

A basic configuration for an LXQt port, specifying required LXQt components and Qt dependencies.

```makefile
USES=	cmake lxqt qt:5 tar:xz
USE_QT=		core dbus widgets buildtools_build qmake_build
USE_LXQT=	buildtools libfmqt
```

--------------------------------

### Install and Run darkman

Source: https://docs.freebsd.org/en/books/accessibility/colors

Install the darkman daemon and start it manually.

```shell
# pkg install darkman
```

```shell
% darkman run &
```

--------------------------------

### Launch Info Documentation

Source: https://docs.freebsd.org/en/books/handbook/basics

Start the info documentation viewer.

```bash
info
```

--------------------------------

### Install additional documentation

Source: https://docs.freebsd.org/en/books/porters-handbook/makefiles

Example of installing non-standard documentation files into the DOCSDIR directory.

```makefile
post-install:
	${MKDIR} ${STAGEDIR}${DOCSDIR}
	${INSTALL_DATA} ${WRKSRC}/docs/xvdocs.ps ${STAGEDIR}${DOCSDIR}
```

--------------------------------

### Installed files for Machine-Build port

Source: https://docs.freebsd.org/en/books/porters-handbook/plist

The list of files installed by the example Machine-Build port.

```text
/usr/local/bin/machine-build
/usr/local/lib/perl5/site_perl/man/man1/machine-build.1.gz
/usr/local/lib/perl5/site_perl/man/man3/Machine::Build.3.gz
/usr/local/lib/perl5/site_perl/Machine/Build.pm
/usr/local/lib/perl5/site_perl/mach/5.20/Machine/Build/Build.so
```

--------------------------------

### Example pkg-plist entries for conditional documentation

Source: https://docs.freebsd.org/en/books/porters-handbook/makefiles

Example of how to prefix documentation files in pkg-plist for conditional installation.

```text
%%PORTDOCS%%%%DOCSDIR%%/AUTHORS
%%PORTDOCS%%%%DOCSDIR%%/CONTACT
```

--------------------------------

### Configure APT sources for arm64

Source: https://docs.freebsd.org/en/books/handbook/linuxemu

Example content for /compat/ubuntu/etc/apt/sources.list on arm64 architectures.

```text
deb http://ports.ubuntu.com/ubuntu-ports bionic main universe restricted multiverse
```

--------------------------------

### Configure APT sources for amd64

Source: https://docs.freebsd.org/en/books/handbook/linuxemu

Example content for /compat/ubuntu/etc/apt/sources.list on amd64 architectures.

```text
deb http://archive.ubuntu.com/ubuntu jammy main universe restricted multiverse
deb http://security.ubuntu.com/ubuntu/ jammy-security universe multiverse restricted main
deb http://archive.ubuntu.com/ubuntu jammy-backports universe multiverse restricted main
deb http://archive.ubuntu.com/ubuntu jammy-updates universe multiverse restricted main
```

--------------------------------

### Display Message on Install or Deinstall

Source: https://docs.freebsd.org/en/books/porters-handbook/pkg-files

Example showing how to trigger specific messages during package installation or removal.

```ucl
[
{
  type: remove
  message: "package being removed."
}
{ type: install, message: "package being installed."}
]
```

--------------------------------

### Install Wayfire and dependencies

Source: https://docs.freebsd.org/en/books/handbook/wayland

Install the required packages to get the Wayfire compositor and associated utilities running.

```shell
# pkg install wayfire wf-shell alacritty swaylock-effects swayidle wlogout kanshi mako wlsunset
```

--------------------------------

### USES=qmake example for Qt 5

Source: https://docs.freebsd.org/en/books/porters-handbook/special

A basic example showing how to enable out-of-source builds and specify Qt 5 dependencies.

```makefile
USES=	qmake:outsource qt:5
USE_QT=	buildtools_build
```

--------------------------------

### Implementation of the @sample keyword

Source: https://docs.freebsd.org/en/books/porters-handbook/plist

A complex example showing how @sample handles file registration, post-install copying, and conditional post-deinstall removal.

```yaml
actions: [file(1)]
arguments: true
post-install: <<EOD
  case "%1" in
  /*) sample_file="%1" ;;
  *) sample_file="%D/%1" ;;
  esac
  target_file="${sample_file%.sample}"
  set -- %@
  if [ $# -eq 2 ]; then
      target_file=${2}
  fi
  case "${target_file}" in
  /*) target_file="${target_file}" ;;
  *) target_file="%D/${target_file}" ;;
  esac
  if ! [ -f "${target_file}" ]; then
    /bin/cp -p "${sample_file}" "${target_file}" && \
      /bin/chmod u+w "${target_file}"
  fi
EOD
pre-deinstall: <<EOD
  case "%1" in
  /*) sample_file="%1" ;;
  *) sample_file="%D/%1" ;;
  esac
  target_file="${sample_file%.sample}"
  set -- %@
  if [ $# -eq 2 ]; then
      set -- %@
      target_file=${2}
  fi
  case "${target_file}" in
  /*) target_file="${target_file}" ;;
  *) target_file="%D/${target_file}" ;;
  esac
  if cmp -s "${target_file}" "${sample_file}"; then
    rm -f "${target_file}"
  else
    echo "You may need to manually remove ${target_file} if it is no longer needed."
  fi
EOD
```

--------------------------------

### Example freebsd-update component detection output

Source: https://docs.freebsd.org/en/books/handbook//cutting-edge

An example of the output displayed by freebsd-update when inspecting the system for installed components.

```text
Looking up update.FreeBSD.org mirrors... 1 mirrors found.
Fetching metadata signature for 13.1-RELEASE from update1.FreeBSD.org... done.
Fetching metadata index... done.
Inspecting system... done.

The following components of FreeBSD seem to be installed:
kernel/smp src/base src/bin src/contrib src/crypto src/etc src/games
src/gnu src/include src/krb5 src/lib src/libexec src/release src/rescue
src/sbin src/secure src/share src/sys src/tools src/ubin src/usbin
world/base world/info world/lib32 world/manpages

The following components of FreeBSD do not seem to be installed:
kernel/generic world/catpages world/dict world/doc world/games
world/proflibs

Does this look reasonable (y/n)? y
```

--------------------------------

### Install specific files to a subdirectory with COPYTREE_SHARE

Source: https://docs.freebsd.org/en/books/porters-handbook/makefiles

Example of installing specific files from a source directory to a subdirectory within DATADIR.

```makefile
post-install:
	${MKDIR} ${STAGEDIR}${DATADIR}/summer
	(cd ${WRKSRC}/temperatures && ${COPYTREE_SHARE} "June July August" ${STAGEDIR}${DATADIR}/summer)
```

--------------------------------

### Sample initial build output

Source: https://docs.freebsd.org/en/articles/freebsd-update-server

Example output showing the progress of an initial build run for a FreeBSD release.

```text
# sh scripts/init.sh amd64 7.2-RELEASE
Mon Aug 24 16:04:36 PDT 2009 Starting fetch for FreeBSD/amd64 7.2-RELEASE
/usr/local/freebsd-update-server/work/7.2-RELE100 of  588 MB  359 kBps 00m00s
Mon Aug 24 16:32:38 PDT 2009 Verifying disc1 hash for FreeBSD/amd64 7.2-RELEASE
Mon Aug 24 16:32:44 PDT 2009 Extracting components for FreeBSD/amd64 7.2-RELEASE
Mon Aug 24 16:34:05 PDT 2009 Constructing world+src image for FreeBSD/amd64 7.2-RELEASE
Mon Aug 24 16:35:57 PDT 2009 Extracting world+src for FreeBSD/amd64 7.2-RELEASE
Mon Aug 24 23:36:24 UTC 2009 Building world for FreeBSD/amd64 7.2-RELEASE
Tue Aug 25 00:31:29 UTC 2009 Distributing world for FreeBSD/amd64 7.2-RELEASE
Tue Aug 25 00:32:36 UTC 2009 Building and distributing kernels for FreeBSD/amd64 7.2-RELEASE
Tue Aug 25 00:44:44 UTC 2009 Constructing world components for FreeBSD/amd64 7.2-RELEASE
Tue Aug 25 00:44:56 UTC 2009 Distributing source for FreeBSD/amd64 7.2-RELEASE
Mon Aug 24 17:46:18 PDT 2009 Moving components into staging area for FreeBSD/amd64 7.2-RELEASE
Mon Aug 24 17:46:33 PDT 2009 Identifying extra documentation for FreeBSD/amd64 7.2-RELEASE
Mon Aug 24 17:47:13 PDT 2009 Extracting extra docs for FreeBSD/amd64 7.2-RELEASE
Mon Aug 24 17:47:18 PDT 2009 Indexing release for FreeBSD/amd64 7.2-RELEASE
Mon Aug 24 17:50:44 PDT 2009 Indexing world0 for FreeBSD/amd64 7.2-RELEASE

Files built but not released:
Files released but not built:
Files which differ by more than contents:
Files which differ between release and build:
kernel|generic|/GENERIC/hptrr.ko
kernel|generic|/GENERIC/kernel
src|sys|/sys/conf/newvers.sh
world|base|/boot/loader
world|base|/boot/pxeboot
world|base|/etc/mail/freebsd.cf
world|base|/etc/mail/freebsd.submit.cf
world|base|/etc/mail/sendmail.cf
world|base|/etc/mail/submit.cf
world|base|/lib/libcrypto.so.5
world|base|/usr/bin/ntpq
world|base|/usr/lib/libalias.a
world|base|/usr/lib/libalias_cuseeme.a
world|base|/usr/lib/libalias_dummy.a
world|base|/usr/lib/libalias_ftp.a
...
```

--------------------------------

### Example pkg-plist file

Source: https://docs.freebsd.org/en/books/porters-handbook/quick-porting

A sample packing list file listing the files installed by the port relative to the installation prefix.

```text
bin/oneko
man/man1/oneko.1.gz
lib/X11/app-defaults/Oneko
lib/X11/oneko/cat1.xpm
lib/X11/oneko/cat2.xpm
lib/X11/oneko/mouse.xpm
```

--------------------------------

### Restart obspamd and start obspamlogd

Source: https://docs.freebsd.org/en/books/handbook/firewalls

Commands to complete the greylisting setup: restart the obspamd service and start the obspamlogd service.

```shell
#  service obspamd restart
#  service obspamlogd start
```

--------------------------------

### Detecting Installed wxWidgets Versions and Components

Source: https://docs.freebsd.org/en/books/porters-handbook/special

Example of a port that conditionally enables wxWidgets based on installed status or user options.

```makefile
WANT_WX=	yes

.include <bsd.port.pre.mk>

.if defined(WITH_WX) || !empty(PORT_OPTIONS:MWX) || !empty(HAVE_WX:Mwx-2.8)
USE_WX=			2.8
CONFIGURE_ARGS+=	--enable-wx
.endif
```

--------------------------------

### Build and install FreeBSD from source

Source: https://docs.freebsd.org/en/articles/committers-guide

Standard commands to build and install the world and kernel after navigating to the source directory.

```bash
% cd src
% make buildworld
% make buildkernel
% make installkernel
% make installworld
```
Tokens:
Raw