original/man7/hier.7

   1 .\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\" License.
  23 .\" Modified Sun Jul 25 11:05:58 1993 by Rik Faith (faith@cs.unc.edu)
  24 .\" Modified Sat Feb 10 16:18:03 1996 by Urs Thuermann (urs@isnogud.escape.de)
  25 .\" Modified Mon Jun 16 20:02:00 1997 by Nicolás Lichtmaier <nick@debian.org>
  26 .\" Modified Mon Feb  6 16:41:00 1999 by Nicolás Lichtmaier <nick@debian.org>
  27 .\" Modified Tue Feb  8 16:46:45 2000 by Chris Pepper <pepper@tgg.com>
  28 .\" Modified Fri Sep  7 20:32:45 2001 by Tammy Fox <tfox@redhat.com>
  29 .TH HIER 7  2009-03-30 "Linux" "Linux Programmer's Manual"
  30 .SH NAME
  31 hier \- Description of the file system hierarchy
  32 .SH DESCRIPTION
  33 A typical Linux system has, among others, the following directories:
  34 .TP
  35 .I /
  36 This is the root directory.
  37 This is where the whole tree starts.
  38 .TP
  39 .I /bin
  40 This directory contains executable programs which are needed in
  41 single user mode and to bring the system up or repair it.
  42 .TP
  43 .I /boot
  44 Contains static files for the boot loader.
  45 This directory only holds
  46 the files which are needed during the boot process.
  47 The map installer
  48 and configuration files should go to
  49 .I /sbin
  50 and
  51 .IR /etc .
  52 .TP
  53 .I /dev
  54 Special or device files, which refer to physical devices.
  55 See
  56 .BR mknod (1).
  57 .TP
  58 .I /etc
  59 Contains configuration files which are local to the machine.
  60 Some
  61 larger software packages, like X11, can have their own subdirectories
  62 below
  63 .IR /etc .
  64 Site-wide configuration files may be placed here or in
  65 .IR /usr/etc .
  66 Nevertheless, programs should always look for these files in
  67 .I /etc
  68 and you may have links for these files to
  69 .IR /usr/etc .
  70 .TP
  71 .I /etc/opt
  72 Host-specific configuration files for add-on applications installed
  73 in
  74 .IR /opt .
  75 .TP
  76 .I /etc/sgml
  77 This directory contains the configuration files for SGML and XML (optional).
  78 .TP
  79 .I /etc/skel
  80 When a new user account is created, files from this directory are
  81 usually copied into the user's home directory.
  82 .TP
  83 .I /etc/X11
  84 Configuration files for the X11 window system (optional).
  85 .TP
  86 .I /home
  87 On machines with home directories for users, these are usually beneath
  88 this directory, directly or not.
  89 The structure of this directory
  90 depends on local administration decisions.
  91 .TP
  92 .I /lib
  93 This directory should hold those shared libraries that are necessary
  94 to boot the system and to run the commands in the root file system.
  95 .TP
  96 .I /media
  97 This directory contains mount points for removable media such as CD
  98 and DVD disks or USB sticks.
  99 .TP
 100 .I /mnt
 101 This directory is a mount point for a temporarily mounted file system.
 102 In some distributions,
 103 .I /mnt
 104 contains subdirectories intended to be used as mount points for several
 105 temporary file systems.
 106 .TP
 107 .I /opt
 108 This directory should contain add-on packages that contain static files.
 109 .TP
 110 .I /proc
 111 This is a mount point for the
 112 .I proc
 113 file system, which provides information about running processes and
 114 the kernel.
 115 This pseudo-file system is described in more detail in
 116 .BR proc (5).
 117 .TP
 118 .I /root
 119 This directory is usually the home directory for the root user (optional).
 120 .TP
 121 .I /sbin
 122 Like
 123 .IR /bin ,
 124 this directory holds commands needed to boot the system, but which are
 125 usually not executed by normal users.
 126 .TP
 127 .I /srv
 128 This directory contains site-specific data that is served by this system.
 129 .TP
 130 .I /tmp
 131 This directory contains temporary files which may be deleted with no
 132 notice, such as by a regular job or at system boot up.
 133 .TP
 134 .I /usr
 135 This directory is usually mounted from a separate partition.
 136 It should hold only sharable, read-only data, so that it can be mounted
 137 by various machines running Linux.
 138 .TP
 139 .I /usr/X11R6
 140 The X\-Window system, version 11 release 6 (optional).
 141 .TP
 142 .I /usr/X11R6/bin
 143 Binaries which belong to the X\-Window system; often, there is a
 144 symbolic link from the more traditional
 145 .I /usr/bin/X11
 146 to here.
 147 .TP
 148 .I /usr/X11R6/lib
 149 Data files associated with the X\-Window system.
 150 .TP
 151 .I /usr/X11R6/lib/X11
 152 These contain miscellaneous files needed to run X;  Often, there is a
 153 symbolic link from
 154 .I /usr/lib/X11
 155 to this directory.
 156 .TP
 157 .I /usr/X11R6/include/X11
 158 Contains include files needed for compiling programs using the X11
 159 window system.
 160 Often, there is a symbolic link from
 161 .I /usr/include/X11
 162 to this directory.
 163 .TP
 164 .I /usr/bin
 165 This is the primary directory for executable programs.
 166 Most programs
 167 executed by normal users which are not needed for booting or for
 168 repairing the system and which are not installed locally should be
 169 placed in this directory.
 170 .TP
 171 .I /usr/bin/X11
 172 is the traditional place to look for X11 executables; on Linux, it
 173 usually is a symbolic link to
 174 .IR /usr/X11R6/bin .
 175 .TP
 176 .I /usr/dict
 177 Replaced by
 178 .IR /usr/share/dict .
 179 .TP
 180 .I /usr/doc
 181 Replaced by
 182 .IR /usr/share/doc .
 183 .TP
 184 .I /usr/etc
 185 Site-wide configuration files to be shared between several machines
 186 may be stored in this directory.
 187 However, commands should always
 188 reference those files using the
 189 .I /etc
 190 directory.
 191 Links from files in
 192 .I /etc
 193 should point to the appropriate files in
 194 .IR /usr/etc .
 195 .TP
 196 .I /usr/games
 197 Binaries for games and educational programs (optional).
 198 .TP
 199 .I /usr/include
 200 Include files for the C compiler.
 201 .TP
 202 .I /usr/include/X11
 203 Include files for the C compiler and the X\-Window system.
 204 This is
 205 usually a symbolic link to
 206 .IR /usr/X11R6/include/X11 .
 207 .TP
 208 .I /usr/include/asm
 209 Include files which declare some assembler functions.
 210 This used to be a
 211 symbolic link to
 212 .IR /usr/src/linux/include/asm .
 213 .TP
 214 .I /usr/include/linux
 215 This contains information which may change from system release to
 216 system release and used to be a symbolic link to
 217 .I /usr/src/linux/include/linux
 218 to get at operating system specific information.
 219
 220 (Note that one should have include files there that work correctly with
 221 the current libc and in user space.
 222 However, Linux kernel source is not
 223 designed to be used with user programs and does not know anything
 224 about the libc you are using.
 225 It is very likely that things will break
 226 if you let
 227 .I /usr/include/asm
 228 and
 229 .I /usr/include/linux
 230 point at a random kernel tree.
 231 Debian systems don't do this
 232 and use headers from a known good kernel
 233 version, provided in the libc*-dev package.)
 234 .TP
 235 .I /usr/include/g++
 236 Include files to use with the GNU C++ compiler.
 237 .TP
 238 .I /usr/lib
 239 Object libraries, including dynamic libraries, plus some executables
 240 which usually are not invoked directly.
 241 More complicated programs may
 242 have whole subdirectories there.
 243 .TP
 244 .I /usr/lib/X11
 245 The usual place for data files associated with X programs, and
 246 configuration files for the X system itself.
 247 On Linux, it usually is
 248 a symbolic link to
 249 .IR /usr/X11R6/lib/X11 .
 250 .TP
 251 .I /usr/lib/gcc-lib
 252 contains executables and include files for the GNU C compiler,
 253 .BR gcc (1).
 254 .TP
 255 .I /usr/lib/groff
 256 Files for the GNU groff document formatting system.
 257 .TP
 258 .I /usr/lib/uucp
 259 Files for
 260 .BR uucp (1).
 261 .TP
 262 .I /usr/local
 263 This is where programs which are local to the site typically go.
 264 .TP
 265 .I /usr/local/bin
 266 Binaries for programs local to the site.
 267 .TP
 268 .I /usr/local/doc
 269 Local documentation.
 270 .TP
 271 .I /usr/local/etc
 272 Configuration files associated with locally installed programs.
 273 .TP
 274 .I /usr/local/games
 275 Binaries for locally installed games.
 276 .TP
 277 .I /usr/local/lib
 278 Files associated with locally installed programs.
 279 .TP
 280 .I /usr/local/include
 281 Header files for the local C compiler.
 282 .TP
 283 .I /usr/local/info
 284 Info pages associated with locally installed programs.
 285 .TP
 286 .I /usr/local/man
 287 Man pages associated with locally installed programs.
 288 .TP
 289 .I /usr/local/sbin
 290 Locally installed programs for system administration.
 291 .TP
 292 .I /usr/local/share
 293 Local application data that can be shared among different architectures
 294 of the same OS.
 295 .TP
 296 .I /usr/local/src
 297 Source code for locally installed software.
 298 .TP
 299 .I /usr/man
 300 Replaced by
 301 .IR /usr/share/man .
 302 .TP
 303 .I /usr/sbin
 304 This directory contains program binaries for system administration
 305 which are not essential for the boot process, for mounting
 306 .IR /usr ,
 307 or for system repair.
 308 .TP
 309 .I /usr/share
 310 This directory contains subdirectories with specific application data, that
 311 can be shared among different architectures of the same OS.
 312 Often one finds stuff here that used to live in
 313 .I /usr/doc
 314 or
 315 .I /usr/lib
 316 or
 317 .IR /usr/man .
 318 .TP
 319 .I /usr/share/dict
 320 Contains the word lists used by spell checkers.
 321 .TP
 322 .I /usr/share/doc
 323 Documentation about installed programs.
 324 .TP
 325 .I /usr/share/games
 326 Static data files for games in
 327 .IR /usr/games .
 328 .TP
 329 .I /usr/share/info
 330 Info pages go here.
 331 .TP
 332 .I /usr/share/locale
 333 Locale information goes here.
 334 .TP
 335 .I /usr/share/man
 336 Manual pages go here in subdirectories according to the man page sections.
 337 .TP
 338 .I /usr/share/man/<locale>/man[1\-9]
 339 These directories contain manual pages for the
 340 specific locale in source code form.
 341 Systems which use a unique language and code set for all manual pages
 342 may omit the <locale> substring.
 343 .TP
 344 .I /usr/share/misc
 345 Miscellaneous data that can be shared among different architectures of the
 346 same OS.
 347 .TP
 348 .I /usr/share/nls
 349 The message catalogs for native language support go here.
 350 .TP
 351 .I /usr/share/sgml
 352 Files for SGML and XML.
 353 .TP
 354 .I /usr/share/terminfo
 355 The database for terminfo.
 356 .TP
 357 .I /usr/share/tmac
 358 Troff macros that are not distributed with groff.
 359 .TP
 360 .I /usr/share/zoneinfo
 361 Files for timezone information.
 362 .TP
 363 .I /usr/src
 364 Source files for different parts of the system, included with some packages
 365 for reference purposes.
 366 Don't work here with your own projects, as files
 367 below /usr should be read-only except when installing software.
 368 .TP
 369 .I /usr/src/linux
 370 This was the traditional place for the kernel source.
 371 Some distributions put here the source for the default kernel they ship.
 372 You should probably use another directory when building your own kernel.
 373 .TP
 374 .I /usr/tmp
 375 Obsolete.
 376 This should be a link
 377 to
 378 .IR /var/tmp .
 379 This link is present only for compatibility reasons and shouldn't be used.
 380 .TP
 381 .I /var
 382 This directory contains files which may change in size, such as spool
 383 and log files.
 384 .TP
 385 .I /var/adm
 386 This directory is superseded by
 387 .I /var/log
 388 and should be a symbolic link to
 389 .IR /var/log .
 390 .TP
 391 .I /var/backups
 392 Reserved for historical reasons.
 393 .TP
 394 .I /var/cache
 395 Data cached for programs.
 396 .TP
 397 .IR /var/catman/cat[1\-9] " or " /var/cache/man/cat[1\-9]
 398 These directories contain preformatted manual pages according to their
 399 man page section.
 400 (The use of preformatted manual pages is deprecated.)
 401 .TP
 402 .I /var/cron
 403 Reserved for historical reasons.
 404 .TP
 405 .I /var/lib
 406 Variable state information for programs.
 407 .TP
 408 .I /var/local
 409 Variable data for
 410 .IR /usr/local .
 411 .TP
 412 .I /var/lock
 413 Lock files are placed in this directory.
 414 The naming convention for
 415 device lock files is
 416 .I LCK..<device>
 417 where
 418 .I <device>
 419 is the device's name in the file system.
 420 The format used is that of HDU UUCP lock files, that is, lock files
 421 contain a PID as a 10-byte ASCII decimal number, followed by a newline
 422 character.
 423 .TP
 424 .I /var/log
 425 Miscellaneous log files.
 426 .TP
 427 .I /var/opt
 428 Variable data for
 429 .IR /opt .
 430 .TP
 431 .I /var/mail
 432 Users' mailboxes.
 433 Replaces
 434 .IR /var/spool/mail .
 435 .TP
 436 .I /var/msgs
 437 Reserved for historical reasons.
 438 .TP
 439 .I /var/preserve
 440 Reserved for historical reasons.
 441 .TP
 442 .I /var/run
 443 Run-time variable files, like files holding process identifiers (PIDs)
 444 and logged user information
 445 .IR (utmp) .
 446 Files in this directory are usually cleared when the system boots.
 447 .TP
 448 .I /var/spool
 449 Spooled (or queued) files for various programs.
 450 .TP
 451 .I /var/spool/at
 452 Spooled jobs for
 453 .BR at (1).
 454 .TP
 455 .I /var/spool/cron
 456 Spooled jobs for
 457 .BR cron (8).
 458 .TP
 459 .I /var/spool/lpd
 460 Spooled files for printing.
 461 .TP
 462 .I /var/spool/mail
 463 Replaced by
 464 .IR /var/mail .
 465 .TP
 466 .I /var/spool/mqueue
 467 Queued outgoing mail.
 468 .TP
 469 .I /var/spool/news
 470 Spool directory for news.
 471 .TP
 472 .I /var/spool/rwho
 473 Spooled files for
 474 .BR rwhod (8).
 475 .TP
 476 .I /var/spool/smail
 477 Spooled files for the
 478 .BR smail (1)
 479 mail delivery program.
 480 .TP
 481 .I /var/spool/uucp
 482 Spooled files for
 483 .BR uucp (1).
 484 .TP
 485 .I /var/tmp
 486 Like
 487 .IR /tmp ,
 488 this directory holds temporary files stored for an unspecified duration.
 489 .TP
 490 .I /var/yp
 491 Database files for NIS.
 492 .SH "CONFORMING TO"
 493 The Filesystem Hierarchy Standard, Version 2.2 <http://www.pathname.com/fhs/>.
 494 .SH BUGS
 495 This list is not exhaustive; different systems may be configured
 496 differently.
 497 .SH "SEE ALSO"
 498 .BR find (1),
 499 .BR ln (1),
 500 .BR proc (5),
 501 .BR mount (8)
 502
 503 The Filesystem Hierarchy Standard