]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - share/man/man7/hier.7
Remove disused /cdrom toplevel dir from hier(7).
[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. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)hier.7      8.1 (Berkeley) 6/5/93
29 .\" $FreeBSD$
30 .\"
31 .Dd November 22, 2022
32 .Dt HIER 7
33 .Os
34 .Sh NAME
35 .Nm hier
36 .Nd layout of file systems
37 .Sh DESCRIPTION
38 A sketch of the file system hierarchy.
39 .Bl -tag -width "/libexec/"
40 .It Pa /
41 root directory of the file system
42 .It Pa /bin/
43 user utilities fundamental to both single-user and multi-user environments
44 .It Pa /boot/
45 programs and configuration files used during operating system bootstrap
46 .Pp
47 .Bl -tag -width "defaults/" -compact
48 .It Pa defaults/
49 default bootstrapping configuration files; see
50 .Xr loader.conf 5
51 .It Pa dtb/
52 Compiled flattened device tree (FDT) files; see
53 .Xr fdt 4
54 and
55 .Xr dtc 1
56 .It Pa efi/
57 Mount point for EFI System Partition (ESP) on UEFI systems
58 .It Pa firmware/
59 loadable kernel modules containing binary firmware for hardware that needs
60 firmware downloaded to it to function
61 .It Pa kernel/
62 pure kernel executable (the operating system loaded into memory
63 at boot time) and kernel modules
64 .It Pa modules/
65 third-party loadable kernel modules, such as the ones installed from
66 .Xr ports 7
67 .It Pa overlays/
68 Compiled flattened device tree (FDT) overlays; see
69 .Xr fdt 4
70 and
71 .Xr dtc 1
72 .It Pa zfs/
73 .Xr zfs 8
74 zpool cache files
75 .El
76 .It Pa /compat/
77 normally a link to
78 .Pa /usr/compat .
79 If not, then the
80 .Pa /usr/compat
81 comments apply
82 .It Pa /dev/
83 device special files managed by
84 .Xr devfs 5
85 .Pp
86 .Bl -tag -width "defaults/" -compact
87 .It Pa fd/
88 file descriptor files;
89 see
90 .Xr \&fd 4
91 .El
92 .It Pa /etc/
93 system configuration files and scripts
94 .Pp
95 .Bl -tag -width "defaults/" -compact
96 .It Pa defaults/
97 default system configuration files;
98 see
99 .Xr rc 8
100 .It Pa bluetooth/
101 bluetooth configuration files
102 .It Pa localtime
103 local timezone information;
104 see
105 .Xr ctime 3
106 .It Pa mail/
107 Sendmail control files
108 .It Pa mtree/
109 mtree configuration files;
110 see
111 .Xr mtree 8
112 .It Pa pam.d/
113 configuration files for the Pluggable Authentication Modules (PAM)
114 library
115 .It Pa periodic/
116 scripts that are run daily, weekly, and monthly, via
117 .Xr cron 8 ;
118 see
119 .Xr periodic 8
120 .It Pa rc.d/
121 system and daemon startup/control scripts;
122 see
123 .Xr rc 8
124 .It Pa security/
125 OpenBSM audit configuration files;
126 see
127 .Xr audit 8
128 .It Pa ppp/
129 ppp configuration files;
130 see
131 .Xr ppp 8
132 .It Pa ssh/
133 OpenSSH configuration files;
134 see
135 .Xr ssh 1
136 .It Pa ssl/
137 OpenSSL configuration files
138 .El
139 .It Pa /lib/
140 critical system libraries needed for binaries in
141 .Pa /bin
142 and
143 .Pa /sbin
144 .Pp
145 .Bl -tag -width "defaults/" -compact
146 .It Pa casper/
147 service-specific
148 .Xr libcasper 3
149 Capsicum support libraries
150 .It Pa geom/
151 class-specific libraries for the
152 .Xr geom 8
153 utility
154 .It Pa nvmecontrol/
155 vendor-specific libraries to extend the
156 .Xr nvmecontrol 8
157 utility
158 .El
159 .It Pa /libexec/
160 critical system utilities needed for binaries in
161 .Pa /bin
162 and
163 .Pa /sbin
164 .It Pa /media/
165 contains subdirectories to be used as mount points
166 for removable media such as CDs, USB drives, and
167 floppy disks
168 .It Pa /mnt/
169 empty directory commonly used by
170 system administrators as a temporary mount point
171 .It Pa /net/
172 automounted NFS shares;
173 see
174 .Xr auto_master 5
175 .It Pa /nonexistent/
176 a non-existent directory;
177 by convention, it serves as a home directory
178 for special user accounts
179 that need no home directory;
180 see also
181 .Pa /var/empty/
182 .It Pa /proc/
183 process file system;
184 see
185 .Xr procfs 5
186 .It Pa /rescue/
187 statically linked programs for emergency recovery;
188 see
189 .Xr rescue 8
190 .It Pa /root/
191 root's HOME directory
192 .It Pa /sbin/
193 system programs and administration utilities
194 fundamental to both single-user and multi-user environments
195 .It Pa /tmp/
196 temporary files that are not guaranteed to persist across system reboots
197 .It Pa /usr/
198 contains the majority of user utilities and applications
199 .Pp
200 .Bl -tag -width "freebsd-dist/" -compact
201 .It Pa bin/
202 common utilities, programming tools, and applications
203 .It Pa compat/
204 files needed to support binary compatibility with other operating systems;
205 see
206 .Xr linux 4
207 .It Pa freebsd-dist/
208 distribution files
209 .Pq like base.txz ;
210 see
211 .Xr release 7
212 and
213 .Xr bsdinstall 8
214 .It Pa include/
215 standard C include files
216 .Pp
217 .Bl -tag -width "kerberos5/" -compact
218 .It Pa arpa/
219 C include files for Internet service protocols
220 .It Pa bsnmp/
221 C include files for the SNMP daemon
222 .It Pa c++/
223 C++ include files
224 .It Pa cam/
225 C include files for the Common Access Methods Layer
226 .Bl -tag -width "kerberos5/" -compact
227 .It Pa scsi/
228 SCSI device on top of CAM
229 .El
230 .It Pa dev/
231 C include files for programming various
232 .Fx
233 devices
234 .Bl -tag -width "kerberos5/" -compact
235 .It Pa ic/
236 various header files describing driver- and bus-independent
237 hardware circuits
238 .It Pa ofw/
239 Open Firmware support
240 .It Pa pbio/
241 8255 PPI cards;
242 see
243 .Xr pbio 4
244 .It Pa ppbus/
245 parallel port bus;
246 see
247 .Xr ppbus 4
248 .It Pa usb/
249 USB subsystem
250 .El
251 .It Pa fs/
252 .Bl -tag -width "kerberos5/" -compact
253 .It Pa fdescfs/
254 per-process file descriptors file system
255 .It Pa msdosfs/
256 MS-DOS file system
257 .It Pa nfs/
258 C include files for NFS (Network File System) version 2, 3 and 4
259 .It Pa nullfs/
260 loopback file system
261 .It Pa procfs/
262 process file system
263 .It Pa smbfs/
264 SMB/CIFS file system
265 .It Pa udf/
266 UDF file system
267 .It Pa unionfs
268 union file system
269 .El
270 .It Pa geom/
271 GEOM framework
272 .Bl -tag -width "kerberos5/" -compact
273 .It Pa concat/
274 CONCAT GEOM class
275 .It Pa gate/
276 GATE GEOM class
277 .It Pa mirror/
278 MIRROR GEOM class
279 .It Pa nop/
280 NOP GEOM class
281 .It Pa raid3/
282 RAID3 GEOM class
283 .It Pa stripe/
284 STRIPE GEOM class
285 .El
286 .It Pa libmilter/
287 C include files for libmilter,
288 the
289 .Xr sendmail 8
290 mail filter API
291 .It Pa machine/
292 machine-specific C include files
293 .It Pa net/
294 miscellaneous network C include files
295 .Bl -tag -width Fl -compact
296 .It Pa altq/
297 C include files for alternate packet queueing; see
298 .Xr altq 4
299 .El
300 .It Pa net80211/
301 C include files for 802.11 wireless networking;
302 see
303 .Xr net80211 4
304 .It Pa netinet/
305 C include files for Internet standard protocols;
306 see
307 .Xr inet 4
308 .It Pa netinet6/
309 C include files for Internet protocol version 6;
310 see
311 .Xr inet6 4
312 .It Pa netipsec/
313 kernel key-management service;
314 see
315 .Xr ipsec 4
316 .It Pa netsmb/
317 SMB/CIFS requester
318 .It Pa nfs/
319 C include files for NFS (Network File System) version 2 and 3 (legacy)
320 .It Pa openssl/
321 OpenSSL (Cryptography/SSL toolkit) headers
322 .It Pa protocols/
323 C include files for Berkeley service protocols
324 .It Pa rpc/
325 remote procedure calls;
326 see
327 .Xr rpc 3
328 .It Pa rpcsvc/
329 definition of RPC service structures; see
330 .Xr rpc 3
331 .It Pa security/
332 PAM; see
333 .Xr pam 8
334 .It Pa sys/
335 system C include files (kernel data structures)
336 .\" .It Pa tcl/
337 .\" Tcl language;
338 .\" see
339 .\" .Xr Tcl n
340 .\" .Bl -tag -width "kerberos5/" -compact
341 .\" .It Pa generic/
342 .\" ???
343 .\" .It Pa unix/
344 .\" ???
345 .\" .El
346 .It Pa ufs/
347 C include files for UFS (The U-word File System)
348 .Bl -tag -width "kerberos5/" -compact
349 .It Pa ffs/
350 Fast file system
351 .It Pa ufs/
352 UFS file system
353 .El
354 .It Pa vm/
355 virtual memory;
356 see
357 .Xr vmstat 8
358 .El
359 .Pp
360 .It Pa lib/
361 shared and archive
362 .Xr ar 1 Ns -type
363 libraries
364 .Pp
365 .Bl -tag -width Fl -compact
366 .It Pa compat/
367 shared libraries for compatibility
368 .It Pa debug/
369 standalone debug data for the kernel and base system libraries and binaries
370 .It Pa dtrace/
371 DTrace library scripts
372 .It Pa engines/
373 OpenSSL (Cryptography/SSL toolkit) dynamically loadable engines
374 .El
375 .Pp
376 .It Pa libdata/
377 miscellaneous utility data files
378 .Pp
379 .Bl -tag -width Fl -compact
380 .It Pa gcc/
381 .Xr gcc 1
382 configuration data
383 .It Pa ldscripts/
384 linker scripts;
385 see
386 .Xr ld 1
387 .It Pa pkgconfig/
388 pc files
389 .El
390 .Pp
391 .It Pa libexec/
392 system daemons & system utilities (executed by other programs)
393 .Pp
394 .Bl -tag -width Fl -compact
395 .It Pa aout/
396 utilities to manipulate a.out executables
397 .It Pa elf/
398 utilities to manipulate ELF executables
399 .It Pa lpr/
400 utilities and filters for LP print system;
401 see
402 .Xr lpr 1
403 .It Pa sendmail/
404 the
405 .Xr sendmail 8
406 binary;
407 see
408 .Xr mailwrapper 8
409 .It Pa sm.bin/
410 restricted shell for
411 .Xr sendmail 8 ;
412 see
413 .Xr smrsh 8
414 .El
415 .Pp
416 .It Pa local/
417 local executables, libraries, etc.
418 Also used as the default destination for the
419 .Xr ports 7
420 framework.
421 Within
422 .Pa local/ ,
423 the general layout sketched out by
424 .Nm
425 for
426 .Pa /usr
427 should be used.
428 Exceptions are the
429 ports documentation
430 .Po in
431 .Pa share/doc/<port>/ Ns Pc ,
432 and
433 .Pa /usr/local/etc
434 .Po mimics
435 .Pa /etc Ns Pc .
436 .It Pa obj/
437 architecture-specific target tree produced by building
438 .Fx
439 from source;
440 see
441 .Xr build 7
442 .It Pa ports/
443 .Fx
444 ports collection; see
445 .Xr ports 7
446 .It Pa sbin/
447 system daemons & system utilities (executed by users)
448 .It Pa share/
449 architecture-independent files
450 .Pp
451 .Bl -tag -width Fl -compact
452 .It Pa calendar/
453 a variety of pre-fab calendar files;
454 see
455 .Xr calendar 1
456 .It Pa dict/
457 word lists;
458 see
459 .Xr look 1
460 .Bl -tag -width Fl -compact
461 .It Pa freebsd
462 .Fx Ns -specific
463 terms, proper names, and jargon
464 .It Pa web2
465 words from Webster's 2nd International
466 .El
467 .It Pa doc/
468 miscellaneous documentation;
469 source for most of the printed
470 .Bx
471 manuals (available
472 from the
473 .Tn USENIX
474 association)
475 .Bl -tag -width Fl -compact
476 .It Pa FAQ/
477 Frequently Asked Questions
478 .It Pa IPv6/
479 implementation notes for IPv6
480 .It Pa es/
481 Spanish translations of documents in /usr/share/doc
482 .It Pa handbook/
483 .Fx
484 Handbook
485 .It Pa ja/
486 Japanese translations of documents in /usr/share/doc
487 .It Pa legal/
488 License files for vendor supplied firmware files
489 .It Pa ncurses/
490 HTML documents pertaining to ncurses;
491 see
492 .Xr ncurses 3
493 .It Pa ntp/
494 HTML documents pertaining to the Network Time Protocol
495 .It Pa ru/
496 Russian translations of documents in /usr/share/doc
497 .It Pa tutorials/
498 .Fx
499 tutorials
500 .It Pa zh/
501 Chinese translations of documents in /usr/share/doc
502 .El
503 .It Pa examples/
504 various examples for users and programmers
505 .It Pa firmware/
506 firmware images loaded by userland programs
507 .It Pa games/
508 ASCII text files used by various games
509 .It Pa keys/
510 known trusted and revoked keys
511 .Bl -tag -width Fl -compact
512 .It Pa pkg/
513 fingerprints for
514 .Xr pkg 7
515 and
516 .Xr pkg 8
517 .El
518 .It Pa locale/
519 localization files;
520 see
521 .Xr setlocale 3
522 .It Pa man/
523 manual pages
524 .It Pa misc/
525 miscellaneous system-wide ASCII text files
526 .Bl -tag -width Fl -compact
527 .It Pa fonts/
528 ???
529 .It Pa termcap
530 terminal characteristics database;
531 see
532 .Xr termcap 5
533 .El
534 .It Pa mk/
535 templates for make;
536 see
537 .Xr make 1
538 .It Pa nls/
539 national language support files
540 .It Pa security/
541 data files for security policies such as
542 .Xr mac_lomac 4
543 .It Pa sendmail/
544 .Xr sendmail 8
545 configuration files
546 .It Pa skel/
547 example
548 .Pa .\&
549 (dot) files for new accounts
550 .It Pa snmp/
551 MIBs, example files and tree definitions for the SNMP daemon
552 .Bl -tag -width Fl -compact
553 .It Pa defs/
554 tree definition files for use with
555 .Xr gensnmptree 1
556 .It Pa mibs/
557 MIB files
558 .El
559 .It Pa syscons/
560 files used by syscons;
561 see
562 .Xr syscons 4
563 .Bl -tag -width Fl -compact
564 .It Pa fonts/
565 console fonts;
566 see
567 .Xr vidcontrol 1
568 and
569 .Xr vidfont 1
570 .It Pa keymaps/
571 console keyboard maps;
572 see
573 .Xr kbdcontrol 1
574 and
575 .Xr kbdmap 1
576 .It Pa scrnmaps/
577 console screen maps
578 .El
579 .It Pa sysroot/
580 files necessary for the -sysroot compiler/linker argument to build non-native
581 binaries.
582 .Bl -tag -width Fl -compact
583 .It Pa VERSION/
584 files for
585 .Fx
586 release VERSION.
587 By convention,
588 .Dq VERSION
589 matches
590 .Xr uname 1
591 .Fl r .
592 .Bl -tag -width Fl -compact
593 .It Pa MACHINE.MACHINE_ARCH/
594 represent the binary ABI for these files.
595 .Dq MACHINE
596 matches
597 .Xr uname 1
598 .Fl m .
599 .Dq MACHINE_ARCH
600 matches
601 .Xr uname 1
602 .Fl p .
603 .El
604 .El
605 .It Pa tabset/
606 tab description files for a variety of terminals; used in
607 the termcap file;
608 see
609 .Xr termcap 5
610 .It Pa vi/
611 localization support and utilities for
612 .Xr vi 1
613 .It Pa vt/
614 files used by vt;
615 see
616 .Xr vt 4
617 .Bl -tag -width Fl -compact
618 .It Pa fonts/
619 console fonts;
620 see
621 .Xr vidcontrol 1
622 and
623 .Xr vidfont 1
624 .It Pa keymaps/
625 console keyboard maps;
626 see
627 .Xr kbdcontrol 1
628 and
629 .Xr kbdmap 1
630 .\" .It Pa scrnmaps/
631 .\" console screen maps
632 .El
633 .It Pa zoneinfo/
634 timezone configuration information;
635 see
636 .Xr tzfile 5
637 .El
638 .Pp
639 .It Pa src/
640 .Fx
641 source code; see
642 .Xr development 7 .
643 The layout of the source tree is described by the top-level
644 .Pa README.md
645 file.
646 .Pp
647 .It Pa tests/
648 The
649 .Fx
650 test suite; see
651 .Xr tests 7
652 .El
653 .It Pa /var/
654 multi-purpose log, temporary, transient, and spool files
655 .Pp
656 .Bl -tag -width "defaults/" -compact
657 .It Pa account/
658 system accounting files
659 .Pp
660 .Bl -tag -width Fl -compact
661 .It Pa acct
662 execution accounting file;
663 see
664 .Xr acct 5
665 .El
666 .Pp
667 .It Pa at/
668 timed command scheduling files;
669 see
670 .Xr \&at 1
671 .Pp
672 .Bl -tag -width Fl -compact
673 .It Pa jobs/
674 directory containing job files
675 .It Pa spool/
676 directory containing output spool files
677 .El
678 .Pp
679 .It Pa backups/
680 miscellaneous backup files
681 .It Pa cache/
682 miscellaneous cached files
683 .Pp
684 .Bl -tag -width Fl -compact
685 .It Pa pkg/
686 cached packages for
687 .Xr pkg 8
688 .El
689 .Pp
690 .It Pa crash/
691 default directory to store kernel crash dumps; see
692 .Xr crash 8
693 and
694 .Xr savecore 8
695 .It Pa cron/
696 files used by cron;
697 see
698 .Xr cron 8
699 .Pp
700 .Bl -tag -width Fl -compact
701 .It Pa tabs/
702 crontab files;
703 see
704 .Xr crontab 5
705 .El
706 .Pp
707 .It Pa db/
708 miscellaneous automatically generated system-specific database files
709 .Bl -tag -width Fl -compact
710 .It Pa freebsd-update/
711 .Xr freebsd-update 8
712 work directory for temporary files and downloaded updates
713 .El
714 .It Pa empty/
715 empty directory for use by programs that need a specifically empty directory.
716 Used for instance by
717 .Xr sshd 8
718 for privilege separation
719 .It Pa games/
720 miscellaneous game status and score files
721 .It Pa heimdal/
722 Kerberos server databases; see
723 .Xr kdc 8
724 .It Pa log/
725 miscellaneous system log files
726 .Pp
727 .Bl -tag -width Fl -compact
728 .It Pa utx.lastlogin
729 last login log;
730 see
731 .Xr getutxent 3
732 .It Pa utx.log
733 login/logout log;
734 see
735 .Xr getutxent 3
736 .El
737 .Pp
738 .It Pa mail/
739 user mailbox files
740 .It Pa msgs/
741 system messages database;
742 see
743 .Xr msgs 1
744 .It Pa preserve/
745 temporary home of files preserved after an accidental death
746 of an editor;
747 see
748 .Xr \&ex 1
749 .It Pa quotas/
750 file system quota information files
751 .It Pa run/
752 system information files describing various info about
753 system since it was booted
754 .Pp
755 .Bl -tag -width Fl -compact
756 .It Pa bhyve/
757 .Xr bhyve 8
758 virtual machine
759 .Xr unix 4 Ns -domain sockets
760 .It Pa ppp/
761 writable by the
762 .Dq network
763 group for command connection sockets; see
764 .Xr ppp 8
765 .It Pa utx.active
766 database of current users;
767 see
768 .Xr getutxent 3
769 .El
770 .Pp
771 .It Pa rwho/
772 rwho data files;
773 see
774 .Xr rwhod 8 ,
775 .Xr rwho 1 ,
776 and
777 .Xr ruptime 1
778 .It Pa spool/
779 miscellaneous printer and mail system spooling directories
780 .Pp
781 .Bl -tag -width Fl -compact
782 .It Pa clientmqueue/
783 undelivered submission mail queue;
784 see
785 .Xr sendmail 8
786 .It Pa ftp/
787 ftp root directory;
788 see
789 .Xr ftpd 8
790 .It Pa mqueue/
791 undelivered mail queue;
792 see
793 .Xr sendmail 8
794 .It Pa output/
795 line printer spooling directories
796 .El
797 .Pp
798 .It Pa tmp/
799 temporary files that are kept between system reboots
800 .Pp
801 .Bl -tag -width Fl -compact
802 .It Pa vi.recover/
803 the directory where recovery files are stored
804 .El
805 .Pp
806 .It Pa yp/
807 the NIS maps; see
808 .Xr yp 8
809 .El
810 .El
811 .Sh NOTES
812 This manual page documents the default
813 .Fx
814 file system layout, but
815 the actual hierarchy on a given system is defined at the system
816 administrator's discretion.
817 A well-maintained installation will include a customized version of
818 this document.
819 .Sh SEE ALSO
820 .Xr apropos 1 ,
821 .Xr find 1 ,
822 .Xr grep 1 ,
823 .Xr ls 1 ,
824 .Xr whereis 1 ,
825 .Xr which 1
826 .Sh HISTORY
827 A
828 .Nm
829 manual page appeared in
830 .At v7 .