fddac040bb3235fdbc59d365ef57a8a0ee8bd488
[ikiwiki.git] / nmatavka / index.mdwn
1 # Chapter 1 Introduction 
2
3 ***Restructured, reorganized, and parts rewritten by Jim Mock. ***
4
5 ## Synopsis 
6
7 Thank you for your interest in DragonFly! The following chapter covers various aspects of the DragonFly Project, such as its history, goals, development model, and so on.
8
9 After reading this chapter, you will know:
10
11 * How DragonFly relates to other computer operating systems.
12
13 * The history of the DragonFly Project.
14
15 * The goals of the DragonFly Project.
16
17 * The basics of the DragonFly open-source development model.
18
19 * And of course: where the name ***DragonFly*** comes from.
20
21 ----
22
23 ## Welcome to DragonFly! 
24
25  DragonFly is a [[4.4BSD-Lite|http://en.wikipedia.org/wiki/Berkeley_Software_Distribution]] unix operating system for Intel (x86) and amd64 (x86_64) architectures.
26
27 ### What Can DragonFly Do? 
28
29 <!-- Cutout of "features". This is outdated bullshit -->
30
31 Work on BSD-flavor Unix systems running on PC compatible hardware started as a fork of the 4.4BSD-Lite release from Computer Systems Research Group (CSRG) at the University of California at Berkeley.  One of the variants that became quite popular became known later as FreeBSD.  Firefly BSD started out as a fork, and continuation of FreeBSD 4.8. 
32
33 Like all other modern PC compatible BSD variants, it carries on the distinguished tradition of BSD systems development. In addition to the fine work provided by CSRG, the DragonFly Project has put in many thousands of hours in fine tuning the system for maximum performance and reliability in real-life load situations. 
34
35 As many of the commercial giants struggle to field PC operating systems with such features, performance and reliability, DragonFly can offer them ***now***!
36 For example the `Hammer` filesystem, which is the default filesystem in DragonFly BSD, is the most powerful and reliable filesystem available on any operating system.
37
38  The applications to which DragonFly can be put are truly limited only by your own imagination. From software development to factory automation, inventory control to azimuth correction of remote satellite antennae; if it can be done with a commercial UNIX product then it is more than likely that you can do it with DragonFly too! DragonFly also benefits significantly from literally thousands of high quality applications developed by research centers and universities around the world, often available at little to no cost. Commercial applications are also available and appearing in greater numbers every day.
39
40  Because the source code for DragonFly itself is generally available, the system can also be customized to an almost unheard of degree for special applications or projects, and in ways not generally possible with operating systems from most major commercial vendors. Here is just a sampling of some of the applications in which people are currently using DragonFly:
41
42 The robust TCP/IP networking built into DragonFly makes it an ideal platform for a variety of Internet services such as:
43
44 * FTP servers
45 * World Wide Web servers (standard or secure [SSL])
46 * Firewalls and NAT (***IP masquerading***) gateways
47 * Electronic Mail servers
48 * USENET News or Bulletin Board Systems
49 * And more...
50
51 With DragonFly, you can install on almost any PC, from older 32 bit computers running 386 or Pentium chips, to modern 64 bit Intel Core or AMD X64 desktop CPUs, and even up to and including high end Xeon CPUs.  All of these CPUs share a common ancestry, and instruction set, going back to the original Intel 80386 CPU which was the first fully 32-bit desktop CPU for "IBM PC compatible" computers.
52
53 Here are some of the fields where people are using Dragonfly BSD, and the reasons that they find DragonFly BSD fits their needs:
54
55 * ***Education:*** Are you a student of computer science or a related engineering field? There is no better way of learning about operating systems, computer architecture and networking than the hands on, under the hood experience that DragonFly can provide. A number of freely available CAD, mathematical and graphic design packages also make it highly useful to those whose primary interest in a computer is to get ***other*** work done!
56
57 * ***Research:*** With source code for the entire system available, DragonFly is an excellent platform for research in operating systems as well as other branches of computer science. DragonFly's freely available nature also makes it possible for remote groups to collaborate on ideas or shared development without having to worry about special licensing agreements or limitations on what may be discussed in open forums.
58
59 * ***Networking:*** Need a new router? A name server (DNS)? A firewall to keep people out of your internal network? DragonFly can easily turn that unused older PC sitting in the corner into an advanced router with sophisticated packet-filtering capabilities.
60
61 * ***X Window workstation:*** DragonFly is a fine choice for an inexpensive X terminal solution, using the freely available X.org server. Unlike an X terminal, DragonFly allows many applications to be run locally if desired, thus relieving the burden on a central server. DragonFly can even boot ***diskless***, making individual workstations even cheaper and easier to administer.
62
63 * ***Software Development:*** The basic DragonFly system comes with a full complement of development tools including the renowned GNU C/C++ compiler and debugger.
64
65  DragonFly is available via anonymous FTP or GIT. Please see [Appendix A](mirrors.html) for more information about obtaining DragonFly.
66
67 For more help on installing, see the appropriate sections of this handbook.
68
69 ----
70
71 ## About the DragonFly Project 
72
73  The following section provides some background information on the project, including a brief history, project goals, and the development model of the project.
74
75 ### A Brief History of DragonFly 
76
77 Matthew Dillon, one of the developers for FreeBSD, was growing increasingly frustrated with the FreeBSD Project's direction for release 5. The FreeBSD 5 release had been delayed multiple times, and had performance problems compared to earlier releases of FreeBSD.  DragonFly was announced in June of 2003. The code base was taken from the 4.8 release of FreeBSD, which offered better performance and more complete features. Development has proceeded at a very quick rate since then, with Matt Dillon and a group of developers fixing longstanding BSD bugs and modernizing the new DragonFly system.
78
79 ### DragonFly Project Goals 
80
81 DragonFly is an effort to maintain the traditional BSD format -- lean, stable code -- along with modern features such as lightweight threads, a workable packaging system, and a revised VFS. Underpinning all this work is efficient support for multiple processors, something rare among open source systems. Because DragonFly is built on an existing very stable code base, it is possible to make these radical changes as part of an incremental process.
82
83 ### The DragonFly Development Model 
84
85 ***Written by Justin Sherrill. ***
86
87 DragonFly is developed by many people around the world. There is no qualification process; anyone may submit his or her code, documentation, or designs, for use in the Project. Here is a general description of the Project's organizational structure.
88
89 Source for DragonFly is kept in [git](http://www.git.org/) which is available with each DragonFly install. The primary [git repository](http://gitweb.dragonflybsd.org/?p=dragonfly.git;a=summary) resides on a machine in California, USA. Documentation on obtaining the DragonFly source is available elsewhere in this book. The best way of getting changes made to the DragonFly source is to mail the [submit](http://www.dragonflybsd.org/mailinglists/) mailing list. Including desired source code changes (unified diff format is best) is the most useful format. A certain number of developers have access to commit changes to the DragonFly source, and can do so after review on that list. The DragonFly development model is loose; changes to the code are generally peer-reviewed and added when any objections have been corrected. There is no formal entry/rejection process, though final say on all code submissions goes to Matt Dillon, as originator of this project.
90
91 ### The Current DragonFly Release 
92
93 DragonFly is a freely available, full source 4.4BSD-Lite based release for almost all Intel and AMD based computer systems. It is based primarily on FreeBSD 4.8, and includes enhancements from U.C. Berkeley's CSRG group, NetBSD, OpenBSD, 386BSD, and the Free Software Foundation. A number of additional documents which you may find very helpful in the process of installing and using DragonFly may now also be found in the `/usr/share/doc` directory on any machine.
94
95 ### DragonFly Origin 
96
97 Matthew Dillon happened to take a picture of a dragonfly in his garden while trying to come up with a name for this new branch of BSD. Taking this as inspiration, "DragonFly" became the new name.
98
99 ## Updating the System 
100
101 ### Supported methods
102
103 The only **supported** method of upgrading DragonFly BSD is by building from source code. <br><br>
104 Supported upgrade process includes going from the *previous release* to *latest release*.<br>
105
106 For example, in our actual case, only the upgrade process involving <u>2.10.x up to 3.0.x</u> would be supported.
107
108 ### Getting the source code
109
110 There is a Makefile in /usr which will ease the task of retrieving the source tree; it needs to be run as root:
111
112     % cd /usr
113     % make src-create
114      [...]
115
116 And that will effectively checkout the source tree on `/usr/src` and switch to master branch. For stable branch you need to check it out with the following command (remember to replace the *DragonFly_RELEASE_3_0* with the appropriate branch name for the release needed).
117
118     % cd /usr/src
119     % git checkout DragonFly_RELEASE_3_0
120
121 To see the available remote branches:
122
123     # cd /usr/src 
124     # git pull
125     # git branch -r
126
127 The leading edge (development trunk) version of the system will be the "master".
128
129 ### Build and upgrade process
130
131 Build process requires some time to build all the userland programs and the DragonFly BSD kernel. Once built, next step is to install everything and make the upgrade target. No configuration files in */etc* are changed by this process. More details can be found in **[build(7)](http://leaf.dragonflybsd.org/cgi/web-man?command=build&section=ANY)** manpage. 
132
133     % cd /usr/src
134     % make buildworld
135     % make buildkernel
136     % make installkernel
137     % make installworld
138     % make upgrade
139     (reboot)
140
141 **Note:** You may use a concurrent build if you have a SMP (a machine with several cores or CPUs). You may specify *-j x* parameter to make where x is the number of CPUs + 1. <br>
142 If you run DragonFly 2.12 or higher the kernel will auto-detect the number of CPUs your computer has and activate them all if possible. To find out how many CPUs your computer has:
143 <br>
144
145     % sysctl hw.ncpu
146     hw.ncpu: 2
147
148 An explanation of each step follows.
149
150 * <u>*make buildworld*</u> : This command builds all userland programs and it is the most time-consuming step.<br>
151 Some programs may be discarded from the build process.<br>
152 For more details check **[make.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=make.conf&section=ANY)** manpage. 
153
154 * <u>*make buildkernel*</u> : This builds the kernel using the config file by default for your architecture. You may also specify a different kernel configuration file using KERNCONF=configfile. More details on **[make.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=make.conf&section=ANY)** manpage.
155
156 * <u>*make installkernel*</u> This installs the kernel using the config file for your architecture or KERNCONF=file can be used to specify which one to install.
157
158 * <u>*make installworld*</u> : This copies all the files built in the buildworld step (i.e. everything that is not the kernel) to the proper places in the filesystem.
159
160 * <u>*make upgrade*</u> : This cleans out any files made unnecessary by this upgrade.
161
162 * (reboot) : Reboot the computer to load the new kernel and use the new files installed as part of this process.
163
164 If your computer fails to boot the new kernel, you can always select 'Boot DragonFly using kernel.old' in the loader menu, so that the old kernel is loaded instead of the new one.
165
166 Additional upgrading instructions can be found in */usr/src/UPDATING* in the source tree. Online it can be found **[here](http://gitweb.dragonflybsd.org/dragonfly.git/blob_plain/master:/UPDATING)**
167
168 # DragonFly BSD Quick Start
169
170 This QuickStart is part of the [[NewHandbook|/docs/newhandbook/]].
171
172 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.
173
174 [[!toc levels=3 ]]
175 ## Some Unix and BSD Fundamentals
176
177 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.
178
179 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.
180
181 You should understand everything in the [[Unix Basics|/docs/newhandbook/UnixBasics/]] section before you proceed with trying to use your new system.
182
183 ## Disk layout of a New Dragonfly BSD System using the HAMMER filesystem
184
185 If you chose to install on the HAMMER file system during installation you will be left with a system with the following disk configuration:
186
187     # df -h
188     Filesystem                Size   Used  Avail Capacity  Mounted on
189     ROOT                      288G    12G   276G     4%    /
190     devfs                     1.0K   1.0K     0B   100%    /dev
191     /dev/serno/9VMBWDM1.s1a   756M   138M   558M    20%    /boot
192     /pfs/@@-1:00001           288G    12G   276G     4%    /var
193     /pfs/@@-1:00002           288G    12G   276G     4%    /tmp
194     /pfs/@@-1:00003           288G    12G   276G     4%    /usr
195     /pfs/@@-1:00004           288G    12G   276G     4%    /home
196     /pfs/@@-1:00005           288G    12G   276G     4%    /usr/obj
197     /pfs/@@-1:00006           288G    12G   276G     4%    /var/crash
198     /pfs/@@-1:00007           288G    12G   276G     4%    /var/tmp
199     procfs                    4.0K   4.0K     0B   100%    /proc
200
201 In this example
202
203 * `/dev/serno/9VMBWDM1` is the hard disk specified with serial number,
204 * `/dev/serno/9VMBWDM1.s1` is the first slice on the hard disk.
205
206 The disklabel looks at follows
207
208     # disklabel /dev/serno/9VMBWDM1.s1
209
210     # /dev/serno/9VMBWDM1.s1:
211     #
212     # Informational fields calculated from the above
213     # All byte equivalent offsets must be aligned
214     #
215     # boot space:    1044992 bytes
216     # data space:  312567643 blocks # 305241.84 MB (320069266944 bytes)
217     #
218     # NOTE: If the partition data base looks odd it may be
219     #       physically aligned instead of slice-aligned
220     #
221     diskid: e67030af-d2af-11df-b588-01138fad54f5
222     label:
223     boot2 data base:      0x000000001000
224     partitions data base: 0x000000100200
225     partitions data stop: 0x004a85ad7000
226     backup label:         0x004a85ad7000
227     total size:           0x004a85ad8200    # 305242.84 MB
228     alignment: 4096
229     display block size: 1024        # for partition display only
230
231     16 partitions:
232     #          size     offset    fstype   fsuuid
233       a:     786432          0    4.2BSD    #     768.000MB
234       b:    8388608     786432      swap    #    8192.000MB
235       d:  303392600    9175040    HAMMER    #  296281.836MB
236       a-stor_uuid: eb1c8aac-d2af-11df-b588-01138fad54f5
237       b-stor_uuid: eb1c8aec-d2af-11df-b588-01138fad54f5
238       d-stor_uuid: eb1c8b21-d2af-11df-b588-01138fad54f5
239
240 The slice has 3 partitions:
241
242 * `a` - for `/boot`
243 * `b` - for swap
244 * `d` - for `/`, a HAMMER file system labeled ROOT
245
246 When you create a HAMMER file system you must give it a label, here the installer labeled it as "ROOT" and mounted it as
247
248     ROOT                      288G    12G   276G     4%    /
249
250 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 `/`.
251
252 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`:
253
254     # cat /etc/fstab
255
256     # Device                Mountpoint      FStype  Options         Dump    Pass#
257     /dev/serno/9VMBWDM1.s1a         /boot           ufs     rw      1       1
258     /dev/serno/9VMBWDM1.s1b         none            swap    sw      0       0
259     /dev/serno/9VMBWDM1.s1d         /               hammer  rw      1       1
260     /pfs/var                /var            null    rw              0       0
261     /pfs/tmp                /tmp            null    rw              0       0
262     /pfs/usr                /usr            null    rw              0       0
263     /pfs/home               /home           null    rw              0       0
264     /pfs/usr.obj    /usr/obj                null    rw              0       0
265     /pfs/var.crash  /var/crash              null    rw              0       0
266     /pfs/var.tmp    /var/tmp                null    rw              0       0
267     proc                    /proc           procfs  rw              0       0
268
269 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).
270
271 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.
272
273 Now if you look in `/var`
274
275     # cd /var/
276     # ls
277     account   backups   caps   cron    empty   log   msgs   run   spool   yp  at        
278     cache     crash     db     games   lib     mail  preserve   rwho  tmp
279
280 you will find the above directories.
281
282 If you look at the status of one of the PFSes, e.g. `/usr` you will see `/var/hammer` is the default snapshot directory.
283
284     # hammer pfs-status /usr/
285     /usr/   PFS #3 {
286         sync-beg-tid=0x0000000000000001
287         sync-end-tid=0x0000000117ac6270
288         shared-uuid=f33e318e-d2af-11df-b588-01138fad54f5
289         unique-uuid=f33e31cb-d2af-11df-b588-01138fad54f5
290         label=""
291         prune-min=00:00:00
292         operating as a MASTER
293         snapshots directory defaults to /var/hammer/<pfs>
294     }
295
296 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`
297
298     # hammer snapls /usr
299     Snapshots on /usr       PFS #3
300     Transaction ID          Timestamp               Note
301
302 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.
303
304     # sudo hammer cleanup
305     cleanup /                    - HAMMER UPGRADE: Creating snapshots
306             Creating snapshots in /var/hammer/root
307      handle PFS #0 using /var/hammer/root
308                snapshots - run
309                    prune - run
310                rebalance - run..
311                  reblock - run....
312                   recopy - run....
313     cleanup /var                 - HAMMER UPGRADE: Creating snapshots
314     [...]
315     cleanup /tmp                 - HAMMER UPGRADE: Creating snapshots
316     [...]
317     cleanup /usr                 - HAMMER UPGRADE: Creating snapshots
318     [...]
319     cleanup /home                - HAMMER UPGRADE: Creating snapshots
320     [...]
321     cleanup /usr/obj             - HAMMER UPGRADE: Creating snapshots
322     [...]
323     cleanup /var/crash           - HAMMER UPGRADE: Creating snapshots
324     [...]
325     cleanup /var/tmp             - HAMMER UPGRADE: Creating snapshots
326     [...]
327     cleanup /var/isos            - HAMMER UPGRADE: Creating snapshots
328     [...]
329
330 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`.
331
332 In `/var` will be a new directory called *hammer* with the following sub directories
333
334     # cd hammer/
335     # ls -l
336     total 0
337     drwxr-xr-x  1 root  wheel  0 Oct 13 11:51 home
338     drwxr-xr-x  1 root  wheel  0 Oct 13 11:42 root
339     drwxr-xr-x  1 root  wheel  0 Oct 13 11:43 tmp
340     drwxr-xr-x  1 root  wheel  0 Oct 13 11:51 usr
341     drwxr-xr-x  1 root  wheel  0 Oct 13 11:54 var
342
343 Well let us look inside `/var/hammer/usr`
344
345     # cd usr/
346     # ls -l
347     total 0
348     drwxr-xr-x  1 root  wheel   0 Oct 13 11:54 obj
349     lrwxr-xr-x  1 root  wheel  25 Oct 13 11:43 snap-20101013-1143 -> /usr/@@0x0000000117ac6cb0
350
351 We have a symlink pointing to the snapshot transaction ID shown below.
352
353     # hammer snapls /usr
354     Snapshots on /usr       PFS #3
355     Transaction ID          Timestamp               Note
356     0x0000000117ac6cb0      2010-10-13 11:43:04 IST -
357     #
358
359 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 ...]"
360
361 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/)
362
363 In order to correctly map hard disk sernos to device names you can use the 'devattr' command.
364
365     # udevd
366     # devattr -d "ad*" -p serno
367     Device ad4:
368             serno = Z2AD9WN4
369     Device ad4s1:
370     Device ad4s1d:
371
372     Device ad5:
373             serno = 9VMRFDSY
374     Device ad5s1:
375     Device ad5s1d:
376
377     Device ad3:
378             serno = Z2AD9WLW
379     Device ad3s1:
380     Device ad3s1a:
381     Device ad3s1b:
382     Device ad3s1d:
383
384 Or if your disks are 'da', just change it as appropiate.
385
386 ## Configuring and Starting the SSH Server
387
388 Described in detail [[here|/docs/newhandbook/sshserver/]]
389
390 ## Software/Programs and Configuration Files Location 
391
392 DragonFly default installation contains the base software/programs from the DragonFly project itself and few other software from other sources. 
393
394 The base system binary software programs are located in the folders 
395
396     /bin    /sbin
397     /usr/bin   /usr/sbin
398
399 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.
400
401 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.
402
403 ## Installing Third-party Software
404
405 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`.
406
407 ### Using pkg
408
409 Read [[dports howto|/docs/howtos/HowToDPorts/]] then for some errata, read [[this|http://lists.dragonflybsd.org/pipermail/users/2013-November/090339.html]].
410
411 You can look at the help and the man page for the pkg tool like this:
412
413 `pkg help install`
414
415 Example: Read man page for pkg-install
416
417 `man pkg-install`
418
419 ### Installing an X.org desktop X11 environment and XFCE desktop
420
421 If it's already on your system run X by typing `startx`. If it's not, be sure to check your dports configuration is finished, then install it using `pkg install xorg-7.7 xfce4-desktop`. This will install the core X.org X11 server, and an XFCE based desktop environment.
422
423 `(obsolete)`
424 Slightly out of date instructions on installing a GUI (X desktop) environment  are in the [new handbook](http://www.dragonflybsd.org/docs/newhandbook/X/).
425
426 # UNIX Basics 
427
428 ***Rewritten by Chris Shumway. ***
429 [[!toc  levels=3]]
430
431 ## Synopsis 
432
433 The following chapter will cover the basic commands and functionality of the DragonFly operating system. Much of this material is relevant for any UNIX®-like operating system. Feel free to skim over this chapter if you are familiar with the material. If you are new to DragonFly, then you will definitely want to read through this chapter carefully.
434
435 After reading this chapter, you will know:
436
437 * How to use the ***virtual consoles*** of DragonFly.
438
439 * How UNIX file permissions work along with understanding file flags in DragonFly.
440
441 * The default DragonFly file system layout.
442
443 * The DragonFly disk organization.
444
445 * How to mount and unmount file systems.
446
447 * What processes, daemons, and signals are.
448
449 * What a shell is, and how to change your default login environment.
450
451 * How to use basic text editors.
452
453 * What devices and device nodes are.
454
455 * What binary format is used under DragonFly.
456
457 * How to read manual pages for more information.
458
459 ## Virtual Consoles and Terminals 
460
461 DragonFly can be used in various ways. One of them is typing commands to a text terminal. A lot of the flexibility and power of a UNIX® operating system is readily available at your hands when using DragonFly this way. This section describes what ***terminals*** and ***consoles*** are, and how you can use them in !DragonFly.
462
463 <!-- XXX: also mention vesa.ko and other modes for the vt, but maybe somewhere else -->
464
465 ### The Console 
466
467 If you have not configured DragonFly to automatically start a graphical environment during startup, the system will present you with a login prompt after it boots, right after the startup scripts finish running. You will see something similar to:
468
469     Additional ABI support:.
470     Starting cron.
471     Local package initialization:.
472     Additional TCP options:.
473     
474     Wed Feb 18 17:53:48 GMT 2009
475     
476     DragonFly/i386 (Amnesiac) (ttyv0)
477
478     login: 
479
480 The messages might be a bit different on your system, but you will see something similar. The last two lines are what we are interested in right now. The second last line reads:
481
482     DragonFly/i386 (Amnesiac) (ttyv0)
483
484 This line contains some bits of information about the system you have just booted. You are looking at a ***DragonFlyBSD*** console, running on an Intel or compatible processor of the x86 architecture[(1)](#FTN.AEN1036). The name of this machine (every UNIX machine has a name) is `Amnesiac`, and you are now looking at its system console--the `ttyv0` terminal. Finally, the last line is always:
485
486     login:
487
488 This is the part where you are supposed to type in your <i>username</i> to log into DragonFly. The next section describes how you can do this.
489
490 ### Logging into DragonFly 
491
492 DragonFly is a multiuser, multiprocessing system. This is the formal description that is usually given to a system that can be used by many different people, who simultaneously run a lot of programs on a single machine. Every multiuser system needs some way to distinguish one <i>user</i>from the rest. In !DragonFly (and all the UNIX-like operating systems), this is accomplished by requiring that every user must ***log into*** the system before being able to run programs. Every user has a unique name (the <i>username</i> and a personal, secret key (the <i>password</i>). DragonFly will ask for these two before allowing a user to run any programs.
493
494 Right after DragonFly boots and finishes running its startup scripts[(2)](#FTN.AEN1060), it will present you with a prompt and ask for a valid username: 
495
496     login:
497
498 For the sake of this example, let us assume that your username is `john`. Type `john` at this prompt and press  **Enter** . You should then be presented with a prompt to enter a <i>password</i>:
499     
500
501     login: john
502     Password:
503
504 Type in `john`'s password now, and press  **Enter** . The password is <i>not echoed!</i> You need not worry about this right now. Suffice it to say that it is done for security reasons. If you have typed your password correctly, you should by now be logged into DragonFly and ready to try out all the available commands. You should see the MOTD or message of the day followed by a command prompt (a `#`, `$`, or `%` character). This indicates you have successfully logged into DragonFly.
505
506 ### Multiple Consoles 
507
508 Running UNIX commands in one console is fine, but DragonFly can run many programs at once. Having one console where commands can be typed would be a bit of a waste when an operating system like DragonFly can run dozens of programs at the same time. This is where <i>virtual consoles</i> can be very helpful. DragonFly can be configured to present you with many different virtual consoles. You can switch from one of them to any other virtual console by pressing a couple of keys on your keyboard. Each console has its own different output channel, and DragonFly takes care of properly redirecting keyboard input and monitor output as you switch from one virtual console to the next.
509
510 Special key combinations have been reserved by DragonFly for switching consoles[(3)](#FTN.AEN1087). You can use  **Alt** - **F1** ,  **Alt** - **F2** , through  **Alt** - **F8**  to switch to a different virtual console in DragonFly. As you are switching from one console to the next, DragonFly takes care of saving and restoring the screen output. The result is an <i>illusion</i> of having multiple <i>virtual</i> screens and keyboards that you can use to type commands for DragonFly to run. The programs that you launch on one virtual console do not stop running when that console is not visible. They continue running when you have switched to a different virtual console.
511
512 ### The /etc/ttys File 
513
514 The default configuration of DragonFly will start up with eight virtual consoles. This is not a hardwired setting though, and you can easily customize your installation to boot with more or fewer virtual consoles. The number and settings of the virtual consoles are configured in the `/etc/ttys` file.
515
516 You can use the `/etc/ttys` file to configure the virtual consoles of DragonFly. Each uncommented line in this file (lines that do not start with a `#` character) contains settings for a single terminal or virtual console. The default version of this file that ships with DragonFly configures nine virtual consoles, and enables eight of them. They are the lines that start with `ttyv`:
517     
518
519     # name  getty                           type    status          comments
520     #
521     ttyv0   "/usr/libexec/getty Pc"         cons25  on  secure
522     # Virtual terminals
523     ttyv1   "/usr/libexec/getty Pc"         cons25  on  secure
524     ttyv2   "/usr/libexec/getty Pc"         cons25  on  secure
525     ttyv3   "/usr/libexec/getty Pc"         cons25  on  secure
526     ttyv4   "/usr/libexec/getty Pc"         cons25  on  secure
527     ttyv5   "/usr/libexec/getty Pc"         cons25  on  secure
528     ttyv6   "/usr/libexec/getty Pc"         cons25  on  secure
529     ttyv7   "/usr/libexec/getty Pc"         cons25  on  secure
530     ttyv8   "/usr/pkg/xorg/bin/xdm -nodaemon"  xterm   off secure
531
532 For a detailed description of every column in this file and all the options you can use to set things up for the virtual consoles, consult the [ttys(5)](http://leaf.dragonflybsd.org/cgi/web-man?command#ttys&section5) manual page.
533
534 ### Single User Mode Console 
535
536 A detailed description of what <i>single user mode</i> is can be found in [boot-init.html#BOOT-SINGLEUSER Section 7.5.2]. It is worth noting that there is only one console when you are running DragonFly in single user mode. There are no virtual consoles available. The settings of the single user mode console can also be found in the `/etc/ttys` file. Look for the line that starts with `console`:
537
538     
539
540     # name  getty                           type    status          comments
541     #
542     # If console is marked "insecure", then init will ask for the root password
543     # when going to single-user mode.
544     console none                            unknown off secure
545
546  **Note:** As the comments above the `console` line indicate, you can edit this line and change `secure` to `insecure`. If you do that, when DragonFly boots into single user mode, it will still ask for the `root` password. ***Be careful when changing this to insecure***. If you ever forget the `root` password, booting into single user mode is a bit involved. It is still possible, but it might be a bit hard for someone who is not very comfortable with the DragonFly booting process and the programs involved.
547
548 #### Notes 
549
550 [[!table  data="""
551 <tablestyle="width:100%">[ (1)](consoles.html#AEN1036) | This is what `i386` means. Note that even if you are not running DragonFly on an Intel 386 CPU, this is going to be `i386`. It is not the type of your processor, but the processor ***architecture*** that is shown here. 
552  [ (2)](consoles.html#AEN1060) | Startup scripts are programs that are run automatically by DragonFly when booting. Their main function is to set things up for everything else to run, and start any services that you have configured to run in the background doing useful things. 
553  [ (3)](consoles.html#AEN1087) | A fairly technical and accurate description of all the details of the DragonFly console and keyboard drivers can be found in the manual pages of [syscons(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=syscons&section4), [atkbd(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=atkbd&section=4), [vidcontrol(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=vidcontrol&section=1) and [kbdcontrol(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=kbdcontrol&section=1). We will not expand on the details here, but the interested reader can always consult the manual pages for a more detailed and thorough explanation of how things work. |
554
555 """]]
556
557 ## Permissions 
558
559 DragonFly, being a direct descendant of BSD UNIX®, is based on several key UNIX concepts. The first and most pronounced is that DragonFly is a multi-user operating system. The system can handle several users all working simultaneously on completely unrelated tasks. The system is responsible for properly sharing and managing requests for hardware devices, peripherals, memory, and CPU time fairly to each user.
560
561 Because the system is capable of supporting multiple users, everything the system manages has a set of permissions governing who can read, write, and execute the resource. These permissions are stored as three octets broken into three pieces, one for the owner of the file, one for the group that the file belongs to, and one for everyone else. This numerical representation works like this:
562
563 [[!table  data="""
564 |<tablestyle="width:100%"> Value | Permission | Directory Listing 
565 <tablestyle="width:100%"> 0 | No read, no write, no execute | `---` 
566  1 | No read, no write, execute | `--x` 
567  2 | No read, write, no execute | `-w-` 
568  3 | No read, write, execute | `-wx` 
569  4 | Read, no write, no execute | `r--` 
570  5 | Read, no write, execute | `r-x` 
571  6 | Read, write, no execute | `rw-` 
572  7 | Read, write, execute | `rwx` |
573
574 """]]
575
576 You can use the `-l` command line argument to [ls(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=ls&section1) to view a long directory listing that includes a column with information about a file's permissions for the owner, group, and everyone else. For example, a `ls -l` in an arbitrary directory may show:
577
578     % ls -l
579     total 530
580     -rw-r--r--  1 root  wheel     512 Sep  5 12:31 myfile
581     -rw-r--r--  1 root  wheel     512 Sep  5 12:31 otherfile
582     -rw-r--r--  1 root  wheel    7680 Sep  5 12:31 email.txt
583     ...
584
585 Here is how the first column of `ls -l` is broken up:    
586
587     -rw-r--r--
588
589 <!-- XXX: Check all these http:// links to see if they are broken -->
590
591 The first (leftmost) character tells if this file is a regular file, a directory, a special character device, a socket, or any other special pseudo-file device. In this case, the `-` indicates a regular file. The next three characters, `rw-` in this example, give the permissions for the owner of the file. The next three characters, `r--`, give the permissions for the group that the file belongs to. The final three characters, `r--`, give the permissions for the rest of the world. A dash means that the permission is turned off. In the case of this file, the permissions are set so the owner can read and write to the file, the group can read the file, and the rest of the world can only read the file. According to the table above, the permissions for this file would be `644`, where each digit represents the three parts of the file's permission.
592
593 This is all well and good, but how does the system control permissions on devices? DragonFly actually treats most hardware devices as a file that programs can open, read, and write data to just like any other file. These special device files are stored on the `/dev` directory.
594
595 Directories are also treated as files. They have read, write, and execute permissions. The executable bit for a directory has a slightly different meaning than that of files. When a directory is marked executable, it means it can be traversed into, that is, it is possible to ***cd*** (change directory) into it. This also means that within the directory it is possible to access files whose names are known (subject, of course, to the permissions on the files themselves).
596
597 In particular, in order to perform a directory listing, read permission must be set on the directory, whilst to delete a file that one knows the name of, it is necessary to have write ***and*** execute permissions to the directory containing the file. There are more permission bits, but they are primarily used in special circumstances such as setuid binaries and sticky directories. If you want more information on file permissions and how to set them, be sure to look at the [chmod(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=chmod&section1) manual page.
598
599 ### Symbolic Permissions 
600
601 ***Contributed by Tom Rhodes.***
602
603 Symbolic permissions, sometimes referred to as symbolic expressions, use characters in place of octal values to assign permissions to files or directories. Symbolic expressions use the syntax of (who) (action) (permissions), where the following values are available:
604
605 [[!table  data="""
606 <tablestyle="width:100%"> Option | Letter | Represents 
607 <tablestyle="width:100%"> (who) | u | User 
608  (who) | g | Group owner 
609  (who) | o | Other 
610  (who) | a | All (***world***) 
611  (action) | + | Adding permissions 
612  (action) | - | Removing permissions 
613  (action) | = | Explicitly set permissions 
614  (permissions) | r | Read 
615  (permissions) | w | Write 
616  (permissions) | x | Execute 
617  (permissions) | t | Sticky bit 
618  (permissions) | s | Set UID or GID |
619
620 """]]
621
622 These values are used with the [chmod(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=chmod&amp;section1) command just like before, but with letters. For an example, you could use the following command to block other users from accessing `FILE`:
623
624     
625
626     % chmod go=FILE
627
628 A comma separated list can be provided when more than one set of changes to a file must be made. For example the following command will remove the groups and ***world*** write permission on `FILE`, then it adds the execute permissions for everyone:
629
630     
631
632     % chmod go-w,a+x FILE
633
634 ### DragonFly File Flags 
635
636 ***Contributed by Tom Rhodes.***
637
638 In addition to file permissions discussed previously, DragonFly supports the use of ***file flags.*** These flags add an additional level of security and control over files, but not directories. These file flags add an additional level of control over files, helping to ensure that in some cases not even the `root` can remove or alter files.  File flags are altered by using the [chflags(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=chflags&amp;section1) utility, using a simple interface. For example, to enable the system undeletable flag on the file `file1`, issue the following command:
639
640     
641
642     # chflags sunlink file1
643
644 And to disable the system undeletable flag, simply issue the previous command with ***no*** in front of the `sunlink`. Observe:
645
646     
647
648     # chflags nosunlink file1
649
650 To view the flags of this file, use the [ls(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=ls&amp;section1) with the `-lo` flags:
651
652     
653
654     # ls -lo file1
655
656 The output should look like the following:
657
658     
659
660     -rw-r--r--  1 trhodes  trhodes  sunlnk 0 Mar  1 05:54 file1
661
662 Several flags may only added or removed to files by the `root` user. In other cases, the file owner may set these flags. It is recommended an administrator read over the [chflags(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=chflags&section1) and [chflags(2)](http://leaf.dragonflybsd.org/cgi/web-man?command=chflags&section=2) manual pages for more information.
663
664 ## Directory Structure 
665
666 The DragonFly directory hierarchy is fundamental to obtaining an overall understanding of the system. The most important concept to grasp is that of the root directory, ***/***. This directory is the first one mounted at boot time and it contains the base system necessary to prepare the operating system for multi-user operation. The root directory also contains mount points for every other file system that you may want to mount.
667
668 A mount point is a directory where additional file systems can be grafted onto the root file system. This is further described in [ this Section](disk-organization.html). Standard mount points include `/usr`, `/var`, `/tmp`, `/mnt`, and `/cdrom`. These directories are usually referenced to entries in the file `/etc/fstab`. `/etc/fstab` is a table of various file systems and mount points for reference by the system. Most of the file systems in `/etc/fstab` are mounted automatically at boot time from the script [rc(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=rc&section8) unless they contain the `noauto` option. Details can be found in [ this section](mount-unmount.html#DISKS-FSTAB).
669
670 A complete description of the file system hierarchy is available in [hier(7)](http://leaf.dragonflybsd.org/cgi/web-man?command=hier&section7). For now, a brief overview of the most common directories will suffice.
671
672 [[!table  data="""
673 <tablestyle="width:100%">Directory | Description 
674 <tablestyle="width:100%">  `/` | Root directory of the file system. 
675  `/bin/` | User utilities fundamental to both single-user and multi-user environments. 
676  `/boot/` | Programs and configuration files used during operating system bootstrap. 
677  `/boot/defaults/` | Default bootstrapping configuration files; see [loader.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=loader.conf&section5). 
678  `/dev/` | Device nodes; see [intro(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=intro&section4). 
679  `/etc/` | System configuration files and scripts. 
680  `/etc/defaults/` | Default system configuration files; see [rc(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=rc&section8). 
681  `/etc/mail/` | Configuration files for mail transport agents such as [sendmail(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=sendmail&section8). 
682  `/etc/namedb/` | `named` configuration files; see [named(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=named&section8). 
683  `/etc/periodic/` | Scripts that are run daily, weekly, and monthly, via [cron(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=cron&section8); see [periodic(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=periodic&section=8). 
684  `/etc/ppp/` | `ppp` configuration files; see [ppp(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=ppp&section8). 
685  `/mnt/` | Empty directory commonly used by system administrators as a temporary mount point. 
686  `/proc/` | Process file system; see [procfs(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=procfs&section5), [mount_procfs(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=mount_procfs&section=8). 
687  `/root/` | Home directory for the `root` account. 
688  `/sbin/` | System programs and administration utilities fundamental to both single-user and multi-user environments. 
689  `/tmp/` | Temporary files. The contents of `/tmp` are usually NOT preserved across a system reboot. A memory-based file system is often mounted at `/tmp`. This can be automated with an entry in `/etc/fstab`; see [mfs(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=mfs&section8). 
690  `/usr/` | The majority of user utilities and applications. 
691  `/usr/bin/` | Common utilities, programming tools, and applications. 
692  `/usr/include/` | Standard C include files. 
693  `/usr/lib/` | Archive libraries. 
694  `/usr/libdata/` | Miscellaneous utility data files. 
695  `/usr/libexec/` | System daemons &amp; system utilities (executed by other programs). 
696  `/usr/local/` | Local executables, libraries, etc. Within `/usr/local`, the general layout sketched out by [hier(7)](http://leaf.dragonflybsd.org/cgi/web-man?command=hier&section7) for `/usr` should be used. An exceptions is the man directory, which is directly under `/usr/local` rather than under `/usr/local/share`. 
697  `/usr/obj/` | Architecture-specific target tree produced by building the `/usr/src` tree. 
698  `/usr/pkg` | Used as the default destination for the files installed via the pkgsrc® tree or pkgsrc packages (optional). The configuration directory is tunable, but the default location is `/usr/pkg/etc`. 
699  `/usr/pkg/xorg/` | Xorg distribution executables, libraries, etc (optional). 
700  `/usr/pkgsrc` | The pkgsrc tree for installing packages (optional). 
701  `/usr/sbin/` | System daemons &amp; system utilities (executed by users). 
702  `/usr/share/` | Architecture-independent files. 
703  `/usr/src/` | BSD and/or local source files. 
704  `/var/` | Multi-purpose log, temporary, transient, and spool files. A memory-based file system is sometimes mounted at `/var`. This can be automated with an entry in `/etc/fstab`; see [mfs(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=mfs&section8). 
705  `/var/log/` | Miscellaneous system log files. 
706  `/var/mail/` | User mailbox files. 
707  `/var/spool/` | Miscellaneous printer and mail system spooling directories. 
708  `/var/tmp/` | Temporary files. The files are usually preserved across a system reboot, unless `/var` is a memory-based file system. 
709  `/var/yp` | NIS maps. |
710
711 """]]
712
713 ## Disk Organization 
714
715 The smallest unit of organization that DragonFly uses to find files is the filename. Filenames are case-sensitive, which means that `readme.txt` and `README.TXT` are two separate files. DragonFly does not use the extension (`.txt`) of a file to determine whether the file is a program, or a document, or some other form of data.
716
717 Files are stored in directories.  A directory may contain no files, or it may contain many hundreds of files.  A directory can also contain other directories, allowing you to build up a hierarchy of directories within one another.  This makes it much easier to organize your data.
718
719 Files and directories are referenced by giving the file or directory name, followed by a forward slash, `/`, followed by any other directory names that are necessary.  If you have directory `foo`, which contains directory `bar`, which contains the file `readme.txt`, then the full name, or ***path*** to the file is `foo/bar/readme.txt`.
720
721 Directories and files are stored in a file system. Each file system contains exactly one directory at the very top level, called the ***root directory*** for that file system.  This root directory can then contain other directories.
722
723 So far this is probably similar to any other operating system you may have used.  There are a few differences; for example, MS-DOS® and Windows® use `\`.
724
725 DragonFly does not use drive letters, or other drive names in the path. You would not write `c:/foo/bar/readme.txt` on DragonFly.
726
727 Instead, one file system is designated the ***root file system***.  The root file system's root directory is referred to as `/`.  Every other file system is then ***mounted*** under the root file system. No matter how many disks you have on your DragonFly system, every directory appears to be part of the same disk.
728
729 Suppose you have three file systems, called `A`, `B`, and `C`. Each file system has one root directory, which contains two other directories, called `A1`, `A2` (and likewise `B1`, `B2` and `C1`, `C2`).
730
731 Call `A` the root file system. If you used the `ls` command to view the contents of this directory you would see two subdirectories, `A1` and `A2`.  The directory tree looks like this:
732
733 <!-- XXX: image -->
734
735 A file system must be mounted on to a directory in another file system. So now suppose that you mount file system `B` on to the directory `A1`.  The root directory of `B` replaces `A1`, and the directories in `B` appear accordingly:
736
737 <!-- XXX: image -->
738
739 Any files that are in the `B1` or `B2` directories can be reached with the path `/A1/B1` or `/A1/B2` as necessary. Any files that were in `/A1` have been temporarily hidden.  They will reappear if `B` is ***unmounted*** from A.
740
741 If `B` had been mounted on `A2` then the diagram would look like this:
742
743 <!-- XXX: image -->
744
745 and the paths would be `/A2/B1` and `/A2/B2` respectively.
746
747 File systems can be mounted on top of one another.  Continuing the last example, the `C` file system could be mounted on top of the `B1` directory in the `B` file system, leading to this arrangement:
748
749 <!-- XXX: image -->
750
751 Or `C` could be mounted directly on to the `A` file system, under the `A1` directory:
752
753 <!-- XXX: image -->
754
755 If you are familiar with MS-DOS, this is similar, although not identical, to the `join` command.
756
757 ## Choosing File System Layout 
758
759 This is not normally something you need to concern yourself with. Typically you create file systems when installing DragonFly and decide where to mount them, and then never change them unless you add a new disk.
760
761 It is entirely possible to have one large root file system, and not need to create any others. There are some drawbacks to this approach, and one advantage.
762
763  **Benefits of Multiple File Systems** 
764
765 * Different file systems can have different ***mount options***.  For example, with careful planning, the root file system can be mounted read-only, making it impossible for you to inadvertently delete or edit a critical file.  Separating user-writable file systems, such as `/home`, from other file systems also allows them to be mounted ***nosuid***; this option prevents the ***suid***/***guid*** bits on executables stored on the file system from taking effect, possibly improving security.
766
767 * The UFS file system automatically optimizes the layout of files, depending on how the file system is being used. So a file system that contains many small files that are written frequently will have a different optimization to one that contains fewer, larger files.  By having one big file system this optimization breaks down.
768
769 * DragonFly's file systems are very robust should you lose power.  However, a power loss at a critical point could still damage the structure of the file system.  By splitting your data over multiple file systems it is more likely that the system will still come up, making it easier for you to restore from backup as necessary. This a major reason to make the root file system of limited size, and with low write activity.
770
771  **Benefit of a Single File System** 
772
773 * File systems are a fixed size. If you create a file system when you install DragonFly and give it a specific size, you may later discover that you need to make the partition bigger.  The [growfs(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=growfs&amp;section8) command makes it possible to increase the size of a UFS file system on the fly.
774 <!-- XXX: what about hammer? -->
775
776 ## Disk Slices, Partitions and local UNIX file systems 
777
778 Here we describe how disks are subdivided.
779
780 <!-- XXX: mention serno stuff -->
781
782 ### Slices 
783
784 A disk can be subdivided in slices.
785
786 Slices are named `s0`, `s1` and so on.
787
788 For example the disk `ad6` can contain the slice `ad6s3`.
789
790 DragonFly support two schemes for slices, MBR and GPT, either of them will manage all slices on a disk:
791
792 * MBR: set up using [fdisk(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=fdisk&amp;section8), can be up to 2 TB in size.  MBR slices are numbered from 1; but if disk is ***dangerously dedicated*** it has slice number 0.
793
794 * GPT: set up using [gpt(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=gpt&amp;section8), can be extremely large: size up to 8 billion TB.  DragonFly doesn't support booting from a GPT slice in DragonFly  2.0.  Note that GPT slices are numbered from 0. ***Dangerously dedicated*** is not supported nor needed for GPT.  DragonFly 2.1 does have some support for booting from a GPT slice, this is described in [gpt(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=gpt&amp;section=8).
795
796 ### Partitions 
797
798 Partitions are contained in slices.
799
800 Partitions are named `a`, `b` and so on.
801
802 DragonFly support 16 partitions per slice, that is `a` through `p`.
803
804 For example the partition `ad6s3a` is contained in the slice `ad6s3`.
805
806 Partition layout is defined in a label on the slice where the partition reside. DragonFly support two types of disk labels, disklabel32 and disklabel64 (the default):
807
808 * [disklabel32(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=disklabel&amp;section8): 32 bit disk label which can use slices with size up to 2 TB.
809
810 * [disklabel64(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=disklabel64&amp;section8): 64 bit disk label which can use very large slices: size up to 16 million TB.
811
812 ### Local UNIX file systems 
813
814 File systems are contained in partitions.  Each partition can contain only one file system, which means that file systems often are described by either their typical mount point in the file system hierarchy, or the letter of the partition they are contained in.  ***Partition*** does not have the same meaning as the common usage of the term partition (for example, MS-DOS partition), because of DragonFly's UNIX® heritage.
815
816 DragonFly support two local UNIX file systems, UFS and HAMMER:
817
818 * UFS: The classical BSD UNIX file system, see [ffs(5)](http://leaf.dragonflybsd.org/cgi/web-man?command#ffs&amp;section5), it supports size up to 2 TB.
819
820 * [HAMMER(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=HAMMER&amp;section5): A new file system, as of DragonFly 2.0, with many advanced features.  HAMMER file system support size up to 1 million TB.
821
822 ### Typical disk layout 
823
824 From the above we see the following typical disk layout scenarios:
825
826 * For booting DragonFly from a local file system UFS is recommended.  A BOOT+HAMMER setup is recommended for HAMMER use, this consists of a small UFS file system for booting, typically 512MB, and a HAMMER root file system.  The BOOT file system is mounted as /boot after boot.
827
828 * For moderate storage requirements UFS can be used; it can be setup on any partition, e.g. on the same disk slice as the boot partition.  HAMMER is an alternative, with extra features supported, like history retention.  You should evaluate if HAMMER is suitable, see note below.
829
830 * If really big storage capacity is needed UFS can't fit the need.  You should evaluate if HAMMER is suitable, see note below.  For this use HAMMER needs to be used on a GPT slice with  a [disklabel64(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=disklabel64&amp;section8) label.  In DragonFly 2.0 it has to be set up on a disk separate from the boot disk.  In  DragonFly 2.1 one disk can be used for both booting and HAMMER file system on GPT slice, as some support for booting from GPT is present, as described in [gpt(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=gpt&amp;section=8).
831
832 ### HAMMER Note 
833
834 [HAMMER(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=HAMMER&amp;section5)
835
836 is a rather new file system, under active development.
837
838 As of DragonFly 2.2.1 release HAMMER is considered production ready.  At 2.0 release it was considered to be in an early Beta state .
839
840 All major features except the mirroring are quite well tested as-of the 2.2.1 release.
841
842 You should evaluate if HAMMER is suitable for your needs.
843 <!-- XXX: mention disk and memory requirements for efficient hammer use -->
844
845 Examples of ongoing development includes:
846
847 * Making HAMMER more self managing; e.g. ability to setup policy for which history to save for how long: e.g. make snapshot every hour and prune and reblock the file system regularly.  When snapshot gets older than 1 month only keep them for every 6 hours; when older than 3 months only keep snapshot for every 24 hours, when older than 3 years only keep snapshot per month.  For now you need to set up [cron(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=cron&amp;section8) jobs for this yourself, see [hammer(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=hammer&amp;section=8).
848
849 * Multi master mirroring. For now only one mirror master is supported, but multiple mirror targets, called slaves, are already supported.
850
851 * Support for shrinking existing HAMMER file systems.  The HAMMER design is prepared for this, utility just have to be written to support it.
852 <!-- XXX: is this still accurate? Do we really want to mention it here? -->
853
854 ### HAMMER Features 
855
856 [HAMMER(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=HAMMER&amp;section5) has several advanced features not found in UFS:
857
858 * Large file systems:  Up to 1 million TB, also called 1 Exabyte is supported.
859
860 * Multiple volumes:  A HAMMER file system can span up to 256 disks, each partition part of a HAMMER file system is called a volume.  Each volume can be up to 4096 TB in size.
861
862 * Support for growing and shrinking existing HAMMER file systems: adding and removing volumes from the file system.  As of 2.4 release an existing HAMMER file system can be expanded by adding extra space, see the `expand` directive to [hammer(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=hammer&amp;section=8).  The HAMMER design is also prepared for removing volumes, utilities just have to be written to support it.
863
864 * Instant crash recovery:  If a crash should occur, then HAMMER file systems will be ready a few seconds after boot, no lenghty fsck have to be run.
865
866 * Full history retention:  All file system changes are saved every ~30 seconds.  Changes are written at least when sync() is called, see [syncer(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=syncer&amp;section4).  Every time data for files are written to disk a transaction is completed, this is assigned an ID and the file updated can after this be accessed with the contents from this moment.  To access the file with the state of this moment, the transaction ID, TID for brevity, just needs to be added to the file name, like: 'file@@<TID>'.  The TID can be saved from the 'snapshot', 'cleanup', or 'synctid' [hammer(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=hammer&amp;section=8) command or looked up with the 'hammer history file' command.  This history will typically grow over time, so any disk will fill up over time.  Two things are done so disks doesn't fill up: first: big disks are used, at least 50GB is typical for HAMMER file systems, and second: unused history information is deleted regularly. Here we need to define what unused means: a TID is used if a snapshot have been taken on it. Data assigned to unused history can be reclaimed using the `prune` and `reblock` [hammer(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=hammer&amp;section=8) commands, this will also defragment the file system and can be done while the file system is in normal operation.  Generally after file system is pruned only TIDs for the snapshots or newer than newest shapshot should be used, see explanation [here](http://leaf.dragonflybsd.org/mailarchive/bugs/2008-07/msg00213.html) (more info on HAMMER design [here](http://leaf.dragonflybsd.org/mailarchive/kernel/2008-07/msg00114.html)).  See also [hammer(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=hammer&amp;section=5). 
867
868 * Mirroring:  A master file system can be mirrored online to a number of slave file systems.  Mirror targets are read-only, but does have history available.  History retension policy can even be different on slaves and master.  Mirroring can be over network and unreliable connections are handled gracefully.
869
870 * Data integrity:  HAMMER has high focus in data integrity and implements a CRC checksum on all data, this means that if disk fails with bit errors it will be detected.
871
872 More info on HAMMER can be found [here](http://www.dragonflybsd.org/hammer/index.html).
873
874 DragonFly also uses disk space for ***swap space***.  Swap space provides DragonFly with ***virtual memory***.  This allows your computer to behave as though it has much more memory than it actually does.  When DragonFly runs low on memory it moves some of the data that is not currently being used to the swap space, and moves it back in (moving something else out) when it needs it.
875
876 <!-- XXX: mention swapcache, and also how to configure and use it (somewhere else, probably) -->
877
878 ### Adding a Disk 
879
880 Adding a disk is done by installing it physically, and to connect it to a disk controller that DragonFly supports.  If you are in doubt if controller is supported, manual pages for disk controllers can be consulted ('man -k disk' or 'man -k scsi' can be of help).  The easiest thing is normally to boot DargonFly with the controller installed and note if boot message contains the controller.
881
882 Assuming that disk `ad6` is installed, we could set it up using [fdisk(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=fdisk&amp;section8) and  disklabel(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=disklabel&amp;section8) or  [gpt(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=gpt&amp;section8) and 
883 [disklabel64(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=disklabel64&amp;section8).
884
885 In this example we choose [gpt(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=gpt&amp;section=8) & [disklabel64(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=disklabel64&amp;section=8).
886
887 <!-- XXX: mention that disklabel64 is default now -->
888     
889
890     # gpt -v create ad6
891
892     ...
893
894     # gpt add -s1 ad6
895
896     ad6s0
897
898     # gpt add ad6
899
900     ad6s1
901
902     # gpt show ad6
903
904     ...
905
906 Here we first create the GPT and then add two slices.  In this example the first slice added is `ad6s0`, which is made a dummy slice of size 1 sector, this is just for not having to make further reference to it, as many users remembers that `s0` has special meaning, which really isn't true for GPT slices.  The second slice is `ad6s1` which will cover the rest of the disk.
907
908     
909
910     # disklabel64 -rw ad6s1 auto
911
912     # disklabel64 -e ad6s1          # edit label to add partitions as needed
913
914 ### disklabel 
915 <!-- XXX: what is all this fuzz about dangerously dedicated? -->
916
917 For [disklabel(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=disklabel&amp;section8) labels some partitions have certain conventions associated with them.
918
919 [[!table  data="""
920 <tablestyle="width:100%"> Partition | Convention 
921 <tablestyle="width:100%"> `a` | Normally contains the root file system 
922  `b` | Normally contains swap space 
923  `c` | Normally the same size as the enclosing slice.  This allows utilities that need to work on the entire slice (for example, a bad block scanner) to work on the `c` partition. You would not normally create a file system on this partition. This is not necessarily true; it is possible to use the 'c' partition as a normal partition.
924  `d` | Partition `d` used to have a special meaning associated with it, although that is now gone.  To this day, some tools may operate oddly if told to work on partition `d`. |
925
926 """]]
927
928 Each partition-that-contains-a-file-system is stored in what DragonFly calls a ***slice***.  Slice is DragonFly's term for what the common call partitions, and again, this is because of DragonFly's UNIX background.  Slices are numbered, starting at 1.
929
930 Slice numbers follow the device name, prefixed with an `s`, starting at 1. So ***da0s1*** is the first slice on the first SCSI drive. There can only be four physical slices on a disk, but you can have logical slices inside physical slices of the appropriate type.  These extended slices are numbered starting at 5, so ***ad0s5*** is the first extended slice on the first IDE disk. These devices are used by file systems that expect to occupy a slice.
931
932 <!-- XXX: gpt allows for way more than 4 partitions... let's remove this stuff above -->
933
934 ***Dangerously dedicated*** physical drives are accessed as slice 0.
935
936 Slices, ***dangerously dedicated*** physical drives, and other drives contain ***partitions***, which are represented as letters from `a` to `p`.  This letter is appended to the device name, so ***da0s0a*** is the a partition on the first da drive, which is ***dangerously dedicated***. ***ad1s3e*** is the fifth partition in the third slice of the second IDE disk drive.
937
938 Finally, each disk on the system is identified.  A disk name starts with a code that indicates the type of disk, and then a number, indicating which disk it is.  Disk numbering starts at 0. Common codes that you will see are listed in [Table 3-1](disk-organization.html#BASICS-DEV-CODES).
939
940 <!-- XXX: here would probably be the right place to talk about serno -->
941
942 When referring to a partition DragonFly requires that you also name the slice and disk that contains the partition, and when referring to a slice you should also refer to the disk name. Do this by listing the disk name, `s`, the slice number, and then the partition letter.  Examples are shown in [Example 3-1](disk-organization.html#BASICS-DISK-SLICE-PART).
943
944 <!-- XXX: later talk also about devfs, definitely not here though. also, devfs rules -->
945
946 [Example 3-2](disk-organization.html#BASICS-CONCEPT-DISK-MODEL) shows a conceptual model of the disk layout that should help make things clearer.
947
948 In order to install DragonFly you must first configure the disk slices, then create partitions within the slice you will use for DragonFly, and then create a file system (or swap space) in each partition, and decide where that file system will be mounted.
949
950 ***'Table 3-1. Disk Device Codes***'
951
952 [[!table  data="""
953 <tablestyle="width:100%"> Code | Meaning 
954 <tablestyle="width:100%"> `ad` | ATAPI (IDE) disk 
955  `da` | SCSI direct access disk 
956  `acd` | ATAPI (IDE) CDROM 
957  `cd` | SCSI CDROM 
958  `vn` | Virtual disk
959  `fd` | Floppy disk |
960
961 """]]
962
963 ***'Example 3-1. Sample Disk, Slice, and Partition Names***'
964
965 [[!table  data="""
966 <tablestyle="width:100%"> Name | Meaning 
967 <tablestyle="width:100%"> `ad0s1a` | The first partition (`a`) on the first slice (`s1`) on the first IDE disk (`ad0`). 
968  `da1s2e` | The fifth partition (`e`) on the second slice (`s2`) on the second SCSI disk (`da1`). |
969
970 """]]
971
972 ***'Example 3-2. Conceptual Model of a Disk***'
973
974 This diagram shows DragonFly's view of the first IDE disk attached to the system. Assume that the disk is 4 GB in size, and contains two 2 GB slices (MS-DOS partitions).  The first slice contains a MS-DOS disk, `C:`, and the second slice contains a DragonFly installation. This example DragonFly installation has three partitions, and a swap partition.
975
976 The three partitions will each hold a file system. Partition `a` will be used for the root file system, `e` for the `/var` directory hierarchy, and `f` for the `/usr` directory hierarchy.
977
978 <!-- XXX: image -->
979
980 ## Mounting and Unmounting File Systems 
981
982 The file system is best visualized as a tree, rooted at `/`.
983
984 The directories, e.g. `/dev` and `/usr`, in the root directory are branches,
985
986 which may have their own branches, such as `/usr/local`, and so on.
987
988 There are various reasons to house some of these directories on separate file systems. `/var` contains the directories `log/` and `spool/`, and various types of temporary files, and as such, may get filled up. Filling up the root file system is not a good idea, so splitting `/var` from `/` is often favorable.
989
990 Another common reason to contain certain directory trees on other file systems is if they are to be housed on separate physical disks, e.g. CD-ROM, or are used as separate virtual disks, such as [Network File System](network-nfs.html) exports.
991
992 ### The fstab File 
993
994 During the [boot process](boot.html), file systems listed in `/etc/fstab` are automatically mounted (unless they are listed with the `noauto` option).
995
996 The `/etc/fstab` file contains a list of lines of the following format:
997   
998
999     device       mount-point   fstype     options      dumpfreq     passno
1000
1001 These parameters have the following meaning:
1002
1003 * `device`: A device name (which should exist), as explained [here](disks-naming.html).
1004
1005 * `mount-point`: A directory (which should exist), on which to mount the file system.
1006
1007 * `fstype`: The file system type to pass to [mount(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=mount&section8). The default DragonFly file system is `ufs`.
1008
1009 * `options`: Either `rw` for read-write file systems, or `ro` for read-only file systems, followed by any other options that may be needed. A common option is `noauto` for file systems not normally mounted during the boot sequence. Other options are listed in the [mount(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=mount&section8) manual page.
1010
1011 * `dumpfreq`: This is used by [dump(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=dump&section8) to determine which file systems require dumping. If the field is missing, a value of zero is assumed.
1012
1013 * `passno`: This determines the order in which file systems should be checked. File systems that should be skipped should have their `passno` set to zero. The root file system (which needs to be checked before everything else) should have its `passno` set to one, and other file systems' `passno` should be set to values greater than one. If more than one file systems have the same `passno` then [fsck(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=fsck&section8) will attempt to check file systems in parallel if possible.
1014
1015 Consult the [fstab(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=fstab&section5) manual page for more information on the format of the `/etc/fstab` file and the options it contains.
1016
1017 ### The mount Command 
1018
1019 The [mount(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=mount&section8) command is what is ultimately used to mount file systems.
1020
1021 In its most basic form, you use:
1022
1023     
1024
1025     # mount device mountpoint
1026
1027 Or, if `mountpoint` is specified in `/etc/fstab`, just:
1028
1029     
1030
1031     # mount mountpoint
1032
1033 There are plenty of options, as mentioned in the [mount(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=mount&section8) manual page, but the most common are:
1034
1035  **Mount Options** 
1036
1037 * `-a`: Mount all the file systems listed in `/etc/fstab`. Except those marked as `noauto`, excluded by the `-t` flag, or those that are already mounted.
1038
1039 * `-d`: Do everything except for the actual mount system call. This option is useful in conjunction with the `-v` flag to determine what [mount(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=mount&section8) is actually trying to do.
1040
1041 * `-f`: Force the mount of an unclean file system (dangerous), or forces the revocation of write access when downgrading a file system's mount status from read-write to read-only.
1042
1043 * `-r`: Mount the file system read-only. This is identical to using the `rdonly` argument to the `-o` option.
1044
1045 * `-t` ***fstype***: Mount the given file system as the given file system type, or, if used with `-a` option, mount only file systems of the given type. `ufs` is the default file system type.
1046
1047 * `-u`: Update mount options on the file system.
1048
1049 * `-v`: Be verbose.
1050
1051 * `-w`: Mount the file system read-write.
1052
1053 The `-o` option takes a comma-separated list of the options, including the following:
1054
1055 * `nodev:` Do not interpret special devices on the file system. This is a useful security option.
1056
1057 * `noexec`: Do not allow execution of binaries on this file system. This is also a useful security option.
1058
1059 * `nosuid`: Do not interpret setuid or setgid flags on the file system. This is also a useful security option.
1060
1061 ### The umount Command 
1062
1063 The [umount(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=umount&section8) command takes, as a parameter, one of a mountpoint, a device name, or the `-a` or `-A` option.
1064
1065 All forms take `-f` to force unmounting, and `-v` for verbosity. Be warned that `-f` is not generally a good idea. Forcibly unmounting file systems might crash the computer or damage data on the file system.
1066
1067 `-a` and `-A` are used to unmount all mounted file systems, possibly modified by the file system types listed after `-t`. `-A`, however, does not attempt to unmount the root file system.
1068
1069 ## Processes 
1070
1071 DragonFly is a multi-tasking operating system. This means that it seems as though more than one program is running at once. Each program running at any one time is called a ***process***. Every command you run will start at least one new process, and there are a number of system processes that run all the time, keeping the system functional.
1072
1073 <!-- XXX: talk about LWPs and threads? -->
1074
1075 Each process is uniquely identified by a number called a ***process ID***, or ***PID***, and, like files, each process also has one owner and group. The owner and group information is used to determine what files and devices the process can open, using the file permissions discussed earlier. Most processes also have a parent process. The parent process is the process that started them. For example, if you are typing commands to the shell then the shell is a process, and any commands you run are also processes. Each process you run in this way will have your shell as its parent process. The exception to this is a special process called [init(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=init&section8). `init` is always the first process, so its PID is always 1. `init` is started automatically by the kernel when DragonFly starts.
1076
1077 Two commands are particularly useful to see the processes on the system, [ps(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=ps&section1) and [top(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=top&section=1). The `ps` command is used to show a static list of the currently running processes, and can show their PID, how much memory they are using, the command line they were started with, and so on. The `top` command displays all the running processes, and updates the display every few seconds, so that you can interactively see what your computer is doing.
1078
1079 By default, `ps` only shows you the commands that are running and are owned by you. For example:
1080
1081     
1082
1083     % ps
1084
1085       PID  TT  STAT      TIME COMMAND
1086       298  p0  Ss     0:01.10 tcsh
1087      7078  p0  S      2:40.88 xemacs mdoc.xsl (xemacs-21.1.14)
1088     37393  p0  I      0:03.11 xemacs freebsd.dsl (xemacs-21.1.14)
1089     48630  p0  S      2:50.89 /usr/local/lib/netscape-linux/navigator-linux-4.77.bi
1090     48730  p0  IW     0:00.00 (dns helper) (navigator-linux-)
1091     72210  p0  R+     0:00.00 ps
1092       390  p1  Is     0:01.14 tcsh
1093      7059  p2  Is+    1:36.18 /usr/local/bin/mutt -y
1094      6688  p3  IWs    0:00.00 tcsh
1095     10735  p4  IWs    0:00.00 tcsh
1096     20256  p5  IWs    0:00.00 tcsh
1097       262  v0  IWs    0:00.00 -tcsh (tcsh)
1098       270  v0  IW+    0:00.00 /bin/sh /usr/X11R6/bin/startx -- -bpp 16
1099       280  v0  IW+    0:00.00 xinit /home/nik/.xinitrc -- -bpp 16
1100       284  v0  IW     0:00.00 /bin/sh /home/nik/.xinitrc
1101       285  v0  S      0:38.45 /usr/X11R6/bin/sawfish
1102
1103 As you can see in this example, the output from [ps(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=ps&section1) is organized into a number of columns. `PID` is the process ID discussed earlier. PIDs are assigned starting from 1, go up to 99999, and wrap around back to the beginning when you run out. The `TT` column shows the tty the program is running on, and can safely be ignored for the moment. `STAT` shows the program's state, and again, can be safely ignored. `TIME` is the amount of time the program has been running on the CPU--this is usually not the elapsed time since you started the program, as most programs spend a lot of time waiting for things to happen before they need to spend time on the CPU. Finally, `COMMAND` is the command line that was used to run the program.
1104
1105 [ps(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#ps&section1) supports a number of different options to change the information that is displayed. One of the most useful sets is `auxww`. `a` displays information about all the running processes, not just your own. `u` displays the username of the process' owner, as well as memory usage. `x` displays information about daemon processes, and `ww` causes [ps(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=ps&section=1) to display the full command line, rather than truncating it once it gets too long to fit on the screen.
1106
1107 The output from [top(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=top&section1) is similar. A sample session looks like this:
1108
1109     
1110
1111     % top
1112     last pid: 72257;  load averages:  0.13,  0.09,  0.03    up 0+13:38:33  22:39:10
1113     47 processes:  1 running, 46 sleeping
1114     CPU states: 12.6% user,  0.0% nice,  7.8% system,  0.0% interrupt, 79.7% idle
1115     Mem: 36M Active, 5256K Inact, 13M Wired, 6312K Cache, 15M Buf, 408K Free
1116     Swap: 256M Total, 38M Used, 217M Free, 15% Inuse
1117     
1118
1119       PID USERNAME PRI NICE  SIZE    RES STATE    TIME   WCPU    CPU COMMAND
1120     72257 nik       28   0  1960K  1044K RUN      0:00 14.86%  1.42% top
1121      7078 nik        2   0 15280K 10960K select   2:54  0.88%  0.88% xemacs-21.1.14
1122       281 nik        2   0 18636K  7112K select   5:36  0.73%  0.73% XF86_SVGA
1123       296 nik        2   0  3240K  1644K select   0:12  0.05%  0.05% xterm
1124     48630 nik        2   0 29816K  9148K select   3:18  0.00%  0.00% navigator-linu
1125       175 root       2   0   924K   252K select   1:41  0.00%  0.00% syslogd
1126      7059 nik        2   0  7260K  4644K poll     1:38  0.00%  0.00% mutt
1127     ...
1128
1129 The output is split into two sections. The header (the first five lines) shows the PID of the last process to run, the system load averages (which are a measure of how busy the system is), the system uptime (time since the last reboot) and the current time. The other figures in the header relate to how many processes are running (47 in this case), how much memory and swap space has been taken up, and how much time the system is spending in different CPU states.
1130
1131 Below that are a series of columns containing similar information to the output from [ps(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=ps&section1). As before you can see the PID, the username, the amount of CPU time taken, and the command that was run. [top(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=top&section=1) also defaults to showing you the amount of memory space taken by the process. This is split into two columns, one for total size, and one for resident size--total size is how much memory the application has needed, and the resident size is how much it is actually using at the moment. In this example you can see that  **Netscape®**  has required almost 30 MB of RAM, but is currently only using 9 MB.
1132
1133 [top(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=top&section1) automatically updates this display every two seconds; this can be changed with the `s` option.
1134
1135 ## Daemons, Signals, and Killing Processes 
1136
1137 When you run an editor it is easy to control the editor, tell it to load files, and so on. You can do this because the editor provides facilities to do so, and because the editor is attached to a ***terminal***. Some programs are not designed to be run with continuous user input, and so they disconnect from the terminal at the first opportunity. For example, a web server spends all day responding to web requests, it normally does not need any input from you. Programs that transport email from site to site are another example of this class of application.
1138
1139 We call these programs ***daemons***. Daemons were characters in Greek mythology; neither good or evil, they were little attendant spirits that, by and large, did useful things for mankind. Much like the web servers and mail servers of today do useful things. This is why the mascot for a number of BSD-based operating systems has, for a long time, been a cheerful looking daemon with sneakers and a pitchfork.
1140
1141 There is a convention to name programs that normally run as daemons with a trailing ***d***.  **BIND**  is the Berkeley Internet Name Daemon (and the actual program that executes is called `named`), the  **Apache**  web server program is called `httpd`, the line printer spooling daemon is `lpd` and so on. This is a convention, not a hard and fast rule; for example, the main mail daemon for the  **Sendmail**  application is called `sendmail`, and not `maild`, as you might imagine.
1142
1143 Sometimes you will need to communicate with a daemon process. These communications are called ***signals***, and you can communicate with a daemon (or with any other running process) by sending it a signal. There are a number of different signals that you can send--some of them have a specific meaning, others are interpreted by the application, and the application's documentation will tell you how that application interprets signals. You can only send a signal to a process that you own. If you send a signal to someone else's process with [kill(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=kill&section=1) or [kill(2)](http://leaf.dragonflybsd.org/cgi/web-man?command=kill&section=2) permission will be denied. The exception to this is the `root` user, who can send signals to everyone's processes.
1144
1145 DragonFly will also send applications signals in some cases. If an application is badly written, and tries to access memory that it is not supposed to, DragonFly sends the process the ***Segmentation Violation*** signal (`SIGSEGV`). If an application has used the [alarm(3)](http://leaf.dragonflybsd.org/cgi/web-man?command=alarm&section=3) system call to be alerted after a period of time has elapsed then it will be sent the Alarm signal (`SIGALRM`), and so on.
1146
1147 Two signals can be used to stop a process, `SIGTERM` and `SIGKILL`. `SIGTERM` is the polite way to kill a process; the process can ***catch*** the signal, realize that you want it to shut down, close any log files it may have open, and generally finish whatever it is doing at the time before shutting down. In some cases a process may even ignore `SIGTERM` if it is in the middle of some task that can not be interrupted.
1148
1149 `SIGKILL` can not be ignored by a process. This is the ***I do not care what you are doing, stop right now*** signal. If you send `SIGKILL` to a process then DragonFly will stop that process there and then[(1)](#FTN.AEN2181).
1150
1151 The other signals you might want to use are `SIGHUP`, `SIGUSR1`, and `SIGUSR2`. These are general purpose signals, and different applications will do different things when they are sent.
1152
1153 Suppose that you have changed your web server's configuration file--you would like to tell the web server to re-read its configuration. You could stop and restart `httpd`, but this would result in a brief outage period on your web server, which may be undesirable. Most daemons are written to respond to the `SIGHUP` signal by re-reading their configuration file. So instead of killing and restarting `httpd` you would send it the `SIGHUP` signal. Because there is no standard way to respond to these signals, different daemons will have different behavior, so be sure and read the documentation for the daemon in question.
1154
1155 Signals are sent using the [kill(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=kill&section=1) command, as this example shows.
1156
1157  **Sending a Signal to a Process** 
1158
1159 This example shows how to send a signal to [inetd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=inetd&section=8). The `inetd` configuration file is `/etc/inetd.conf`, and `inetd` will re-read this configuration file when it is sent `SIGHUP`.
1160
1161   1. Find the process ID of the process you want to send the signal to. Do this using [ps(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#ps&section=1) and [grep(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=grep&section=1). The [grep(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=grep&section=1) command is used to search through output, looking for the string you specify. This command is run as a normal user, and [inetd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=inetd&section=8) is run as `root`, so the `ax` options must be given to [ps(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=ps&section=1).
1162
1163       
1164
1165         % ps -ax | grep inetd
1166
1167         198  ??  IWs    0:00.00 inetd -wW
1168
1169   
1170
1171   So the [inetd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#inetd&section8) PID is 198. In some cases the `grep inetd` command might also occur in this output. This is because of the way [ps(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=ps&section=1) has to find the list of running processes.
1172
1173   2. Use [kill(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=kill&section=1) to send the signal. Because [inetd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=inetd&section=8) is being run by `root` you must use [su(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=su&section=1) to become `root` first.
1174
1175       
1176
1177         % su
1178
1179         Password:
1180
1181         # /bin/kill -s HUP 198
1182
1183   
1184
1185   In common with most UNIX® commands, [kill(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=kill&section=1) will not print any output if it is successful. If you send a signal to a process that you do not own then you will see `kill: PID: Operation not permitted`. If you mistype the PID you will either send the signal to the wrong process, which could be bad, or, if you are lucky, you will have sent the signal to a PID that is not currently in use, and you will see `kill: PID: No such process`.
1186
1187 **Why Use `/bin/kill`?** Many shells provide the `kill` command as a built in command; that is, the shell will send the signal directly, rather than running `/bin/kill`. This can be very useful, but different shells have a different syntax for specifying the name of the signal to send. Rather than try to learn all of them, it can be simpler just to use the `/bin/kill ...` command directly.
1188
1189 Sending other signals is very similar, just substitute `TERM` or `KILL` in the command line as necessary.
1190
1191  **Important:** Killing random process on the system can be a bad idea. In particular, [init(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=init&section=8), process ID 1, is very special. Running `/bin/kill -s KILL 1` is a quick way to shutdown your system. ***Always*** double check the arguments you run [kill(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=kill&section=1) with ***before*** you press  **Return** .
1192
1193  
1194  
1195  
1196  
1197  
1198 ## Shells 
1199
1200 In DragonFly, a lot of everyday work is done in a command line interface called a shell. A shell's main job is to take commands from the input channel and execute them. A lot of shells also have built in functions to help everyday tasks such as file management, file globbing, command line editing, command macros, and environment variables. DragonFly comes with a set of shells, such as `sh`, the Bourne Shell, and `tcsh`, the improved C-shell. Many other shells are available from pkgsrc®, such as `zsh` and `bash`.
1201
1202 Which shell do you use? It is really a matter of taste. If you are a C programmer you might feel more comfortable with a C-like shell such as `tcsh`. If you have come from Linux or are new to a UNIX® command line interface you might try `bash`. The point is that each shell has unique properties that may or may not work with your preferred working environment, and that you have a choice of what shell to use.
1203
1204 One common feature in a shell is filename completion. Given the typing of the first few letters of a command or filename, you can usually have the shell automatically complete the rest of the command or filename by hitting the  **Tab**  key on the keyboard. Here is an example. Suppose you have two files called `foobar` and `foo.bar`. You want to delete `foo.bar`. So what you would type on the keyboard is: `rm fo[ **Tab** ].[ **Tab** ]`.
1205
1206 The shell would print out `rm foo[BEEP].bar`.
1207
1208 The [BEEP] is the console bell, which is the shell telling me it was unable to totally complete the filename because there is more than one match. Both `foobar` and `foo.bar` start with `fo`, but it was able to complete to `foo`. If you type in `.`, then hit  **Tab**  again, the shell would be able to fill in the rest of the filename for you.
1209
1210 Another feature of the shell is the use of environment variables. Environment variables are a variable key pair stored in the shell's environment space. This space can be read by any program invoked by the shell, and thus contains a lot of program configuration. Here is a list of common environment variables and what they mean:
1211
1212 [[!table  data="""
1213 <tablestyle="width:100%"> Variable | Description 
1214 <tablestyle="width:100%"> `USER` | Current logged in user's name. 
1215  `PATH` | Colon separated list of directories to search for binaries. 
1216  `DISPLAY` | Network name of the X11 display to connect to, if available. 
1217  `SHELL` | The current shell. 
1218  `TERM` | The name of the user's terminal. Used to determine the capabilities of the terminal. 
1219  `TERMCAP` | Database entry of the terminal escape codes to perform various terminal functions. 
1220  `OSTYPE` | Type of operating system. e.g., DragonFly. 
1221  `MACHTYPE` | The CPU architecture that the system is running on. 
1222  `EDITOR` | The user's preferred text editor. 
1223  `PAGER` | The user's preferred text pager. 
1224  `MANPATH` | Colon separated list of directories to search for manual pages. |
1225
1226 """]]
1227
1228 Setting an environment variable differs somewhat from shell to shell. For example, in the C-Style shells such as `tcsh` and `csh`, you would use `setenv` to set environment variables. Under Bourne shells such as `sh` and `bash`, you would use `export` to set your current environment variables. For example, to set or modify the `EDITOR` environment variable, under `csh` or `tcsh` a command like this would set `EDITOR` to `/usr/pkg/bin/emacs`:
1229     
1230
1231     % setenv EDITOR /usr/pkg/bin/emacs
1232
1233 Under Bourne shells:
1234    
1235
1236     % export EDITOR="/usr/pkg/bin/emacs"
1237
1238 You can also make most shells expand the environment variable by placing a `$` character in front of it on the command line. For example, `echo $TERM` would print out whatever `$TERM` is set to, because the shell expands `$TERM` and passes it on to `echo`.
1239
1240 Shells treat a lot of special characters, called meta-characters as special representations of data. The most common one is the `*` character, which represents any number of characters in a filename. These special meta-characters can be used to do filename globbing. For example, typing in `echo *` is almost the same as typing in `ls` because the shell takes all the files that match `*` and puts them on the command line for `echo` to see.
1241
1242 To prevent the shell from interpreting these special characters, they can be escaped from the shell by putting a backslash (`\`) character in front of them. `echo $TERM` prints whatever your terminal is set to. `echo \$TERM` prints `$TERM` as is.
1243
1244 ### Changing Your Shell 
1245
1246 <!-- XXX: does chsh still exist? chpass will do, too -->
1247
1248 The easiest way to change your shell is to use the `chsh` command. Running `chsh` will place you into the editor that is in your `EDITOR` environment variable; if it is not set, you will be placed in `vi`. Change the ***Shell:*** line accordingly.
1249
1250 You can also give `chsh` the `-s` option; this will set your shell for you, without requiring you to enter an editor. For example, if you wanted to change your shell to `bash`, the following should do the trick:
1251
1252     
1253
1254     % chsh -s /usr/pkg/bin/bash
1255
1256  **Note:** The shell that you wish to use ***must*** be present in the `/etc/shells` file. If you have installed a shell from the [ pkgsrc tree ](pkgsrc.html), then this should have been done for you already. If you installed the shell by hand, you must do this.
1257
1258 For example, if you installed `bash` by hand and placed it into `/usr/local/bin`, you would want to:
1259
1260     
1261
1262     # echo "/usr/local/bin/bash" >> /etc/shells
1263
1264 Then rerun `chsh`.
1265
1266 ## Text Editors 
1267
1268 A lot of configuration in DragonFly is done by editing text files. Because of this, it would be a good idea to become familiar with a text editor. DragonFly comes with a few as part of the base system, and many more are available in the pkgsrc® tree.
1269
1270 The easiest and simplest editor to learn is an editor called  **ee** , which stands for easy editor. To start  **ee** , one would type at the command line `ee filename` where `filename` is the name of the file to be edited. For example, to edit `/etc/rc.conf`, type in `ee /etc/rc.conf`. Once inside of `ee`, all of the commands for manipulating the editor's functions are listed at the top of the display. The caret `^` character represents the  **Ctrl**  key on the keyboard, so `^e` expands to the key combination  **Ctrl** + **e** . To leave  **ee** , hit the  **Esc**  key, then choose leave editor. The editor will prompt you to save any changes if the file has been modified.
1271
1272 DragonFly also comes with more powerful text editors such as  **vi**  as part of the base system, while other editors, like  **emacs**  and  **vim** , are part of the pkgsrc tree. These editors offer much more functionality and power at the expense of being a little more complicated to learn. However if you plan on doing a lot of text editing, learning a more powerful editor such as  **vim**  or  **emacs**  will save you much more time in the long run.
1273
1274 ## Devices and Device Nodes 
1275
1276 A device is a term used mostly for hardware-related activities in a system, including disks, printers, graphics cards, and keyboards. When DragonFly boots, the majority of what DragonFly displays are devices being detected. You can look through the boot messages again by viewing `/var/run/dmesg.boot`.
1277
1278 For example, `acd0` is the first IDE CDROM drive, while `kbd0` represents the keyboard.
1279
1280 Most of these devices in a UNIX® operating system must be accessed through special files called device nodes, which are located in the `/dev` directory.
1281
1282 The device nodes in the `/dev` directory are created and destroyed automatically on DragonFly >= 2.4, by means of the device file system (devfs).
1283
1284 ## Binary Formats 
1285
1286 To understand why DragonFly uses the [elf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=elf&amp;section=5) format, you must first know a little about the three currently ***dominant*** executable formats for UNIX®:
1287
1288 * [a.out(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=a.out&amp;section=5)
1289
1290   The oldest and ***classic*** UNIX object format. It uses a short and compact header with a magic number at the beginning that is often used to characterize the format (see [a.out(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=a.out&amp;section=5) for more details). It contains three loaded segments: .text, .data, and .bss plus a symbol table and a string table.
1291
1292 * <u>COFF</u>
1293
1294   The SVR3 object format. The header now comprises a section table, so you can have more than just .text, .data, and .bss sections.
1295
1296 * [elf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=elf&amp;section=5)
1297
1298   The successor to COFF, featuring multiple sections and 32-bit or 64-bit possible values. One major drawback: ELF was also designed with the assumption that there would be only one ABI per system architecture. That assumption is actually quite incorrect, and not even in the commercial SYSV world (which has at least three ABIs: SVR4, Solaris, SCO) does it hold true. DragonFly tries to work around this problem somewhat by providing a utility for ***branding*** a known ELF executable with information about the ABI it is compliant with. See the manual page for [brandelf(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=brandelf&amp;section=1) for more information. DragonFly runs ELF.
1299
1300 So, why are there so many different formats? Back in the dim, dark past, there was simple hardware. This simple hardware supported a simple, small system. `a.out` was completely adequate for the job of representing binaries on this simple system (a PDP-11). As people ported UNIX from this simple system, they retained the `a.out` format because it was sufficient for the early ports of UNIX to architectures like the Motorola 68k, VAXen, etc.
1301
1302 Then some bright hardware engineer decided that if he could force software to do some sleazy tricks, then he would be able to shave a few gates off the design and allow his CPU core to run faster. While it was made to work with this new kind of hardware (known these days as RISC), `a.out` was ill-suited for this hardware, so many formats were developed to get to a better performance from this hardware than the limited, simple `a.out` format could offer. Things like COFF, ECOFF, and a few obscure others were invented and their limitations explored before things seemed to settle on ELF.
1303
1304 In addition, program sizes were getting huge and disks (and physical memory) were still relatively small so the concept of a shared library was born. The VM system also became more sophisticated. While each one of these advancements was done using the `a.out` format, its usefulness was stretched more and more with each new feature. In addition, people wanted to dynamically load things at run time, or to junk parts of their program after the init code had run to save in core memory and swap space. Languages became more sophisticated and people wanted code called before main automatically. Lots of hacks were done to the `a.out` format to allow all of these things to happen, and they basically worked for a time. In time, `a.out` was not up to handling all these problems without an ever increasing overhead in code and complexity. While ELF solved many of these problems, it would be painful to switch from the system that basically worked. So ELF had to wait until it was more painful to remain with `a.out` than it was to migrate to ELF.
1305
1306 ELF is more expressive than `a.out` and allows more extensibility in the base system. The ELF tools are better maintained, and offer cross compilation support, which is important to many people. ELF may be a little slower than `a.out`, but trying to measure it can be difficult. There are also numerous details that are different between the two in how they map pages, handle init code, etc. None of these are very important, but they are differences.
1307
1308 <!-- XXX: do we really need all this bullshit about file formats? -->
1309
1310 ## For More Information 
1311
1312 ### Manual Pages 
1313
1314 The most comprehensive documentation on DragonFly is in the form of manual pages. Nearly every program on the system comes with a short reference manual explaining the basic operation and various arguments. These manuals can be viewed with the `man` command. Use of the `man` command is simple:
1315
1316     % man command
1317
1318 `command` is the name of the command you wish to learn about. For example, to learn more about `ls` command type:
1319
1320     % man ls
1321
1322 The online manual is divided up into numbered sections:
1323
1324   1. User commands.
1325   1. System calls and error numbers.
1326   1. Functions in the C libraries.
1327   1. Device drivers.
1328   1. File formats.
1329   1. Games and other diversions.
1330   1. Miscellaneous information.
1331   1. System maintenance and operation commands.
1332   1. Kernel internals.
1333
1334 In some cases, the same topic may appear in more than one section of the online manual. For example, there is a `chmod` user command and a `chmod()` system call. In this case, you can tell the `man` command which one you want by specifying the section:
1335     
1336
1337     % man 1 chmod
1338
1339 This will display the manual page for the user command `chmod`. References to a particular section of the online manual are traditionally placed in parenthesis in written documentation, so [chmod(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=chmod&section=1) refers to the `chmod` user command and [chmod(2)](http://leaf.dragonflybsd.org/cgi/web-man?command=chmod&section=2) refers to the system call.
1340
1341 This is fine if you know the name of the command and simply wish to know how to use it, but what if you cannot recall the command name? You can use `man` to search for keywords in the command descriptions by using the `-k` switch:
1342
1343    
1344
1345     % man -k mail
1346
1347 With this command you will be presented with a list of commands that have the keyword ***mail*** in their descriptions. This is actually functionally equivalent to using the `apropos` command.
1348
1349 So, you are looking at all those fancy commands in `/usr/bin` but do not have the faintest idea what most of them actually do? Simply do:    
1350
1351     % cd /usr/bin
1352     % man -f *
1353
1354 or
1355    
1356
1357     % cd /usr/bin
1358     % whatis *
1359
1360 which does the same thing.
1361
1362 ### GNU Info Files 
1363
1364 DragonFly includes many applications and utilities produced by the Free Software Foundation (FSF). In addition to manual pages, these programs come with more extensive hypertext documents called `info` files which can be viewed with the `info` command or, if you installed  **emacs** , the info mode of  **emacs** . To use the [info(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=info&section=1) command, simply type:
1365
1366     % info
1367
1368 For a brief introduction, type `h`. For a quick command reference, type `?`.
1369
1370 # DPorts and pkgng
1371
1372 Dports is DragonFly's own third-party software build system.  It is based on FreeBSD's Ports Collection.  Differences between ports and DPorts are intentionally kept to a minimum, both to maintain familiarity for mutual users of both operating systems and also to leverage the tremendous amount of work the FreeBSD contributors put into ports.  DPorts can and does feature ports unique to DragonFly, so it's truly a native system.
1373
1374 The __pkgng__ tool called "pkg" is a modern and fast binary package manager.  It was developed for FreeBSD, but PC-BSD used it in production first, followed soon after by DragonFly.  In the future, it will be the only binary package manager on FreeBSD just as it is for DPorts.
1375
1376 __pkgng__ is not a replacement for port management tools like `ports-mgmt/portmaster` or `ports-mgmt/portupgrade`. While `ports-mgmt/portmaster` and `ports-mgmt/portupgrade` can install third-party software from both binary packages and DPorts, __pkgng__ installs only binary packages.
1377
1378 ## Getting started with pkgng
1379
1380 DragonFly daily snapshots and Releases (starting with 3.4) come with __pkgng__ already installed.  However upgrades from earlier releases won't have it.  If the "pkg" program is missing on the system for any reason, it can be quickly bootstrapped without having to build it from source.
1381
1382 To ensure  __pkgng__ on a DragonFly BSD 3.4 or higher system is  ready for use, run the following BEFORE you try to use `pkg` the first time:
1383
1384     # cd /usr
1385     # make dports-create
1386     # rm -rf /usr/pkg
1387     # pkg upgrade
1388     # rehash
1389
1390 Since you may need to manually edit the configuration file `/usr/local/etc/pkg.conf`  here is the
1391 usual command to edit it using the vi editor:
1392
1393      # vi /usr/local/etc/pkg.conf
1394
1395 Before using consult the man page (`man pkg`) and then try things like these examples:
1396
1397     # pkg search editors
1398     # pkg install vim
1399
1400 To bootstrap __pkgng__ with a download on a very old version of DragonFly that is still using `pkgsrc` run:
1401
1402     # make pkg-bootstrap
1403     # rehash
1404     # pkg-static install -y pkg
1405     # rehash
1406
1407 Note that this step is unnecessary for any newly installed release from DragonFly 3.4 onwards.
1408
1409 ## Configuring pkgng
1410
1411 Information previously contained in here worked for older versions of pkg, but as pkgng has undergone some changes, so too do the configurations.
1412
1413 Previously /usr/local/etc/pkg.conf was used and reference to a PACKAGESITE was made. This might still work but it'll complain.
1414
1415 # pkg update
1416 pkg: PACKAGESITE in pkg.conf is deprecated. Please create a repository configuration file
1417 Updating repository catalogue
1418 pkg: Warning: use of http:// URL scheme with SRV records is deprecated: switch to pkg+http://
1419
1420 Insead, listen to the errors. Throw an octothorpe in front of that packagesite line, save it, and move on.
1421
1422 Go to /usr/local/etc/pkg/repos/
1423
1424 You should see something like this with an ls
1425
1426 df-latest.conf.sample   df-releases.conf.sample
1427
1428 cp or mv one of them to be .conf
1429
1430 edit the one you choose and make the following changes. (I edited the latest version)
1431
1432 Avalon: {
1433         url             : pkg+http://mirror-master.dragonflybsd.org/dports/${ABI}/L\
1434 ATEST,
1435         mirror_type     : SRV,
1436         signature_type  : NONE,
1437         pubkey          : NONE,
1438         fingerprints    : /usr/share/fingerprints,
1439         enabled         : yes
1440 }
1441
1442 Depending on when and how you installed and/or upgraded, you may have to chmod 644 the file first to be able to edit it.
1443
1444 ## Basic pkgng Operations
1445
1446 Usage information for __pkgng__ is available in the pkg(8) manual page, or by running `pkg` without additional arguments.
1447
1448 Each __pkgng__ command argument is documented in a command-specific manual page. To read the manual page for `pkg install`, for example, run either:
1449
1450     # pkg help install
1451     # man pkg-install
1452
1453 ## Obtaining Information About Installed Packages with pkgng
1454
1455 Information about the packages installed on a system can be viewed by running `pkg info`. Similar to pkg_info(1), the package version and description for all packages will be listed.  Information about a specific package is available by running:
1456
1457     # pkg info packagename
1458
1459 For example, to see which version of __pkgng__ is installed on the system, run:
1460
1461     # pkg info pkg
1462     pkg-1.0.12                   New generation package manager
1463
1464 ## Installing and Removing Packages with pkgng
1465
1466 In general, most DragonFly users will install binary packages by typing:
1467
1468     # pkg install <packagename>
1469
1470 For example, to install curl:
1471
1472     # pkg install curl
1473
1474     Updating repository catalogue
1475     Repository catalogue is up-to-date, no need to fetch fresh copy
1476     The following packages will be installed:
1477     
1478         Installing ca_root_nss: 3.13.5
1479         Installing curl: 7.24.0
1480     
1481     The installation will require 4 MB more space
1482     
1483     1 MB to be downloaded
1484     
1485     Proceed with installing packages [y/N]: y
1486     ca_root_nss-3.13.5.txz           100%    255KB   255.1KB/s  255.1KB/s   00:00
1487     curl-7.24.0.txz                  100%   1108KB     1.1MB/s    1.1MB/s   00:00
1488     Checking integrity... done
1489     Installing ca_root_nss-3.13.5... done
1490     Installing curl-7.24.0... done
1491
1492 The new package and any additional packages that were installed as dependencies can be seen in the installed packages list:
1493
1494     # pkg info
1495     ca_root_nss-3.13.5    The root certificate bundle from the Mozilla Project
1496     curl-7.24.0           Non-interactive tool to get files from FTP, GOPHER, HTTP(S) servers
1497     pkg-1.0.12            New generation package manager
1498
1499 Packages that are no longer needed can be removed with `pkg delete`. For example, if it turns out that curl is not needed after all:
1500
1501     # pkg delete curl
1502     The following packages will be deleted:
1503     
1504         curl-7.24.0_1
1505     
1506     The deletion will free 3 MB
1507     
1508     Proceed with deleting packages [y/N]: y
1509     Deleting curl-7.24.0_1... done
1510
1511 ## Upgrading Installed Packages with pkgng
1512
1513 Packages that are outdated can be found with `pkg version`. If a local ports tree does not exist, pkg-version(8) will use the remote repository catalogue, otherwise the local ports tree will be used to identify package versions.
1514
1515 Packages can be upgraded to newer versions with __pkgng__. Suppose a new version of curl has been released. The local package can be upgraded to the new version:
1516
1517     # pkg upgrade
1518     Updating repository catalogue
1519     repo.txz            100%    297KB   296.5KB/s   296.5KB/s   00:00
1520     The following packages will be upgraded:
1521     
1522     Upgrading curl: 7.24.0 -> 7.24.0_1
1523     
1524     1 MB to be downloaded
1525     
1526     Proceed with upgrading packages [y/N]: y
1527     curl-7.24.0_1.txz   100%    1108KB  1.1MB/s       1.1MB/s   00:00
1528     Checking integrity... done
1529     Upgrading curl from 7.24.0 to 7.24.0_1... done
1530
1531 ## Auditing Installed Packages with pkgng
1532
1533 Occasionally, software vulnerabilities may be discovered in software within DPorts. __pkgng__ includes built-in auditing. To audit the software installed on the system, type:
1534
1535     # pkg audit -F
1536
1537 # Advanced pkgng Operations
1538
1539 ## Automatically Removing Leaf Dependencies with pkgng
1540
1541 Removing a package may leave behind unnecessary dependencies, like `security/ca_root_nss` in the example above. Such packages are still installed, but nothing depends on them any more. Unneeded packages that were installed as dependencies can be automatically detected and removed:
1542
1543     # pkg autoremove
1544     Packages to be autoremoved:
1545         ca_root_nss-3.13.5
1546     
1547     The autoremoval will free 723 kB
1548     
1549     Proceed with autoremoval of packages [y/N]: y
1550     Deinstalling ca_root_nss-3.13.5... done
1551
1552 ## Backing Up the pkgng Package Database
1553
1554 __pkgng__ includes its own package database backup mechanism. To manually back up the package database contents, type:
1555
1556     # pkg backup -d <pkgng.db>
1557
1558 Additionally, __pkgng__ includes a periodic(8) script to automatically back up the package database daily if `daily_backup_pkgng_enable` is set to `YES` in periodic.conf(5).   To prevent the `pkg_install` periodic script from also backing up the package database, set `daily_backup_pkgdb_enable` to `NO` in periodic.conf(5).
1559
1560 To restore the contents of a previous package database backup, run:
1561
1562     # pkg backup -r </path/to/pkgng.db>
1563
1564 ## Removing Stale pkgng Packages
1565
1566 By default, __pkgng__ stores binary packages in a cache directory as defined by `PKG_CACHEDIR` in pkg.conf(5). When upgrading packages with pkg upgrade, old versions of the upgraded packages are not automatically removed.
1567
1568 To remove the outdated binary packages, type:
1569
1570     # pkg clean
1571
1572 ##Modifying pkgng Package Metadata
1573
1574 __pkgng__ has a built-in command to update package origins. For example, if `lang/php5` was originally at version 5.3, but has been renamed to lang/php53 for the inclusion of version 5.4, the package database can be updated to deal with this. For __pkgng__, the syntax is:
1575
1576     # pkg set -o <category/oldport>:<category/newport>
1577
1578 For example, to change the package origin for the above example, type:
1579
1580     # pkg set -o lang/php5:lang/php53
1581
1582 As another example, to update lang/ruby18 to lang/ruby19, type:
1583
1584     # pkg set -o lang/ruby18:lang/ruby19
1585
1586 As a final example, to change the origin of the libglut shared libraries from graphics/libglut to graphics/freeglut, type:
1587
1588     # pkg set -o graphics/libglut:graphics/freeglut
1589
1590 _Note_: When changing package origins, in most cases it is important to reinstall packages that are dependent on the package that has had the origin changed. To force a reinstallation of dependent packages, type:
1591
1592     # pkg install -Rf graphics/freeglut
1593
1594 # Building DPorts from source
1595
1596 The average user will probably not build packages from source.  However, it's easy to do and it can be done even when packages have already been pre-installed on the system.  Common reasons to build from source are:
1597
1598 * The port is new and there's no pre-binary available yet
1599 * The pre-built binaries use the default options and the user needs a package built with a different set of options
1600 * Testing FreeBSD port in order to patch them and submit to DPorts
1601 * The user just prefers building from source
1602
1603 ## Installing DPorts tree
1604
1605 DragonFly 3.4 or later is the minimum version that can build DPorts from source.
1606
1607 It's probably that pkgsrc binaries are already installed because it comes bootstrapped with new systems.  It is necessary to rename `/usr/pkg` directory so that the existing pkgsrc binary tools and libraries don’t get accidentally used while building DPorts, causing breakage.  For the installation of the DPorts tree, type:
1608
1609     # cd /usr
1610     # make dports-create-shallow
1611
1612 If the `/usr/pkg directory` has already been renamed, `git` won’t be in the search path any more.  One option is to download a tarball of DPorts and unpack it.  To do this, type:
1613
1614     # cd /usr
1615     # make dports-download
1616
1617 For future updates, pull delta changes via `git` is fastest, so it is suggested to convert the static tree to a git repository by typing:
1618
1619     # cd /usr/dports/devel/git
1620     # make install
1621     # cd /usr
1622     # rm -rf /usr/dports
1623     # make dports-create-shallow
1624
1625 The git repository is hosted on the [github account of John Marino](https://github.com/jrmarino/DPorts/#readme).
1626
1627 ## Final thoughts
1628
1629 Building from source works similar to ports and pkgsrc: cd into the appropriate program's directory, and type 'make'. 'make install' to install the software, 'make clean' to clean up work files, and so on. Use 'make config-recursive' if you want to set all the port's options, and the options of its dependencies, immediately instead of during the build.
1630
1631 To take all the default build options and avoid getting the pop-up dialog box, set `NO_DIALOG=yes` on either the command line or the make.conf file.
1632
1633 If you just want to set the options for one package, and accept the default for all of its dependencies, do 'make config' in the package in you want non-default options, and then 'make NO_DIALOG=yes'.  Note that this is only necessary if you want to build from source with a non-default set of options, or if no pre-built binary package is available yet.
1634
1635 ## More reading
1636 * How fix/add broken ports: [[docs/howtos/fixdports]]
1637 * [Trick: How to get i386-only software via dports](http://leaf.dragonflybsd.org/mailarchive/users/2013-06/msg00023.html)
1638
1639 # Disclaimer 
1640
1641 DragonFly, up to and including version 3.4, used pkgsrc to manage third party software packages.  DragonFly switched to dports at the 3.6 release.
1642
1643 This page is still useful for anyone wanting to use pkgsrc, but the recommended packaging method is dports, which is covered in a similar document here: 
1644
1645 [http://www.dragonflybsd.org/docs/howtos/HowToDPorts/](http://www.dragonflybsd.org/docs/howtos/HowToDPorts/)
1646
1647 ----
1648
1649 # pkgsrc on DragonFly
1650
1651 DragonFly uses a specially crafted Makefile in /usr and a git mirror
1652 of the official pkgsrc repository to make pkgsrc distribution more user-friendly.
1653
1654 The basics of the pkgsrc system can be found in NetBSD's [Pkgsrc Guide](http://www.netbsd.org/docs/pkgsrc/), and can be considered the canonical resource.
1655
1656 [[!toc levels=3 ]]
1657
1658 ## Overview 
1659
1660 ### History 
1661 [Pkgsrc](http://www.pkgsrc.org) is a packaging system that was originally created for NetBSD. It has been ported to DragonFly, along with other operating systems.  Pkgsrc is very similar to FreeBSD's ports mechanism.
1662
1663 ### Overview
1664
1665 The pkgsrc collection supplies a collection of files designed to automate the process of compiling an application from source code. Remember that there are a number of steps you would normally carry out if you compiled a program yourself (downloading, unpacking, patching, compiling, installing). The files that make up a pkgsrc source collection contain all the necessary information to allow the system to do this for you. You run a handful of simple commands and the source code for the application is automatically downloaded, extracted, patched, compiled, and installed for you. In fact, the pkgsrc source subsystem can also be used to generate packages which can later be manipulated with `pkg_add` and the other package management commands that will be introduced shortly.
1666
1667 Pkgsrc understands ***dependencies***. Suppose you want to install an application that depends on a specific library being installed. Both the application and the library have been made available through the pkgsrc collection. If you use the `pkg_add` command or the pkgsrc subsystem to add the application, both will notice that the library has not been installed, and automatically install the library first. You might be wondering why pkgsrc® bothers with both. Binary packages and the source tree both have their own strengths, and which one you use will depend on your own preference.
1668
1669  **Binary Package Benefits** 
1670
1671 * A compressed package tarball is typically smaller than the compressed tarball containing the source code for the application.
1672
1673 * Packages do not require any additional compilation. For large applications, such as ***Mozilla***, ***KDE***, or ***GNOME*** this can be important, particularly if you are on a slow system.
1674
1675 * Packages do not require any understanding of the process involved in compiling software on DragonFly.
1676
1677 **Pkgsrc source Benefits** 
1678
1679 * Binary packages are normally compiled with conservative options, because they have to run on the maximum number of systems. By installing from the source, you can tweak the compilation options to (for example) generate code that is specific to a Pentium IV or Athlon processor.
1680
1681 * Some applications have compile time options relating to what they can and cannot do. For example, <i>Apache</i> can be configured with a wide variety of different built-in options. By building from the source you do not have to accept the default options, and can set them yourself. In some cases, multiple packages will exist for the same application to specify certain settings. For example, <i>vim</i> is available as a `vim` package and a `vim-gtk` package, depending on whether you have installed an X11 server. This sort of rough tweaking is possible with packages, but rapidly becomes impossible if an application has more than one or two different compile time options.
1682
1683 * The licensing conditions of some software distributions forbid binary distribution. They must be distributed as source code.
1684
1685 * Some people do not trust binary distributions. With source code, it is possible to check for any vulnerabilities built into the program before installing it to an otherwise secure system. Few people perform this much review, however.
1686
1687 * If you have local patches, you will need the source in order to apply them.
1688
1689 * Some people like having code around, so they can read it if they get bored, hack it, debug crashes, borrow from it (license permitting, of course), and so on.
1690
1691 To keep track of pkgsrc releases subscribe to the [NetBSD pkgsrc users mailing list](http://www.netbsd.org/MailingLists/pkgsrc-users) and the [NetBSD pkgsrc users mailing list](http://www.netbsd.org/MailingLists/tech-pkgsrc). It's also useful to watch the [DragonFly User related mailing list](http://leaf.dragonflybsd.org/mailarchive/) as errors with pkgsrc on DragonFly should be reported there.
1692
1693  **Warning:** Before installing any application, you should check http://www.pkgsrc.org/ for security issues related to your application.
1694
1695 Audit-packages will automatically check all installed applications for known vulnerabilities, a check will be also performed before any application build. Meanwhile, you can use the command `audit-packages -d` after you have installed some packages.
1696
1697 **Note:** Binary packages and source packages are effectively the same software and can be manipulated with the same pkg_* tools.  
1698
1699 ## Installing pkgsrc 
1700
1701 The basic pkgsrc tools are provided with every DragonFly system as part of installation.  However, you still need to download the pkgsrc tree for building applications with these tools.  
1702
1703 Set GITHOST in /etc/make.conf or set it as an environment variable to select a different download location, if desired. See mirrors page for available mirrors.
1704
1705 This downloads the stable version of the pkgsrc tree from the default mirror, if you didn't set GITHOST. As root:
1706
1707     # cd /usr
1708     # make pkgsrc-create
1709
1710 to fetch the intial pkgsrc repository from the net, or
1711
1712     # cd /usr
1713     # make pkgsrc-update
1714
1715 to update.
1716
1717 **Note**: If your DragonFly install is not up to date, you might have ended up with an old release of the pkgsrc tree.
1718
1719     # cd /usr/pkgsrc
1720     # git branch
1721
1722 will show what release you are on. See Tracking the stable branch for more information.
1723
1724 ### Tracking the stable branch
1725
1726 There are quarterly releases of pkgsrc that are specifically designed for stability.  You should in general follow these, rather than the bleeding edge pkgsrc. When a new branch is out you need to set up a local branch tracking that one. 'make pkgsrc-update' will not do this for you.
1727
1728 To see the available remote branches:
1729
1730     # cd /usr/pkgsrc 
1731     # git pull
1732     # git branch -r
1733
1734 To create a local branch, tracking the remote quarterly release:
1735
1736     # cd /usr/pkgsrc 
1737     # git branch pkgsrc-2010Q4 origin/pkgsrc-2010Q4
1738
1739 Branch naming format is 'pkgsrc-YYYYQX', where YYYY is the year and QX is quarters 1-4 of the year.  Check [pkgsrc.org](http://www.pkgsrc.org/) to see the name of the latest stable branch.
1740
1741 After adding a new branch, it can be downloaded with:
1742
1743     # cd /usr/pkgsrc 
1744     # git checkout pkgsrc-2010Q4
1745     # git pull
1746
1747 ## Dealing with pkgsrc packages
1748
1749 The following section explains how to find, install and remove pkgsrc packages.
1750
1751 ### Finding Your Application 
1752
1753 Before you can install any applications you need to know what you want, and what the application is called. DragonFly's list of available applications is growing all the time. Fortunately, there are a number of ways to find what you want:
1754
1755 Since DragonFly 1.11 [pkg_search(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=pkg_search&section1) is included in the base system.  [pkg_search(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=pkg_search&section=1) searches an already installed pkgsrc INDEX for for a given package name.  If pkgsrc is not installed or the INDEX file is missing, it fetches the [pkg_summary(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=pkg_summary&section=5) file.
1756
1757     # pkg_search fvwm
1758     fvwm-2.4.20nb1          Newer version of X11 Virtual window manager
1759     fvwm-2.5.24             Development version of X11 Virtual window manager
1760     fvwm-themes-0.6.2nb8    Configuration framework for fvwm2 with samples
1761     fvwm-wharf-1.0nb1       Copy of AfterStep's Wharf compatible with fvwm2
1762     fvwm1-1.24rnb1          Virtual window manager for X
1763
1764     # pkg_search -v fvwm-2.5
1765     Name    : fvwm-2.5.24-50
1766     Dir     : wm/fvwm-devel                                     
1767     Desc    : Development version of X11 Virtual window manager 
1768     URL     : any                                               
1769     Deps    : perl>#5.0 gettext-lib>0.14.5 [...]
1770
1771 Its also possible to issue the command
1772
1773     # cd /usr/pkgsrc/
1774     # bmake search key='package you are looking for'
1775
1776 from the `/usr/pkgsrc` directory.
1777
1778 It's also possible to browse website that show all the available pkgsrc packages, such as [http://pkgsrc.se/](http://pkgsrc.se) .
1779
1780 ### Installing applications
1781
1782 Downloading a binary package is almost always faster than building from source, but not all programs in pkgsrc can be redistributed as a binary.  In most cases, you will want to download a binary package if possible, and otherwise build from source if it's not available.  
1783
1784 The `bin-install` target on DragonFly (with pkgsrc from 2011/02/07 and later) will do just that:
1785
1786     # cd /usr/pkgsrc/misc/screen
1787     # bmake bin-install clean
1788
1789 This will download and install the appropriate `screen` binary package if it exists, and try building from source if it can't complete the download.
1790
1791 ### Installing applications, source only
1792
1793 Packages are built by going into the appropriate directory and issuing `bmake install clean`. For example, to build the *screen* package you need to issue the following commands.
1794
1795     # cd /usr/pkgsrc/misc/screen
1796     # bmake install clean
1797
1798 To find out the options that can affect how a program is built:
1799
1800     # bmake show-options
1801
1802 To change options:
1803
1804     # bmake PKG_OPTIONS.<package_name>="-option1 option2" install clean
1805
1806 Listing an option enables it.  Listing an option with a "-" before it disables the option.
1807
1808 To make these option changes permanent for every future build or upgrade of this package, put a similar line in `/usr/pkg/etc/mk.conf`:
1809
1810      . PKG_OPTIONS.<package_name>=-option1 option2
1811     
1812 ### Installing applications, binary only
1813
1814 Binary packages can be installed using *pkg_radd*:
1815
1816     # pkg_radd screen
1817
1818 This program works by setting the `PKG_PATH` environment variable to the appropriate path for the operating system and architecture to a remote repository of binary packages, and then using *pkg_add* to get packages. This will install most packages, but will not upgrade packages that are already installed.
1819
1820 You can manually set `BINPKG_BASE` and use *pkg_add* to get the same effect, using a different server.
1821
1822     # setenv BINPKG_BASE http://mirror-master.dragonflybsd.org/packages
1823     # pkg_add screen
1824
1825 #### Issues with pre-built packages
1826
1827 * The default remote repository for binary packages tracks quarterly pkgsrc releases, so your local install of pkgsrc should be the same quarterly release.
1828 * Some packages are not licensed for distribution in binary form, so they may be able to build on DragonFly but won't be available with *pkg_radd*.  If it fails, try going to that package's directory and install the package manually as described above.
1829 * If you upgrade to an new DEVELOPMENT version of DragonFly very early (i.e. shortly after the branch), it might be possible that *pkg_radd* fails to install packages. This is due the fact, that it takes some time to built binary packages and thus, there are no binary packages available on the mirrors yet. Usually you'll see an announcement on the lists once the first packages for DEVELOPMENT are ready.
1830
1831 ### List all installed applications 
1832
1833 To obtain a list of all the packages that are installed on your system:
1834
1835     # pkg_info
1836
1837 To see if certain packages have been installed, filter for the name of the package.  This example will show all *xorg*-related packages currently installed on the system:
1838
1839     # pkg_info | grep xorg
1840
1841 ### Removing packages
1842
1843 If a program was installed as a package:
1844
1845     # pkg_delete packagename
1846
1847 If a package was installed from the source files, you can also change to the directory they were installed from and issue the command:
1848
1849     # bmake deinstall
1850
1851 Note that these methods are effectively interchangeable.  Either will work whether the package was originally installed from source or binary.
1852
1853 #### Remove associated files needed for building a package 
1854
1855 To remove the work file from building a package, and the package's dependencies:
1856
1857     # bmake clean clean-depends
1858
1859 This can be combined with other steps:
1860
1861     # bmake install clean clean-depends
1862
1863 ## Upgrading packages 
1864
1865 There's a number of ways to upgrade pkgsrc; some of these are built in and some are packages installable with pkgsrc.  This list is not necessarily comprehensive.
1866
1867 ### Update pkgsrc system packages
1868
1869 **Note**: Sometimes basic pkgsrc tools; *bmake*, *pkg_install* and *bootstrap-mk-files* need to be upgraded.  However, they can't be deleted and replaced since you need that tool to accomplish replacement.  The solution is to build a separate package before deletion, and install that package. 
1870
1871     # cd /usr/pkgsrc/devel/bmake
1872     or
1873     # cd /usr/pkgsrc/pkgtools/pkg_install
1874     or 
1875     # cd /usr/pkgsrc/pkgtools/bootstrap-mk-files
1876     
1877     # env USE_DESTDIR=yes bmake package
1878     # bmake clean-depends clean
1879
1880 And go to the packages directory and install the binary package with
1881
1882     # cd /usr/pkgsrc/packages/All
1883     # pkg_add -u <pkg_name> (i.e. the name of the .tgz file).
1884
1885 ### bmake replace
1886 Performed in the `/usr/pkgsrc` directory that correlates with the installed package, the software is first built and then replaced.
1887
1888     # cd /usr/pkgsrc/chat/ircII
1889     # bmake replace
1890
1891 ### pkg_rolling-replace
1892
1893 *pkg_rolling-replace* replaces packages one by one and you can use it for a better way of package management. Actually it does `bmake replace` on one package at a time, sorting the packages being replaced according to their interdependencies, which avoids most duplicate rebuilds. Once *pkg_rolling-replace* is installed you can update the packages through the following steps.
1894
1895     # cd /usr && make pkgsrc-update
1896     # pkg_rolling-replace -u
1897
1898 ### pkgin
1899
1900 Downloads and installs binary packages.  Check the [[mirrors]] page for sites carrying binary packages to use with pkgin. You can run the following commands to get the packages updated. This assumes that *pkgin* is already configured. Please consult the documentation and the man page on how to do so.
1901
1902     # pkgin update
1903     # pkgin full-upgrade 
1904
1905 ### pkg_chk
1906
1907 It updates packages by removing them and rebuilding them.  Warning: programs are unavailable until a rebuild finishes.  If they don't rebuild, it won't work. *pkg_chk* requires a few steps in order to work correctly. They are listed here.
1908
1909     # pkg_chk -g  # make initial list of installed packages
1910     # pkg_chk -r  # remove all packages that are not up to date and packages that depend on them
1911     # pkg_chk -a  # install all missing packages (use binary packages, this is the default)
1912     # pkg_chk -as # install all missing packages (build from source)
1913
1914 The above process removes all packages at once and installs the missing packages one by one. This can cause longer disruption of services when the removed package has to wait a long time for its turn to get installed. 
1915
1916 ### pkg_add -u
1917
1918 Point at a local or online binary archive location to download and update packages.
1919
1920 ### rpkgmanager
1921
1922 This requires that you've set up rpkgmanager first. Read more about rpkgmanager [[here|docs/howtos/rpkgmanager/]].
1923
1924     # yes | rpkgmanager.rb
1925
1926 ## Start pkgsrc applications on system startup
1927
1928 Packages often install rc.d scripts to control software running on startup.  To specify where the rc.d scripts from the installed packages should go, add the following lines to your `/usr/pkg/etc/mk.conf` file:
1929
1930     RCD_SCRIPTS_DIR=/etc/rc.d
1931     PKG_RCD_SCRIPTS=YES
1932
1933 This option can be set in the environment to activate it for binary packages.  These packages will still have to be enabled in `/etc/rc.conf/` to run at boot.  If these options aren't set, the rc file will be placed in `/usr/pkg/share/examples/rc.d/` and will need to be manually copied over to `/etc/rc.d`.
1934
1935 Many other options can be set in this file; see `/usr/pkgsrc/mk/defaults/mk.conf` for examples.
1936
1937 ## Miscellaneous topics
1938
1939 ### Post-installation Activities 
1940
1941 After installing a new application you will normally want to read any documentation it may have included, edit any configuration files that are required, ensure that the application starts at boot time (if it is a daemon), and so on.
1942  The exact steps you need to take to configure each application will obviously be different. However, if you have just installed a new application and are wondering *What now?* These tips might help:
1943
1944 Use [pkg_info(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=pkg_info&section=1) to find out which files were installed, and where. For example, if you have just installed Foo_Package version 1.0.0, then this command
1945
1946     # pkg_info -L foopackage-1.0.0 | less
1947
1948 will show all the files installed by the package. Pay special attention to files in `man/` directories, which will be manual pages, `etc/` directories, which will be configuration files, and `doc/`, which will be more comprehensive documentation. If you are not sure which version of the application was just installed, a command like this
1949
1950     # pkg_info | grep -i foopackage
1951
1952 will find all the installed packages that have *foopackage* in the package name. Replace *foopackage* in your command line as necessary.
1953
1954 Once you have identified where the application's manual pages have been installed, review them using [man(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=man&section=1). Similarly, look over the sample configuration files, and any additional documentation that may have been provided. If the application has a web site, check it for additional documentation, frequently asked questions, and so forth. If you are not sure of the web site address it may be listed in the output from
1955
1956     # pkg_info foopackage-1.0.0
1957
1958 A `WWW:` line, if present, should provide a URL for the application's web site.
1959
1960 ### Dealing with Broken Packages 
1961
1962 If you come across a package that does not work for you, there are a few things you can do, including:
1963
1964   1. Fix it! The [pkgsrc Guide](http://www.netbsd.org/Documentation/pkgsrc/) includes detailed information on the ***pkgsrc®*** infrastructure so that you can fix the occasional broken package or even submit your own!
1965
1966   1. Send email to the maintainer of the package first. Type `bmake maintainer` or read the `Makefile` to find the maintainer's email address. Remember to include the name and version of the port (send the `$NetBSD:` line from the `Makefile`) and the output leading up to the error when you email the maintainer. If you do not get a response from the maintainer, you can try [users](http://leaf.dragonflybsd.org/mailarchive/) .
1967
1968   1. Grab a pre-built package from an [[mirror|mirrors]] site near you. 
1969
1970 ### What is WIP? 
1971
1972 Packages that can be built within the pkgsrc framework but are not yet necessarily ready for production use can be found in [http://pkgsrc-wip.sourceforge.net](http://pkgsrc-wip.sourceforge.net).  These packages need to be downloaded separately; check the website for details.  Packages in this collection are in development and may not build successfully.
1973
1974 ### Links
1975
1976 * More information: The pkgsrc guide [http://www.netbsd.org/Documentation/pkgsrc/](http://www.netbsd.org/Documentation/pkgsrc/)
1977
1978 * Web interface for searching packages: [http://www.pkgsrc.se](http://www.pkgsrc.se)
1979
1980 * Ways to upgrade packages [http://wiki-static.aydogan.net/How_to_upgrade_packages](http://wiki-static.aydogan.net/How_to_upgrade_packages)
1981
1982 * To search and/or report bugs against packages in pkgsrc, look at [http://www.netbsd.org/support/send-pr.html](http://www.netbsd.org/support/send-pr.html) - use category 'pkg'.
1983
1984 * The #pkgsrc IRC channel on Freenode
1985
1986 * The #dragonflybsd IRC channel on EFnet
1987
1988 # The X Window System 
1989 ***Updated for X.Org's X11 server by Ken Tom and Marc Fonvieille. Updated for DragonFly by Victor Balada Diaz. Updated for 2014 pkgng by Warren Postma***
1990
1991 [[!toc  levels=3]]
1992
1993 ## Synopsis 
1994
1995 This chapter will cover the installation and some configuration of the usual way of giving your Dragonfly BSD system an X-Windows style Graphical User Interface (GUI) and a modern Desktop Environment.  In Unix systems, the graphical drawing system is provided by the combination of an X11R6 compliant X-Windows Server, such as the X.org server, and other software such as Window Managers and Desktop Environments.  This multi-layered approach may be surprising to people coming from systems like the Mac or like Windows where these components are not so flexible, or provided by so many separately installed and configured pieces. 
1996
1997 For more information on the video hardware support in X.org, check the [X.org](http://www.x.org/) web site. If you have problems configuring your X server, just search the web. There are lots of tutorials and guides on how to set up your X properly, if the information in this page is not enough for your situation.
1998
1999 Before reading this chapter, you should know how to install additional third-party software. Read the  `dports` section of the documentation, for DragonFly 3.4 and later.
2000
2001 You may find the FreeBSD X Configuration instructions apply exactly and unchanged in DragonFly BSD.
2002 They are found [[here|http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/x-config.html]]
2003
2004 ## Understanding X 
2005
2006 ### What is X.Org
2007
2008 X.Org is the most popular free implementation of the X11 specification.  The X11 specification is an open standard, and there are other implementations, some commercial, and some free.
2009
2010 ### The Window Manager and the Desktop Environment
2011
2012 An X Server is a very low level piece of software.  It does not provide any way to move windows around or resize them. It does not provide a title bar on the top of your windows, or a dock, or any menus.
2013
2014 These things are the job, in the oldest style of X environment, of your window manager, or in more recent times, of a Desktop Environment.
2015
2016 Installing X.org by itself does not give you any window manager or any desktop environment. You will have to choose one and install it yourself. Until you select one, your system will not be usable.
2017
2018 There are dozens of window managers and desktop environments available for X. The most retro ones you might chose include `fvwm` and `twm` which have that retro 1980s workstation look and feel.  There are also window managers included inside modern desktop environments like XFCE, KDE and Gnome.  
2019
2020 If you are brand new and don't know what to do, select the XFCE4 desktop and follow those instructions.
2021 Every desktop environment and window manager also has a different configuration mechanism. Read your chosen environment's documentation to learn more.   Some are configured by text files alone, and some (like KDE and Gnome) have sophisticated graphical configuration utilities and "control panels".
2022
2023 Note that XFCE4 and Gnome and KDE do not require you to install any window manager as they include one automatically.
2024
2025 ## Installing X
2026
2027 **X.org**  is currently available in the DragonFly dports collection.
2028
2029 To install:
2030
2031     pkg install xorg-7.7
2032
2033 By the time you read this, it might be a newer version of xorg than 7.7, you can also try this general command:
2034
2035     pkg install xorg
2036
2037 ## Configuring X
2038
2039 You may need to add the following lines to `/etc/rc.conf` for regular PCs but you might not want to set these two lines to NO instead on a Virtual Machine as they cause problems in Dragonfly BSD 3.4 through 3.6:
2040
2041     hald_enable ="YES"
2042     dbus_enable= "YES" 
2043
2044 Also see below about enabling `moused` in rc.conf, which may be required for you to see your mouse pointer in X.
2045
2046 As of version 7.3, Xorg can often work without any configuration file by simply typing at prompt:
2047
2048     
2049
2050     % startx
2051
2052 If this does not work, or if the default configuration is not acceptable, then X11 must be configured manually.  For example, if X11 does not detect your mouse then you will not get a mouse pointer, you will get a desktop (either a color or a dotted-pattern) but moving your mouse will not result in you seeing a mouse pointer move around.  Also, you might get a garbled display, or no display at all. If any of these happen to you, you need to do some manual configuration of X.org, which means a configuration text file.
2053
2054 Configuration of X11 is a multi-step process. The first step is to build an initial configuration file. As the super user, simply run:
2055    
2056
2057     # Xorg -configure
2058
2059 This will generate an X11 configuration skeleton file in the `/root` directory called `xorg.conf.new` (whether you [su(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=su&amp;section=1) or do a direct login affects the inherited supervisor `$HOME` directory variable). The X11 program will attempt to probe the graphics hardware on the system and write a configuration file to load the proper drivers for the detected hardware on the target system.
2060
2061 The next step is to test the existing configuration to verify that  **X.org**  can work with the graphics hardware on the target system. To perform this task, type:
2062
2063    
2064
2065     # Xorg -config xorg.conf.new -retro
2066
2067 The -retro option is now required or you will only get a black desktop when testing. This retro mode is an empty X desktop with a dot pattern on the background and an X cursor in the center. If the mouse is working, you should be able to move it.
2068
2069 If a black and grey grid and an X mouse cursor appear, the configuration was successful. To exit the test, just press  **Ctrl** + **Alt** + **Backspace**  simultaneously.
2070
2071 **Note:** If the mouse does not work, you will need to first configure it before proceeding. This can usually be achieved by just using `/dev/sysmouse` as the input device in the config file and enabling `moused`:
2072
2073         # rcenable moused
2074
2075 Tune the `xorg.conf.new` configuration file to taste and move it to where [Xorg(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=xorg&section=1) can find it. This is typically `/etc/X11/xorg.conf` or `/usr/pkg/xorg/lib/X11/xorg.conf`.
2076
2077     
2078
2079 The X11 configuration process is now complete. You can start  **X.org**  with [startx(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=startx&section=1). The X11 server may also be started with the use of [xdm(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=xdm&section=1).
2080
2081 ## The X Display Manager 
2082
2083  ***Contributed by Seth Kingsley.***
2084
2085 ### Overview 
2086
2087  The X Display Manager ( **XDM** ) is an optional part of the X Window System that is used for login session management. This is useful for several types of situations, including minimal "X Terminals", desktops, and large network display servers. Since the X Window System is network and protocol independent, there are a wide variety of possible configurations for running X clients and servers on different machines connected by a network.  **XDM**  provides a graphical interface for choosing which display server to connect to, and entering authorization information such as a login and password combination.
2088
2089  Think of  **XDM**  as providing the same functionality to the user as the [getty(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=getty&section=8) utility (see [ Section 17.3.2](term.html#TERM-CONFIG) for details). That is, it performs system logins to the display being connected to and then runs a session manager on behalf of the user (usually an X window manager).  **XDM**  then waits for this program to exit, signaling that the user is done and should be logged out of the display. At this point,  **XDM**  can display the login and display chooser screens for the next user to login.
2090
2091 ### Using XDM 
2092
2093  The  **XDM**  daemon program is located in `/usr/pkg/bin/xdm`. This program can be run at any time as `root` and it will start managing the X display on the local machine. If  **XDM**  is to be run every time the machine boots up, a convenient way to do this is by adding an entry to `/etc/ttys`. For more information about the format and usage of this file, see [ Section 17.3.2.1](term.html#TERM-ETCTTYS). There is a line in the default `/etc/ttys` file for running the  **XDM**  daemon on a virtual terminal:
2094
2095      
2096
2097     ttyv8   "/usr/pkg/bin/xdm -nodaemon"  xterm   off secure
2098
2099  By default this entry is disabled; in order to enable it change field 5 from `off` to `on` and restart [init(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=init&section=8) using the directions in [ Section 17.3.2.2](term.html#TERM-HUP). The first field, the name of the terminal this program will manage, is `ttyv8`. This means that  **XDM**  will start running on the 9th virtual terminal.
2100
2101 ### Configuring XDM 
2102
2103  The  **XDM**  configuration directory is located in `/var/lib/xdm`. The sample configuration files are in `/usr/pkg/share/examples/xdm/`, in this directory there are several files used to change the behavior and appearance of  **XDM** . Typically these files will be found:
2104
2105 [[!table  data="""
2106 <tablestyle="width:100%">  **File**  |  **Description**
2107 <tablestyle="width:100%"> `Xaccess` | Client authorization ruleset.
2108 `Xresources` | Default X resource values.
2109 `Xservers` | List of remote and local displays to manage.
2110 `Xsession` | Default session script for logins.
2111 `Xsetup_`* | Script to launch applications before the login interface.
2112 `xdm-config` | Global configuration for all displays running on this machine.
2113 `xdm-errors` | Errors generated by the server program.
2114 `xdm-pid` | The process ID of the currently running XDM. |
2115
2116 """]]
2117
2118  Also in this directory are a few scripts and programs used to set up the desktop when  **XDM**  is running. The purpose of each of these files will be briefly described. The exact syntax and usage of all of these files is described in [xdm(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=xdm&section=1).
2119
2120  The default configuration is a simple rectangular login window with the hostname of the machine displayed at the top in a large font and "Login:" and "Password:" prompts below. This is a good starting point for changing the look and feel of  **XDM**  screens.
2121
2122 #### Xaccess 
2123
2124  The protocol for connecting to  **XDM**  controlled displays is called the X Display Manager Connection Protocol (XDMCP). This file is a ruleset for controlling XDMCP connections from remote machines. It is ignored unless the `xdm-config` is changed to listen for remote connections. By default, it does not allow any clients to connect.
2125
2126 #### Xresources 
2127
2128  This is an application-defaults file for the display chooser and the login screens. This is where the appearance of the login program can be modified. The format is identical to the app-defaults file described in the X11 documentation.
2129
2130 #### Xservers 
2131
2132  This is a list of the remote displays the chooser should provide as choices.
2133
2134 #### Xsession 
2135
2136  This is the default session script for  **XDM**  to run after a user has logged in. Normally each user will have a customized session script in `~/.xsession` that overrides this script.
2137
2138 #### Xsetup_* 
2139
2140  These will be run automatically before displaying the chooser or login interfaces. There is a script for each display being used, named `Xsetup_` followed by the local display number (for instance `Xsetup_0`). Typically these scripts will run one or two programs in the background such as `xconsole`.
2141
2142 #### xdm-config 
2143
2144  This contains settings in the form of app-defaults that are applicable to every display that this installation manages.
2145
2146 #### xdm-errors 
2147
2148  This contains the output of the X servers that  **XDM**  is trying to run. If a display that  **XDM**  is trying to start hangs for some reason, this is a good place to look for error messages. These messages are also written to the user's `~/.xsession-errors` file on a per-session basis.
2149
2150 ### Running a Network Display Server 
2151
2152  In order for other clients to connect to the display server, edit the access control rules, and enable the connection listener. By default these are set to conservative values. To make  **XDM**  listen for connections, first comment out a line in the `xdm-config` file:
2153
2154      
2155
2156     ! SECURITY: do not listen for XDMCP or Chooser requests
2157
2158     ! Comment out this line if you want to manage X terminals with xdm
2159
2160     DisplayManager.requestPort:     0
2161
2162  and then restart  **XDM** . Remember that comments in app-defaults files begin with a "!" character, not the usual "#". More strict access controls may be desired. Look at the example entries in `Xaccess`, and refer to the [xdm(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=xdm&section=1) manual page for further information.
2163
2164 ### Replacements for XDM 
2165
2166  Several replacements for the default  **XDM**  program exist. One of them,  **kdm**  (bundled with  **KDE** ) is described later in this chapter. The  **kdm**  display manager offers many visual improvements and cosmetic frills, as well as the functionality to allow users to choose their window manager of choice at login time.
2167
2168 ----
2169
2170 ## Desktop Environments 
2171
2172  ***Contributed by Valentino Vaschetto. ***
2173
2174  This section describes the different desktop environments available for X on FreeBSD. A ***desktop environment*** can mean anything ranging from a simple window manager to a complete suite of desktop applications, such as  **KDE**  or  **GNOME** .
2175
2176 ### GNOME 
2177
2178 #### About GNOME 
2179
2180    **GNOME**  is a user-friendly desktop environment that enables users to easily use and configure their computers.  **GNOME**  includes a panel (for starting applications and displaying status), a desktop (where data and applications can be placed), a set of standard desktop tools and applications, and a set of conventions that make it easy for applications to cooperate and be consistent with each other. Users of other operating systems or environments should feel right at home using the powerful graphics-driven environment that  **GNOME**  provides.
2181
2182 #### Installing GNOME 
2183
2184    **GNOME**  can be easily installed from a package or from the pkgsrc framework:
2185
2186   To install the  **GNOME**  package from the network, simply type:
2187
2188     # pkg install gnome-desktop
2189
2190   To build  **GNOME**  from source, if you have the pkgsrc tree on your system:      
2191
2192     # cd /usr/pkgsrc/meta-pkgs/gnome
2193
2194     # bmake install clean
2195
2196   Once  **GNOME**  is installed, the X server must be told to start  **GNOME**  instead of a default window manager.
2197
2198   The easiest way to start  **GNOME**  is with  **GDM** , the GNOME Display Manager.  **GDM** , which is installed as a part of the  **GNOME**  desktop (but is disabled by default), can be enabled by adding `gdm_enable="YES"` to `/etc/rc.conf`. Once you have rebooted,  **GNOME**  will start automatically once you log in -- no further configuration is necessary.
2199
2200 **GNOME**  may also be started from the command-line by properly configuring a file named `.xinitrc`. If a custom `.xinitrc` is already in place, simply replace the line that starts the current window manager with one that starts  **/usr/pkg/bin/gnome-session**  instead. If nothing special has been done to the configuration file, then it is enough simply to type:
2201
2202       
2203
2204     % echo "/usr/pkg/bin/gnome-session" > ~/.xinitrc
2205
2206   Next, type `startx`, and the  **GNOME**  desktop environment will be started.
2207
2208 **Note:** If an older display manager, like  **XDM** , is being used, this will not work. Instead, create an executable `.xsession` file with the same command in it. To do this, edit the file and replace the existing window manager command with  **/usr/pkg/bin/gnome-session** :
2209
2210         
2211
2212     % echo "#!/bin/sh" > ~/.xsession
2213
2214     % echo "/usr/pkg/bin/gnome-session" >> ~/.xsession
2215
2216     % chmod +x ~/.xsession
2217
2218   Yet another option is to configure the display manager to allow choosing the window manager at login time; the section on [ KDE details](x11-wm.html#X11-WM-KDE-DETAILS) explains how to do this for  **kdm** , the display manager of  **KDE** .
2219
2220 #### Anti-aliased Fonts with GNOME 
2221
2222   X11 supports anti-aliasing via its ***RENDER*** extension. GTK+ 2.0 and greater (the toolkit used by  **GNOME** ) can make use of this functionality. Configuring anti-aliasing is described in [ Section 5.5.3](x-fonts.html#ANTIALIAS).
2223   
2224   So, with up-to-date software, anti-aliasing is possible within the  **GNOME**  desktop. Just go to  **Applications->Desktop Preferences->Font** , and select either Best shapes, Best contrast, or Subpixel smoothing (LCDs). For a GTK+ application that is not part of the  **GNOME**  desktop, set the environment variable `GDK_USE_XFT` to `1` before launching the program.
2225
2226 ### KDE 
2227
2228 #### About KDE 
2229
2230   **KDE**  is an easy to use contemporary desktop environment. Some of the things that  **KDE**  brings to the user are:
2231
2232 * A beautiful contemporary desktop
2233
2234 * A desktop exhibiting complete network transparency
2235
2236 * An integrated help system allowing for convenient, consistent access to help on the use of the  **KDE**  desktop and its applications
2237
2238 * Consistent look and feel of all  **KDE**  applications
2239
2240 * Standardized menu and toolbars, keybindings, color-schemes, etc.
2241
2242 * Internationalization:  **KDE**  is available in more than 40 languages
2243
2244 * Centralized consisted dialog driven desktop configuration
2245
2246 * A great number of useful  **KDE**  applications
2247
2248   **KDE**  comes with a web browser called  **Konqueror** , which represents a solid competitor to other existing web browsers on UNIX® systems. More information on  **KDE**  can be found on the [KDE website](http://www.kde.org/).
2249
2250 #### Installing KDE 
2251
2252  Just as with  **GNOME**  or any other desktop environment, the easiest way to install  **KDE**  is through the pkgsrc framework or from a package:
2253
2254  To install the  **KDE**  4.10 package from the network, simply type:
2255
2256    # pkg install kde-4.10
2257
2258  To build  **KDE**  from source, using the pkgsrc framework:
2259
2260     # cd /usr/pkgsrc/meta-pkgs/kde3
2261
2262     # bmake install clean
2263
2264  After  **KDE**  has been installed, the X server must be told to launch this application instead of the default window manager. This is accomplished by editing the `.xinitrc` file:
2265
2266     % echo "exec startkde" > ~/.xinitrc
2267
2268  Now, whenever the X Window System is invoked with `startx`,  **KDE**  will be the desktop.
2269
2270  If a display manager such as  **XDM**  is being used, the configuration is slightly different. Edit the `.xsession` file instead. Instructions for  **kdm**  are described later in this chapter.
2271
2272 #### More Details on KDE 
2273
2274  Now that  **KDE**  is installed on the system, most things can be discovered through the help pages, or just by pointing and clicking at various menus. Windows® or Mac® users will feel quite at home.
2275
2276  The best reference for  **KDE**  is the on-line documentation.  **KDE**  comes with its own web browser,  **Konqueror** , dozens of useful applications, and extensive documentation. The remainder of this section discusses the technical items that are difficult to learn by random exploration.
2277
2278 #### The KDE Display Manager 
2279
2280  An administrator of a multi-user system may wish to have a graphical login screen to welcome users. [ XDM](x-xdm.html) can be used, as described earlier. However,  **KDE**  includes an alternative,  **kdm** , which is designed to look more attractive and include more login-time options. In particular, users can easily choose (via a menu) which desktop environment ( **KDE** ,  **GNOME** , or something else) to run after logging on.
2281
2282  To enable  **kdm** , the `ttyv8` entry in `/etc/ttys` has to be adapted. The line should look as follows:
2283   
2284
2285     ttyv8 "/usr/pkg/bin/kdm -nodaemon" xterm on secure
2286
2287     
2288 ### XFce 
2289
2290 #### About XFce 
2291
2292   **XFce**  is a desktop environment based on the GTK+ toolkit used by  **GNOME** , but is much more lightweight and meant for those who want a simple, efficient desktop which is nevertheless easy to use and configure. Visually, it looks very much like  **CDE** , found on commercial UNIX systems. Some of  **XFce** 's features are:
2293
2294 * A simple, easy-to-handle desktop
2295
2296 * Fully configurable via mouse, with drag and drop, etc
2297
2298 * Main panel similar to  **CDE** , with menus, applets and applications launchers
2299
2300 * Integrated window manager, file manager, sound manager,  **GNOME**  compliance module, and other things
2301
2302 * Themeable (since it uses GTK+)
2303
2304 * Fast, light and efficient: ideal for older/slower machines or machines with memory limitations
2305
2306 More information on  **XFce**  can be found on the [XFce website](http://www.xfce.org/).
2307
2308 #### Installing XFce 
2309
2310  A binary package for  **XFce**  exists. To install, simply type:
2311
2312     # pkg install xfce
2313
2314 This should install the main xfce4 desktop package, and most of the required components.
2315
2316  Alternatively, to build from source, use the pkgsrc framework:
2317
2318    
2319
2320     # cd /usr/pkgsrc/meta-pkgs/xfce4
2321
2322     # bmake install clean
2323
2324  Now, tell the X server to launch  **XFce**  the next time X is started. Simply type this:
2325
2326     % echo "/usr/pkg/bin/startxfce4" > ~/.xinitrc
2327
2328  The next time X is started,  **XFce**  will be the desktop. As before, if a display manager like  **XDM**  is being used, create an `.xsession`, as described in the section on [ GNOME](x11-wm.html#X11-WM-GNOME), but with the `/usr/pkg/bin/startxfce4` command; or, configure the display manager to allow choosing a desktop at login time, as explained in the section on [ kdm](x11-wm.html#X11-WM-KDE-KDM).
2329
2330 <!-- XXX: FreeBSD's handbook has a nice user-oriented section about X applications here. maybe we should have one, too -->
2331
2332 ----
2333
2334 # Configuration and Tuning 
2335
2336 ***Written by Chern Lee.  Based on a tutorial written by Mike Smith.  Also based on [tuning(7)](http://leaf.dragonflybsd.org/cgi/web-man?command#tuning&section7) written by Matt Dillon.***
2337
2338 [[!toc  levels=3]]
2339
2340 ##Synopsis 
2341
2342 One of the important aspects of DragonFly is system configuration. Correct system configuration will help prevent headaches during future upgrades. This chapter will explain much of the DragonFly configuration process, including some of the parameters which can be set to tune a DragonFly system.
2343
2344 After reading this chapter, you will know:
2345
2346 * How to efficiently work with file systems and swap partitions.
2347
2348 * The basics of `rc.conf` configuration and `rc.d` startup systems.
2349
2350 * How to configure and test a network card.
2351
2352 * How to configure virtual hosts on your network devices.
2353
2354 * How to use the various configuration files in `/etc`.
2355
2356 * How to tune DragonFly using `sysctl` variables.
2357
2358 * How to tune disk performance and modify kernel limitations.
2359
2360 Before reading this chapter, you should:
2361
2362 * Understand UNIX® and DragonFly basics ([Chapter 3](basics.html)).
2363
2364 * Be familiar with the basics of kernel configuration/compilation ([Chapter 9](kernelconfig.html)).
2365
2366 ## Initial Configuration 
2367
2368 ### Partition Layout 
2369
2370 #### Base Partitions 
2371
2372 When laying out file systems with [disklabel(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=disklabel&section=8) remember that hard drives transfer data faster from the outer tracks to the inner. Thus smaller and heavier-accessed file systems should be closer to the outside of the drive, while larger partitions like `/usr` should be placed toward the inner. It is a good idea to create partitions in a similar order to: root, swap, `/var`, `/usr`.
2373 <!-- XXX: on the advent of SSDs, do we really need to talk about this stuff? Who knows where on the platter the partitions land, considering that a hard disk has multiple platters? -->
2374
2375 The size of `/var` reflects the intended machine usage. `/var` is used to hold mailboxes, log files, and printer spools. Mailboxes and log files can grow to unexpected sizes depending on how many users exist and how long log files are kept. Most users would never require a gigabyte, but remember that `/var/tmp` must be large enough to contain packages.
2376
2377 The `/usr` partition holds much of the files required to support the system, the pkgsrc® collection (recommended) and the source code (optional). At least 2 gigabytes would be recommended for this partition.
2378
2379 When selecting partition sizes, keep the space requirements in mind. Running out of space in one partition while barely using another can be a hassle.
2380
2381 #### Swap Partition 
2382
2383 As a rule of thumb, the swap partition should be about double the size of system memory (RAM). For example, if the machine has 128 megabytes of memory, the swap file should be 256 megabytes. Systems with less memory may perform better with more swap. Less than 256 megabytes of swap is not recommended and memory expansion should be considered. The kernel's VM paging algorithms are tuned to perform best when the swap partition is at least two times the size of main memory. Configuring too little swap can lead to inefficiencies in the VM page scanning code and might create issues later if more memory is added.
2384 <!-- XXX: do we really recommend double the RAM for swap? IMHO the amount of RAM should be more than enough -->
2385
2386 On larger systems with multiple SCSI disks (or multiple IDE disks operating on different controllers), it is recommend that a swap is configured on each drive (up to four drives). The swap partitions should be approximately the same size. The kernel can handle arbitrary sizes but internal data structures scale to 4 times the largest swap partition. Keeping the swap partitions near the same size will allow the kernel to optimally stripe swap space across disks. Large swap sizes are fine, even if swap is not used much. It might be easier to recover from a runaway program before being forced to reboot.
2387
2388 #### Why Partition? 
2389
2390 Several users think a single large partition will be fine, but there are several reasons why this is a bad idea. First, each partition has different operational characteristics and separating them allows the file system to tune accordingly. For example, the root and `/usr` partitions are read-mostly, without much writing. While a lot of reading and writing could occur in `/var` and `/var/tmp`.
2391
2392 By properly partitioning a system, fragmentation introduced in the smaller write heavy partitions will not bleed over into the mostly-read partitions. Keeping the write-loaded partitions closer to the disk's edge, will increase I/O performance in the partitions where it occurs the most. Now while I/O performance in the larger partitions may be needed, shifting them more toward the edge of the disk will not lead to a significant performance improvement over moving `/var` to the edge. Finally, there are safety concerns. A smaller, neater root partition which is mostly read-only has a greater chance of surviving a bad crash.
2393 <!-- XXX: again, same story about the edges of disks... -->
2394
2395 CategoryHandbook
2396
2397 CategoryHandbook-configuration
2398
2399 ## Core Configuration 
2400
2401 The principal location for system configuration information is within `/etc/rc.conf`. This file contains a wide range of configuration information, principally used at system startup to configure the system. Its name directly implies this; it is configuration information for the `rc*` files.
2402
2403 An administrator should make entries in the `rc.conf` file to override the default settings from `/etc/defaults/rc.conf`. The defaults file should not be copied verbatim to `/etc` - it contains default values, not examples. All system-specific changes should be made in the `rc.conf` file itself.
2404
2405 A number of strategies may be applied in clustered applications to separate site-wide configuration from system-specific configuration in order to keep administration overhead down. The recommended approach is to place site-wide configuration into another file, such as `/etc/rc.conf.site`, and then include this file into `/etc/rc.conf`, which will contain only system-specific information.
2406
2407 As `rc.conf` is read by [sh(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=sh&section=1) it is trivial to achieve this. For example:
2408
2409 * rc.conf:
2410
2411         hostname="node15.example.com"
2412
2413         network_interfaces="fxp0 lo0"
2414
2415         ifconfig_fxp0="inet 10.1.1.1"
2416
2417   
2418
2419 * rc.conf.site: 
2420
2421         defaultrouter="10.1.1.254"
2422
2423         saver="daemon"
2424
2425         blanktime="100"
2426
2427   
2428
2429 The `rc.conf.site` file can then be distributed to every system using `rsync` or a similar program, while the `rc.conf` file remains unique.
2430
2431 Upgrading the system using `make world` will not overwrite the `rc.conf` file, so system configuration information will not be lost.
2432
2433 CategoryHandbook
2434
2435 CategoryHandbook-configuration
2436
2437 ## Application Configuration 
2438
2439 Typically, installed applications have their own configuration files, with their own syntax, etc. It is important that these files be kept separate from the base system, so that they may be easily located and managed by the package management tools.
2440
2441 Typically, these files are installed in `/usr/pkg/etc`. In the case where an application has a large number of configuration files, a subdirectory will be created to hold them.
2442
2443 Normally, when a port or package is installed, sample configuration files are also installed. These are usually identified with a `.default` suffix. If there are no existing configuration files for the application, they will be created by copying the `.default` files.
2444
2445 For example, consider the contents of the directory `/usr/pkg/etc/httpd`:
2446
2447     
2448
2449     total 90
2450
2451     -rw-r--r--  1 root  wheel  -   34K Jan 11 12:04 httpd.conf
2452
2453     -rw-r--r--  1 root  wheel  -   13K Jan 11 12:02 magic
2454
2455     -rw-r--r--  1 root  wheel  -   28K Jan 11 12:02 mime.types
2456
2457     -rw-r--r--  1 root  wheel  -   11K Jan 11 12:02 ssl.conf
2458
2459     
2460     
2461     
2462     
2463     
2464
2465 ## Starting Services 
2466
2467 It is common for a system to host a number of services. These may be started in several different fashions, each having different advantages.
2468
2469 Software installed from a port or the packages collection will often place a script in `/usr/pkg/share/examples/rc.d` which is invoked at system startup with a `start` argument, and at system shutdown with a `stop` argument. This is the recommended way for starting system-wide services that are to be run as `root`, or that expect to be started as `root`. These scripts are registered as part of the installation of the package, and will be removed when the package is removed.
2470
2471 A generic startup script in `/usr/pkg/share/examples/rc.d` looks like:
2472
2473     
2474
2475     #!/bin/sh
2476
2477     echo -n ' FooBar'
2478
2479     
2480
2481     case "$1" in
2482
2483     start)
2484
2485             /usr/pkg/bin/foobar
2486
2487             ;;
2488
2489     stop)
2490
2491             kill -9 `cat /var/run/foobar.pid`
2492
2493             ;;
2494
2495     
2496 *)
2497
2498             echo "Usage: `basename $0` {start|stop}" >&2
2499
2500             exit 64
2501
2502             ;;
2503
2504     esac
2505
2506     
2507
2508     exit 0
2509
2510     
2511
2512 <!-- XXX: I don't think we actually look in /usr/pkg/share/examples/rc.d -->
2513
2514 The startup scripts of DragonFly will look in `/usr/pkg/share/examples/rc.d` for scripts that have an `.sh` extension and are executable by `root`. Those scripts that are found are called with an option `start` at startup, and `stop` at shutdown to allow them to carry out their purpose. So if you wanted the above sample script to be picked up and run at the proper time during system startup, you should save it to a file called `FooBar.sh` in `/usr/local/etc/rc.d` and make sure it is executable. You can make a shell script executable with [chmod(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=chmod&section=1) as shown below:
2515
2516     
2517
2518     # chmod 755 "FooBar.sh"
2519
2520 Some services expect to be invoked by [inetd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=inetd&section=8) when a connection is received on a suitable port. This is common for mail reader servers (POP and IMAP, etc.). These services are enabled by editing the file `/etc/inetd.conf`. See [inetd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=inetd&section=8) for details on editing this file.
2521
2522 Some additional system services may not be covered by the toggles in `/etc/rc.conf`. These are traditionally enabled by placing the command(s) to invoke them in `/etc/rc.local` (which does not exist by default). Note that `rc.local` is generally regarded as the location of last resort; if there is a better place to start a service, do it there.
2523
2524  **Note:** Do ***not*** place any commands in `/etc/rc.conf`. To start daemons, or run any commands at boot time, place a script in `/usr/pkg/share/examples/rc.d` instead.
2525
2526 It is also possible to use the [cron(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=cron&section=8) daemon to start system services. This approach has a number of advantages, not least being that because [cron(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=cron&section=8) runs these processes as the owner of the `crontab`, services may be started and maintained by non-`root` users.
2527
2528 This takes advantage of a feature of [cron(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=cron&section=8): the time specification may be replaced by `@reboot`, which will cause the job to be run when [cron(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=cron&section=8) is started shortly after system boot.
2529
2530 CategoryHandbook
2531
2532 CategoryHandbook-configuration
2533
2534 ## Configuring the cron Utility 
2535
2536 <!-- XXX: can't really comment on this. someone please revise it -->
2537
2538 ***Contributed by Tom Rhodes. ***
2539
2540 One of the most useful utilities in DragonFly is [cron(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=cron&section=8). The `cron` utility runs in the background and constantly checks the `/etc/crontab` file. The `cron` utility also checks the `/var/cron/tabs` directory, in search of new `crontab` files. These `crontab` files store information about specific functions which `cron` is supposed to perform at certain times.
2541
2542 The `cron` utility uses two different types of configuration files, the system crontab and user crontabs. The only difference between these two formats is the sixth field. In the system crontab, the sixth field is the name of a user for the command to run as. This gives the system crontab the ability to run commands as any user. In a user crontab, the sixth field is the command to run, and all commands run as the user who created the crontab; this is an important security feature.
2543
2544  **Note:** User crontabs allow individual users to schedule tasks without the need for root privileges. Commands in a user's crontab run with the permissions of the user who owns the crontab.
2545
2546 The `root` user can have a user crontab just like any other user. This one is different from `/etc/crontab` (the system crontab). Because of the system crontab, there's usually no need to create a user crontab for `root`.
2547
2548 Let us take a look at the `/etc/crontab` file (the system crontab):
2549
2550     
2551
2552     # /etc/crontab - root's crontab for DragonFly
2553
2554     #
2555
2556     #                                                                  (1)
2557
2558     #
2559
2560     SHELL=/bin/sh
2561
2562     PATH=/etc:/bin:/sbin:/usr/bin:/usr/sbin                            (2)
2563
2564     HOME=/var/log
2565
2566     #
2567
2568     #
2569
2570     #minute     hour    mday    month   wday    who     command            (3)
2571
2572     #
2573
2574     #
2575
2576     
2577     */5 *       *       *       *       root    /usr/libexec/atrun (4)
2578
2579  1. Like most DragonFly configuration files, the `#` character represents a comment. A comment can be placed in the file as a reminder of what and why a desired action is performed. Comments cannot be on the same line as a command or else they will be interpreted as part of the command; they must be on a new line. Blank lines are ignored.
2580
2581  1. First, the environment must be defined. The equals (`=`) character is used to define any environment settings, as with this example where it is used for the `SHELL`, `PATH`, and `HOME` options. If the shell line is omitted, `cron` will use the default, which is `sh`. If the `PATH` variable is omitted, no default will be used and file locations will need to be absolute. If `HOME` is omitted, `cron` will use the invoking users home directory.
2582
2583  1. This line defines a total of seven fields. Listed here are the values `minute`, `hour`, `mday`, `month`, `wday`, `who`, and `command`. These are almost all self explanatory. `minute` is the time in minutes the command will be run. `hour` is similar to the `minute` option, just in hours. `mday` stands for day of the month. `month` is similar to `hour` and `minute`, as it designates the month. The `wday` option stands for day of the week. All these fields must be numeric values, and follow the twenty-four hour clock. The `who` field is special, and only exists in the `/etc/crontab` file. This field specifies which user the command should be run as. When a user installs his or her `crontab` file, they will not have this option. Finally, the `command` option is listed. This is the last field, so naturally it should designate the command to be executed.
2584
2585  1. This last line will define the values discussed above. Notice here we have a `*/5` listing, followed by several more `*` characters. These `*` characters mean ***first-last***, and can be interpreted as ***every*** time. So, judging by this line, it is apparent that the `atrun` command is to be invoked by `root` every five minutes regardless of what day or month it is. For more information on the `atrun` command, see the [atrun(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=atrun&section=8) manual page.Commands can have any number of flags passed to them; however, commands which extend to multiple lines need to be broken with the backslash ***\*** continuation character.
2586
2587 This is the basic set up for every `crontab` file, although there is one thing different about this one. Field number six, where we specified the username, only exists in the system `/etc/crontab` file. This field should be omitted for individual user `crontab` files.
2588
2589 ### Installing a Crontab 
2590
2591  **Important:** You must not use the procedure described here to edit/install the system crontab. Simply use your favorite editor: the `cron` utility will notice that the file has changed and immediately begin using the updated version. If you use `crontab` to load the `/etc/crontab` file you may get an error like `root: not found` because of the system crontab's additional user field.
2592
2593 To install a freshly written user `crontab`, first use your favorite editor to create a file in the proper format, and then use the `crontab` utility. The most common usage is:
2594
2595     
2596
2597     % crontab crontab-file
2598
2599 In this example, `crontab-file` is the filename of a `crontab` that was previously created.
2600
2601 There is also an option to list installed `crontab` files: just pass the `-l` option to `crontab` and look over the output.
2602
2603 For users who wish to begin their own crontab file from scratch, without the use of a template, the `crontab -e` option is available. This will invoke the selected editor with an empty file. When the file is saved, it will be automatically installed by the `crontab` command.
2604
2605 If you later want to remove your user `crontab` completely, use `crontab` with the `-r` option.
2606
2607 ## Using rc under DragonFly 
2608
2609 ***Contributed by Tom Rhodes. ***
2610
2611 DragonFly uses the NetBSD® `rc.d` system for system initialization. Users should notice the files listed in the `/etc/rc.d` directory. Many of these files are for basic services which can be controlled with the `start`, `stop`, and `restart` options. For instance, [sshd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=sshd&section=8&manpath=OpenBSD+3.3) can be restarted with the following command:
2612
2613     
2614
2615     # /etc/rc.d/sshd restart
2616
2617 This procedure is similar for other services. Of course, services are usually started automatically as specified in [rc.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=rc.conf&section=5). For example, enabling the Network Address Translation daemon at startup is as simple as adding the following line to `/etc/rc.conf`:
2618
2619     natd_enable="YES"
2620
2621 If a `natd_enable="NO"` line is already present, then simply change the `NO` to `YES`. The rc scripts will automatically load any other dependent services during the next reboot, as described below.
2622
2623 Another way to add services to the automatic startup/shutdown is to type, for example for `natd`,
2624
2625      # rcenable natd
2626
2627 Since the `rc.d` system is primarily intended to start/stop services at system startup/shutdown time, the standard `start`, `stop` and `restart` options will only perform their action if the appropriate `/etc/rc.conf` variables are set. For instance the above `sshd restart` command will only work if `sshd_enable` is set to `YES` in `/etc/rc.conf`. To `start`, `stop` or `restart` a service regardless of the settings in `/etc/rc.conf`, the commands should be prefixed with ***force***. For instance to restart `sshd` regardless of the current `/etc/rc.conf` setting, execute the following command:
2628
2629     
2630
2631     # /etc/rc.d/sshd forcerestart
2632
2633 It is easy to check if a service is enabled in `/etc/rc.conf` by running the appropriate `rc.d` script with the option `rcvar`. Thus, an administrator can check that `sshd` is in fact enabled in `/etc/rc.conf` by running:
2634
2635     
2636
2637     # /etc/rc.d/sshd rcvar
2638
2639     # sshd
2640
2641     $sshd_enable=YES
2642
2643  **Note:** The second line (`# sshd`) is the output from the `rc.d` script, not a `root` prompt.
2644
2645 To determine if a service is running, a `status` option is available. For instance to verify that `sshd` is actually started:
2646
2647     
2648
2649     # /etc/rc.d/sshd status
2650
2651     sshd is running as pid 433.
2652
2653 It is also possible to `reload` a service. This will attempt to send a signal to an individual service, forcing the service to reload its configuration files. In most cases this means sending the service a `SIGHUP` signal.
2654
2655 The  **rcNG**  structure is used both for network services and system initialization. Some services are run only at boot; and the RCNG system is what triggers them.
2656
2657 Many system services depend on other services to function properly. For example, NIS and other RPC-based services may fail to start until after the `rpcbind` (portmapper) service has started. To resolve this issue, information about dependencies and other meta-data is included in the comments at the top of each startup script. The [rcorder(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=rcorder&section=8) program is then used to parse these comments during system initialization to determine the order in which system services should be invoked to satisfy the dependencies. The following words may be included at the top of each startup file:
2658
2659 * `PROVIDE`: Specifies the services this file provides.
2660
2661 * `REQUIRE`: Lists services which are required for this service. This file will run ***after*** the specified services.
2662
2663 * `BEFORE`: Lists services which depend on this service. This file will run ***before*** the specified services.
2664
2665 * KEYWORD: When [rcorder(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=rcorder&section=8) uses the `-k` option, then only the rc.d files matching this keyword are used. [(1)](#FTN.AEN4751) For example, when using `-k shutdown`, only the `rc.d` scripts defining the `shutdown` keyword are used.
2666
2667   With the `-s` option, [rcorder(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=rcorder&section=8) will skip any `rc.d` script defining the corresponding keyword to skip. For example, scripts defining the `nostart` keyword are skipped at boot time.
2668
2669 By using this method, an administrator can easily control system services without the hassle of ***runlevels*** like some other UNIX® operating systems.
2670
2671 Additional information about the DragonFly `rc.d` system can be found in the [rc(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=rc&section=8), [rc.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=rc.conf&section=5), and [rc.subr(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=rc.subr&section=8) manual pages.
2672
2673 ### Using DragonFly's rcrun(8) 
2674
2675 Besides the methods described above DragonFly supports [rcrun(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=rcrun&section=8) to control rc(8) scripts.  [rcrun(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=rcrun&section=8) provides a number of command for controlling rc(8)
2676
2677 scripts.  The ***start***, ***forcestart***, ***faststart***, ***stop***, ***restart***, and ***rcvar*** commands are just passed to the scripts.  See rc(8) for more information on these commands.
2678
2679 The remaining commands are:
2680
2681 [[!table  data="""
2682   **disable**  | Sets the corresponding `_enable` variable in rc.conf(5) to ***NO*** and runs the stop command. 
2683   **enable**   | Sets the corresponding `_enable` variable in rc.conf(5) to ***YES*** and runs the start command. 
2684   **list**  | Shows the status of the specified scripts.  If no argument is specified, the status of all scripts is shown. |
2685
2686 """]]
2687
2688 To enable the [dntpd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=dntpd&section=8) service, you can use:
2689
2690      # rcenable dntpd
2691      
2692  
2693
2694 To check if [dntpd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=dntpd&section=8) is running you can use the following command:
2695
2696     
2697
2698     # rclist dntpd
2699
2700     rcng_dntpd=stopped
2701
2702 To start [dntpd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=dntpd&section=8):
2703
2704     
2705
2706     # rcstart dntpd
2707
2708     Running /etc/rc.d/dntpd start
2709
2710     Starting dntpd.
2711
2712 Restart and stop works the same way:
2713
2714     
2715
2716     # rcrestart dntpd
2717
2718     Stopping dntpd.
2719
2720     Starting dntpd.
2721
2722     
2723
2724     # rcstop dntpd
2725
2726     Stopping dntpd.
2727
2728 If a service is not enabled in `/etc/rc.conf`, but you want it start anyway, execute the following:
2729
2730     
2731
2732     # rcforce dntpd
2733
2734     Running /etc/rc.d/dntpd forcestart
2735
2736     Starting dntpd.
2737
2738 #### Notes 
2739
2740 [[!table  data="""
2741 <tablestyle="width:100%"> [(1)](configtuning-rcng.html#AEN4751) | Previously this was used to define *BSD dependent features.
2742 | |
2743
2744 """]]
2745
2746 ## Setting Up Network Interface Cards 
2747
2748 ***Contributed by Marc Fonvieille. ***
2749
2750 Nowadays we can not think about a computer without thinking about a network connection. Adding and configuring a network card is a common task for any DragonFly administrator.
2751
2752 ### Locating the Correct Driver 
2753
2754 Before you begin, you should know the model of the card you have, the chip it uses, and whether it is a PCI or ISA card. DragonFly supports a wide variety of both PCI and ISA cards. Check the Hardware Compatibility List for your release to see if your card is supported.
2755
2756 Once you are sure your card is supported, you need to determine the proper driver for the card. The file `/usr/src/sys/i386/conf/LINT` will give you the list of network interfaces drivers with some information about the supported chipsets/cards. If you have doubts about which driver is the correct one, read the manual page of the driver. The manual page will give you more information about the supported hardware and even the possible problems that could occur.
2757
2758 If you own a common card, most of the time you will not have to look very hard for a driver. Drivers for common network cards are present in the `GENERIC` kernel, so your card should show up during boot, like so:
2759
2760     
2761
2762     dc0: <82c169 PNIC 10/100BaseTX> port 0xa000-0xa0ff mem 0xd3800000-0xd38
2763
2764     000ff irq 15 at device 11.0 on pci0
2765
2766     dc0: Ethernet address: 00:a0:cc:da:da:da
2767
2768     miibus0: <MII bus> on dc0
2769
2770     ukphy0: <Generic IEEE 802.3u media interface> on miibus0
2771
2772     ukphy0:  10baseT, 10baseT-FDX, 100baseTX, 100baseTX-FDX, auto
2773
2774     dc1: <82c169 PNIC 10/100BaseTX> port 0x9800-0x98ff mem 0xd3000000-0xd30
2775
2776     000ff irq 11 at device 12.0 on pci0
2777
2778     dc1: Ethernet address: 00:a0:cc:da:da:db
2779
2780     miibus1: <MII bus> on dc1
2781
2782     ukphy1: <Generic IEEE 802.3u media interface> on miibus1
2783
2784     ukphy1:  10baseT, 10baseT-FDX, 100baseTX, 100baseTX-FDX, auto
2785
2786 In this example, we see that two cards using the [dc(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=dc&section=4) driver are present on the system.
2787
2788 To use your network card, you will need to load the proper driver. This may be accomplished in one of two ways. The easiest way is to simply load a kernel module for your network card with [kldload(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=kldload&section=8). A module is not available for all network card drivers (ISA cards and cards using the [ed(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=ed&section=4) driver, for example). Alternatively, you may statically compile the support for your card into your kernel. Check `/usr/src/sys/i386/conf/LINT` and the manual page of the driver to know what to add in your kernel configuration file. For more information about recompiling your kernel, please see [kernelconfig.html Chapter 9]. If your card was detected at boot by your kernel (`GENERIC`) you do not have to build a new kernel.
2789
2790 ### Configuring the Network Card 
2791
2792 Once the right driver is loaded for the network card, the card needs to be configured. As with many other things, the network card may have been configured at installation time.
2793
2794 To display the configuration for the network interfaces on your system, enter the following command:
2795
2796     
2797
2798     % ifconfig
2799
2800     dc0: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> mtu 1500
2801
2802             inet 192.168.1.3 netmask 0xffffff00 broadcast 192.168.1.255
2803
2804             ether 00:a0:cc:da:da:da
2805
2806             media: Ethernet autoselect (100baseTX <full-duplex>)
2807
2808             status: active
2809
2810     dc1: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> mtu 1500
2811
2812             inet 10.0.0.1 netmask 0xffffff00 broadcast 10.0.0.255
2813
2814             ether 00:a0:cc:da:da:db
2815
2816             media: Ethernet 10baseT/UTP
2817
2818             status: no carrier
2819
2820     lp0: flags=8810<POINTOPOINT,SIMPLEX,MULTICAST> mtu 1500
2821
2822     lo0: flags=8049<UP,LOOPBACK,RUNNING,MULTICAST> mtu 16384
2823
2824             inet 127.0.0.1 netmask 0xff000000
2825
2826     tun0: flags=8010<POINTOPOINT,MULTICAST> mtu 1500
2827
2828  **Note:** Note that entries concerning IPv6 (`inet6` etc.) were omitted in this example.
2829
2830 In this example, the following devices were displayed:
2831
2832 * `dc0`: The first Ethernet interface
2833
2834 * `dc1`: The second Ethernet interface
2835
2836 * `lp0`: The parallel port interface
2837
2838 * `lo0`: The loopback device
2839
2840 * `tun0`: The tunnel device used by  **ppp** 
2841
2842 DragonFly uses the driver name followed by the order in which one the card is detected at the kernel boot to name the network card, starting the count at zero. For example, `sis2` would be the third network card on the system using the [sis(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=sis&section=4) driver.
2843
2844 In this example, the `dc0` device is up and running. The key indicators are:
2845
2846   1. `UP` means that the card is configured and ready.
2847
2848   1. The card has an Internet (`inet`) address (in this case `192.168.1.3`).
2849
2850   1. It has a valid subnet mask (`netmask`; `0xffffff00` is the same as `255.255.255.0`).
2851
2852   1. It has a valid broadcast address (in this case, `192.168.1.255`).
2853
2854   1. The MAC address of the card (`ether`) is `00:a0:cc:da:da:da`
2855
2856   1. The physical media selection is on autoselection mode (`media: Ethernet autoselect (100baseTX <full-duplex>)`). We see that `dc1` was configured to run with `10baseT/UTP` media. For more information on available media types for a driver, please refer to its manual page.
2857
2858   1. The status of the link (`status`) is `active`, i.e. the carrier is detected. For `dc1`, we see `status: no carrier`. This is normal when an Ethernet cable is not plugged into the card.
2859
2860 If the [ifconfig(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=ifconfig&section=8) output had shown something similar to:
2861
2862     
2863
2864     dc0: flags=8843<BROADCAST,SIMPLEX,MULTICAST> mtu 1500
2865
2866                 ether 00:a0:cc:da:da:da
2867
2868 it would indicate the card has not been configured.
2869
2870 To configure your card, you need `root` privileges. The network card configuration can be done from the command line with [ifconfig(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=ifconfig&section=8) as root.
2871
2872     
2873
2874     # ifconfig dc0 inet 192.168.1.3 netmask 255.255.255.0
2875
2876 Manually configuring the care has the disadvantage that you would have to do it after each reboot of the system. The file `/etc/rc.conf` is where to add the network card's configuration.
2877
2878 Open `/etc/rc.conf` in your favorite editor. You need to add a line for each network card present on the system, for example in our case, we added these lines:
2879
2880     
2881
2882     ifconfig_dc0="inet 192.168.1.3 netmask 255.255.255.0"
2883
2884     ifconfig_dc1="inet 10.0.0.1 netmask 255.255.255.0 media 10baseT/UTP"
2885
2886 You have to replace `dc0`, `dc1`, and so on, with the correct device for your cards, and the addresses with the proper ones. You should read the card driver and [ifconfig(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ifconfig&section8) manual pages for more details about the allowed options and also [rc.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=rc.conf&section=5) manual page for more information on the syntax of `/etc/rc.conf`.
2887
2888 If you configured the network during installation, some lines about the network card(s) may be already present. Double check `/etc/rc.conf` before adding any lines.
2889
2890 You will also have to edit the file `/etc/hosts` to add the names and the IP addresses of various machines of the LAN, if they are not already there. For more information please refer to [hosts(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=hosts&section=5) and to `/usr/share/examples/etc/hosts`.
2891
2892 ### Testing and Troubleshooting 
2893
2894 Once you have made the necessary changes in `/etc/rc.conf`, you should reboot your system. This will allow the change(s) to the interface(s) to be applied, and verify that the system restarts without any configuration errors.
2895
2896 Once the system has been rebooted, you should test the network interfaces.
2897
2898 #### Testing the Ethernet Card 
2899
2900 To verify that an Ethernet card is configured correctly, you have to try two things. First, ping the interface itself, and then ping another machine on the LAN.
2901
2902 First test the local interface:
2903
2904     
2905
2906     % ping -c5 192.168.1.3
2907
2908     PING 192.168.1.3 (192.168.1.3): 56 data bytes
2909
2910     64 bytes from 192.168.1.3: icmp_seq#0 ttl64 time=0.082 ms
2911
2912     64 bytes from 192.168.1.3: icmp_seq#1 ttl64 time=0.074 ms
2913
2914     64 bytes from 192.168.1.3: icmp_seq#2 ttl64 time=0.076 ms
2915
2916     64 bytes from 192.168.1.3: icmp_seq#3 ttl64 time=0.108 ms
2917
2918     64 bytes from 192.168.1.3: icmp_seq#4 ttl64 time=0.076 ms
2919
2920     
2921
2922     --- 192.168.1.3 ping statistics ---
2923
2924     5 packets transmitted, 5 packets received, 0% packet loss
2925
2926     round-trip min/avg/max/stddev = 0.074/0.083/0.108/0.013 ms
2927
2928 Now we have to ping another machine on the LAN:
2929
2930     
2931
2932     % ping -c5 192.168.1.2
2933
2934     PING 192.168.1.2 (192.168.1.2): 56 data bytes
2935
2936     64 bytes from 192.168.1.2: icmp_seq#0 ttl64 time=0.726 ms
2937
2938     64 bytes from 192.168.1.2: icmp_seq#1 ttl64 time=0.766 ms
2939
2940     64 bytes from 192.168.1.2: icmp_seq#2 ttl64 time=0.700 ms
2941
2942     64 bytes from 192.168.1.2: icmp_seq#3 ttl64 time=0.747 ms
2943
2944     64 bytes from 192.168.1.2: icmp_seq#4 ttl64 time=0.704 ms
2945
2946     
2947
2948     --- 192.168.1.2 ping statistics ---
2949
2950     5 packets transmitted, 5 packets received, 0% packet loss
2951
2952     round-trip min/avg/max/stddev = 0.700/0.729/0.766/0.025 ms
2953
2954 You could also use the machine name instead of `192.168.1.2` if you have set up the `/etc/hosts` file.
2955
2956 #### Troubleshooting 
2957
2958 Troubleshooting hardware and software configurations is always a pain, and a pain which can be alleviated by checking the simple things first. Is your network cable plugged in? Have you properly configured the network services? Did you configure the firewall correctly? Is the card you are using supported by DragonFly? Always check the hardware notes before sending off a bug report. Update your version of DragonFly to the latest PREVIEW version. Check the mailing list archives, or perhaps search the Internet.
2959
2960 If the card works, yet performance is poor, it would be worthwhile to read over the [tuning(7)](http://leaf.dragonflybsd.org/cgi/web-man?command=tuning&section=7) manual page. You can also check the network configuration as incorrect network settings can cause slow connections.
2961
2962 Some users experience one or two ***device timeouts***, which is normal for some cards. If they continue, or are bothersome, you may wish to be sure the device is not conflicting with another device. Double check the cable connections. Perhaps you may just need to get another card.
2963
2964 At times, users see a few ***`watchdog timeout`*** errors. The first thing to do here is to check your network cable. Many cards require a PCI slot which supports Bus Mastering. On some old motherboards, only one PCI slot allows it (usually slot 0). Check the network card and the motherboard documentation to determine if that may be the problem.
2965
2966 ***`No route to host`*** messages occur if the system is unable to route a packet to the destination host. This can happen if no default route is specified, or if a cable is unplugged. Check the output of `netstat -rn` and make sure there is a valid route to the host you are trying to reach. If there is not, read on to [advanced-networking.html Chapter 19].
2967
2968 ***`ping: sendto: Permission denied`*** error messages are often caused by a misconfigured firewall. If `ipfw` is enabled in the kernel but no rules have been defined, then the default policy is to deny all traffic, even ping requests! Read on to [firewalls.html Section 10.7] for more information.
2969
2970 Sometimes performance of the card is poor, or below average. In these cases it is best to set the media selection mode from `autoselect` to the correct media selection. While this usually works for most hardware, it may not resolve this issue for everyone. Again, check all the network settings, and read over the [tuning(7)](http://leaf.dragonflybsd.org/cgi/web-man?command=tuning&section=7) manual page.
2971
2972 ## Virtual Hosts 
2973
2974 A very common use of DragonFly is virtual site hosting, where one server appears to the network as many servers. This is achieved by assigning multiple network addresses to a single interface.
2975
2976 A given network interface has one ***real*** address, and may have any number of ***alias*** addresses. These aliases are normally added by placing alias entries in `/etc/rc.conf`.
2977
2978 An alias entry for the interface `fxp0` looks like:
2979
2980     
2981
2982     ifconfig_fxp0_alias0="inet xxx.xxx.xxx.xxx netmask xxx.xxx.xxx.xxx"
2983
2984 Note that alias entries must start with `alias0` and proceed upwards in order, (for example, `_alias1`, `_alias2`, and so on). The configuration process will stop at the first missing number.
2985
2986 The calculation of alias netmasks is important, but fortunately quite simple. For a given interface, there must be one address which correctly represents the network's netmask. Any other addresses which fall within this network must have a netmask of all `1`s (expressed as either `255.255.255.255` or `0xffffffff`).
2987
2988 For example, consider the case where the `fxp0` interface is connected to two networks, the `10.1.1.0` network with a netmask of `255.255.255.0` and the `202.0.75.16` network with a netmask of `255.255.255.240`. We want the system to appear at `10.1.1.1` through `10.1.1.5` and at `202.0.75.17` through `202.0.75.20`. As noted above, only the first address in a given network range (in this case, `10.0.1.1` and `202.0.75.17`) should have a real netmask; all the rest (`10.1.1.2` through `10.1.1.5` and `202.0.75.18` through `202.0.75.20`) must be configured with a netmask of `255.255.255.255`.
2989
2990 The following entries configure the adapter correctly for this arrangement:
2991
2992     
2993
2994      ifconfig_fxp0="inet 10.1.1.1 netmask 255.255.255.0"
2995
2996      ifconfig_fxp0_alias0="inet 10.1.1.2 netmask 255.255.255.255"
2997
2998      ifconfig_fxp0_alias1="inet 10.1.1.3 netmask 255.255.255.255"
2999
3000      ifconfig_fxp0_alias2="inet 10.1.1.4 netmask 255.255.255.255"
3001
3002      ifconfig_fxp0_alias3="inet 10.1.1.5 netmask 255.255.255.255"
3003
3004      ifconfig_fxp0_alias4="inet 202.0.75.17 netmask 255.255.255.240"
3005
3006      ifconfig_fxp0_alias5="inet 202.0.75.18 netmask 255.255.255.255"
3007
3008      ifconfig_fxp0_alias6="inet 202.0.75.19 netmask 255.255.255.255"
3009
3010      ifconfig_fxp0_alias7="inet 202.0.75.20 netmask 255.255.255.255"
3011
3012 CategoryHandbook
3013
3014 CategoryHandbook-configuration
3015
3016 ## Configuration Files 
3017
3018 ### /etc Layout 
3019
3020 There are a number of directories in which configuration information is kept. These include:
3021
3022 [[!table  data="""
3023  `/etc` | Generic system configuration information; data here is system-specific. 
3024  `/etc/defaults` | Default versions of system configuration files. 
3025  `/etc/mail` | Extra [sendmail(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=sendmail&section=8) configuration, other MTA configuration files. 
3026  `/etc/ppp` | Configuration for both user- and kernel-ppp programs. 
3027  `/etc/namedb` | Default location for [named(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=named&section=8) data. Normally `named.conf` and zone files are stored here. 
3028  `/usr/local/etc` | Configuration files for installed applications. May contain per-application subdirectories. 
3029  `/usr/local/etc/rc.d` | Start/stop scripts for installed applications. 
3030  `/var/db` | Automatically generated system-specific database files, such as the package database, the locate database, and so on |
3031
3032 """]]
3033
3034 ### Hostnames 
3035
3036 #### /etc/resolv.conf 
3037
3038 `/etc/resolv.conf` dictates how DragonFly's resolver accesses the Internet Domain Name System (DNS).
3039
3040 The most common entries to `resolv.conf` are:
3041
3042 [[!table  data="""
3043  `nameserver` | The IP address of a name server the resolver should query. The servers are queried in the order listed with a maximum of three.
3044  `search` | Search list for hostname lookup. This is normally determined by the domain of the local hostname. 
3045  `domain` | The local domain name. |
3046
3047 """]]
3048
3049 A typical `resolv.conf`:
3050
3051     
3052
3053     search example.com
3054
3055     nameserver 147.11.1.11
3056
3057     nameserver 147.11.100.30
3058
3059  **Note:** Only one of the `search` and `domain` options should be used.
3060
3061 If you are using DHCP, [dhclient(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=dhclient&section=8) usually rewrites `resolv.conf` with information received from the DHCP server.
3062
3063 #### /etc/hosts 
3064
3065 `/etc/hosts` is a simple text database reminiscent of the old Internet. It works in conjunction with DNS and NIS providing name to IP address mappings. Local computers connected via a LAN can be placed in here for simplistic naming purposes instead of setting up a [named(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=named&section=8) server. Additionally, `/etc/hosts` can be used to provide a local record of Internet names, reducing the need to query externally for commonly accessed names.
3066
3067     
3068
3069     #
3070
3071     #
3072
3073     # Host Database
3074
3075     # This file should contain the addresses and aliases
3076
3077     # for local hosts that share this file.
3078
3079     # In the presence of the domain name service or NIS, this file may
3080
3081     # not be consulted at all; see /etc/nsswitch.conf for the resolution order.
3082
3083     #
3084
3085     #
3086
3087     ::1                     localhost localhost.my.domain myname.my.domain
3088
3089     127.0.0.1               localhost localhost.my.domain myname.my.domain
3090
3091     #
3092
3093     # Imaginary network.
3094
3095     #10.0.0.2               myname.my.domain myname
3096
3097     #10.0.0.3               myfriend.my.domain myfriend
3098
3099     #
3100
3101     # According to RFC 1918, you can use the following IP networks for
3102
3103     # private nets which will never be connected to the Internet:
3104
3105     #
3106
3107     #       10.0.0.0        -   10.255.255.255
3108
3109     #       172.16.0.0      -   172.31.255.255
3110
3111     #       192.168.0.0     -   192.168.255.255
3112
3113     #
3114
3115     # In case you want to be able to connect to the Internet, you need
3116
3117     # real official assigned numbers.  PLEASE PLEASE PLEASE do not try
3118
3119     # to invent your own network numbers but instead get one from your
3120
3121     # network provider (if any) or from the Internet Registry (ftp to
3122
3123     # rs.internic.net, directory `/templates').
3124
3125     #
3126
3127 `/etc/hosts` takes on the simple format of:
3128
3129     
3130
3131     [Internet address] [official hostname] [alias1] [alias2] ...
3132
3133 For example:
3134
3135     
3136
3137     10.0.0.1 myRealHostname.example.com myRealHostname foobar1 foobar2
3138
3139 Consult [hosts(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=hosts&section=5) for more information.
3140
3141 ### Log File Configuration 
3142
3143 #### syslog.conf 
3144
3145 `syslog.conf` is the configuration file for the [syslogd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=syslogd&section=8) program. It indicates which types of `syslog` messages are logged to particular log files.
3146
3147     
3148
3149     #
3150
3151     #
3152
3153     #       Spaces ARE valid field separators in this file. However,
3154
3155     #       other *nix-like systems still insist on using tabs as field
3156
3157     #       separators. If you are sharing this file between systems, you
3158
3159     #       may want to use only tabs as field separators here.
3160
3161     #       Consult the syslog.conf(5) manual page.
3162
3163     
3164 *.err;kern.debug;auth.notice;mail.crit          /dev/console
3165
3166     *.notice;kern.debug;lpr.info;mail.crit;news.err /var/log/messages
3167
3168     security.*                                      /var/log/security
3169
3170     mail.info                                       /var/log/maillog
3171
3172     lpr.info                                        /var/log/lpd-errs
3173
3174     cron.*                                          /var/log/cron
3175
3176     
3177 *.err                                           root
3178
3179     *.notice;news.err                               root
3180
3181     *.alert                                         root
3182
3183     *.emerg                                         *
3184
3185     # uncomment this to log all writes to /dev/console to /var/log/console.log
3186
3187     #console.info                                   /var/log/console.log
3188
3189     # uncomment this to enable logging of all log messages to /var/log/all.log
3190
3191     #*.*                                            /var/log/all.log
3192
3193     # uncomment this to enable logging to a remote log host named loghost
3194
3195     #*.*                                            @loghost
3196
3197     # uncomment these if you're running inn
3198
3199     # news.crit                                     /var/log/news/news.crit
3200
3201     # news.err                                      /var/log/news/news.err
3202
3203     # news.notice                                   /var/log/news/news.notice
3204
3205     !startslip
3206
3207     
3208 *.*                                             /var/log/slip.log
3209
3210     !ppp
3211
3212     
3213 *.*                                             /var/log/ppp.log
3214
3215 Consult the [syslog.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=syslog.conf&section=5) manual page for more information.
3216
3217 #### newsyslog.conf 
3218
3219 `newsyslog.conf` is the configuration file for [newsyslog(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=newsyslog&section=8), a program that is normally scheduled to run by [cron(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=cron&section=8). [newsyslog(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=newsyslog&section=8) determines when log files require archiving or rearranging. `logfile` is moved to `logfile.0`, `logfile.0` is moved to `logfile.1`, and so on. Alternatively, the log files may be archived in [gzip(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=gzip&section=1) format causing them to be named: `logfile.0.gz`, `logfile.1.gz`, and so on.
3220
3221 `newsyslog.conf` indicates which log files are to be managed, how many are to be kept, and when they are to be touched. Log files can be rearranged and/or archived when they have either reached a certain size, or at a certain periodic time/date.
3222
3223     
3224
3225     # configuration file for newsyslog
3226
3227     #
3228
3229     #
3230
3231     # filename          [owner:group]    mode count size when [ZB] [/pid_file] [sig_num]
3232
3233     /var/log/cron                           600  3     100  *     Z
3234
3235     /var/log/amd.log                        644  7     100  *     Z
3236
3237     /var/log/kerberos.log                   644  7     100  *     Z
3238
3239     /var/log/lpd-errs                       644  7     100  *     Z
3240
3241     /var/log/maillog                        644  7     *    @T00  Z
3242
3243     /var/log/sendmail.st                    644  10    *    168   B
3244
3245     /var/log/messages                       644  5     100  *     Z
3246
3247     /var/log/all.log                        600  7     *    @T00  Z
3248
3249     /var/log/slip.log                       600  3     100  *     Z
3250
3251     /var/log/ppp.log                        600  3     100  *     Z
3252
3253     /var/log/security                       600  10    100  *     Z
3254
3255     /var/log/wtmp                           644  3     *    @01T05 B
3256
3257     /var/log/daily.log                      640  7     *    @T00  Z
3258
3259     /var/log/weekly.log                     640  5     1    $W6D0 Z
3260
3261     /var/log/monthly.log                    640  12    *    $M1D0 Z
3262
3263     /var/log/console.log                    640  5     100  *     Z
3264
3265 Consult the [newsyslog(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=newsyslog&section=8) manual page for more information.
3266
3267 ### sysctl.conf 
3268
3269 `sysctl.conf` looks much like `rc.conf`. Values are set in a `variable=value` form. The specified values are set after the system goes into multi-user mode. Not all variables are settable in this mode.
3270
3271 A sample `sysctl.conf` turning off logging of fatal signal exits and letting Linux programs know they are really running under DragonFly:
3272
3273     
3274
3275     kern.logsigexit=0       # Do not log fatal signal exits (e.g. sig 11)
3276
3277     compat.linux.osname=DragonFly
3278
3279     compat.linux.osrelease=4.3-STABLE
3280
3281     
3282     
3283     
3284     
3285     
3286 ## Tuning with sysctl 
3287
3288 [sysctl(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=sysctl&section=8) is an interface that allows you to make changes to a running DragonFly system. This includes many advanced options of the TCP/IP stack and virtual memory system that can dramatically improve performance for an experienced system administrator. Over five hundred system variables can be read and set using [sysctl(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=sysctl&section=8).
3289
3290 At its core, [sysctl(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=sysctl&section=8) serves two functions: to read and to modify system settings.
3291
3292 To view all readable variables:
3293
3294     
3295
3296     % sysctl -a
3297
3298 To read a particular variable, for example, `kern.maxproc`:
3299
3300     
3301
3302     % sysctl kern.maxproc
3303
3304     kern.maxproc: 1044
3305
3306 To set a particular variable, use the intuitive `***variable***`=`***value***` syntax:
3307
3308     
3309
3310     # sysctl kern.maxfiles=5000
3311
3312     kern.maxfiles: 2088 -< 5000
3313
3314 Settings of sysctl variables are usually either strings, numbers, or booleans (a boolean being `1` for yes or a `0` for no).
3315
3316 If you want to set automatically some variables each time the machine boots, add them to the `/etc/sysctl.conf` file. For more information see the [sysctl.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=sysctl.conf&section=5) manual page and the [configtuning-configfiles.html#CONFIGTUNING-SYSCTLCONF Section 6.10.4].
3317
3318 ### sysctl(8) Read-only 
3319
3320 ***Contributed by Tom Rhodes. ***
3321
3322 In some cases it may be desirable to modify read-only [sysctl(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=sysctl&section=8) values. While this is not recommended, it is also sometimes unavoidable.
3323
3324 For instance on some laptop models the [cardbus(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=cardbus&section=4) device will not probe memory ranges, and fail with errors which look similar to:
3325
3326     
3327
3328     cbb0: Could not map register memory
3329
3330     device_probe_and_attach: cbb0 attach returned 12
3331
3332 Cases like the one above usually require the modification of some default [sysctl(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=sysctl&section=8) settings which are set read only. To overcome these situations a user can put [sysctl(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=sysctl&section=8) ***OIDs*** in their local `/boot/loader.conf`. Default settings are located in the `/boot/defaults/loader.conf` file.
3333
3334 Fixing the problem mentioned above would require a user to set `hw.pci.allow_unsupported_io_range=1` in the aforementioned file. Now [cardbus(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=cardbus&section=4) will work properly.
3335
3336 ## Tuning Disks 
3337
3338 ### Sysctl Variables 
3339
3340 #### `vfs.vmiodirenable` 
3341
3342 The `vfs.vmiodirenable` sysctl variable may be set to either 0 (off) or 1 (on); it is 1 by default. This variable controls how directories are cached by the system. Most directories are small, using just a single fragment (typically 1 K) in the file system and less (typically 512 bytes) in the buffer cache. With this variable turned off (to 0), the buffer cache will only cache a fixed number of directories even if ou have a huge amount of memory. When turned on (to 1), this sysctl allows the buffer cache to use the VM Page Cache to cache the directories, making all the memory available for caching directories. However, the minimum in-core memory used to cache a directory is the physical page size (typically 4 K) rather than 512  bytes. We recommend keeping this option on if you are running any services which manipulate large numbers of files. Such services can include web caches, large mail systems, and news systems. Keeping this option on will generally not reduce performance even with the wasted memory but you should experiment to find out.
3343
3344 #### `vfs.write_behind` 
3345
3346 The `vfs.write_behind` sysctl variable defaults to `1` (on). This tells the file system to issue media writes as full clusters are collected, which typically occurs when writing large sequential files. The idea is to avoid saturating the buffer cache with dirty buffers when it would not benefit I/O performance. However, this may stall processes and under certain circumstances you may wish to turn it off.
3347
3348 #### `vfs.hirunningspace` 
3349
3350 The `vfs.hirunningspace` sysctl variable determines how much outstanding write I/O may be queued to disk controllers system-wide at any given instance. The default is usually sufficient but on machines with lots of disks you may want to bump it up to four or five ***megabytes***. Note that setting too high a value (exceeding the buffer cache's write threshold) can lead to extremely bad clustering performance. Do not set this value arbitrarily high! Higher write values may add latency to reads occurring at the same time.
3351
3352 There are various other buffer-cache and VM page cache related sysctls. We do not recommend modifying these values. The VM system does an extremely good job of automatically tuning itself.
3353
3354 #### `vm.swap_idle_enabled` 
3355
3356 The `vm.swap_idle_enabled` sysctl variable is useful in large multi-user systems where you have lots of users entering and leaving the system and lots of idle processes. Such systems tend to generate a great deal of continuous pressure on free memory reserves. Turning this feature on and tweaking the swapout hysteresis (in idle seconds) via `vm.swap_idle_threshold1` and `vm.swap_idle_threshold2` allows you to depress the priority of memory pages associated with idle processes more quickly then the normal pageout algorithm. This gives a helping hand to the pageout daemon. Do not turn this option on unless you need it, because the tradeoff you are making is essentially pre-page memory sooner rather than later; thus eating more swap and disk bandwidth. In a small system this option will have a determinable effect but in a large system that is already doing moderate paging this option allows the VM system to stage whole processes into and out of memory easily.
3357
3358 #### `hw.ata.wc` 
3359
3360 IDE drives lie about when a write completes. With IDE write caching turned on, IDE hard drives not only write data to disk out of order, but will sometimes delay writing some blocks indefinitely when under heavy disk loads. A crash or power failure may cause serious file system corruption. Turning off write caching will remove the danger of this data loss, but will also cause disk operations to proceed ***very slowly.*** Change this only if prepared to suffer with the disk slowdown.
3361
3362 Changing this variable must be done from the boot loader at boot time. Attempting to do it after the kernel boots will have no effect.
3363
3364 For more information, please see [ata(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=ata&section=4) manual page.
3365
3366 <!-- XXX: add some more sysctls, e.g. relating to AHCI, nata, ... -->
3367
3368 ### Soft Updates 
3369
3370 **Note** that soft updates are only available on UFS.
3371
3372 The [tunefs(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=tunefs&section=8) program can be used to fine-tune a UFS file system. This program has many different options, but for now we are only concerned with toggling Soft Updates on and off, which is done by:
3373
3374     
3375
3376     # tunefs -n enable /filesystem
3377
3378     # tunefs -n disable /filesystem
3379
3380 A filesystem cannot be modified with [tunefs(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=tunefs&section=8) while it is mounted. A good time to enable Soft Updates is before any partitions have been mounted, in single-user mode.
3381
3382  **Note:** It is possible to enable Soft Updates at filesystem creation time, through use of the `-U` option to [newfs(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=newfs&section=8).
3383
3384 Soft Updates drastically improves meta-data performance, mainly file creation and deletion, through the use of a memory cache. We recommend to use Soft Updates on all of your file systems. There are two downsides to Soft Updates that you should be aware of: First, Soft Updates guarantees filesystem consistency in the case of a crash but could very easily be several seconds (even a minute!) behind updating the physical disk. If your system crashes you may lose more work than otherwise. Secondly, Soft Updates delays the freeing of filesystem blocks. If you have a filesystem (such as the root filesystem) which is almost full, performing a major update, such as `make installworld`, can cause the filesystem to run out of space and the update to fail.
3385
3386 #### More Details about Soft Updates 
3387 <!-- XXX: consider axing this section -->
3388
3389 There are two traditional approaches to writing a file systems meta-data back to disk. (Meta-data updates are updates to non-content data like inodes or directories.)
3390
3391 Historically, the default behavior was to write out meta-data updates synchronously. If a directory had been changed, the system waited until the change was actually written to disk. The file data buffers (file contents) were passed through the buffer cache and backed up to disk later on asynchronously. The advantage of this implementation is that it operates safely. If there is a failure during an update, the meta-data are always in a consistent state. A file is either created completely or not at all. If the data blocks of a file did not find their way out of the buffer cache onto the disk by the time of the crash, [fsck(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#fsck&section8) is able to recognize this and repair the filesystem by setting the file length to 0. Additionally, the implementation is clear and simple. The disadvantage is that meta-data changes are slow. An `rm -r`, for instance, touches all the files in a directory sequentially, but each directory change (deletion of a file) will be written synchronously to the disk. This includes updates to the directory itself, to the inode table, and possibly to indirect blocks allocated by the file. Similar considerations apply for unrolling large hierarchies (`tar -x`).
3392
3393 The second case is asynchronous meta-data updates. This is the default for Linux/ext2fs and `mount -o async` for *BSD ufs. All meta-data updates are simply being passed through the buffer cache too, that is, they will be intermixed with the updates of the file content data. The advantage of this implementation is there is no need to wait until each meta-data update has been written to disk, so all operations which cause huge amounts of meta-data updates work much faster than in the synchronous case. Also, the implementation is still clear and simple, so there is a low risk for bugs creeping into the code. The disadvantage is that there is no guarantee at all for a consistent state of the filesystem. If there is a failure during an operation that updated large amounts of meta-data (like a power failure, or someone pressing the reset button), the filesystem will be left in an unpredictable state. There is no opportunity to examine the state of the filesystem when the system comes up again; the data blocks of a file could already have been written to the disk while the updates of the inode table or the associated directory were not. It is actually impossible to implement a `fsck` which is able to clean up the resulting chaos (because the necessary information is not available on the disk). If the filesystem has been damaged beyond repair, the only choice is to use [newfs(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#newfs&section8) on it and restore it from backup.
3394
3395 The usual solution for this problem was to implement ***dirty region logging***, which is also referred to as ***journaling***, although that term is not used consistently and is occasionally applied to other forms of transaction logging as well. Meta-data updates are still written synchronously, but only into a small region of the disk. Later on they will be moved to their proper location. Because the logging area is a small, contiguous region on the disk, there are no long distances for the disk heads to move, even during heavy operations, so these operations are quicker than synchronous updates. Additionally the complexity of the implementation is fairly limited, so the risk of bugs being present is low. A disadvantage is that all meta-data are written twice (once into the logging region and once to the proper location) so for normal work, a performance ***pessimization*** might result. On the other hand, in case of a crash, all pending meta-data operations can be quickly either rolled-back or completed from the logging area after the system comes up again, resulting in a fast filesystem startup.
3396
3397 Kirk McKusick, the developer of Berkeley FFS, solved this problem with Soft Updates: all pending meta-data updates are kept in memory and written out to disk in a sorted sequence (***ordered meta-data updates***). This has the effect that, in case of heavy meta-data operations, later updates to an item ***catch*** the earlier ones if the earlier ones are still in memory and have not already been written to disk. So all operations on, say, a directory are generally performed in memory before the update is written to disk (the data blocks are sorted according to their position so that they will not be on the disk ahead of their meta-data). If the system crashes, this causes an implicit ***log rewind***: all operations which did not find their way to the disk appear as if they had never happened. A consistent filesystem state is maintained that appears to be the one of 30 to 60 seconds earlier. The algorithm used guarantees that all resources in use are marked as such in their appropriate bitmaps: blocks and inodes. After a crash, the only resource allocation error that occurs is that resources are marked as ***used*** which are actually ***free***. [fsck(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#fsck&section8) recognizes this situation, and frees the resources that are no longer used. It is safe to ignore the dirty state of the filesystem after a crash by forcibly mounting it with `mount -f`. In order to free resources that may be unused, [fsck(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=fsck&section=8) needs to be run at a later time.
3398
3399 The advantage is that meta-data operations are nearly as fast as asynchronous updates (i.e. faster than with ***logging***, which has to write the meta-data twice). The disadvantages are the complexity of the code (implying a higher risk for bugs in an area that is highly sensitive regarding loss of user data), and a higher memory consumption. Additionally there are some idiosyncrasies one has to get used to. After a crash, the state of the filesystem appears to be somewhat ***older***. In situations where the standard synchronous approach would have caused some zero-length files to remain after the `fsck`, these files do not exist at all with a Soft Updates filesystem because neither the meta-data nor the file contents have ever been written to disk. Disk space is not released until the updates have been written to disk, which may take place some time after running `rm`. This may cause problems when installing large amounts of data on a filesystem that does not have enough free space to hold all the files twice.
3400
3401 ## Tuning Kernel Limits 
3402
3403 ### File/Process Limits 
3404
3405 #### `kern.maxfiles` 
3406
3407 <!-- XXX: revise this section; someone who knows about it -->
3408
3409 `kern.maxfiles` can be raised or lowered based upon your system requirements. This variable indicates the maximum number of file descriptors on your system. When the file descriptor table is full, ***`file: table is full`*** will show up repeatedly in the system message buffer, which can be viewed with the `dmesg` command.
3410
3411 Each open file, socket, or fifo uses one file descriptor. A large-scale production server may easily require many thousands of file descriptors, depending on the kind and number of services running concurrently.
3412
3413 `kern.maxfile`'s default value is dictated by the `MAXUSERS` option in your kernel configuration file. `kern.maxfiles` grows proportionally to the value of `MAXUSERS`. When compiling a custom kernel, it is a good idea to set this kernel configuration option according to the uses of your system. From this number, the kernel is given most of its pre-defined limits. Even though a production machine may not actually have 256 users connected at once, the resources needed may be similar to a high-scale web server.
3414
3415  **Note:** Setting `MAXUSERS` to `0` in your kernel configuration file will choose a reasonable default value based on the amount of RAM present in your system. It is set to 0 in the default GENERIC kernel.
3416
3417 #### `kern.ipc.somaxconn` 
3418
3419 The `kern.ipc.somaxconn` sysctl variable limits the size of the listen queue for accepting new TCP connections. The default value of `128` is typically too low for robust handling of new connections in a heavily loaded web server environment. For such environments, it is recommended to increase this value to `1024` or higher. The service daemon may itself limit the listen queue size (e.g. [sendmail(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=sendmail&section=8), or  **Apache** ) but will often have a directive in its configuration file to adjust the queue size. Large listen queues also do a better job of avoiding Denial of Service (DoS) attacks.
3420
3421 ### Network Limits 
3422
3423 The `NMBCLUSTERS` kernel configuration option dictates the amount of network Mbufs available to the system. A heavily-trafficked server with a low number of Mbufs will hinder DragonFly's ability. Each cluster represents approximately 2 K of memory, so a value of 1024 represents 2 megabytes of kernel memory reserved for network buffers. A simple calculation can be done to figure out how many are needed. If you have a web server which maxes out at 1000 simultaneous connections, and each connection eats a 16 K receive and 16 K send buffer, you need approximately 32 MB worth of network buffers to cover the web server. A good rule of thumb is to multiply by 2, so 2x32 MB / 2 KB # 64 MB / 2 kB  32768. We recommend values between 4096 and 32768 for machines with greater amounts of memory. Under no circumstances should you specify an arbitrarily high value for this parameter as it could lead to a boot time crash. The `-m` option to [netstat(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=netstat&section=1) may be used to observe network cluster use. `kern.ipc.nmbclusters` loader tunable should be used to tune this at boot time.
3424
3425 <!-- XXX: mention kern.ipc.mbufs sysctl -->
3426
3427 For busy servers that make extensive use of the [sendfile(2)](http://leaf.dragonflybsd.org/cgi/web-man?command=sendfile&section=2) system call, it may be necessary to increase the number of [sendfile(2)](http://leaf.dragonflybsd.org/cgi/web-man?command=sendfile&section=2) buffers via the `NSFBUFS` kernel configuration option or by setting its value in `/boot/loader.conf` (see [loader(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=loader&section=8) for details). A common indicator that this parameter needs to be adjusted is when processes are seen in the `sfbufa` state. The sysctl variable `kern.ipc.nsfbufs` is a read-only glimpse at the kernel configured variable. This parameter nominally scales with `kern.maxusers`, however it may be necessary to tune accordingly.
3428
3429  **Important:** Even though a socket has been marked as non-blocking, calling [sendfile(2)](http://leaf.dragonflybsd.org/cgi/web-man?command=sendfile&section=2) on the non-blocking socket may result in the [sendfile(2)](http://leaf.dragonflybsd.org/cgi/web-man?command=sendfile&section=2) call blocking until enough `struct sf_buf`'s are made available.
3430
3431 #### `net.inet.ip.portrange.*` 
3432
3433 The `net.inet.ip.portrange.*` sysctl variables control the port number ranges automatically bound to TCP and UDP sockets. There are three ranges: a low range, a default range, and a high range. Most network programs use the default range which is controlled by the `net.inet.ip.portrange.first` and `net.inet.ip.portrange.last`, which default to 1024 and 5000, respectively. Bound port ranges are used for outgoing connections, and it is possible to run the system out of ports under certain circumstances. This most commonly occurs when you are running a heavily loaded web proxy. The port range is not an issue when running servers which handle mainly incoming connections, such as a normal web server, or has a limited number of outgoing connections, such as a mail relay. For situations where you may run yourself out of ports, it is recommended to increase `net.inet.ip.portrange.last` modestly. A value of `10000`, `20000` or `30000` may be reasonable. You should also consider firewall effects when changing the port range. Some firewalls may block large ranges of ports (usually low-numbered ports) and expect systems to use higher ranges of ports for outgoing connections -- for this reason it is recommended that `net.inet.ip.portrange.first` be lowered.
3434
3435 #### TCP Bandwidth Delay Product 
3436 <!-- XXX: Revise this stuff, I'm not familiar with it -->
3437
3438 The TCP Bandwidth Delay Product Limiting is similar to TCP/Vegas in NetBSD. It can be enabled by setting `net.inet.tcp.inflight_enable` sysctl variable to `1`. The system will attempt to calculate the bandwidth delay product for each connection and limit the amount of data queued to the network to just the amount required to maintain optimum throughput.
3439
3440 This feature is useful if you are serving data over modems, Gigabit Ethernet, or even high speed WAN links (or any other link with a high bandwidth delay product), especially if you are also using window scaling or have configured a large send window. If you enable this option, you should also be sure to set `net.inet.tcp.inflight_debug` to `0` (disable debugging), and for production use setting `net.inet.tcp.inflight_min` to at least `6144` may be beneficial. However, note that setting high minimums may effectively disable bandwidth limiting depending on the link. The limiting feature reduces the amount of data built up in intermediate route and switch packet queues as well as reduces the amount of data built up in the local host's interface queue. With fewer packets queued up, interactive connections, especially over slow modems, will also be able to operate with lower ***Round Trip Times***. However, note that this feature only effects data transmission (uploading / server side). It has no effect on data reception (downloading).
3441
3442 Adjusting `net.inet.tcp.inflight_stab` is ***not*** recommended. This parameter defaults to 20, representing 2 maximal packets added to the bandwidth delay product window calculation. The additional window is required to stabilize the algorithm and improve responsiveness to changing conditions, but it can also result in higher ping times over slow links (though still much lower than you would get without the inflight algorithm). In such cases, you may wish to try reducing this parameter to 15, 10, or 5; and may also have to reduce `net.inet.tcp.inflight_min` (for example, to 3500) to get the desired effect. Reducing these parameters should be done as a last resort only.
3443
3444 ## Adding Swap Space 
3445 <!-- XXX: swapcache -->
3446
3447 No matter how well you plan, sometimes a system does not run as you expect. If you find you need more swap space, it is simple enough to add. You have three ways to increase swap space: adding a new hard drive, enabling swap over NFS, and creating a swap file on an existing partition.
3448
3449 ### Swap on a New Hard Drive 
3450
3451 The best way to add swap, of course, is to use this as an excuse to add another hard drive. You can always use another hard drive, after all. If you can do this, go reread the discussion about swap space in [configtuning-initial.html Section 6.2] for some suggestions on how to best arrange your swap.
3452
3453 ### Swapping over NFS 
3454
3455 Swapping over NFS is only recommended if you do not have a local hard disk to swap to. Even though DragonFly has an excellent NFS implementation, NFS swapping will be limited by the available network bandwidth and puts an additional burden on the NFS server.
3456
3457 ### Swapfiles 
3458
3459 You can create a file of a specified size to use as a swap file. In our example here we will use a 64MB file called `/usr/swap0`. You can use any name you want, of course.
3460
3461  **Example 6-1. Creating a Swapfile** 
3462
3463   1. Be certain that your kernel configuration includes the vnode driver. It is ***not*** in recent versions of `GENERIC`.
3464
3465       
3466
3467          pseudo-device   vn 1   #Vnode driver (turns a file into a device)
3468
3469   
3470
3471   1. Create a swapfile (`/usr/swap0`):
3472
3473       
3474
3475          # dd if=/dev/zero of=/usr/swap0 bs=1024k count=64
3476
3477   
3478
3479   1. Set proper permissions on (`/usr/swap0`):
3480
3481       
3482
3483          # chmod 0600 /usr/swap0
3484
3485   
3486
3487   1. Enable the swap file in `/etc/rc.conf`:
3488
3489       
3490
3491          swapfile="/usr/swap0"   # Set to name of swapfile if aux swapfile desired.
3492
3493   
3494
3495   1. Reboot the machine or to enable the swap file immediately, type:
3496
3497       
3498
3499          # vnconfig -e /dev/vn0b /usr/swap0 swap
3500
3501   
3502
3503 ## Power and Resource Management 
3504
3505 ***Written by Hiten Pandya and Tom Rhodes. ***
3506
3507 It is very important to utilize hardware resources in an efficient manner. Before ACPI was introduced, it was very difficult and inflexible for operating systems to manage the power usage and thermal properties of a system. The hardware was controlled by some sort of BIOS embedded interface, such as ***Plug and Play BIOS (PNPBIOS)***, or ***Advanced Power Management (APM)*** and so on. Power and Resource Management is one of the key components of a modern operating system. For example, you may want an operating system to monitor system limits (and possibly alert you) in case your system temperature increased unexpectedly.
3508
3509 In this section, we will provide comprehensive information about ACPI. References will be provided for further reading at the end. Please be aware that ACPI is available on DragonFly systems as a default kernel module.
3510
3511 ### What Is ACPI? 
3512
3513 Advanced Configuration and Power Interface (ACPI) is a standard written by an alliance of vendors to provide a standard interface for hardware resources and power management (hence the name). It is a key element in ***Operating System-directed configuration and Power Management***, i.e.: it provides more control and flexibility to the operating system (OS). Modern systems ***stretched*** the limits of the current Plug and Play interfaces (such as APM), prior to the introduction of ACPI. ACPI is the direct successor to APM (Advanced Power Management).
3514
3515 ### Shortcomings of Advanced Power Management (APM) 
3516
3517 The ***Advanced Power Management (APM)*** facility control's the power usage of a system based on its activity. The APM BIOS is supplied by the (system) vendor and it is specific to the hardware platform. An APM driver in the OS mediates access to the ***APM Software Interface***, which allows management of power levels.
3518
3519 There are four major problems in APM. Firstly, power management is done by the (vendor-specific) BIOS, and the OS does not have any knowledge of it. One example of this, is when the user sets idle-time values for a hard drive in the APM BIOS, that when exceeded, it (BIOS) would spin down the hard drive, without the consent of the OS. Secondly, the APM logic is embedded in the BIOS, and it operates outside the scope of the OS. This means users can only fix problems in their APM BIOS by flashing a new one into the ROM; which, is a very dangerous procedure, and if it fails, it could leave the system in an unrecoverable state. Thirdly, APM is a vendor-specific technology, which, means that there is a lot or parity (duplication of efforts) and bugs found in one vendor's BIOS, may not be solved in others. Last but not the least, the APM BIOS did not have enough room to implement a sophisticated power policy, or one that can adapt very well to the purpose of the machine.
3520
3521 ***Plug and Play BIOS (PNPBIOS)*** was unreliable in many situations. PNPBIOS is 16-bit technology, so the OS has to use 16-bit emulation in order to ***interface*** with PNPBIOS methods.
3522
3523 The DragonFly APM driver is documented in the [apm(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=apm&section=4) manual page.
3524
3525 ### Configuring ACPI 
3526
3527 The `acpi.ko` driver is loaded by default at start up by the [loader(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=loader&section=8) and should ***not*** be compiled into the kernel. The reasoning behind this is that modules are easier to work with, say if switching to another `acpi.ko` without doing a kernel rebuild. This has the advantage of making testing easier. Another reason is that starting ACPI after a system has been brought up is not too useful, and in some cases can be fatal. In doubt, just disable ACPI all together. This driver should not and can not be unloaded because the system bus uses it for various hardware interactions. ACPI can be disabled with the [acpiconf(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=acpiconf&section=8) utility. In fact most of the interaction with ACPI can be done via [acpiconf(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=acpiconf&section=8). Basically this means, if anything about ACPI is in the [dmesg(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=dmesg&section=8) output, then most likely it is already running.
3528
3529  **Note:** ACPI and APM cannot coexist and should be used separately. The last one to load will terminate if the driver notices the other running.
3530
3531 In the simplest form, ACPI can be used to put the system into a sleep mode with [acpiconf(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=acpiconf&section=8), the `-s` flag, and a `1-5` option. Most users will only need `1`. Option `5` will do a soft-off which is the same action as:
3532
3533   
3534
3535     # halt -p
3536
3537 The other options are available. Check out the [acpiconf(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=acpiconf&section=8) manual page for more information.
3538
3539 ## Using and Debugging DragonFly ACPI 
3540
3541 ***Written by Nate Lawson. With contributions from Peter Schultz and Tom Rhodes. ***
3542
3543 ACPI is a fundamentally new way of discovering devices, managing power usage, and providing standardized access to various hardware previously managed by the BIOS. Progress is being made toward ACPI working on all systems, but bugs in some motherboards ***ACPI Machine Language*** (AML) bytecode, incompleteness in DragonFly's kernel subsystems, and bugs in the Intel ACPI-CA interpreter continue to appear.
3544
3545 This document is intended to help you assist the DragonFly ACPI maintainers in identifying the root cause of problems you observe and debugging and developing a solution. Thanks for reading this and we hope we can solve your system's problems.
3546
3547 ### Submitting Debugging Information 
3548
3549  **Note:** Before submitting a problem, be sure you are running the latest BIOS version and, if available, embedded controller firmware version.
3550
3551 For those of you that want to submit a problem right away, please send the following information to [bugs](http://leaf.dragonflybsd.org/mailarchive/)
3552
3553 * Description of the buggy behavior, including system type and model and anything that causes the bug to appear. Also, please note as accurately as possible when the bug began occurring if it is new for you.
3554
3555 * The dmesg output after ***boot `-v`***, including any error messages generated by you exercising the bug.
3556
3557 * dmesg output from ***boot `-v`*** with ACPI disabled, if disabling it helps fix the problem.
3558
3559 * Output from ***sysctl hw.acpi***. This is also a good way of figuring out what features your system offers.
3560
3561 * URL where your ***ACPI Source Language*** (ASL) can be found. Do ***not*** send the ASL directly to the list as it can be very large. Generate a copy of your ASL by running this command:
3562       
3563
3564       # acpidump -t -d > name-system.asl
3565
3566   
3567
3568   (Substitute your login name for `name` and manufacturer/model for `system`. Example: `njl-FooCo6000.asl`)
3569
3570 ### Background 
3571
3572 ACPI is present in all modern computers that conform to the ia32 (x86), ia64 (Itanium), and amd64 (AMD) architectures. The full standard has many features including CPU performance management, power planes control, thermal zones, various battery systems, embedded controllers, and bus enumeration. Most systems implement less than the full standard. For instance, a desktop system usually only implements the bus enumeration parts while a laptop might have cooling and battery management support as well. Laptops also have suspend and resume, with their own associated complexity.
3573
3574 An ACPI-compliant system has various components. The BIOS and chipset vendors provide various fixed tables (e.g., FADT) in memory that specify things like the APIC map (used for SMP), config registers, and simple configuration values. Additionally, a table of bytecode (the ***Differentiated System Description Table*** DSDT) is provided that specifies a tree-like name space of devices and methods.
3575
3576 The ACPI driver must parse the fixed tables, implement an interpreter for the bytecode, and modify device drivers and the kernel to accept information from the ACPI subsystem. For DragonFly, Intel has provided an interpreter (ACPI-CA) that is shared with Linux and NetBSD®. The path to the ACPI-CA source code is `src/sys/dev/acpica5`.  Finally, drivers that implement various ACPI devices are found in `src/sys/dev/acpica5`.
3577
3578 ### Common Problems 
3579
3580 For ACPI to work correctly, all the parts have to work correctly. Here are some common problems, in order of frequency of appearance, and some possible workarounds or fixes.
3581
3582 #### Suspend/Resume 
3583
3584 ACPI has three suspend to RAM (STR) states, `S1`-`S3`, and one suspend to disk state (`STD`), called `S4`. `S5` is ***soft off*** and is the normal state your system is in when plugged in but not powered up. `S4` can actually be implemented two separate ways. `S4`BIOS is a BIOS-assisted suspend to disk. `S4`OS is implemented entirely by the operating system.
3585
3586 Start by checking `sysctl` `hw.acpi` for the suspend-related items. Here are the results for my Thinkpad:
3587
3588     hw.acpi.supported_sleep_state: S3 S4 S5
3589
3590     hw.acpi.s4bios: 0
3591
3592 This means that I can use `acpiconf -s` to test `S3`, `S4`OS, and `S5`. If `s4bios` was one (`1`), I would have `S4`BIOS support instead of `S4` OS.
3593
3594 When testing suspend/resume, start with `S1`, if supported. This state is most likely to work since it doesn't require much driver support. No one has implemented `S2` but if you have it, it's similar to `S1`. The next thing to try is `S3`. This is the deepest STR state and requires a lot of driver support to properly reinitialize your hardware. If you have problems resuming, feel free to email the [bugs](http://leaf.dragonflybsd.org/mailarchive/) list but do not expect the problem to be resolved since there are a lot of drivers/hardware that need more testing and work.
3595
3596 To help isolate the problem, remove as many drivers from your kernel as possible. If it works, you can narrow down which driver is the problem by loading drivers until it fails again. Typically binary drivers like `nvidia.ko`,  **X11**  display drivers, and USB will have the most problems while Ethernet interfaces usually work fine. If you can load/unload the drivers ok, you can automate this by putting the appropriate commands in `/etc/rc.suspend` and `/etc/rc.resume`. There is a commented-out example for unloading and loading a driver. Try setting `hw.acpi.reset_video` to zero (0) if your display is messed up after resume. Try setting longer or shorter values for `hw.acpi.sleep_delay` to see if that helps.
3597
3598 Another thing to try is load a recent Linux distribution with ACPI support and test their suspend/resume support on the same hardware. If it works on Linux, it's likely a DragonFly driver problem and narrowing down which driver causes the problems will help us fix the problem. Note that the ACPI maintainers do not usually maintain other drivers (e.g sound, ATA, etc.) so any work done on tracking down a driver problem should probably eventually be posted to the [bugs](http://leaf.dragonflybsd.org/mailarchive/) list and mailed to the driver maintainer. If you are feeling adventurous, go ahead and start putting some debugging [printf(3)](http://leaf.dragonflybsd.org/cgi/web-man?command#printf&section3)s in a problematic driver to track down where in its resume function it hangs.
3599
3600 Finally, try disabling ACPI and enabling APM instead. If suspend/resume works with APM, you may be better off sticking with APM, especially on older hardware (pre-2000). It took vendors a while to get ACPI support correct and older hardware is more likely to have BIOS problems with ACPI.
3601
3602 <-- XXX: mention sensors somewhere; but not in this section -->
3603
3604 #### System Hangs (temporary or permanent) 
3605
3606 Most system hangs are a result of lost interrupts or an interrupt storm. Chipsets have a lot of problems based on how the BIOS configures interrupts before boot, correctness of the APIC (MADT) table, and routing of the ***System Control Interrupt*** (SCI).
3607
3608 Interrupt storms can be distinguished from lost interrupts by checking the output of `vmstat -i` and looking at the line that has `acpi0`. If the counter is increasing at more than a couple per second, you have an interrupt storm. If the system appears hung, try breaking to DDB ( **CTRL** + **ALT** + **ESC**  on console) and type `show interrupts`.
3609
3610 Your best hope when dealing with interrupt problems is to try disabling APIC support with `hint.apic.0.disabled="1"` in `loader.conf`.
3611
3612 #### Panics 
3613
3614 Panics are relatively rare for ACPI and are the top priority to be fixed. The first step is to isolate the steps to reproduce the panic (if possible) and get a backtrace. Follow the advice for enabling `options DDB` and setting up a serial console (see [ this section](serialconsole-setup.html#SERIALCONSOLE-DDB)) or setting up a [dump(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=dump&section=8) partition. You can get a backtrace in DDB with `tr`. If you have to handwrite the backtrace, be sure to at least get the lowest five (5) and top five (5) lines in the trace.
3615
3616 Then, try to isolate the problem by booting with ACPI disabled. If that works, you can isolate the ACPI subsystem by using various values of `debug.acpi.disable`. See the [acpi(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=acpi&section=4) manual page for some examples.
3617
3618 #### System Powers Up After Suspend or Shutdown 
3619
3620 First, try setting `hw.acpi.disable_on_poweroff#0` in [loader.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=loader.conf&section=5). This keeps ACPI from disabling various events during the shutdown process. Some systems need this value set to ***1*** (the default) for the same reason. This usually fixes the problem of a system powering up spontaneously after a suspend or poweroff.
3621
3622 #### Other Problems 
3623
3624 If you have other problems with ACPI (working with a docking station, devices not detected, etc.), please email a description to the mailing list as well; however, some of these issues may be related to unfinished parts of the ACPI subsystem so they might take a while to be implemented. Please be patient and prepared to test patches we may send you.
3625
3626 ### ASL, acpidump, and IASL 
3627 <!-- XXX: IMHO all this crap about fixing your DSDT etc should  be axed -->
3628
3629 The most common problem is the BIOS vendors providing incorrect (or outright buggy!) bytecode. This is usually manifested by kernel console messages like this:
3630
3631     
3632
3633     ACPI-1287: *** Error: Method execution failed [\\_SB_.PCI0.LPC0.FIGD._STA] \\
3634
3635     (Node 0xc3f6d160), AE_NOT_FOUND
3636
3637 Often, you can resolve these problems by updating your BIOS to the latest revision. Most console messages are harmless but if you have other problems like battery status not working, they're a good place to start looking for problems in the AML. The bytecode, known as AML, is compiled from a source language called ASL. The AML is found in the table known as the DSDT. To get a copy of your ASL, use [acpidump(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=acpidump&section=8). You should use both the `-t` (show contents of the fixed tables) and `-d` (disassemble AML to ASL) options. See the [submitting Debugging Information](acpi-debug.html#ACPI-SUBMITDEBUG) section for an example syntax.
3638
3639 The simplest first check you can do is to recompile your ASL to check for errors. Warnings can usually be ignored but errors are bugs that will usually prevent ACPI from working correctly. To recompile your ASL, issue the following command:
3640
3641     
3642
3643     # iasl your.asl
3644
3645 ### Fixing Your ASL 
3646
3647 In the long run, our goal is for almost everyone to have ACPI work without any user intervention. At this point, however, we are still developing workarounds for common mistakes made by the BIOS vendors. The Microsoft interpreter (`acpi.sys` and `acpiec.sys`) does not strictly check for adherence to the standard, and thus many BIOS vendors who only test ACPI under Windows never fix their ASL. We hope to continue to identify and document exactly what non-standard behavior is allowed by Microsoft's interpreter and replicate it so DragonFly can work without forcing users to fix the ASL. As a workaround and to help us identify behavior, you can fix the ASL manually. If this works for you, please send a [diff(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=diff&section=1) of the old and new ASL so we can possibly work around the buggy behavior in ACPI-CA and thus make your fix unnecessary.
3648
3649 Here is a list of common error messages, their cause, and how to fix them:
3650
3651 #### OS dependencies 
3652
3653 Some AML assumes the world consists of various Windows versions. You can tell DragonFly to claim it is any OS to see if this fixes problems you may have. An easy way to override this is to set `hw.acpi.osname=Windows 2001` in `/boot/loader.conf` or other similar strings you find in the ASL.
3654
3655 #### Missing Return statements 
3656
3657 Some methods do not explicitly return a value as the standard requires. While ACPI-CA does not handle this, DragonFly has a workaround that allows it to return the value implicitly. You can also add explicit Return statements where required if you know what value should be returned. To force `iasl` to compile the ASL, use the `-f` flag.
3658
3659 #### Overriding the Default AML 
3660
3661 After you customize `your.asl`, you will want to compile it, run:
3662    
3663
3664     # iasl your.asl
3665
3666 You can add the `-f` flag to force creation of the AML, even if there are errors during compilation. Remember that some errors (e.g., missing Return statements) are automatically worked around by the interpreter.
3667
3668 `DSDT.aml` is the default output filename for `iasl`. You can load this instead of your BIOS's buggy copy (which is still present in flash memory) by editing `/boot/loader.conf` as follows:
3669
3670     
3671
3672     acpi_dsdt_load="YES"
3673
3674     acpi_dsdt_name="/boot/DSDT.aml"
3675
3676 Be sure to copy your `DSDT.aml` to the `/boot` directory.
3677
3678 ### Getting Debugging Output From ACPI 
3679
3680 The ACPI driver has a very flexible debugging facility. It allows you to specify a set of subsystems as well as the level of verbosity. The subsystems you wish to debug are specified as ***layers*** and are broken down into ACPI-CA components (ACPI_ALL_COMPONENTS) and ACPI hardware support (ACPI_ALL_DRIVERS). The verbosity of debugging output is specified as the ***level*** and ranges from ACPI_LV_ERROR (just report errors) to ACPI_LV_VERBOSE (everything). The ***level*** is a bitmask so multiple options can be set at once, separated by spaces. In practice, you will want to use a serial console to log the output if it is so long it flushes the console message buffer.
3681
3682 Debugging output is not enabled by default. To enable it, add `options ACPI_DEBUG` to your kernel config if ACPI is compiled into the kernel. You can add `ACPI_DEBUG=1` to your `/etc/make.conf` to enable it globally. If it is a module, you can recompile just your `acpi.ko` module as follows:
3683
3684     
3685
3686     # cd /sys/dev/acpica5 && make clean && make ACPI_DEBUG=1
3687
3688 Install `acpi.ko` in `/boot/kernel` and add your desired level and layer to `loader.conf`. This example enables debug messages for all ACPI-CA components and all ACPI hardware drivers (CPU, LID, etc.) It will only output error messages, the least verbose level.
3689
3690     
3691
3692     debug.acpi.layer="ACPI_ALL_COMPONENTS ACPI_ALL_DRIVERS"
3693
3694     debug.acpi.level="ACPI_LV_ERROR"
3695
3696 If the information you want is triggered by a specific event (say, a suspend and then resume), you can leave out changes to `loader.conf` and instead use `sysctl` to specify the layer and level after booting and preparing your system for the specific event. The `sysctl`s are named the same as the tunables in `loader.conf`.
3697
3698 ### References 
3699
3700 More information about ACPI may be found in the following locations:
3701
3702 * The [FreeBSD ACPI mailing list](http://lists.FreeBSD.org/mailman/listinfo/freebsd-acpi) (This is FreeBSD-specific; posting DragonFly questions here may not generate much of an answer.)
3703
3704 * The ACPI Mailing List Archives (FreeBSD) http://lists.freebsd.org/pipermail/freebsd-acpi/
3705
3706 * The old ACPI Mailing List Archives (FreeBSD) http://home.jp.FreeBSD.org/mail-list/acpi-jp/
3707
3708 * The ACPI 2.0 Specification http://acpi.info/spec.htm
3709
3710 * DragonFly Manual pages: [acpidump(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=acpidump&section8), [acpiconf(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=acpiconf&section=8), [acpidb(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=acpidb&section=8)
3711
3712 * [DSDT debugging resource](http://www.cpqlinux.com/acpi-howto.html#fix_broken_dsdt). (Uses Compaq as an example but generally useful.)
3713
3714 # The DragonFly virtual kernels 
3715 [[!toc  levels=3]]
3716
3717 ***Obtained from [vkernel(7)](http://leaf.dragonflybsd.org/cgi/web-man?command=vkernel&section=7) written by Sascha Wildner, added by Matthias Schmidt***
3718
3719 The idea behind the development of the vkernel architecture was to find an elegant solution to debugging of the kernel and its components. It eases debugging, as it allows for a virtual kernel being loaded in userland and hence debug it without affecting the real kernel itself. By being able to load it on a running system it also removes the need for reboots between kernel compiles.
3720
3721 The vkernel architecture allows for running DragonFly kernels in userland.
3722
3723 ## Supported devices 
3724
3725 A number of virtual device drivers exist to supplement the virtual kernel.
3726
3727 <!-- XXX: why do they only support 16 devices? is this really true? -->
3728
3729 ### Disk device 
3730
3731 The vkd driver allows for up to 16 [vn(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=vn&section=4) based disk devices.  The root device will be `vkd0`.
3732
3733 ### CD-ROM device 
3734
3735 The vcd driver allows for up to 16 virtual CD-ROM devices.  Basically this is a read only `vkd` device with a block size of 2048.
3736
3737 ### Network interface 
3738
3739 The vke driver supports up to 16 virtual network interfaces which are
3740
3741 associated with [tap(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=tap&section=4) devices on the host.  For each `vke` device, the per-interface read only [sysctl(3)](http://leaf.dragonflybsd.org/cgi/web-man?command=sysctl&section=3) variable `hw.vkeX.tap_unit` holds the unit number of the associated [tap(4)](http://leaf.dragonflybsd.org/cgi/web-man?command=tap&section=4) device.
3742
3743 ## Setup a virtual kernel environment 
3744
3745 A couple of steps are necessary in order to prepare the system to build and run a virtual kernel.
3746
3747 ### Setting up the filesystem