Add /etc/bluetooth/ with common files.
[dragonfly.git] / share / man / man7 / hier.7
1 .\" Copyright (c) 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)hier.7      8.1 (Berkeley) 6/5/93
33 .\" $FreeBSD: src/share/man/man7/hier.7,v 1.29.2.17 2003/01/13 21:43:50 ceri Exp $
34 .\" $DragonFly: src/share/man/man7/hier.7,v 1.16 2008/01/03 13:35:21 hasso Exp $
35 .\"
36 .Dd December 25, 2007
37 .Dt HIER 7
38 .Os
39 .Sh NAME
40 .Nm hier
41 .Nd layout of filesystems
42 .Sh DESCRIPTION
43 A sketch of the filesystem hierarchy.
44 .Bl -tag -width ".Pa /modules/"
45 .It Pa /
46 root directory of the filesystem
47 .It Pa /bin/
48 user utilities fundamental to both single-user and multi-user environments
49 .It Pa /boot/
50 programs and configuration files used during operating system bootstrap
51 .Pp
52 .Bl -tag -width ".Pa defaults/" -compact
53 .It Pa defaults/
54 default bootstrapping configuration files; see
55 .Xr loader.conf 5
56 .El
57 .It Pa /dev/
58 block and character device files
59 .Pp
60 .Bl -tag -width ".Pa MAKEDEV" -compact
61 .It Pa MAKEDEV
62 script for creating device files;
63 see
64 .Xr MAKEDEV 8
65 .It Pa fd/
66 file descriptor files;
67 see
68 .Xr \&fd 4
69 .El
70 .It Pa /etc/
71 system configuration files and scripts
72 .Pp
73 .Bl -tag -width ".Pa bluetooth/" -compact
74 .It Pa bluetooth/
75 bluetooth configuration files
76 .It Pa firmware/
77 Firmware image files;
78 see
79 .Xr firmware 9
80 .It Pa defaults/
81 default system configuration files;
82 see
83 .Xr rc 8
84 .It Pa isdn/
85 isdn4bsd configuration files;
86 see
87 .Xr isdnd 8
88 .It Pa localtime
89 local timezone information;
90 see
91 .Xr ctime 3
92 .It Pa mail/
93 Sendmail control files
94 .It Pa mtree/
95 mtree configuration files;
96 see
97 .Xr mtree 8
98 .It Pa namedb/
99 named configuration files;
100 see
101 .Xr named 8
102 .It Pa pam.d/
103 configuration files for the Pluggable Authentication Modules (PAM)
104 library
105 .It Pa periodic/
106 scripts that are run daily, weekly, and monthly, via
107 .Xr cron 8 ;
108 see
109 .Xr periodic 8
110 .It Pa ppp/
111 ppp configuration files;
112 see
113 .Xr ppp 8
114 .It Pa rc.d/
115 System and daemon startup/control scripts;
116 see
117 .Xr rc 8
118 .It Pa ssh/
119 OpenSSH configuration files;
120 see
121 .Xr ssh 1
122 .It Pa ssl/
123 OpenSSL configuration files
124 .It Pa uucp/
125 uucp configuration files;
126 see
127 .Xr uucp 1
128 .El
129 .It Pa /home/
130 HOME directories of non-root users
131 .It Pa /kernel
132 pure kernel executable (the operating system loaded into memory
133 at boot time).
134 .It Pa /mnt/
135 empty directory commonly used by
136 system administrators as a temporary mount point
137 .It Pa /modules/
138 loadable kernel modules;
139 see
140 .Xr kldstat 8
141 .It Pa /proc/
142 process file system;
143 see
144 .Xr procfs 5 ,
145 .Xr mount_procfs 8
146 .It Pa /root/
147 root's HOME directory
148 .It Pa /sbin/
149 system programs and administration utilities
150 fundamental to both single-user and multi-user environments
151 .It Pa /sys/
152 the kernel's source code (usually a symbolic link to
153 .Pa /usr/src/sys )
154 .It Pa /tmp/
155 temporary files that are not guaranteed to persist across system reboots
156 .It Pa /usr/
157 contains the majority of user utilities and applications
158 .Pp
159 .Bl -tag -width ".Pa libdata/" -compact
160 .It Pa bin/
161 common utilities, programming tools, and applications
162 .It Pa games/
163 useful and semi-frivolous programs
164 .It Pa include/
165 standard C include files
166 .Pp
167 .Bl -tag -width ".Pa libmilter/" -compact
168 .It Pa arpa/
169 C include files for Internet service protocols
170 .It Pa c++/
171 C++ include files
172 .It Pa cam/
173 C include files for the Common Access Methods Layer
174 .Pp
175 .Bl -tag -width ".Pa scsi/" -compact
176 .It Pa scsi/
177 The SCSI device on top of CAM
178 .El
179 .Pp
180 .It Pa dev/
181 C include files for programming various
182 .Dx
183 devices
184 .It Pa emulation/
185 Include Files for various emulation layers
186 .It Pa fs/
187 .Pp
188 .Bl -tag -width ".Pa smbfs/" -compact
189 .It Pa smbfs/
190 SMB/CIFS filesystem
191 .El
192 .Pp
193 .It Pa isc/
194 ISC utility library libisc include files
195 .It Pa isofs/
196 .Pp
197 .Bl -tag -width ".Pa cd9660/" -compact
198 .It Pa cd9660/
199 iso9660 filesystem
200 .El
201 .Pp
202 .It Pa libmilter/
203 C include files for libmilter,
204 the sendmail mail filter API
205 .It Pa machine/
206 machine-specific C include files
207 .It Pa msdosfs/
208 MS-DOS file system
209 .It Pa net/
210 misc network C include files
211 .It Pa netatalk/
212 Appletalk protocol
213 .It Pa netatm/
214 ATM include files;
215 see
216 .Xr atm 8
217 .It Pa netinet/
218 C include files for Internet standard protocols;
219 see
220 .Xr inet 4
221 .It Pa netinet6/
222 C include files for Internet protocol version 6;
223 see
224 .Xr inet6 4
225 .It Pa netipx/
226 IPX/SPX protocol stacks
227 .It Pa netkey/
228 kernel key-management service
229 .It Pa netnatm/
230 NATM include files;
231 see
232 .Xr natm 4
233 .It Pa netns/
234 Xerox NS protocols
235 .It Pa netsmb/
236 SMB/CIFS requester
237 .It Pa nfs/
238 C include files for NFS (Network File System)
239 .It Pa objc/
240 Objective C include files
241 .It Pa openssl/
242 OpenSSL (Cryptography/SSL toolkit) headers
243 .It Pa pccard/
244 PC-CARD controllers
245 .It Pa protocols/
246 C include files for Berkeley service protocols
247 .It Pa readline/
248 get a line from a user, with editing;
249 see
250 .Xr readline 3
251 .It Pa rpc/
252 remote procedure calls;
253 see
254 .Xr rpc 3
255 .It Pa rpcsvc/
256 definition of RPC service structures; see
257 .Xr rpc 3
258 .It Pa security/
259 PAM; see
260 .Xr pam 8
261 .It Pa sys/
262 system C include files (kernel data structures)
263 .It Pa ufs/
264 C include files for UFS (The U-word File System)
265 .Pp
266 .Bl -tag -width ".Pa ffs/" -compact
267 .It Pa ffs/
268 Fast filesystem
269 .It Pa mfs/
270 memory file system;
271 see
272 .Xr mount_mfs 8
273 .It Pa ufs/
274 UFS filesystem
275 .El
276 .Pp
277 .It Pa vm/
278 virtual memory;
279 see
280 .Xr vmstat 8
281 .El
282 .Pp
283 .It Pa lib/
284 archive libraries
285 .Pp
286 .Bl -tag -width ".Pa compat/" -compact
287 .It Pa aout/
288 a.out archive libraries
289 .It Pa compat/
290 shared libraries for compatibility
291 .Pp
292 .Bl -tag -width ".Pa aout/" -compact
293 .It Pa aout/
294 a.out backward compatibility libraries
295 .El
296 .El
297 .Pp
298 .It Pa libdata/
299 misc. utility data files
300 .Pp
301 .Bl -tag -width ".Pa stallion/" -compact
302 .It Pa doscmd/
303 files used by doscmd (drivers, fonts, etc.);
304 see
305 .Xr doscmd 1
306 .Pp
307 .Bl -tag -width ".Pa fonts/" -compact
308 .It Pa fonts/
309 fonts used by doscmd
310 .El
311 .Pp
312 .It Pa lint/
313 various prebuilt lint libraries;
314 see
315 .Xr lint 1
316 .It Pa msdosfs/
317 Character set conversion tables
318 .It Pa stallion/
319 holds the download firmware images
320 .El
321 .Pp
322 .It Pa libexec/
323 system daemons & system utilities (executed by other programs)
324 .Pp
325 .Bl -tag -width ".Pa binutils217/" -compact
326 .It Pa lpr/
327 utilities and filters for LP print system;
328 see
329 .Xr lpr 1
330 .It Pa binutils217/
331 .Pp
332 .Bl -tag -width ".Pa ldscripts/" -compact
333 .It Pa ldscripts/
334 linker scripts;
335 see
336 .Xr ld 1
337 .El
338 .Pp
339 .It Pa sendmail/
340 the sendmail binary;
341 see
342 .Xr mailwrapper 8
343 and
344 .Xr sendmail 8
345 .It Pa sm.bin/
346 restricted shell for sendmail;
347 see
348 .Xr smrsh 8
349 .It Pa uucp/
350 uucp utilities;
351 see
352 .Xr uucp 1
353 .El
354 .Pp
355 .It Pa local/
356 local executables, libraries, etc.
357 Within
358 .Pa local/ ,
359 the general layout sketched out by
360 .Xr hier 7
361 for
362 .Pa /usr
363 should be used.  Exceptions are the man directory (directly under
364 .Pa local/
365 rather than under
366 .Pa local/share/ ) ,
367 documentation (in
368 .Pa share/doc/<app>/ ) ,
369 and
370 .Pa /usr/local/etc
371 .Pf ( mimics
372 .Pa /etc ) .
373 .It Pa obj/
374 architecture-specific target tree produced by building the
375 .Pa /usr/src
376 tree
377 .It Pa pkg/
378 default destination directory for the
379 .Xr pkgsrc 7
380 collection.
381 Within
382 .Pa pkg/ ,
383 the general layout sketched out by
384 .Xr hier 7
385 for
386 .Pa /usr
387 should be used.  Exceptions are the man directory (directly under
388 .Pa pkg/
389 rather than under
390 .Pa pkg/share/ ) ,
391 documentation (in
392 .Pa share/doc/<pkg>/ ) ,
393 and
394 .Pa /usr/pkg/etc
395 .Pf ( mimics
396 .Pa /etc ) .
397 .It Pa pkgsrc/
398 The
399 .Xr pkgsrc 7
400 collection (optional).
401 .It Pa sbin/
402 system daemons & system utilities (executed by users)
403 .It Pa share/
404 architecture-independent files
405 .Pp
406 .Bl -tag -width ".Pa groff_font/" -compact
407 .It Pa calendar/
408 a variety of pre-fab calendar files;
409 see
410 .Xr calendar 1
411 .It Pa dict/
412 word lists;
413 see
414 .Xr look 1
415 .Pp
416 .Bl -tag -width ".Pa papers/" -compact
417 .It Pa web2
418 words from Webster's 2nd International
419 .It Pa words
420 common words
421 .It Pa papers/
422 reference databases;
423 see
424 .Xr refer 1
425 .El
426 .Pp
427 .It Pa doc/
428 miscellaneous documentation;
429 .Pp
430 .Bl -tag -width ".Pa handbook/" -compact
431 .It Pa handbook/
432 A copy of the handbook
433 .El
434 .Pp
435 .It Pa examples/
436 various examples for users and programmers
437 .It Pa games/
438 ASCII text files used by various games
439 .It Pa groff_font/
440 device description file for device name
441 .It Pa info/
442 GNU Info hypertext system
443 .It Pa isdn/
444 ISDN
445 .It Pa libg++/
446 libg++'s genclass prototype/template class files
447 .It Pa locale/
448 localization files;
449 see
450 .Xr setlocale 3
451 .It Pa man/
452 manual pages
453 .It Pa me/
454 macros for use with the me macro package;
455 see
456 .Xr me 7
457 .It Pa misc/
458 misc system-wide ASCII text files
459 .Pp
460 .Bl -tag -width ".Pa termcap" -compact
461 .It Pa termcap
462 terminal characteristics database;
463 see
464 .Xr termcap 5
465 .El
466 .Pp
467 .It Pa mk/
468 templates for make;
469 see
470 .Xr make 1
471 .It Pa nls/
472 national language support files;
473 see
474 .Xr mklocale 1
475 .It Pa sendmail/
476 sendmail configuration files;
477 see
478 .Xr sendmail 8
479 .It Pa skel/
480 example . (dot) files for new accounts
481 .It Pa syscons/
482 files used by
483 .Xr syscons 4
484 .Pp
485 .Bl -tag -width ".Pa scrnmaps/" -compact
486 .It Pa fonts/
487 console fonts;
488 see
489 .Xr vidcontrol 1
490 and
491 .Xr vidfont 1
492 .It Pa keymaps/
493 console keyboard maps;
494 see
495 .Xr kbdcontrol 1
496 and
497 .Xr kbdmap 1
498 .It Pa scrnmaps/
499 console screen maps
500 .El
501 .Pp
502 .It Pa tabset/
503 tab description files for a variety of terminals; used in
504 the termcap file;
505 see
506 .Xr termcap 5
507 .It Pa tmac/
508 text processing macros;
509 see
510 .Xr nroff 1
511 and
512 .Xr troff 1
513 .It Pa vi/
514 localization support and utilities for
515 .Xr vi 1
516 .It Pa zoneinfo/
517 timezone configuration information;
518 see
519 .Xr tzfile 5
520 .El
521 .Pp
522 .It Pa src/
523 .Bx ,
524 third-party, and/or local source files
525 .Pp
526 .Bl -tag -width ".Pa kerberos5/" -compact
527 .It Pa bin/
528 source code for files in
529 .Pa /bin
530 .It Pa contrib/
531 source code for contributed software
532 .It Pa crypto/
533 source code for contributed cryptography software
534 .It Pa etc/
535 source code for files in
536 .Pa /etc
537 .It Pa games/
538 source code for files in
539 .Pa /usr/games
540 .It Pa gnu/
541 Utilities covered by the GNU General Public License
542 .It Pa include/
543 source code for files in
544 .Pa /usr/include
545 .It Pa kerberos5/
546 source code for kerberos version 5
547 .It Pa lib/
548 source code for files in
549 .Pa /usr/lib
550 .It Pa libexec/
551 source code for files in
552 .Pa /usr/libexec
553 .It Pa nrelease/
554 files required to produce a
555 .Dx
556 release
557 .It Pa sbin/
558 source code for files in
559 .Pa /sbin
560 .It Pa secure/
561 build directory for files in
562 .Pa /usr/src/crypto
563 .It Pa share/
564 source for files in
565 .Pa /usr/share
566 .It Pa sys/
567 kernel source code
568 .It Pa tools/
569 tools used for maintenance and testing of
570 .Dx
571 .It Pa usr.bin/
572 source code for files in
573 .Pa /usr/bin
574 .It Pa usr.sbin/
575 source code for files in
576 .Pa /usr/sbin
577 .El
578 .El
579 .It Pa /var/
580 multi-purpose log, temporary, transient, and spool files
581 .Pp
582 .Bl -tag -width ".Pa preserve/" -compact
583 .It Pa account/
584 system accounting files
585 .Pp
586 .Bl -tag -width ".Pa acct" -compact
587 .It Pa acct
588 execution accounting file;
589 see
590 .Xr acct 5
591 .El
592 .Pp
593 .It Pa at/
594 timed command scheduling files;
595 see
596 .Xr \&at 1
597 .Pp
598 .Bl -tag -width ".Pa spool/" -compact
599 .It Pa jobs/
600 directory containing job files
601 .It Pa spool/
602 directory containing output spool files
603 .El
604 .Pp
605 .It Pa backups/
606 misc. backup files
607 .It Pa crash/
608 default directory to store kernel crash dumps; see
609 .Xr crash 8
610 and
611 .Xr savecore 8
612 .It Pa cron/
613 files used by cron;
614 see
615 .Xr cron 8
616 .Pp
617 .Bl -tag -width ".Pa tabs/" -compact
618 .It Pa tabs/
619 crontab files;
620 see
621 .Xr crontab 5
622 .El
623 .Pp
624 .It Pa db/
625 misc. automatically generated system-specific database files
626 .It Pa empty/
627 empty directory used by
628 .Xr sshd 8
629 for privilege separation
630 .It Pa games/
631 misc. game status and score files
632 .It Pa heimdal/
633 kerberos server databases; see
634 .Xr kdc 8
635 .It Pa log/
636 misc. system log files
637 .Pp
638 .Bl -tag -width ".Pa wtmp" -compact
639 .It Pa wtmp
640 login/logout log;
641 see
642 .Xr wtmp 5
643 .El
644 .Pp
645 .It Pa mail/
646 user mailbox files
647 .It Pa msgs/
648 system messages database;
649 see
650 .Xr msgs 1
651 .It Pa preserve/
652 temporary home of files preserved after an accidental death
653 of an editor;
654 see
655 .Xr \&ex 1
656 .It Pa quotas/
657 filesystem quota information files
658 .It Pa run/
659 system information files describing various info about
660 system since it was booted
661 .Pp
662 .Bl -tag -width ".Pa ppp/" -compact
663 .It Pa ppp/
664 writable by the
665 .Dq network
666 group for command connection sockets; see
667 .Xr ppp 8
668 .It Pa utmp
669 database of current users;
670 see
671 .Xr utmp 5
672 .El
673 .Pp
674 .It Pa rwho/
675 rwho data files;
676 see
677 .Xr rwhod 8 ,
678 .Xr rwho 1 ,
679 and
680 .Xr ruptime 1
681 .It Pa spool/
682 misc. printer and mail system spooling directories
683 .Pp
684 .Bl -tag -width ".Pa clientmqueue/" -compact
685 .It Pa clientmqueue/
686 undelivered submission mail queue;
687 see
688 .Xr sendmail 8
689 .It Pa ftp/
690 commonly
691 .Pa ~ftp ;
692 the anonymous ftp root directory
693 .It Pa mqueue/
694 undelivered mail queue;
695 see
696 .Xr sendmail 8
697 .It Pa output/
698 line printer spooling directories
699 .It Pa uucp/
700 uucp spool directory
701 .It Pa uucppublic/
702 commonly
703 .Pa ~uucp ;
704 public uucp temporary directory
705 .El
706 .Pp
707 .It Pa tmp/
708 temporary files that are kept between system reboots
709 .Pp
710 .Bl -tag -width ".Pa vi.recover/" -compact
711 .It Pa vi.recover/
712 the directory where recovery files are stored
713 .El
714 .Pp
715 .It Pa yp/
716 the NIS maps
717 .El
718 .El
719 .Sh NOTES
720 This manual page documents the default
721 .Dx
722 filesystem layout, but
723 the actual hierarchy on a given system is defined at the system
724 administrator's discretion.
725 A well-maintained installation will include a customized version of
726 this document.
727 .Sh SEE ALSO
728 .Xr apropos 1 ,
729 .Xr find 1 ,
730 .Xr finger 1 ,
731 .Xr grep 1 ,
732 .Xr ls 1 ,
733 .Xr whatis 1 ,
734 .Xr whereis 1 ,
735 .Xr which 1 ,
736 .Xr fsck 8
737 .Sh HISTORY
738 A
739 .Nm
740 manual page appeared in
741 .At v7 .