]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - share/man/man7/hier.7
sqlite3: Vendor import of sqlite3 3.40.1
[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 23, 2022
32 .Dt HIER 7
33 .Os
34 .Sh NAME
35 .Nm hier
36 .Nd layout of file systems
37 .Sh SYNOPSIS
38 A sketch of the file system hierarchy.
39 .Sh DESCRIPTION
40 .Bl -tag -width "/libexec/"
41 .It Pa /
42 root directory of the file system
43 .It Pa /bin/
44 user utilities fundamental to both single-user and multi-user environments
45 .It Pa /boot/
46 programs and configuration files used during operating system bootstrap
47 .Pp
48 .Bl -tag -width "defaults/" -compact
49 .It Pa defaults/
50 default bootstrapping configuration files; see
51 .Xr loader.conf 5
52 .It Pa dtb/
53 Compiled flattened device tree (FDT) files; see
54 .Xr fdt 4
55 and
56 .Xr dtc 1
57 .It Pa efi/
58 Mount point for EFI System Partition (ESP) on UEFI systems
59 .It Pa firmware/
60 loadable kernel modules containing binary firmware for hardware that needs
61 firmware downloaded to it to function
62 .It Pa kernel/
63 pure kernel executable (the operating system loaded into memory
64 at boot time) and kernel modules
65 .It Pa modules/
66 third-party loadable kernel modules, such as the ones installed from
67 .Xr ports 7
68 .It Pa overlays/
69 Compiled flattened device tree (FDT) overlays; see
70 .Xr fdt 4
71 and
72 .Xr dtc 1
73 .It Pa zfs/
74 .Xr zfs 8
75 zpool cache files
76 .El
77 .It Pa /compat/
78 normally a link to
79 .Pa /usr/compat .
80 If not, then the
81 .Pa /usr/compat
82 comments apply
83 .It Pa /dev/
84 device special files managed by
85 .Xr devfs 5
86 .Pp
87 .Bl -tag -width "defaults/" -compact
88 .It Pa fd/
89 file descriptor files;
90 see
91 .Xr \&fd 4
92 .El
93 .It Pa /etc/
94 system configuration files and scripts
95 .Pp
96 .Bl -tag -width "defaults/" -compact
97 .It Pa defaults/
98 default system configuration files;
99 see
100 .Xr rc 8
101 .It Pa bluetooth/
102 bluetooth configuration files
103 .It Pa localtime
104 local timezone information;
105 see
106 .Xr ctime 3
107 .It Pa mail/
108 Sendmail control files
109 .It Pa mtree/
110 mtree configuration files;
111 see
112 .Xr mtree 8
113 .It Pa pam.d/
114 configuration files for the Pluggable Authentication Modules (PAM)
115 library
116 .It Pa periodic/
117 scripts that are run daily, weekly, and monthly, via
118 .Xr cron 8 ;
119 see
120 .Xr periodic 8
121 .It Pa rc.d/
122 system and daemon startup/control scripts;
123 see
124 .Xr rc 8
125 .It Pa security/
126 OpenBSM audit configuration files;
127 see
128 .Xr audit 8
129 .It Pa ppp/
130 ppp configuration files;
131 see
132 .Xr ppp 8
133 .It Pa ssh/
134 OpenSSH configuration files;
135 see
136 .Xr ssh 1
137 .It Pa ssl/
138 OpenSSL configuration files
139 .El
140 .It Pa /lib/
141 critical system libraries needed for binaries in
142 .Pa /bin
143 and
144 .Pa /sbin
145 .Pp
146 .Bl -tag -width "defaults/" -compact
147 .It Pa casper/
148 service-specific
149 .Xr libcasper 3
150 Capsicum support libraries
151 .It Pa geom/
152 class-specific libraries for the
153 .Xr geom 8
154 utility
155 .It Pa nvmecontrol/
156 vendor-specific libraries to extend the
157 .Xr nvmecontrol 8
158 utility
159 .El
160 .It Pa /libexec/
161 critical system utilities needed for binaries in
162 .Pa /bin
163 and
164 .Pa /sbin
165 .It Pa /media/
166 contains subdirectories to be used as mount points
167 for removable media such as CDs, USB drives, and
168 floppy disks
169 .It Pa /mnt/
170 empty directory commonly used by
171 system administrators as a temporary mount point
172 .It Pa /net/
173 automounted NFS shares;
174 see
175 .Xr auto_master 5
176 .It Pa /nonexistent/
177 a non-existent directory;
178 by convention, it serves as a home directory
179 for special user accounts
180 that need no home directory;
181 see also
182 .Pa /var/empty/
183 .It Pa /proc/
184 process file system;
185 see
186 .Xr procfs 5
187 .It Pa /rescue/
188 statically linked programs for emergency recovery;
189 see
190 .Xr rescue 8
191 .It Pa /root/
192 root's HOME directory
193 .It Pa /sbin/
194 system programs and administration utilities
195 fundamental to both single-user and multi-user environments
196 .It Pa /tmp/
197 temporary files that are not guaranteed to persist across system reboots
198 .It Pa /usr/
199 contains the majority of user utilities and applications
200 .Pp
201 .Bl -tag -width "freebsd-dist/" -compact
202 .It Pa bin/
203 common utilities, programming tools, and applications
204 .It Pa compat/
205 files needed to support binary compatibility with other operating systems;
206 see
207 .Xr linux 4
208 .It Pa freebsd-dist/
209 distribution files
210 .Pq like base.txz ;
211 see
212 .Xr release 7
213 and
214 .Xr bsdinstall 8
215 .It Pa include/
216 standard C include files
217 .Pp
218 .Bl -tag -width "kerberos5/" -compact
219 .It Pa arpa/
220 C include files for Internet service protocols
221 .It Pa bsnmp/
222 C include files for the SNMP daemon
223 .It Pa c++/
224 C++ include files
225 .It Pa cam/
226 C include files for the Common Access Methods Layer
227 .Bl -tag -width "kerberos5/" -compact
228 .It Pa scsi/
229 SCSI device on top of CAM
230 .El
231 .It Pa dev/
232 C include files for programming various
233 .Fx
234 devices
235 .Bl -tag -width "kerberos5/" -compact
236 .It Pa ic/
237 various header files describing driver- and bus-independent
238 hardware circuits
239 .It Pa ofw/
240 Open Firmware support
241 .It Pa pbio/
242 8255 PPI cards;
243 see
244 .Xr pbio 4
245 .It Pa ppbus/
246 parallel port bus;
247 see
248 .Xr ppbus 4
249 .It Pa usb/
250 USB subsystem
251 .El
252 .It Pa fs/
253 .Bl -tag -width "kerberos5/" -compact
254 .It Pa fdescfs/
255 per-process file descriptors file system
256 .It Pa msdosfs/
257 MS-DOS file system
258 .It Pa nfs/
259 C include files for NFS (Network File System) version 2, 3 and 4
260 .It Pa nullfs/
261 loopback file system
262 .It Pa procfs/
263 process file system
264 .It Pa smbfs/
265 SMB/CIFS file system
266 .It Pa udf/
267 UDF file system
268 .It Pa unionfs
269 union file system
270 .El
271 .It Pa geom/
272 GEOM framework
273 .Bl -tag -width "kerberos5/" -compact
274 .It Pa concat/
275 CONCAT GEOM class
276 .It Pa gate/
277 GATE GEOM class
278 .It Pa mirror/
279 MIRROR GEOM class
280 .It Pa nop/
281 NOP GEOM class
282 .It Pa raid3/
283 RAID3 GEOM class
284 .It Pa stripe/
285 STRIPE GEOM class
286 .El
287 .It Pa libmilter/
288 C include files for libmilter,
289 the
290 .Xr sendmail 8
291 mail filter API
292 .It Pa machine/
293 machine-specific C include files
294 .It Pa net/
295 miscellaneous network C include files
296 .Bl -tag -width Fl -compact
297 .It Pa altq/
298 C include files for alternate packet queuing; see
299 .Xr altq 4
300 .El
301 .It Pa net80211/
302 C include files for 802.11 wireless networking;
303 see
304 .Xr net80211 4
305 .It Pa netinet/
306 C include files for Internet standard protocols;
307 see
308 .Xr inet 4
309 .It Pa netinet6/
310 C include files for Internet protocol version 6;
311 see
312 .Xr inet6 4
313 .It Pa netipsec/
314 kernel key-management service;
315 see
316 .Xr ipsec 4
317 .It Pa netsmb/
318 SMB/CIFS requester
319 .It Pa nfs/
320 C include files for NFS (Network File System) version 2 and 3 (legacy)
321 .It Pa openssl/
322 OpenSSL (Cryptography/SSL toolkit) headers
323 .It Pa protocols/
324 C include files for Berkeley service protocols
325 .It Pa rpc/
326 remote procedure calls;
327 see
328 .Xr rpc 3
329 .It Pa rpcsvc/
330 definition of RPC service structures; see
331 .Xr rpc 3
332 .It Pa security/
333 PAM; see
334 .Xr pam 3
335 .It Pa sys/
336 system C include files (kernel data structures)
337 .\" .It Pa tcl/
338 .\" Tcl language;
339 .\" see
340 .\" .Xr Tcl n
341 .\" .Bl -tag -width "kerberos5/" -compact
342 .\" .It Pa generic/
343 .\" ???
344 .\" .It Pa unix/
345 .\" ???
346 .\" .El
347 .It Pa ufs/
348 C include files for UFS (The U-word File System)
349 .Bl -tag -width "kerberos5/" -compact
350 .It Pa ffs/
351 Fast file system
352 .It Pa ufs/
353 UFS file system
354 .El
355 .It Pa vm/
356 virtual memory;
357 see
358 .Xr vmstat 8
359 .El
360 .Pp
361 .It Pa lib/
362 shared and archive
363 .Xr ar 1 Ns -type
364 libraries
365 .Pp
366 .Bl -tag -width Fl -compact
367 .It Pa compat/
368 shared libraries for compatibility
369 .It Pa debug/
370 standalone debug data for the kernel and base system libraries and binaries
371 .It Pa dtrace/
372 DTrace library scripts
373 .It Pa engines/
374 OpenSSL (Cryptography/SSL toolkit) dynamically loadable engines
375 .El
376 .Pp
377 .It Pa libdata/
378 miscellaneous utility data files
379 .Pp
380 .Bl -tag -width Fl -compact
381 .It Pa gcc/
382 GCC configuration data
383 .It Pa ldscripts/
384 linker scripts;
385 see
386 .Xr ld 1
387 .It Pa pkgconfig/
388 .Xr pc 5 Pq Pa ports/devel/pkgconf
389 files: collections of compiler flags, linker flags, and other
390 information relevant to library use
391 .El
392 .Pp
393 .It Pa libexec/
394 system daemons & system utilities (executed by other programs)
395 .Pp
396 .Bl -tag -width Fl -compact
397 .It Pa aout/
398 utilities to manipulate a.out executables
399 .It Pa elf/
400 utilities to manipulate ELF executables
401 .It Pa lpr/
402 utilities and filters for LP print system;
403 see
404 .Xr lpr 1
405 .It Pa sendmail/
406 the
407 .Xr sendmail 8
408 binary;
409 see
410 .Xr mailwrapper 8
411 .It Pa sm.bin/
412 restricted shell for
413 .Xr sendmail 8 ;
414 see
415 .Xr smrsh 8
416 .El
417 .Pp
418 .It Pa local/
419 local executables, libraries, etc.
420 Also used as the default destination for the
421 .Xr ports 7
422 framework.
423 Within
424 .Pa local/ ,
425 the general layout sketched out by
426 .Nm
427 for
428 .Pa /usr
429 should be used.
430 Exceptions are the
431 ports documentation
432 .Po in
433 .Pa share/doc/<port>/ Ns Pc ,
434 and
435 .Pa /usr/local/etc
436 .Po mimics
437 .Pa /etc Ns Pc .
438 .It Pa obj/
439 architecture-specific target tree produced by building
440 .Fx
441 from source;
442 see
443 .Xr build 7
444 .It Pa ports/
445 .Fx
446 ports collection; see
447 .Xr ports 7
448 .It Pa sbin/
449 system daemons & system utilities (executed by users)
450 .It Pa share/
451 architecture-independent files
452 .Pp
453 .Bl -tag -width Fl -compact
454 .It Pa calendar/
455 a variety of pre-fab calendar files;
456 see
457 .Xr calendar 1
458 .It Pa dict/
459 word lists;
460 see
461 .Xr look 1
462 .Bl -tag -width Fl -compact
463 .It Pa freebsd
464 .Fx Ns -specific
465 terms, proper names, and jargon
466 .It Pa web2
467 words from Webster's Second International
468 .El
469 .It Pa doc/
470 miscellaneous documentation;
471 source for most of the printed
472 .Bx
473 manuals (available
474 from the USENIX 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 .