share/man/man5/kernfs.5

   1 .\" Copyright (c) 1996
   2 .\"     Mike Pritchard <mpp@FreeBSD.org>.  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 Mike Pritchard.
  15 .\" 4. Neither the name of author nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd December 14, 1996
  34 .Dt KERNFS 5
  35 .Os BSD 4.4
  36 .Sh NAME
  37 .Nm kernfs
  38 .Nd kernel file system
  39 .Sh SYNOPSIS
  40 .Bd -literal
  41 kern            /kern   kernfs  rw 0 0
  42 .Ed
  43 .Sh DESCRIPTION
  44 The kernel file system, or
  45 .Nm kernfs ,
  46 provides access to information on the currently running kernel.
  47 It is normally mounted on
  48 .Pa /kern .
  49 The file system includes several regular files which can be
  50 read, and some of which can also be written.
  51 The contents of the files are in a machine-independent format,
  52 either a string or an integer in decimal ASCII.  A trailing
  53 newline character is added when a number is returned.
  54 .Pp
  55 The mount point contains the following files:
  56 .Bl -tag -width copyright
  57 .It Pa bootfile
  58 The path from which the current kernel was booted.
  59 .It Pa boottime
  60 The time at which the system was last booted (decimal ASCII).
  61 .It Pa copyright
  62 The kernel copyright message.
  63 .It Pa hostname
  64 The current hostname, with a trailing newline.  The
  65 current hostname can be changed by writing to this file.
  66 A trailing newline will be stripped from the hostname being
  67 written.
  68 .It Pa hz
  69 The frequency of the system clock (decimal ASCII).
  70 .It Pa  loadavg
  71 The 1, 5 and 15 minute load averages in kernel fixed-point
  72 format.  The final integer is the fix-point scaling factor.
  73 All numbers are in decimal ASCII.
  74 .It Pa pagesize
  75 The machine pagesize (decimal ASCII).
  76 .It Pa physmem
  77 The number of pages of physical memory in the machine (decimal ASCII).
  78 .It Pa root
  79 The system root directory.  In a chroot'ed environment,
  80 .Xr mount_kernfs 8
  81 can be used to create a new
  82 .Pa /kern
  83 mount point.
  84 .Pa /kern/root
  85 will then refer to the system global root, not the current
  86 process root.  Not currently enabled.
  87 .It Pa rootdev
  88 The root device.  Not currently enabled.
  89 .It Pa rrootdev
  90 The raw root device.  Not currently enabled.
  91 .It Pa time
  92 The second and microsecond values of the system clock (decimal ASCII).
  93 .It Pa version
  94 The kernel version string.  The head line for
  95 .Pa /etc/motd
  96 can be generated by running
  97 .Dq Ic "sed 1q /kern/version"
  98 .El
  99 .Pp
 100 Most of the information provided by the
 101 .Nm
 102 is also available from
 103 .Xr sysctl 8 .
 104 .Sh FILES
 105 .Bl -tag -width /kern/XXXXXXX
 106 .It Pa /kern
 107 normal mount point for the
 108 .Nm kernfs .
 109 .El
 110 .Sh SEE ALSO
 111 .Xr sysctl 3 ,
 112 .Xr mount_kernfs 8 ,
 113 .Xr sysctl 8
 114 .Sh HISTORY
 115 The
 116 .Nm
 117 first appeared in
 118 .Bx 4.4 .
 119 The
 120 .Nm
 121 manual page first appeared in
 122 .Fx 2.2 .
 123 .Sh AUTHORS
 124 This manual page was written by
 125 .An Mike Pritchard Aq mpp@FreeBSD.org ,
 126 and was adapted from the
 127 .Xr mount_kernfs 8
 128 manual page written by
 129 .An Jan-Simon Pendry .