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