Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[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.2 2003/06/17 04:37:00 dillon Exp $
35 .\"
36 .Dd June 5, 1993
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 "/stand/"
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 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 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 "disklabels/" -compact
74 .It Pa defaults/
75 default system configuration files;
76 see
77 .Xr rc 8
78 .It Pa gnats/
79 gnats configuration files;
80 see
81 .Xr send-pr 1
82 .It Pa isdn/
83 isdn4bsd configuration files;
84 see
85 .Xr isdnd 8
86 .It Pa kerberosIV/
87 configuration files for kerberos version IV;
88 see
89 .Xr kerberos 1
90 .It Pa localtime
91 local timezone information;
92 see
93 .Xr ctime 3
94 .It Pa mail/
95 Sendmail control files
96 .It Pa mtree/
97 mtree configuration files;
98 see
99 .Xr mtree 8
100 .It Pa namedb/
101 named configuration files;
102 see
103 .Xr named 8
104 .It Pa periodic/
105 scripts that are run daily, weekly, and monthly, via
106 .Xr cron 8 ;
107 see
108 .Xr periodic 8
109 .It Pa ppp/
110 ppp configuration files;
111 see
112 .Xr ppp 8
113 .It Pa ssl/
114 OpenSSL configuration files
115 .It Pa uucp/
116 uucp configuration files;
117 see
118 .Xr uucp 1
119 .El
120 .It Pa /kernel
121 pure kernel executable (the operating system loaded into memory
122 at boot time).
123 .It Pa /modules/
124 loadable kernel modules;
125 see
126 .Xr kldstat 8
127 .It Pa /mnt/
128 empty directory commonly used by
129 system administrators as a temporary mount point
130 .It Pa /proc/
131 process file system;
132 see
133 .Xr procfs 5 ,
134 .Xr mount_procfs 8
135 .It Pa /root/
136 root's HOME directory
137 .It Pa /sbin/
138 system programs and administration utilities
139 fundamental to both single-user and multi-user environments
140 .It Pa /stand/
141 programs used in a standalone environment
142 .It Pa /tmp/
143 temporary files that are not guaranteed to persist across system reboots
144 .It Pa /usr/
145 contains the majority of user utilities and applications
146 .Pp
147 .Bl -tag -width "libdata/" -compact
148 .It Pa bin/
149 common utilities, programming tools, and applications
150 .It Pa games/
151 useful and semi-frivolous programs
152 .It Pa include/
153 standard C include files
154 .Pp
155 .Bl -tag -width "kerberosIV/" -compact
156 .It Pa arpa/
157 C include files for Internet service protocols
158 .It Pa cam/
159 C include files for the Common Access Methods Layer
160 .Bl -tag -width "kerberosIV/" -compact
161 .It Pa scsi/
162 The SCSI device on top of CAM
163 .El
164 .It Pa dev/
165 C include files for programming various
166 .Fx
167 devices
168 .Bl -tag -width "kerberosIV/" -compact
169 .It Pa ppbus/
170 The parallel port bus;
171 see
172 .Xr ppbus 4
173 .It Pa usb/
174 The USB subsystem
175 .El
176 .It Pa fs/
177 .Bl -tag -width "kerberosIV/" -compact
178 .It Pa smbfs/
179 SMB/CIFS filesystem
180 .El
181 .It Pa g++/
182 GNU C++ include files
183 .Bl -tag -width "kerberosIV/" -compact
184 .It Pa std/
185 GNU C++ libstdc++ include files
186 .El
187 .It Pa isc/
188 ISC utility library libisc include files
189 .It Pa isofs/
190 .Bl -tag -width "kerberosIV/" -compact
191 .It Pa cd9660/
192 iso9660 filesystem
193 .El
194 .It Pa kerberosIV/
195 C include files for kerberos authentication package;
196 see
197 .Xr kerberos 1
198 .It Pa libmilter/
199 C include files for libmilter,
200 the sendmail mail filter API
201 .It Pa machine/
202 machine-specific C include files
203 .It Pa msdosfs/
204 MS-DOS file system
205 .It Pa net/
206 misc network C include files
207 .It Pa netatalk/
208 Appletalk protocol
209 .It Pa netatm/
210 ATM include files;
211 see
212 .Xr atm 8
213 .It Pa netinet/
214 C include files for Internet standard protocols;
215 see
216 .Xr inet 4
217 .It Pa netinet6/
218 C include files for Internet protocol version 6;
219 see
220 .Xr inet6 4
221 .It Pa netipx/
222 IPX/SPX protocol stacks
223 .It Pa netkey/
224 kernel key-management service
225 .It Pa netnatm/
226 NATM include files;
227 see
228 .Xr natm 4
229 .It Pa netns/
230 Xerox NS protocols
231 .It Pa netsmb/
232 SMB/CIFS requester
233 .It Pa nfs/
234 C include files for NFS (Network File System)
235 .It Pa objc/
236 Objective C include files
237 .It Pa openssl/
238 OpenSSL (Cryptography/SSL toolkit) headers
239 .It Pa pccard/
240 PC-CARD controllers
241 .It Pa posix4/
242 POSIX real-time extensions includes;
243 see
244 .Xr p1003_1b 9
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 ss/
262 MIT SIPB
263 .Sq subsystem
264 library, part of Kerberos IV.
265 .It Pa sys/
266 system C include files (kernel data structures)
267 .\" .It Pa tcl/
268 .\" Tcl language;
269 .\" see
270 .\" .Xr Tcl n
271 .\" .Bl -tag -width "kerberosIV/" -compact
272 .\" .It Pa generic/
273 .\" ???
274 .\" .It Pa unix/
275 .\" ???
276 .\" .El
277 .It Pa ufs/
278 C include files for UFS (The U-word File System)
279 .Bl -tag -width "kerberosIV/" -compact
280 .It Pa ffs/
281 Fast filesystem
282 .It Pa mfs/
283 memory file system;
284 see
285 .Xr mount_mfs 8
286 .It Pa ufs/
287 UFS filesystem
288 .El
289 .It Pa vm/
290 virtual memory;
291 see
292 .Xr vmstat 8
293 .El
294 .Pp
295 .It Pa lib/
296 archive libraries
297 .Bl -tag -width Fl -compact
298 .It Pa aout/
299 a.out archive libraries
300 .It Pa compat/
301 shared libraries for compatibility
302 .Bl -tag -width Fl -compact
303 .It Pa aout/
304 a.out backward compatibility libraries
305 .El
306 .El
307 .Pp
308 .It Pa libdata/
309 misc. utility data files
310 .Bl -tag -width Fl -compact
311 .It Pa doscmd/
312 files used by doscmd (drivers, fonts, etc.);
313 see
314 .Xr doscmd 1
315 .Bl -tag -width 6n -compact
316 .It Pa fonts/
317 fonts used by doscmd
318 .El
319 .It Pa gcc/
320 ???
321 .It Pa ldscripts/
322 linker scripts;
323 see
324 .Xr ld 1
325 .It Pa lint/
326 various prebuilt lint libraries;
327 see
328 .Xr lint 1
329 .It Pa msdosfs/
330 Character set conversion tables
331 .It Pa perl/
332 .Bl -tag -width Fl -compact
333 .It Pa 5.00503/
334 contains Perl modules for Perl version 5.00503;
335 see
336 .Xr perl 1
337 .El
338 .It Pa stallion/
339 holds the download firmware images
340 .El
341 .Pp
342 .It Pa libexec/
343 system daemons & system utilities (executed by other programs)
344 .Bl -tag -width Fl -compact
345 .It Pa aout/
346 utilities to manipulate a.out executables
347 .It Pa elf/
348 utilities to manipulate ELF executables
349 .It Pa lpr/
350 utilities and filters for LP print system;
351 see
352 .Xr lpr 1
353 .It Pa sendmail/
354 the sendmail binary;
355 see
356 .Xr mailwrapper 8
357 and
358 .Xr sendmail 8
359 .It Pa sm.bin/
360 restricted shell for sendmail;
361 see
362 .Xr smrsh 8
363 .It Pa uucp/
364 uucp utilities;
365 see
366 .Xr uucp 1
367 .El
368 .Pp
369 .It Pa local/
370 local executables, libraries, etc.
371 Also used as the default destination for the
372 .Fx
373 ports framework.
374 Within local/, the general layout sketched out by
375 .Xr hier 7
376 for /usr
377 should be used.  Exceptions are the man directory (directly under local/
378 rather than under local/share/), ports documentation (in share/doc/<port>/),
379 and /usr/local/etc (mimics /etc).
380 .It Pa obj/
381 architecture-specific target tree produced by building the /usr/src tree
382 .It Pa ports/
383 The
384 .Fx
385 ports collection (optional).
386 .It Pa sbin/
387 system daemons & system utilities (executed by users)
388 .It Pa share/
389 architecture-independent files
390 .Pp
391 .Bl -tag -width "calendar/" -compact
392 .It Pa calendar/
393 a variety of pre-fab calendar files;
394 see
395 .Xr calendar 1
396 .It Pa dict/
397 word lists;
398 see
399 .Xr look 1
400 .Pp
401 .Bl -tag -width Fl -compact
402 .It Pa web2
403 words from Webster's 2nd International
404 .It Pa words
405 common words
406 .It Pa papers/
407 reference databases;
408 see
409 .Xr refer 1
410 .El
411 .Pp
412 .It Pa doc/
413 miscellaneous documentation;
414 source for most of the printed
415 .Bx
416 manuals (available
417 from the
418 .Tn USENIX
419 association)
420 .Bl -tag -width Fl -compact
421 .It Pa FAQ/
422 Frequently Asked Questions
423 .It Pa IPv6/
424 implementation notes for IPv6
425 .It Pa bind/
426 documents pertaining to BIND (the Berkeley Internet Name Domain)
427 .It Pa es/
428 Spanish translations of documents in /usr/share/doc
429 .It Pa handbook/
430 .Fx
431 Handbook
432 .It Pa ja/
433 Japanese translations of documents in /usr/share/doc
434 .It Pa ncurses/
435 HTML documents pertaining to ncurses;
436 see
437 .Xr ncurses 3X
438 .It Pa ntp/
439 HTML documents pertaining to the Network Time Protocol
440 .It Pa papers/
441 UNIX Papers
442 .It Pa psd/
443 UNIX Programmer's Supplementary Documents
444 .It Pa ru/
445 Russian translations of documents in /usr/share/doc
446 .It Pa smm/
447 UNIX System Manager's Manual
448 .It Pa tutorials/
449 .Fx
450 tutorials
451 .It Pa usd/
452 UNIX User's Supplementary Documents
453 .It Pa zh/
454 Chinese translations of documents in /usr/share/doc
455 .El
456 .Pp
457 .It Pa examples/
458 various examples for users and programmers
459 .It Pa games/
460 ASCII text files used by various games
461 .It Pa groff_font/
462 device description file for device name
463 .It Pa info/
464 GNU Info hypertext system
465 .It Pa isdn/
466 ISDN
467 .It Pa libg++/
468 libg++'s genclass prototype/template class files
469 .It Pa locale/
470 localization files;
471 see
472 .Xr setlocale 3
473 .It Pa man/
474 manual pages
475 .It Pa me/
476 macros for use with the me macro package;
477 see
478 .Xr me 7
479 .It Pa misc/
480 misc system-wide ASCII text files
481 .Bl -tag -width Fl -compact
482 .It Pa fonts/
483 ???
484 .It Pa pcvtfonts/
485 pcvt fonts;
486 see
487 .Xr pcvt 4
488 .It Pa termcap
489 terminal characteristics database;
490 see
491 .Xr termcap 5
492 .El
493 .It Pa mk/
494 templates for make;
495 see
496 .Xr make 1
497 .It Pa nls/
498 national language support files;
499 see
500 .Xr mklocale 1
501 .It Pa pcvt/
502 pcvt documentation and etc examples;
503 see
504 .Xr pcvt 4
505 .It Pa perl/
506 perl library files;
507 see
508 .Xr perl 1
509 .It Pa sendmail/
510 sendmail configuration files;
511 see
512 .Xr sendmail 8
513 .It Pa skel/
514 example . (dot) files for new accounts
515 .It Pa syscons/
516 files used by syscons;
517 see
518 .Xr syscons 4
519 .Bl -tag -width "scrnmaps/xx" -compact
520 .It Pa fonts/
521 console fonts;
522 see
523 .Xr vidcontrol 1
524 and
525 .Xr vidfont 1
526 .It Pa keymaps/
527 console keyboard maps;
528 see
529 .Xr kbdcontrol 1
530 and
531 .Xr kbdmap 1
532 .It Pa scrnmaps/
533 console screen maps
534 .El
535 .It Pa tabset/
536 tab description files for a variety of terminals; used in
537 the termcap file;
538 see
539 .Xr termcap 5
540 .It Pa tmac/
541 text processing macros;
542 see
543 .Xr nroff 1
544 and
545 .Xr troff 1
546 .It Pa vi/
547 localization support and utilities for
548 .Xr vi 1
549 .It Pa zoneinfo/
550 timezone configuration information;
551 see
552 .Xr tzfile 5
553 .El
554 .It Pa src/
555 .Bx ,
556 third-party, and/or local source files
557 .Pp
558 .Bl -tag -width "kerberosIV/" -compact
559 .It Pa bin/
560 source code for files in /bin
561 .It Pa contrib/
562 source code for contributed software
563 .It Pa crypto/
564 source code for contributed cryptography software
565 .It Pa etc/
566 source code for files in /etc
567 .It Pa games/
568 source code for files in /usr/games
569 .It Pa gnu/
570 Utilities covered by the GNU General Public License
571 .It Pa include/
572 source code for files in /usr/include
573 .It Pa kerberosIV/
574 source code for kerberos version IV
575 .It Pa lib/
576 source code for files in /usr/lib
577 .It Pa libexec/
578 source code for files in /usr/libexec
579 .It Pa release/
580 files required to produce a
581 .Fx
582 release
583 .It Pa sbin/
584 source code for files in /sbin
585 .It Pa secure/
586 build directory for files in /usr/src/crypto
587 .It Pa share/
588 source for files in /usr/share
589 .It Pa sys/
590 kernel source code
591 .It Pa tools/
592 tools used for maintenance and testing of
593 .Fx
594 .It Pa usr.bin/
595 source code for files in /usr/bin
596 .It Pa usr.sbin/
597 source code for files in /usr/sbin
598 .El
599 .Pp
600 .It Pa X11R6/
601 X11R6 distribution executables, libraries, etc (optional).
602 .Bl -tag -width "include/" -compact
603 .It Pa bin/
604 X11R6 binaries (servers, utilities, local packages/ports).
605 .It Pa etc/
606 X11R6 configuration files and scripts.
607 .It Pa include/
608 X11R6 include files.
609 .It Pa lib/
610 X11R6 libraries.
611 .It Pa man/
612 X11R6 manual pages.
613 .It Pa share/
614 architecture-independent files.
615 .El
616 .El
617 .It Pa /var/
618 multi-purpose log, temporary, transient, and spool files
619 .Pp
620 .Bl -tag -width "preserve/" -compact
621 .It Pa account/
622 system accounting files
623 .Pp
624 .Bl -tag -width Fl -compact
625 .It Pa acct
626 execution accounting file;
627 see
628 .Xr acct 5
629 .El
630 .Pp
631 .It Pa at/
632 timed command scheduling files;
633 see
634 .Xr \&at 1
635 .Bl -tag -width "preserve/" -compact
636 .It Pa jobs/
637 directory containing job files
638 .It Pa spool/
639 directory containing output spool files
640 .El
641 .Pp
642 .It Pa backups/
643 misc. backup files
644 .It Pa crash/
645 default directory to store kernel crash dumps; see
646 .Xr crash 8
647 and
648 .Xr savecore 8
649 .It Pa cron/
650 files used by cron;
651 see
652 .Xr cron 8
653 .Bl -tag -width "preserve/" -compact
654 .It Pa tabs/
655 crontab files;
656 see
657 .Xr crontab 5
658 .El
659 .Pp
660 .It Pa db/
661 misc. automatically generated system-specific database files
662 .It Pa empty/
663 empty directory used by sshd(8) for privilege separation;
664 see
665 .Xr sshd 8
666 .It Pa games/
667 misc. game status and score files
668 .It Pa heimdal/
669 kerberos server databases; see
670 .Xr kdc 8
671 .It Pa log/
672 misc. system log files
673 .Pp
674 .Bl -tag -width Fl -compact
675 .It Pa wtmp
676 login/logout log;
677 see
678 .Xr wtmp 5
679 .El
680 .Pp
681 .It Pa mail/
682 user mailbox files
683 .It Pa msgs/
684 system messages database;
685 see
686 .Xr msgs 1
687 .It Pa preserve/
688 temporary home of files preserved after an accidental death
689 of an editor;
690 see
691 .Xr \&ex 1
692 .It Pa quotas/
693 filesystem quota information files
694 .It Pa run/
695 system information files describing various info about
696 system since it was booted
697 .Pp
698 .Bl -tag -width Fl -compact
699 .It Pa ppp/
700 writable by the
701 .Dq network
702 group for command connection sockets; see
703 .Xr ppp 8
704 .It Pa utmp
705 database of current users;
706 see
707 .Xr utmp 5
708 .El
709 .Pp
710 .It Pa rwho/
711 rwho data files;
712 see
713 .Xr rwhod 8 ,
714 .Xr rwho 1 ,
715 and
716 .Xr ruptime 1
717 .It Pa spool/
718 misc. printer and mail system spooling directories
719 .Pp
720 .Bl -tag -width Fl -compact
721 .It Pa clientmqueue/
722 undelivered submission mail queue;
723 see
724 .Xr sendmail 8
725 .It Pa ftp/
726 commonly ~ftp; the anonymous ftp root directory
727 .It Pa mqueue/
728 undelivered mail queue;
729 see
730 .Xr sendmail 8
731 .It Pa output/
732 line printer spooling directories
733 .It Pa uucp/
734 uucp spool directory
735 .It Pa uucppublic/
736 commonly ~uucp; public uucp temporary directory
737 .El
738 .Pp
739 .It Pa tmp/
740 temporary files that are kept between system reboots
741 .Bl -tag -width Fl -compact
742 .It Pa vi.recover/
743 the directory where recovery files are stored
744 .El
745 .It Pa yp/
746 the NIS maps
747 .El
748 .El
749 .Sh NOTES
750 This manual page documents the default
751 .Fx
752 filesystem layout, but
753 the actual hierarchy on a given system is defined at the system
754 administrator's discretion.
755 A well-maintained installation will include a customized version of
756 this document.
757 .Sh SEE ALSO
758 .Xr apropos 1 ,
759 .Xr find 1 ,
760 .Xr finger 1 ,
761 .Xr grep 1 ,
762 .Xr ls 1 ,
763 .Xr whatis 1 ,
764 .Xr whereis 1 ,
765 .Xr which 1 ,
766 .Xr fsck 8
767 .Sh HISTORY
768 A
769 .Nm
770 manual page appeared in
771 .At v7 .