Added a referral to the Unix basics section
[ikiwiki.git] / docs / newhandbook / environmentquickstart / index.mdwn
1 # DragonFly BSD Quick Start
2
3 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.
4
5 [[!toc levels=3 ]]
6 ## Some Unix and BSD Fundamentals
7
8 If you have used another Unix flavor, another BSD or Linux before, you may need to spend some time learning basic subjects.  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.
9
10 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, then you may get a lot farther in using any BSD variant (like Dragonfly BSD) then the rest of this page may be enough to orient you to your surroundings.
11
12 If so, go spend some time at the [[Unix Basics|/docs/newhandbook/UnixBasics/]] section before you proceed.
13
14 ## Disk layout
15
16 If you chose to install on the HAMMER file system during installation you will be left with a system with the following disk configuration:
17
18     # df -h
19     Filesystem                Size   Used  Avail Capacity  Mounted on
20     ROOT                      288G    12G   276G     4%    /
21     devfs                     1.0K   1.0K     0B   100%    /dev
22     /dev/serno/9VMBWDM1.s1a   756M   138M   558M    20%    /boot
23     /pfs/@@-1:00001           288G    12G   276G     4%    /var
24     /pfs/@@-1:00002           288G    12G   276G     4%    /tmp
25     /pfs/@@-1:00003           288G    12G   276G     4%    /usr
26     /pfs/@@-1:00004           288G    12G   276G     4%    /home
27     /pfs/@@-1:00005           288G    12G   276G     4%    /usr/obj
28     /pfs/@@-1:00006           288G    12G   276G     4%    /var/crash
29     /pfs/@@-1:00007           288G    12G   276G     4%    /var/tmp
30     procfs                    4.0K   4.0K     0B   100%    /proc
31
32 In this example
33
34 * `/dev/serno/9VMBWDM1` is the hard disk specified with serial number,
35 * `/dev/serno/9VMBWDM1.s1` is the first slice on the hard disk.
36
37 The disklabel looks at follows
38
39     # disklabel /dev/serno/9VMBWDM1.s1
40
41     # /dev/serno/9VMBWDM1.s1:
42     #
43     # Informational fields calculated from the above
44     # All byte equivalent offsets must be aligned
45     #
46     # boot space:    1044992 bytes
47     # data space:  312567643 blocks # 305241.84 MB (320069266944 bytes)
48     #
49     # NOTE: If the partition data base looks odd it may be
50     #       physically aligned instead of slice-aligned
51     #
52     diskid: e67030af-d2af-11df-b588-01138fad54f5
53     label:
54     boot2 data base:      0x000000001000
55     partitions data base: 0x000000100200
56     partitions data stop: 0x004a85ad7000
57     backup label:         0x004a85ad7000
58     total size:           0x004a85ad8200    # 305242.84 MB
59     alignment: 4096
60     display block size: 1024        # for partition display only
61
62     16 partitions:
63     #          size     offset    fstype   fsuuid
64       a:     786432          0    4.2BSD    #     768.000MB
65       b:    8388608     786432      swap    #    8192.000MB
66       d:  303392600    9175040    HAMMER    #  296281.836MB
67       a-stor_uuid: eb1c8aac-d2af-11df-b588-01138fad54f5
68       b-stor_uuid: eb1c8aec-d2af-11df-b588-01138fad54f5
69       d-stor_uuid: eb1c8b21-d2af-11df-b588-01138fad54f5
70
71
72 The slice has 3 partitions:
73
74 * `a` - for `/boot`
75 * `b` - for swap
76 * `d` - for `/`, a HAMMER file system labeled ROOT
77
78 When you create a HAMMER file system you must give it a label, here the installer labeled it as "ROOT" and mounted it as
79
80     ROOT                      288G    12G   276G     4%    /
81
82 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 `/`.
83
84 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 `/etc/fstab`:
85
86     # cat /etc/fstab
87
88     # Device                Mountpoint      FStype  Options         Dump    Pass#
89     /dev/serno/9VMBWDM1.s1a         /boot           ufs     rw      1       1
90     /dev/serno/9VMBWDM1.s1b         none            swap    sw      0       0
91     /dev/serno/9VMBWDM1.s1d         /               hammer  rw      1       1
92     /pfs/var                /var            null    rw              0       0
93     /pfs/tmp                /tmp            null    rw              0       0
94     /pfs/usr                /usr            null    rw              0       0
95     /pfs/home               /home           null    rw              0       0
96     /pfs/usr.obj    /usr/obj                null    rw              0       0
97     /pfs/var.crash  /var/crash              null    rw              0       0
98     /pfs/var.tmp    /var/tmp                null    rw              0       0
99     proc                    /proc           procfs  rw              0       0
100
101
102 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).
103
104 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 PFSs. 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.
105
106 Now if you look in `/var`
107
108     # cd /var/
109     # ls
110     account   backups   caps   cron    empty   log   msgs   run   spool   yp  at        
111     cache     crash     db     games   lib     mail  preserve   rwho  tmp
112
113 you will find the above directories.
114
115 If you look at the status of one of the PFSes, e.g. `/usr` you will see `/var/hammer` is the default snapshot directory.
116
117     # hammer pfs-status /usr/
118     /usr/   PFS #3 {
119         sync-beg-tid=0x0000000000000001
120         sync-end-tid=0x0000000117ac6270
121         shared-uuid=f33e318e-d2af-11df-b588-01138fad54f5
122         unique-uuid=f33e31cb-d2af-11df-b588-01138fad54f5
123         label=""
124         prune-min=00:00:00
125         operating as a MASTER
126         snapshots directory defaults to /var/hammer/<pfs>
127     }
128
129 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`
130
131     # hammer snapls /usr
132     Snapshots on /usr       PFS #3
133     Transaction ID          Timestamp               Note
134
135 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 activites, it will take a snapshot of the filesystem.
136
137     # sudo hammer cleanup
138     cleanup /                    - HAMMER UPGRADE: Creating snapshots
139             Creating snapshots in /var/hammer/root
140      handle PFS #0 using /var/hammer/root
141                snapshots - run
142                    prune - run
143                rebalance - run..
144                  reblock - run....
145                   recopy - run....
146     cleanup /var                 - HAMMER UPGRADE: Creating snapshots
147     [...]
148     cleanup /tmp                 - HAMMER UPGRADE: Creating snapshots
149     [...]
150     cleanup /usr                 - HAMMER UPGRADE: Creating snapshots
151     [...]
152     cleanup /home                - HAMMER UPGRADE: Creating snapshots
153     [...]
154     cleanup /usr/obj             - HAMMER UPGRADE: Creating snapshots
155     [...]
156     cleanup /var/crash           - HAMMER UPGRADE: Creating snapshots
157     [...]
158     cleanup /var/tmp             - HAMMER UPGRADE: Creating snapshots
159     [...]
160     cleanup /var/isos            - HAMMER UPGRADE: Creating snapshots
161     [...]
162
163 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 the history is pruned. To prevent that temporary files on the mentioned PFSes (e.g., object files, crash dumps) consume disk space, the PFSes are marked as `nohistory`.
164
165 In `/var` will be a new directory called *hammer* with the following sub directories
166
167
168     # cd hammer/
169     # ls -l
170     total 0
171     drwxr-xr-x  1 root  wheel  0 Oct 13 11:51 home
172     drwxr-xr-x  1 root  wheel  0 Oct 13 11:42 root
173     drwxr-xr-x  1 root  wheel  0 Oct 13 11:43 tmp
174     drwxr-xr-x  1 root  wheel  0 Oct 13 11:51 usr
175     drwxr-xr-x  1 root  wheel  0 Oct 13 11:54 var
176
177
178 Well let us look inside `/var/hammer/usr`
179
180
181     # cd usr/
182     # ls -l
183     total 0
184     drwxr-xr-x  1 root  wheel   0 Oct 13 11:54 obj
185     lrwxr-xr-x  1 root  wheel  25 Oct 13 11:43 snap-20101013-1143 -> /usr/@@0x0000000117ac6cb0
186
187
188 We have a symlink pointing to the snapshot transaction ID shown below.
189
190
191     # hammer snapls /usr
192     Snapshots on /usr       PFS #3
193     Transaction ID          Timestamp               Note
194     0x0000000117ac6cb0      2010-10-13 11:43:04 IST -
195     #
196
197
198 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 ...]"
199
200 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/)
201
202 In order to correctly map hard disk sernos to device names you can use the 'devattr' command.
203
204     # udevd
205     # devattr -d "ad*" -p serno
206     Device ad4:
207             serno = Z2AD9WN4
208     Device ad4s1:
209     Device ad4s1d:
210
211     Device ad5:
212             serno = 9VMRFDSY
213     Device ad5s1:
214     Device ad5s1d:
215
216     Device ad3:
217             serno = Z2AD9WLW
218     Device ad3s1:
219     Device ad3s1a:
220     Device ad3s1b:
221     Device ad3s1d:
222
223 Or if your disks are 'da', just change it as appropiate.
224
225 ## Configuring and Starting the SSH Server
226
227 Described in detail [[here|/docs/newhandbook/sshserver/]]
228
229 ## Software/Programs and Configuration Files Location 
230
231 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 *packages*.
232
233 The base programs are located in the folders 
234
235     /bin    /sbin
236     /usr/bin   /usr/sbin
237
238 The configuration files for the base system can be found in `/etc`. There is also `/usr/local/etc` which is used by third-party programs. The software/programs from pkgsrc are located in `/usr/pkg/bin` and `/usr/pkg/sbin`. Their configuration files are found in `/usr/pkg/etc`.
239
240 ## Installing Third-party Software
241
242 Have a look at the [[dports howto|/docs/howtos/HowToDPorts/]] for an in-depth description about dealing with packaging systems. Note that DragonFly BSD has several older package managers (like `pkgin`), but that the most modern binary package installation system as of 2014, is `pkg`.
243
244 ### Using pkg
245
246 Read [[dports howto|/docs/howtos/HowToDPorts/]] then for some errata, read [[this|http://lists.dragonflybsd.org/pipermail/users/2013-November/090339.html]].
247
248
249 You can look at the help and the man page for the pkg tool like this:
250
251 `pkg help install`
252
253 Example: Read man page for pkg-install
254
255 `man pkg-install`
256
257
258 ### Installing an X desktop environment
259
260 If it's already on your system run X by typing `startx`. If it's not, install
261 it using `pkg install`.
262
263 `(obsolete)`
264 Slightly out of date instructions on installing a GUI (X desktop) environment  are in the [new handbook](http://www.dragonflybsd.org/docs/newhandbook/X/).
265