Skip to content
This repository was archived by the owner on Dec 4, 2020. It is now read-only.

Commit 803abe7

Browse files
committed
Start to switch to TrueOS. This is a WIP and some sections have been ignored for now until they can be switched over, removed, or rewritten.
1 parent 97635f5 commit 803abe7

File tree

12 files changed

+361
-369
lines changed

12 files changed

+361
-369
lines changed

src-qt5/docs/advanced.rst

Lines changed: 26 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Advanced Installation Topics
55
****************************
66

7-
The previous section discussed a default installation of PC-BSD®. This section covers the following advanced installation topics:
7+
The previous section discussed a default installation of TrueOS®. This section covers the following advanced installation topics:
88

99
* :ref:`Using the Text Installer`
1010

@@ -23,7 +23,7 @@ Using the Text Installer
2323
========================
2424

2525
If you prefer to perform an installation using an ncurses menu rather than a full graphical installer, start the installation as usual and select the option "install" from
26-
the :numref:`Figure %s: PC-BSD® Installation Menu <install1c>`.
26+
the :numref:`Figure %s: TrueOS® Installation Menu <install1c>`.
2727

2828
.. _install1c:
2929

@@ -111,7 +111,7 @@ The next screen, shown in :numref:`Figure %s: Review Installation Options <text9
111111
* **hardware:** selecting this option will display a summary of the system's hardware. The example shown in :numref:`Figure %s: Hardware Summary <text10>` is from a system with a disabled
112112
sound card and no wireless card.
113113

114-
* **quit:** select this option to return to the screen shown in :numref:`Figure %s: PC-BSD® Installation Menu <install1c>`.
114+
* **quit:** select this option to return to the screen shown in :numref:`Figure %s: TrueOS® Installation Menu <install1c>`.
115115

116116
.. _text9:
117117

@@ -172,9 +172,9 @@ This screen contains the following options:
172172
Using the System Utilities Menu
173173
-------------------------------
174174

175-
The text installer contains some handy tools for troubleshooting and fixing an existing PC-BSD® or TrueOS® installation.
175+
The text installer contains some handy tools for troubleshooting and fixing an existing TrueOS® installation.
176176

177-
If you click the *utility* option in the main menu of the text based installer shown in :numref:`Figure %s: PC-BSD® Installation Menu <install1c>`, it will open the screen shown in
177+
If you click the *utility* option in the main menu of the text based installer shown in :numref:`Figure %s: TrueOS® Installation Menu <install1c>`, it will open the screen shown in
178178
:numref:`Figure %s: System Utilities Menu <util1>`.
179179

180180
.. _util1:
@@ -183,7 +183,7 @@ If you click the *utility* option in the main menu of the text based installer s
183183

184184
This screen provides the following options:
185185

186-
* **shell:** this option is useful if you are troubleshooting a PC-BSD® system that no longer boots. It will open a shell with administrative access that
186+
* **shell:** this option is useful if you are troubleshooting a TrueOS® system that no longer boots. It will open a shell with administrative access that
187187
includes the base FreeBSD utilities. Advanced users can use this shell to try to determine what the problem is, to create a backup or copy essential
188188
files to another system, or edit configuration files with an editor such as `ee <https://www.freebsd.org/cgi/man.cgi?query=ee>`_ or :command:`vi`. When you are finished using the shell,
189189
type :command:`exit` to return to the screen shown in :numref:`Figure %s: System Utilities Menu <util1>`.
@@ -196,33 +196,32 @@ This screen provides the following options:
196196
* **fixgrub:** this option can be used to restamp the GRUB boot loader should the installed system no longer boot. When this option is selected, it will first
197197
show the available ZFS pools and prompt you to input the name of the pool to import.
198198

199-
* **exit:** this option will return you to the main menu seen in :numref:`Figure %s: PC-BSD® Installation Menu <install1c>`.
199+
* **exit:** this option will return you to the main menu seen in :numref:`Figure %s: TrueOS® Installation Menu <install1c>`.
200200

201201
.. index:: install
202202
.. _Install a Server:
203203

204204
Install a Server
205205
=================
206206

207-
The :ref:`System Selection Screen` of the PC-BSD® installer can be used to install TrueOS®, a FreeBSD-based server operating system, rather than a PC-BSD®
208-
desktop operating system.
207+
The :ref:`System Selection Screen` of the TrueOS® installer can be used to install a FreeBSD-based server operating system rather than a desktop operating system.
209208

210209
TrueOS® adds the following to a vanilla installation of FreeBSD: :command:`iocage` for jail management and the command line
211210
versions of most of the :ref:`Control Panel` utilities. You will find those utilities in :file:`/usr/local/bin/pc-*`. It also installs the software mentioned in
212211
`the RUN_DEPENDS= section of this file <https://github.com/pcbsd/freebsd-ports/blob/master/misc/trueos-base/Makefile>`_.
213212

214-
For a server installation, using the PC-BSD® installer rather than the FreeBSD installer offers several benefits:
213+
For a server installation, using the TrueOS® installer rather than the FreeBSD installer offers several benefits:
215214

216215
* the ability to easily configure ZFS during installation
217216

218217
* the ability to configure multiple boot environments
219218

220219
* a wizard (described in this section) is provided during installation to configure the server for first use
221220

222-
.. note:: this section describes how to install a command-line only server using the PC-BSD® graphical installer. Alternately, you can also install a server
221+
.. note:: this section describes how to install a command-line only server using the graphical installer. Alternately, you can also install a server
223222
:ref:`Using the TrueOS® CD` or :ref:`Using the Text Installer`.
224223

225-
To perform a graphical server installation, start the PC-BSD® installation as usual. When you get to the :ref:`System Selection Screen` of the installer, select "TrueOS
224+
To perform a graphical server installation, start the TrueOS® installation as usual. When you get to the :ref:`System Selection Screen` of the installer, select "TrueOS
226225
(Console based server)".
227226

228227
Click "Next" to start the "Server Setup Wizard" then click "Next" again to see the screen shown in :numref:`Figure %s: Set the Root Password <server2>`.
@@ -298,13 +297,11 @@ can now configure and use the server as you would any other FreeBSD server insta
298297
Using the TrueOS® CD
299298
=====================
300299

301-
PC-BSD® provides a CD-sized TrueOS® ISO which provides an ncurses installer for installing a command-line version of TrueOS®. If your
300+
The CD-sized TrueOS® ISO provides an ncurses installer for installing a command-line version of TrueOS®. If your
302301
intent is to only install servers and you do not need a graphical installer, this ISO is convenient to use and quick to download.
303302

304-
To start a server installation using the TrueOS® ISO, insert the prepared boot media. The initial boot menu will be similar to the :numref:`Figure %s: Initial Boot Menu <install1b>`, but
305-
the logo will be for TrueOS instead of PC-BSD.
306-
307-
Once the system has finished booting into the installer, it will display the installation menu shown in :numref:`Figure %s: TrueOS® Installation Menu <cd2>`.
303+
To start a server installation using the TrueOS® ISO, insert the prepared boot media. Once the system has finished booting into the installer, it will display the installation menu shown in
304+
:numref:`Figure %s: TrueOS® Installation Menu <cd2>`.
308305

309306
.. _cd2:
310307

@@ -320,20 +317,20 @@ The TrueOS® boot media can also be used to repair an existing installation, usi
320317
Dual Booting
321318
============
322319

323-
A PC-BSD® installation assumes that you have an existing primary partition to install into. If your computer has only one disk and PC-BSD® will be the only
324-
operating system, it is fine to accept the default partitioning scheme. However, if you will be sharing PC-BSD® with other operating systems, be
325-
careful that PC-BSD® is installed into the correct partition or you may inadvertently overwrite an existing operating system.
320+
A TrueOS® installation assumes that you have an existing primary partition to install into. If your computer has only one disk and TrueOS® will be the only
321+
operating system, it is fine to accept the default partitioning scheme. However, if you will be sharing TrueOS® with other operating systems, be
322+
careful that TrueOS® is installed into the correct partition or you may inadvertently overwrite an existing operating system.
326323

327324
If you wish to install multiple operating systems on your computer, you will need the following:
328325

329-
* a partition for each operating system. Many operating systems, including PC-BSD®, can only be installed into a primary or GPT partition. This means that
326+
* a partition for each operating system. Many operating systems, including TrueOS®, can only be installed into a primary or GPT partition. This means that
330327
you will need to use partitioning software as described in :ref:`Creating Free Space`.
331328

332329
* a backup of any existing data. This backup should not be stored on your computer's hard drive but on another computer or on a removable media such as a USB
333330
drive or burnt onto a DVD media. If you are careful in your installation, everything should go fine. However, you will be glad that you made a backup should
334331
something go wrong.
335332

336-
When installing PC-BSD® onto a computer that is to contain multiple operating systems, care must be taken to **select the correct partition** in the
333+
When installing TrueOS® onto a computer that is to contain multiple operating systems, care must be taken to **select the correct partition** in the
337334
:ref:`Disk Selection Screen` of the installation. On a system containing multiple partitions, each partition will be listed. Highlight the partition that you
338335
wish to install into and **make sure that you do not select a partition that already contains an operating system or data that you wish to keep.**
339336

@@ -346,10 +343,10 @@ wish to install into and **make sure that you do not select a partition that alr
346343
GRUB Boot Loader
347344
----------------
348345

349-
In PC-BSD® 11, the FreeBSD boot loader is the preferred, and default, boot loader as it provides native support for ZFS boot environments. If you changed the default during installation,
346+
In TrueOS® 11, the FreeBSD boot loader is the preferred, and default, boot loader as it provides native support for ZFS boot environments. If you changed the default during installation,
350347
the installer will use a customized version of the GRUB boot loader that provides limited ZFS boot environment support.
351348

352-
The PC-BSD® version of GRUB will attempt to identify other installed operating systems, such as Windows and Linux, and add them to the GRUB boot menu. If your other operating system is not
349+
The TrueOS® version of GRUB will attempt to identify other installed operating systems, such as Windows and Linux, and add them to the GRUB boot menu. If your other operating system is not
353350
automatically detected, you will need to manually add an entry to the :file:`/usr/local/etc/grub.d/40_custom.dist` file. For more information on the syntax used, refer to the
354351
`GRUB Manual <http://www.gnu.org/software/grub/manual/grub.html>`_.
355352

@@ -359,14 +356,14 @@ automatically detected, you will need to manually add an entry to the :file:`/us
359356
Creating an Automated Installation
360357
==================================
361358

362-
PC-BSD® provides a set of Bourne shell scripts that allow advanced users to create automatic or customized PC-BSD® installations. :command:`pc-sysinstall`
359+
TrueOS® provides a set of Bourne shell scripts that allow advanced users to create automatic or customized TrueOS® installations. :command:`pc-sysinstall`
363360
is the name of the master script; it reads a customizable configuration file and uses dozens of backend scripts to perform the installation. You can read more
364361
about this utility by typing **man pc-sysinstall**.
365362

366363
Here is a quick overview of the components used by :command:`pc-sysinstall`:
367364

368-
* :file:`/usr/local/share/pc-sysinstall/backend/` contains the scripts used by the PC-BSD® installer. Scripts have been divided by function, such as
369-
:file:`functions-bsdlabel.sh` and :file:`functions-installcomponents.sh`. If you have ever wondered how the PC-BSD® installer works, read through these
365+
* :file:`/usr/local/share/pc-sysinstall/backend/` contains the scripts used by the TrueOS® installer. Scripts have been divided by function, such as
366+
:file:`functions-bsdlabel.sh` and :file:`functions-installcomponents.sh`. If you have ever wondered how the TrueOS® installer works, read through these
370367
scripts. This directory also contains the :file:`parseconfig.sh` and :file:`startautoinstall.sh` scripts which :command:`pc-sysinstall` uses to parse the
371368
configuration file and begin the installation.
372369

@@ -388,7 +385,7 @@ First, determine which variables you wish to customize. A list of possible varia
388385
are summarized in Table 5.5a. Note that the Table is meant as a quick reference to determine which variables are available. The :file:`README` file contains more
389386
complete descriptions for each variable.
390387

391-
**Table 5.5a: Available Variables for Customizing a PC-BSD® Installation**
388+
**Table 5.5a: Available Variables for Customizing a TrueOS® Installation**
392389

393390
+----------------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
394391
| Variable | Options | Description |
@@ -567,7 +564,7 @@ Finally, create a custom installation media or installation server. :command:`pc
567564

568565
* from an installation directory on an HTTP, FTP, SSH+rsync, or a :ref:`PXE Boot Install Server`
569566

570-
The easiest way to create a custom installation media is to modify an existing installation image. For example, if you have downloaded an ISO for the PC-BSD®
567+
The easiest way to create a custom installation media is to modify an existing installation image. For example, if you have downloaded an ISO for the TrueOS®
571568
version that you wish to customize, the superuser can access the contents of the ISO as follows::
572569

573570
mdconfig -a -t vnode -f PCBSD10.1.2-RELEASE-x64-DVD-USB.iso -u 1

0 commit comments

Comments
 (0)