nat
[ikiwiki.git] / docs / newhandbook / environmentquickstart / index.mdwn
index a62f824..12c5694 100644 (file)
@@ -1,12 +1,22 @@
-This document describes the DragonFly environment one will find on a newly installed system using the default options in the installer after selecting HAMMER for the file systems option.
+# DragonFly BSD Quick Start
+
+This QuickStart is part of the [[NewHandbook|/docs/newhandbook/]].
+
+This document describes the DragonFly environment one will find on a newly installed system.  While you are getting started, please pay careful attention to the version or level of DragonFly that the documentation was written for.  Some documentation on this site may be out of date. Watch for the marker `(obsolete)` on items that are out of date or need updating.
+
 
 [[!toc levels=3 ]]
+## Some Unix and BSD Fundamentals
 
-## Disk, Partition layout, Mount points, PFSes, Snapshots
+If you have used another Unix flavour, another BSD, or Linux before, you may need to spend some time learning the differences between DragonFly and the system you are experienced in.  If you have never used any flavor of Unix, BSD or otherwise, and have only used Windows before, please be prepared for a lengthy period of learning.
 
-If you followed the default options during installation you will be
-left with a system with the following disk configuration
+If you already know your way around a Unix filesystem, and already know what the `/etc` folder is, how to use `vi` or `vim` to edit a file, how to use a shell like `tcsh` or `bash`, how to configure that shell, or change what shell you're using, how `su` and `sudo` work, and what a `root` account is, the rest of this page may be enough to orient you to your surroundings.
 
+You should understand everything in the [[Unix Basics|/docs/newhandbook/UnixBasics/]] section before you proceed with trying to use your new system.
+
+## Disk layout of a New Dragonfly BSD System using the HAMMER filesystem
+
+If you chose to install on the HAMMER file system during installation you will be left with a system with the following disk configuration:
 
     # df -h
     Filesystem                Size   Used  Avail Capacity  Mounted on
@@ -24,14 +34,13 @@ left with a system with the following disk configuration
 
 In this example
 
-**/dev/serno/9VMBWDM1** is the hard disk specified with serial number,
-
-**/dev/serno/9VMBWDM1.s1** is the first slice on the hard disk.
+* `/dev/serno/9VMBWDM1` is the hard disk specified with serial number,
+* `/dev/serno/9VMBWDM1.s1` is the first slice on the hard disk.
 
-Let us see its disklabel
+The disk label looks as follows:
 
+    # disklabel /dev/serno/9VMBWDM1.s1
 
-    # sudo disklabel /dev/serno/9VMBWDM1.s1
     # /dev/serno/9VMBWDM1.s1:
     #
     # Informational fields calculated from the above
@@ -65,22 +74,20 @@ Let us see its disklabel
 
 The slice has 3 partitions:
 
-a - for /boot
+* `a` - for `/boot`
+* `b` - for swap
+* `d` - for `/`, a HAMMER file system labeled ROOT
 
-b - for swap
-
-d - for /, a HAMMER file system labeled ROOT
-
-When you create a HAMMER file system you must give it a label, here the Installer labeled it as "ROOT" and mounted it as
+When you create a HAMMER file system, you must give it a label.  Here, the installer labelled it as "ROOT" and mounted it as
 
     ROOT                      288G    12G   276G     4%    /
 
-Now a PFS is a Pseudo File System inside a HAMMER file system. The HAMMER file system in which the PFSes are created is referred to as the root file system. (You should not confuse the "root" file system with the Label "ROOT", the label can be anything it is just that the installer Labeled it as ROOT
-because it is mounted as /)
+A PFS is a Pseudo File System inside a HAMMER file system. The HAMMER file system in which the PFSes are created is referred to as the root file system. You should not confuse the "root" file system with the label "ROOT": the label can be anything. The installer labeled it as ROOT because it is mounted at `/`.
 
-Now inside the ROOT HAMMER file system you find the installed created 7 PFSes from the `df -h' output above, let us see how they are mounted in fstab
+Now inside the root HAMMER file system you find the installer created 7 PFSes from the `df -h` output above, let us see how they are mounted in `/etc/fstab`:
 
     # cat /etc/fstab
+
     # Device                Mountpoint      FStype  Options         Dump    Pass#
     /dev/serno/9VMBWDM1.s1a         /boot           ufs     rw      1       1
     /dev/serno/9VMBWDM1.s1b         none            swap    sw      0       0
@@ -95,11 +102,11 @@ Now inside the ROOT HAMMER file system you find the installed created 7 PFSes fr
     proc                    /proc           procfs  rw              0       0
 
 
-The PFSes are mounted using a NULL mount because they are also HAMMER file systems. You can read more on NULL mounts here [mount_null(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=mount_null&section=8).
+The PFSes are mounted using a NULL mount because they are also HAMMER file systems. You can read more on NULL mounts at the [mount_null(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=mount_null&section=8) manpage.
 
-You don't need to specify a Size for the PFSes like you do for Logical Volumes inside a Volume Group for LVM. All the Free space in the root HAMMER file system is available for all the PFSes to grow. That is the reason in the `df -h' output above you saw free space is same for all PFSes and the root HAMMER file system.
+You don't need to specify a size for the PFSes like you do for logical volumes inside a volume group for LVM. All the free space in the root HAMMER file system is available to all the PFSes; it can be seen in the `df -h` output above that the free space is the same for all PFSes and the root HAMMER file system.
 
-Now if you look in /var
+If you look in `/var`
 
     # cd /var/
     # ls
@@ -108,10 +115,9 @@ Now if you look in /var
 
 you will find the above directories.
 
-If you look at the status of one of the PFSes say /usr you will see /var/hammer is the default snapshot directory.
+If you look at the status of one of the PFSes, e.g. `/usr` you will see `/var/hammer` is the default snapshot directory.
 
-
-   # hammer pfs-status /usr/
+    # hammer pfs-status /usr/
     /usr/   PFS #3 {
         sync-beg-tid=0x0000000000000001
         sync-end-tid=0x0000000117ac6270
@@ -122,17 +128,14 @@ If you look at the status of one of the PFSes say /usr you will see /var/hammer
         operating as a MASTER
         snapshots directory defaults to /var/hammer/<pfs>
     }
-   #
-
 
-But there is no "hammer" directory in /var now. That is because no snapshots are yet taken. You can verify this by checking the snapshots available for /usr
+At installation time, it will be seen that there is no `hammer` directory in `/var`. The reason for this is that no snapshots have yet been taken. You can verify this by checking the snapshots available for `/usr`
 
     # hammer snapls /usr
     Snapshots on /usr       PFS #3
     Transaction ID          Timestamp               Note
-    #
 
-The best way to take a snapshot of the whole system is to run the command `hammer cleanup'. It does a lot of things but the fist thing it does during cleanup of a PFS is to take its snapshots as configured.
+Snapshots will appear automatically each night as the system performs housekeeping on the Hammer filesystem.  For a new volume, an immediate snapshot can be taken by running the command 'hammer cleanup'.  Among other activities, it will take a snapshot of the filesystem.
 
     # sudo hammer cleanup
     cleanup /                    - HAMMER UPGRADE: Creating snapshots
@@ -144,82 +147,25 @@ The best way to take a snapshot of the whole system is to run the command `hamme
                  reblock - run....
                   recopy - run....
     cleanup /var                 - HAMMER UPGRADE: Creating snapshots
-            Creating snapshots in /var/hammer/var
-     handle PFS #1 using /var/hammer/var
-               snapshots - run
-                   prune - run
-               rebalance - run..
-                 reblock - run....
-                  recopy - run....
+    [...]
     cleanup /tmp                 - HAMMER UPGRADE: Creating snapshots
-            Creating snapshots in /var/hammer/tmp
-     handle PFS #2 using /var/hammer/tmp
-               snapshots - disabled
-                   prune - run
-               rebalance - run..
-                 reblock - run....
-                  recopy - run....
+    [...]
     cleanup /usr                 - HAMMER UPGRADE: Creating snapshots
-            Creating snapshots in /var/hammer/usr
-     handle PFS #3 using /var/hammer/usr
-               snapshots - run
-                   prune - run
-               rebalance - run..
-                 reblock - run....
-                  recopy - run....
+    [...]
     cleanup /home                - HAMMER UPGRADE: Creating snapshots
-            Creating snapshots in /var/hammer/home
-     handle PFS #4 using /var/hammer/home
-               snapshots - run
-                   prune - run
-               rebalance - run..
-                 reblock - run....
-                  recopy - run....
+    [...]
     cleanup /usr/obj             - HAMMER UPGRADE: Creating snapshots
-            Creating snapshots in /var/hammer/usr/obj
-     handle PFS #5 using /var/hammer/usr/obj
-               snapshots - disabled
-                   prune - run
-               rebalance - run..
-                 reblock - run....
-                  recopy - run....
+    [...]
     cleanup /var/crash           - HAMMER UPGRADE: Creating snapshots
-            Creating snapshots in /var/hammer/var/crash
-     handle PFS #6 using /var/hammer/var/crash
-               snapshots - run
-                   prune - run
-               rebalance - run..
-                 reblock - run....
-                  recopy - run....
+    [...]
     cleanup /var/tmp             - HAMMER UPGRADE: Creating snapshots
-            Creating snapshots in /var/hammer/var/tmp
-     handle PFS #7 using /var/hammer/var/tmp
-               snapshots - disabled
-                   prune - run
-               rebalance - run..
-                 reblock - run....
-                  recopy - run....
+    [...]
     cleanup /var/isos            - HAMMER UPGRADE: Creating snapshots
-            Creating snapshots in /var/hammer/var/isos
-     handle PFS #8 using /var/hammer/var/isos
-               snapshots - run
-                   prune - run
-               rebalance - run..
-                 reblock - run....
-                  recopy - run....
-    #
-
-You  must have noticed that snapshots were not taken for '/tmp', '/usr/obj' and '/var/tmp'. That is how it is automatically configured by the installer.
-
-Let us look again in /var now
+    [...]
 
-    # ls
-    account   backups   caps   cron    empty   hammer log   msgs   run   spool   yp  
-    at        cache     crash     db     games   lib     mail  preserve   rwho  tmp
-
-
-We have a new directory called "hammer" with the following sub directories
+No snapshots were taken for `/tmp`, `/usr/obj` and `/var/tmp`. This is because the PFSes are flagged as `nohistory`. HAMMER tracks history for all files in a PFS.  Naturally, this consumes disk space until  history is pruned, at which point the available disk space will stabilise. To prevent temporary files on the mentioned PFSes (e.g., object files, crash dumps) from consuming disk space, the PFSes are marked as `nohistory`.
 
+After performing nightly housekeeping, a new directory called *hammer* will be found in `/var` with the following sub directories:
 
     # cd hammer/
     # ls -l
@@ -231,8 +177,7 @@ We have a new directory called "hammer" with the following sub directories
     drwxr-xr-x  1 root  wheel  0 Oct 13 11:54 var
 
 
-Well let us look inside /var/hammer/usr 
-
+Looking inside `/var/hammer/usr`, one finds:
 
     # cd usr/
     # ls -l
@@ -241,9 +186,7 @@ Well let us look inside /var/hammer/usr
     lrwxr-xr-x  1 root  wheel  25 Oct 13 11:43 snap-20101013-1143 -> /usr/@@0x0000000117ac6cb0
 
 
-We have a symlink pointing to the snapshot Transaction ID shown below.
-
-
+We have a symlink pointing to the snapshot transaction ID shown below.
 
     # hammer snapls /usr
     Snapshots on /usr       PFS #3
@@ -251,145 +194,46 @@ We have a symlink pointing to the snapshot Transaction ID shown below.
     0x0000000117ac6cb0      2010-10-13 11:43:04 IST -
     #
 
-
-You can read more about snapshots, prune, reblance, reblock, recopy etc from [hammer(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=hammer&section=8) especially look under the heading "cleanup [filesystem ...]"
+You can read more about snapshots, prune, reblance, reblock, recopy etc from [hammer(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=hammer&section=8).  Make especially sure to look under the heading "cleanup [filesystem ...]".
 
 You can learn more about PFS mirroring [here](http://www.dragonflybsd.org/docs/how_to_implement_hammer_pseudo_file_system__40___pfs___41___slave_mirroring_from_pfs_master/)
 
-## Configuring and Starting the SSH Server
-
-Described in detail [here](http://www.dragonflybsd.org/docs/newhandbook/sshserver/)
-
-## Software/Programs and Configuration Files Location 
-
-DragonFly default installation contains the base software/programs from the DragonFly project itself and few other software from [pkgsrc](http://www.netbsd.org/docs/software/packages.html) which is the DragonFly official package management system. Ready to install binary software from pkgsrc is referred to as "<b>Packages</b>".
-
-The base programs are located in the folders 
-
-    /bin    /sbin
-    /usr/bin   /usr/sbin
-    /usr/local/bin   /usr/local/sbin
-
-Their configuration files are found mainly in <b>/etc</b>. there is also <b> /usr/local/etc </b>
+In order to correctly map hard disk sernos to device names you can use the 'devattr' command.
 
-The software/programs from pkgsrc are located in <b>/usr/pkg/bin and /usr/pkg/sbin</b>. Their configuration files are found in <b>/usr/pkg/etc</b>.
+    # udevd
+    # devattr -d "ad*" -p serno
+    Device ad4:
+            serno = Z2AD9WN4
+    Device ad4s1:
+    Device ad4s1d:
 
-## Installing new Software from pkgsrc packages 
+    Device ad5:
+            serno = 9VMRFDSY
+    Device ad5s1:
+    Device ad5s1d:
 
-A Detailed description on how to use packages and pkgsrc are given [[here|docs/howtos/HowToPkgsrc]].
+    Device ad3:
+            serno = Z2AD9WLW
+    Device ad3s1:
+    Device ad3s1a:
+    Device ad3s1b:
+    Device ad3s1d:
 
-For those who are new to the BSD way of doing things can also have the Debian's apt like way of installing, removing and updating packages. 
+If your disks are 'da', change as appropriate.
 
-**pkgin** does things similar to **apt-get** or **aptitude** or **yum** for that matter.
-
-First we need to configure pkgin to use a repository which contains the pkgsrc binary packages. You can get a list of DragonFly mirrors [here](http://www.dragonflybsd.org/mirrors/). For this example we will use the <b>Belarus</b> [HTTP mirror](http://mirror.datacenter.by/pub/DragonFlyBSD/) shown on that page first under Europe.
-
-
-    #echo "http://mirror.datacenter.by/pub/DragonFlyBSD/packages/i386/DragonFly-2.7/stable/All/" > /usr/pkg/etc/pkgin/repositories.conf
-
-
-Now to update pkgin with the list of latest packages available from that repository.
-
-
-    # pkgin update
-    cleaning database from
-    http://mirror.datacenter.by/pub/DragonFlyBSD/packages/i386/DragonFly-2.7/stable/
-    entries...
-    downloading pkg_summary.bz2: 100%
-    processing remote summary
-    (http://mirror.datacenter.by/pub/DragonFlyBSD/packages/i386/DragonFly-2.7/stable/All)...
-    updating database: 100%
-
-Now to upgrade packages that are already installed in the system
-
-
-    # pkgin full-upgrade
-    6 packages to be upgraded: freetype2-2.3.12 gtar-info-1.22
-    openldap-client-2.4.21 png-1.4.2 python26-2.6.5 tiff-3.9.4
-    1 packages to be removed: asciidoc-8.6.1
-    6 packages to be installed: png-1.4.3 python26-2.6.5nb1 tiff-3.9.4nb1
-    freetype2-2.4.2 gtar-info-1.23 openldap-client-2.4.23 (15M to
-    download, 59M to install)
-    proceed ? [y/N] y
-    downloading packages...
-    downloading png-1.4.3.tgz: 100%
-    downloading python26-2.6.5nb1.tgz: 100%
-    downloading tiff-3.9.4nb1.tgz: 100%
-    downloading freetype2-2.4.2.tgz: 100%
-    downloading gtar-info-1.23.tgz: 100%
-    downloading openldap-client-2.4.23.tgz: 100%
-    .....
-
-In order to search for a new Package for example **rdesktop**.
-
-
-    # pkgin search rdesktop
-    rdesktop-1.6.0 =     Open-source Remote Desktop Protocol client
-    tsclient-0.132nb25   GNOME2 Frontend for rdesktop
-    
-    =: package is installed and up-to-date
-    <: package is installed but newer version is available
-    >: installed package has a greater version than available package
-
-
-If there are symbols **=** or **<** or **>** after a package name in the output then the last 3 lines of the output will explain them.
-
-To search for a package and install it you can do the following. If there are different versions of the package available in the repository it will show you the list and you need to specify one from them explicitly. At the end of the installation it will show you a message if you need any further configuration for the software to work in a particular way.
-
-
-    dfly-vmsrv# pkgin search mysql-client
-    mysql-client-4.1.22nb4  MySQL 4, a free SQL database (client)
-    mysql-client-5.0.91  MySQL 5, a free SQL database (client)
-    mysql-client-5.1.49  MySQL 5, a free SQL database (client)
-    
-    =: package is installed and up-to-date
-    <: package is installed but newer version is available
-    >: installed package has a greater version than available package
-    dfly-vmsrv# pkgin install mysql-client
-    there's more than one version available for this package.
-    please re-run pkgin with a package name matching one of the following:
-    mysql-client-4.1.22nb4
-    mysql-client-5.0.91
-    mysql-client-5.1.49
-    nothing to do.
-    dfly-vmsrv# pkgin install mysql-client-5.1.49
-    calculating dependencies for mysql-client-5.1.49...
-    nothing to upgrade. 
-    1 packages to be installed: mysql-client-5.1.49 (7620K to download, 24M to install)
-    proceed ? [y/N] y
-    downloading packages...
-    downloading mysql-client-5.1.49.tgz: 100%
-    installing packages...
-    installing mysql-client-5.1.49...
-    ===========================================================================
-    $NetBSD: MESSAGE,v 1.1.1.1 2010/03/04 16:27:18 taca Exp $
-
-    To use the ``mysqlhotcopy'' script, you'll have to install the following
-    packages:
+## Configuring and Starting the SSH Server
 
-            databases/p5-DBD-mysql
-            devel/p5-File-Temp
+Described in detail [here](docs/newhandbook/Users/#index3h1)
 
-    ===========================================================================
-    processing local summary...
-    updating database: 100%
-    marking mysql-client-5.1.49 as non auto-removable
+## Software/Programs and Configuration Files Location 
 
+The DragonFly default installation contains the base software/programs from the DragonFly project itself and additional software from other sources. 
 
-To remove a package
+The base system binary software programs are located in the folders 
 
+    /bin    /sbin
+    /usr/bin   /usr/sbin
 
-    # pkgin remove mysql-client
-    1 packages to delete: mysql-client-5.1.49
-    proceed ? [y/N] y
-    removing mysql-client-5.1.49...
-    processing local summary...
-    updating database: 100%
-
+The configuration files for the base system can be found in `/etc`. Third-party programs use `/usr/local/etc`.
 
-**pkgin** is very similar to **apt-get, aptitude , yum, emerge, pacman** and friends in the linux world.
-
-All the **pkgin** commands can be seen [here](http://imil.net/pkgin/). **pkgin** comes installed with the default DragonFly install so you can skip the installation part on that page
-
-To install a desktop you can [read the following](http://www.dragonflybsd.org/docs/newhandbook/X/)
-Other Docs can be found [here](http://www.dragonflybsd.org/docs/newhandbook/X/). When ever you find **pkg_add** or **pkg_radd** used to install a software just use **pkgin** instead.
+There are several different ways to install software and which version you use depends on which DragonFly BSD version you have.  You can compile things from source code, or you can use binary packages.