Handbook (for 2.0-RC1)

Content:

1. About
2. Intro
3. Burning DVD
4. Log In
5. Configuring the system
6. Saving & restoring user's settings
7. Installing TrueBSD on the hard drive
8. Included software
9. Bug reporting
10. Contribution
11. Detailed info


1. About TrueBSD

TrueBSD is an operating system based on FreeBSD (http://freebsd.org) with useful software (KDE, GNOME, OpenOffice etc.) wich helps you: watch video, listen to a music, work with documents, write programs, browse the Internet and many others. It boots from the DVD and works without using a hard drive.
TrueBSD is distributed under the BSD license (see '/truebsd/doc/copyright' for details) and included software under its own licenses.

2. Intro

I had a task in my university and couldn't decide what I'll develop for a while. Then I decided to develop TrueBSD cause I like FreeBSD and know it.
I think that some people may be in situation when they need a configured *BSD-system but they can't install it on a computer (e.g. a computer on work running on W**dows). So I have a good motivation.
After the realization the task for the university I decided to continue developing TrueBSD and even my death won't stop me :).

3. Burning DVD

For burning TrueBSD DVD you'll need DVD recorder, empty DVD and program for burning DVD.
If you use FreeBSD (or other *nix operating system), you may use growisofs utility (from the dvd+rw-tools package):

#growisofs -Z /dev/cd0=truebsd.iso

In this example /dev/cd0 - your DVD recorder and truebsd.iso - image of the TrueBSD DVD.

4. Log In

For log in the system use 'tuser' username and 'tuser' password. The superuser's (root) password is 'root' (use it as a last resort!).
When OS boots from the DVD you don't need username and password cause the prelogin utility loads (/sysutils/prelogin) and proposes such variants:

1. Load graphic interface
2. Back to system console
3. Reboot
4. Turn off

If you choose the first item the automatic configuration of your videocard and monitor will run. After that the GDM graphic manager will load.

5. Configuring the system

After loading the GDM graphic manager you can choose preferable language and window manager (Gnome, KDE and Xfce are more easily in learning and configuring). Then you can enter username ('tuser') and password ('tuser').
All other settings (screen resolution, appearance, network) you can set directly in chosen window manager.
For configuring the firewall you may use the pfw utility (ports/security/pfw). For using the pfw you'll need to run the Apache web-server:

%sudo sh /usr/local/etc/rc.d/apache22 forcestart'

open your browser (e.g. firefox) and enter in adress bar: http://localhost/pfw/

6. Saving & restoring user's settings

To save your profile use the /sysutils/saveprofile script. For restoring the profile run the /sysutils/restoreprofile script.
Before using both scripts it's necessary to mount in `/mnt/backup` a drive where the archive with setting will store (the truebsdprofile.tar file).
It's very simple. If you need to save current settings and copy them on flash drive then execute:

%sudo mount_msdosfs /dev/da0s1 /mnt/backup

In the same way this operation is executing for other file sytems (mount(8)).
Then you should run script /sysutils/saveprofile:

%sudo saveprofile

After running it the `truebsdprofile.tar` file in `/mnt/backup` directory should be created. Then you may unmount file system with the next command:

%sudo umount /mnt/backup

In the same way you can restore the profile. Mount in `/mnt/backup` file system with saved archive and run the /sysutils/restoreprofile script:

%sudo restoreprofile

Note: saveprofile/restoreprofiles stores followed directories:

* /home/
* /etc/
* /usr/local/etc/
* /usr/X11R6/etc/
* /usr/local/www/

7. Installing TrueBSD on the hard drive

Trueinstall is the tool wich helps you to install TrueBSD on your hard drive.
NB! You'll need at least 7 Gb (10 Gb needed for good working of the system) of the free disk space on your hard drive and a primary partition of the hard drive.
Run the scrtipt in the console:

$sudo trueinstall

Then choose more preferable language and follow the instructions.
After the istallation OS first of all you should change superuser's password:

%sudo passwd root

and user's password:

%passwd tuser

If the prelogin utility disturbs you each time when you authorise, run in console:

%touch ~/.prelogin

For the GDM automatic launching, execute the next command:

%sudo dm_daemon start

For OpenGL configuring (only for NVidia videocards!) try this:

%sudo nvidiadrv start

And press Ctrl+Alt+Backspace.
If module nvidia.ko (OS TrueBSD, in other words) doesn't support your videocard restore previous settings with the next command:

%sudo nvidiadrv stop

8. Included software

TrueBSD includes the most useful software both for usual users and for developers and system administrators:

* Browsers: Firefox, Seamonkey, Epiphany, Konqueror, Opera, elinks;
* Mail/News clients: Claws-mail, Seamonkey Mail, mutt;
* IM/IRC clients: Pidgin, Gajim, Skype, Kopete, micq;
* Utilities for burning CD/DVD: K3b, nautilus-cd-burner;
* Audioplayers: Amarok, Audacious, mpg123, moc, mpc;
* Videoplayers: mplayer (with the gtk2 shell: gMplayer), Xine, Totem;
* File managers: Nautilus, Konqueror, Thunar, Midnight Commander (mc);
* Text editors: Emacs, Vim/gVim, Gedit, Mousepad, nvi, ee, ed;
* Text processors: OpenOffice.org Writer, AbiWord;
* Math processors: OpenOffice.org Calc, Gnumeric;
* Image viewers: Gqview, Kview;
* Pdf/djvu/chm readers: Kpdf/Djvulibre/Kchm (correspondingly);
* Compilers: C/С++, Fortran, Java and NASM;
* Interpreters: Perl, Python, PHP, Lua, m4, tcl;
* Command interpreters: csh, tcsh, zsh;
* Antivirus: clamav;
* Archivers: zip, bzip2, gzip, unzoo, unrar, unace;
* Software for restoring archives;
* Win-modems support;
* Software for checking different file systems;
* Software for restoring file systems;
* Software for testing computer and network;
* Web-server Apache;
* Modules mod_perl, mod_php for web-server;
* Net utilities (LAN, modem, Bluetooth, dial-up, VPN, Wireless);
* Remote administration (ssh, telnet, rdesktop);
* Security scanner nmap;
* Firewalls: ipfw, ipf, pf;
* FTP clients: ftp, lftp;
* MySQL and PosgreSQL clients;
* Utility for downloading files wget;
* Emulators: qemu, wine;
* Utilities for audio encoding;
* Window managers: KDE3, Gnome, xfce4, Beryl/Compiz, ion3, wmii3, evilwm;

To view the full list of the included software see the '/truebsd/doc/progslist' file.
If you need some other software in TrueBSD write me support@TrueBSD and I'll try to include it.

9. Bug reporting

If you find any bug or other problem while using the TrueBSD please report it: nullbsd at gmail dot com (include a result of the `/sysutils/version` command) or use our forum: https://truebsdorg.github.io/forum/.
Note: before reporting make sure that you use current version of the TrueBSD (2.0-RC1 or upper).

10. Contributing

If you want to help the project write me an e-mail and I'll answer you as soon as I can. Help may be differently: we need people who will test the OS, write documentation and utilities for it, designers and people who can give a web space for mirrors.
That's why if you are talented and want to work on the TrueBSD project, write me. It's more intresting and simple to learn and create something new together.

11. Detailed info.

TrueBSD is fully compatible with the FreeBSD. So documentation of the FreeBSD is actual for TrueBSD.
The best e-book for the moment is the FreeBSD handbook wich you can find at /truebsd/doc/freebsd/handbook/' (in Russian and English).