**Preface** 

Written by users of the PC-BSDÂŽ operating system.

Version |version|

Copyright Š 2005 - 2016 The PC-BSDŽ Project.

Welcome to PC-BSDÂŽ! This Handbook covers the installation and use of PC-BSDÂŽ |version|. This Handbook is a work in progress and relies on the contributions of many individuals. If you are interested in assisting with the Handbook, refer to the documentation `README <https://github.com/pcbsd/pcbsd/blob/master/src-qt5/docs/README.md>`_. If you use IRC Freenode, you are welcome to join the #pcbsd channel where you will find other PC-BSDÂŽ users.

Previous versions of the Handbook in various formats and languages are available from `here <ftp://ftp.pcbsd.org/pub/handbook/>`_. 

The PC-BSDÂŽ Users Handbook is freely available for sharing and redistribution under the terms of the `Creative Commons Attribution License <https://creativecommons.org/licenses/by/4.0/>`_. This means that you have permission to copy, distribute, translate, and adapt the work as long as you attribute the PC-BSDÂŽ Project as the original source of the Handbook.

PC-BSDÂŽ and the PC-BSDÂŽ logo are registered trademarks of `iXsystems <https://www.ixsystems.com/>`_. If you wish to use the PC-BSDÂŽ logo in your own works, ask for permission first from marketing@ixsystems.com.

AMD is a trademark of Advanced Micro Devices, Inc.

Apache is a trademark of The Apache Software Foundation.

AppCafeÂŽ is a registered trademark of `iXsystems <https://www.ixsystems.com/>`_.

AsusÂŽ and Eee PCÂŽ are registered trademarks of ASUSTeKÂŽ Computer Inc.

FacebookÂŽ is a registered trademark of Facebook Inc.

FlashÂŽ is a registered trademark of Adobe Systems Incorporated in the United States and/or other countries.

FreeBSDÂŽ is a registered trademark of the `FreeBSD Foundation <https://www.freebsdfoundation.org/>`_. 

FreeNASÂŽ is a registered trademark of `iXsystems <https://www.ixsystems.com/>`_.

IBMÂŽ is a registered trademark of International Business Machines Corporation.

Intel, the Intel logo, Pentium Inside, and Pentium are trademarks of Intel Corporation in the U.S. and/or other countries.

Java™ is a trademark of Oracle America and/or its affiliates in the United States and other countries.

LenovoÂŽ is a registered trademark of Lenovo.

LinkedInÂŽ is a registered trademark of LinkedIn Corporation.

LinuxÂŽ is a registered trademark of Linus Torvalds.

Mac and Mac OS are trademarks of Apple Inc., registered in the U.S. and other countries.

MacBookÂŽ is a registered trademark of Apple Inc.

MySQL is a trademark of Oracle.

NVIDIAÂŽ is a trademark and/or registered trademark of NVIDIA Corporation in the U.S. and other countries.

PostgreSQLÂŽ is a registered trademark of the PostgreSQL Global Development Group.

ThinkPadÂŽ is a registered trademark of Lenovo.

TrueOSÂŽ is a registered trademark of `iXsystems <https://www.ixsystems.com/>`_.

Twitter is a trademark of Twitter, Inc. in the United States and other countries.

UNIXÂŽ is a registered trademark of The Open Group.

VirtualBoxÂŽ is a registered trademark of Oracle.

VMWareÂŽ is a registered trademark of VMWare, Inc.

WindowsÂŽ is a registered trademark of Microsoft Corporation in the United States and other countries.

**Typographic Conventions** 

* Names of graphical elements such as buttons, icons, fields, columns, and boxes are enclosed within quotes. For example: click the "Browse Categories" button.

* Menu selections are italicized and separated by arrows. For example: :menuselection:`Control Panel --> About`.

* Commands that are mentioned within text are highlighted in :command:`bold text`. Command examples and command output are contained in green code blocks.

* File names are enclosed in a blue box :file:`/like/this`.

* Keystrokes are formatted in a blue box. For example: press :kbd:`Enter`.

* **bold text** is used to emphasize an important point.

* *italic text* is used to represent device names or text that is input into a GUI field.

Introduction
************

Welcome to PC-BSDÂŽ!

`PC-BSDÂŽ <http://www.pcbsd.org/>`_ began in 2005 when Kris Moore presented the first beta version of a FreeBSD operating system pre-configured for desktop use. Since then, PC-BSDÂŽ has matured into a polished, feature-rich, free-of-charge, open source operating system that meets the desktop or server needs of the beginner to the advanced user alike.

PC-BSDÂŽ is essentially a customized installation of FreeBSD, not a forked derivative. Since the underlying FreeBSD system has been kept intact, you have a fully functional FreeBSD system under the hood. PC-BSDÂŽ provides a graphical installer which can be used to easily install a desktop or a server version of FreeBSD, known as TrueOSÂŽ. Other differences from FreeBSD include: 

* PC-BSDÂŽ pre-configures at least one desktop environment during a desktop installation. Installed desktop environments appear in the login menu, allowing the user to select which environment to log into.

* The PC-BSDÂŽ graphical installer supports additional features such as configuring ZFS and encryption during installation.

* PC-BSDÂŽ provides a graphical software management system for the desktop and a command line equivalent for the server.

* PC-BSDÂŽ provides a :ref:`Control Panel` of utilities for configuring the system. The graphical versions of these utilities are available on both versions, the desktop and server.

* PC-BSDÂŽ comes pre-configured with a number of automatic scripts to perform tasks such as connecting digital cameras or USB memory sticks.

* The PC-BSDÂŽ boot menu supports boot environments, or snapshots of the operating system, and the PC-BSDÂŽ Update Manager automatically adds a new boot environment to the boot menu before updating the operating system or software. This means that if an update fails, you can reboot into the previous version of the operating system, before the update occurred.

PC-BSDÂŽ started off as an independent project, but since October, 2006 PC-BSDÂŽ is financially backed and supported by the enterprise-class hardware solutions provider `iXsystems <https://www.ixsystems.com/>`_.

.. index:: features
.. _Goals and Features:

Goals and Features
==================

PC-BSDÂŽ provides the following features: 

* **Easy installation:** to install either a graphical desktop or command-line server version of PC-BSDÂŽ, simply insert the installation media, reboot the
  system to start the installer, and answer a few questions in the installation menus.

* **Automatically configured hardware:** video, sound, network, and other devices are automatically configured for you.

* **Intuitive desktop interface:** PC-BSDÂŽ comes with a choice of :ref:`Desktops` to support your day-to-day computing needs.

* **Easy software management:** with :ref:`AppCafeÂŽ`, installing, upgrading, and uninstalling software is safe and easy.

* **Lots of software available:** in addition to its own software, PC-BSDÂŽ can install software that has been ported to FreeBSD (currently over 24,700
  applications).

* **Easy to update:** PC-BSDÂŽ provides a built-in :ref:`Update Manager` that will notify you of available updates and allow you to apply operating system
  security fixes, bug fixes, and system enhancements as well as upgrade to newer versions of the operating system or installed software.

* **Virus-free:** PC-BSDÂŽ is not affected by viruses, spyware, or other malware.

* **No defragmentation:** PC-BSDÂŽ hard drives do not need to be defragmented and do not slow down over time. PC-BSDÂŽ uses OpenZFS which is a self-healing
  filesystem.

* **Laptop support:** provides power saving and swap space encryption and automatically switches between wired and wifi network connections.

* **Secure environment:** PC-BSDÂŽ provides a pre-configured firewall and a built-in host-based Intrusion Detection System.

* **Easy system administration:** PC-BSDÂŽ provides a :ref:`Control Panel` containing many graphical tools for performing system administration tasks.

* **Localization:** PC-BSDÂŽ supports a number of native languages and locales.

* **Vibrant community:** PC-BSDÂŽ has a friendly and helpful community. 

* **Professional support:** professional email and phone support is available from
  `iXsystems <https://www.ixsystems.com/support/>`_.

.. index:: What's New
.. _What's New in |version|:

What's New in |version|
=======================

The following features or enhancements were introduced for PC-BSDÂŽ |version|:

* Based on FreeBSD 10.3 which adds these `features <https://www.freebsd.org/releases/10.3R/relnotes.html>`_.

* The initial boot menu has changed on the :file:`PC-BSD10.3-*` boot media.

* The LibreOffice and Office role packages have been removed from installation media in order to reduce their download size. These can be installed post-installation using
  :ref:`AppCafeÂŽ`.
  
* EasyPBI has been removed as it is no longer needed to add meta-data to packages.

* The "Plugins" tab has been removed from :ref:`AppCafeÂŽ` as this functionality is being rewritten for the upcoming 11-RELEASE. In the interim, refer to
  :ref:`Managing Jails from the CLI` if you wish to manage jails on your PC-BSDÂŽ system.

* The "Search all available PBIs and packages" checkbox has been renamed to "Search all available software" in :menuselection:`AppCafeÂŽ --> App Search`.

* The "Auto-play optical disks" checkbox has been added to :menuselection:`Mount Tray --> More Options --> Change Settings`.

.. index:: Linux
.. _PC-BSDÂŽ for Linux Users:

PC-BSDÂŽ for Linux Users
========================

PC-BSDÂŽ is based on FreeBSD, meaning that it is not a Linux distribution. If you have used Linux before, you will find that some features that you are used
to have different names on a BSD system and that some commands are different. This section covers some of these differences.

.. index:: filesystems
.. _Filesystems:

BSD and Linux use different filesystems during installation. Many Linux distros use EXT2, EXT3, EXT4, or ReiserFS, while PC-BSDÂŽ uses OpenZFS. This means
that if you wish to dual-boot with Linux or access data on an external drive that has been formatted with another filesystem, you will want to do a bit of
research first to see if the data will be accessible to both operating systems.

Table 1.3a summarizes the various filesystems commonly used by desktop systems. Most of the desktop managers available from PC-BSDÂŽ should automatically
mount the following filesystems: FAT16, FAT32, EXT2, EXT3 (without journaling), EXT4 (read-only), NTFS5, NTFS6, and XFS. See the section on
:ref:`Files and File Sharing` for more information about available file manager utilities.

**Table 1.3a: Filesystem Support on PC-BSDÂŽ**

+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| Filesystem | Native to         | Type of non-native support                     | **Usage notes**                                                          |
+============+===================+================================================+==========================================================================+
| Btrfs      | Linux             | none                                           |                                                                          |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| exFAT      | Windows           | none                                           | requires a license from Microsoft                                        |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| EXT2       | Linux             | r/w support loaded by default                  |                                                                          |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| EXT3       | Linux             | r/w support loaded by default                  | since EXT3 journaling is not supported, you will not be able to mount    |
|            |                   |                                                | a filesystem requiring a journal replay unless you :command:`fsck` it    |
|            |                   |                                                | using an external utility such as                                        |
|            |                   |                                                | `e2fsprogs <http://e2fsprogs.sourceforge.net>`_                          |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| EXT4       | Linux             | r/o support loaded by default                  | EXT3 journaling, extended attributes, and inodes greater than 128 bytes  |
|            |                   |                                                | are not supported; EXT3 filesystems converted to EXT4 may have better    |
|            |                   |                                                | performance                                                              |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| FAT16      | Windows           | r/w support loaded by default                  |                                                                          |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| FAT32      | Windows           | r/w support loaded by default                  |                                                                          |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| HFS+       | Mac OS X          | none                                           | older Mac versions might work with                                       |
|            |                   |                                                | `hfsexplorer <http://www.catacombae.org/hfsexplorer>`_                   |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| JFS        | Linux             | none                                           |                                                                          |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| NTFS5      | Windows           | full r/w support loaded by default             |                                                                          |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| NTFS6      | Windows           | r/w support loaded by default                  |                                                                          |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| ReiserFS   | Linux             | r/o support is loaded by default               |                                                                          |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| UFS2       | FreeBSD           | check if your Linux distro provides ufsutils;  |                                                                          |
|            |                   | r/w support on Mac; UFS Explorer can be used   |                                                                          |
|            |                   | on Windows                                     | changed to r/o support in Mac Lion                                       |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+
| ZFS        | PC-BSD, FreeBSD   |                                                |                                                                          |
+------------+-------------------+------------------------------------------------+--------------------------------------------------------------------------+

.. index:: devices

Linux and BSD use different naming conventions for devices. For example: 

* in Linux, Ethernet interfaces begin with :file:`eth`; in BSD, interface names indicate the name of the driver. For example, an Ethernet interface may be
  listed as :file:`re0`, indicating that it uses the Realtek :file:`re` driver. The advantage of this convention is that you can read the **man 4** page for
  the driver (e.g. type :command:`man 4 re`) to see which models and features are provided by that driver.

- BSD disk names differ from Linux. IDE drives begin with :file:`ad` and SCSI and USB drives begin with :file:`da`.

Some of the features used by BSD have similar counterparts to Linux, but the name of the feature is different. Table 1.3b provides some common examples: 

**Table 1.3b: Names for BSD and Linux Features**

+------------------------------------------------+--------------------------------------+--------------------------------------------------------------------+
| PC-BSD                                         | Linux                                | **Description**                                                    |
+================================================+======================================+====================================================================+
| IPFW                                           | iptables                             | default firewall                                                   |
+------------------------------------------------+--------------------------------------+--------------------------------------------------------------------+
| :file:`/etc/rc.d/` for operating system and    | :file:`rc0.d/`, :file:`rc1.d/`, etc. | in PC-BSD the directories containing the startup scripts do not    |
| :file:`/usr/local/etc/rc.d/` for applications  |                                      | link to runlevels as there are no runlevels; system startup        |
|                                                |                                      | scripts are separated from third-party application scripts         |
+------------------------------------------------+--------------------------------------+--------------------------------------------------------------------+
| :file:`/etc/ttys` and :file:`/etc/rc.conf`     | :command:`telinit`, :file:`init.d/`  | terminals are configured in *ttys* and *rc.conf* indicates which   |
|                                                |                                      | services will start at boot time                                   |
+------------------------------------------------+--------------------------------------+--------------------------------------------------------------------+

If you are comfortable with the command line, you may find that some of the commands that you are used to have different names on BSD. Table 1.3c lists some
common commands and what they are used for.

**Table 1.3c: Common BSD and Linux Commands**

+-----------------------------------+------------------------------------------------------------+
| Command                           | **Used to:**                                               |
+===================================+============================================================+
| :command:`dmesg`                  | discover what hardware was detected by the kernel          |
+-----------------------------------+------------------------------------------------------------+
| :command:`sysctl dev`             | display configured devices                                 |
+-----------------------------------+------------------------------------------------------------+
| :command:`pciconf -l -cv`         | show PCI devices                                           |
+-----------------------------------+------------------------------------------------------------+
| :command:`dmesg | grep usb`       | show USB devices                                           |
+-----------------------------------+------------------------------------------------------------+
| :command:`kldstat`                | list all modules loaded in the kernel                      |
+-----------------------------------+------------------------------------------------------------+
| :command:`kldload <module>`       | load a kernel module for the current session               |
+-----------------------------------+------------------------------------------------------------+
| :command:`pbi_add -r <pbiname>`   | install software from the command line                     |
+-----------------------------------+------------------------------------------------------------+
| :command:`sysctl hw.realmem`      | display hardware memory                                    |
+-----------------------------------+------------------------------------------------------------+
| :command:`sysctl hw.model`        | display CPU model                                          |
+-----------------------------------+------------------------------------------------------------+
| :command:`sysctl hw.machine_arch` | display CPU Architecture                                   |
+-----------------------------------+------------------------------------------------------------+
| :command:`sysctl hw.ncpu`         | display number of CPUs                                     |
+-----------------------------------+------------------------------------------------------------+
| :command:`uname -vm`              | get release version information                            |
+-----------------------------------+------------------------------------------------------------+
| :command:`gpart show`             | show device partition information                          |
+-----------------------------------+------------------------------------------------------------+
| :command:`fuser`                  | list IDs of all processes that have one or more files open |
+-----------------------------------+------------------------------------------------------------+

The following articles and videos provide additional information about some of the differences between BSD and Linux: 

* `Comparing BSD and Linux <http://www.freebsd.org/doc/en/articles/explaining-bsd/comparing-bsd-and-linux.html>`_

* `FreeBSD Quickstart Guide for LinuxÂŽ Users <http://www.freebsd.org/doc/en/articles/linux-users/index.html>`_

* `BSD vs Linux <http://www.over-yonder.net/~fullermd/rants/bsd4linux/01>`_

* `Why Choose FreeBSD? <http://www.freebsd.org/advocacy/whyusefreebsd.html>`_

* `Interview: BSD for Human Beings <http://www.unixmen.com/bsd-for-human-beings-interview/>`_

* `Video: BSD 4 Linux Users <https://www.youtube.com/watch?v=xk6ouxX51NI>`_

* `Why you should use a BSD style license for your Open Source Project <http://www.freebsd.org/doc/en/articles/bsdl-gpl/article.html>`_

* `A Sysadmin's Unixersal Translator (ROSETTA STONE) <http://bhami.com/rosetta.html>`_