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