Sync usage with man page.
[netbsd-mini2440.git] / sbin / mount_kernfs / mount_kernfs.8
bloba4f7b15b3a4880278945fec9d3c0538789f0ec4e
1 .\"     $NetBSD: mount_kernfs.8,v 1.15 2004/11/21 09:09:46 jmmv Exp $
2 .\"
3 .\" Copyright (c) 1992, 1993, 1994
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\" All rights reserved.
6 .\"
7 .\" This code is derived from software donated to Berkeley by
8 .\" Jan-Simon Pendry.
9 .\"
10 .\" Redistribution and use in source and binary forms, with or without
11 .\" modification, are permitted provided that the following conditions
12 .\" are met:
13 .\" 1. Redistributions of source code must retain the above copyright
14 .\"    notice, this list of conditions and the following disclaimer.
15 .\" 2. Redistributions in binary form must reproduce the above copyright
16 .\"    notice, this list of conditions and the following disclaimer in the
17 .\"    documentation and/or other materials provided with the distribution.
18 .\" 3. Neither the name of the University nor the names of its contributors
19 .\"    may be used to endorse or promote products derived from this software
20 .\"    without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" SUCH DAMAGE.
33 .\"
34 .\"     @(#)mount_kernfs.8      8.2 (Berkeley) 3/27/94
35 .\"
36 .Dd September 8, 2003
37 .Dt MOUNT_KERNFS 8
38 .Os
39 .Sh NAME
40 .Nm mount_kernfs
41 .Nd mount the /kern file system
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl o Ar options
45 .Ar /kern
46 .Ar mount_point
47 .Sh DESCRIPTION
48 The
49 .Nm
50 command attaches an instance of the kernel parameter
51 namespace to the global filesystem namespace.
52 The conventional mount point is
53 .Pa /kern .
54 The directory specified by
55 .Ar mount_point
56 is converted to an absolute path before use.
57 This command is normally executed by
58 .Xr mount 8
59 at boot time.
60 .Pp
61 The filesystem includes several regular files which can be read,
62 some of which can also be written.
63 The contents of the files is in a machine-independent format,
64 either a string, or an integer in decimal ASCII.
65 Where numbers are returned, a trailing newline character is also added.
66 .Pp
67 The options are as follows:
68 .Bl -tag -width indent
69 .It Fl o
70 Options are specified with a
71 .Fl o
72 flag followed by a comma separated string of options.
73 See the
74 .Xr mount 8
75 man page for possible options and their meanings.
76 .El
77 .Sh FILES
78 .Bl -tag -width copyright -compact
79 .It Pa boottime
80 the time at which the system was last booted (decimal ASCII).
81 .It Pa copyright
82 kernel copyright message.
83 .It Pa hostname
84 the hostname, with a trailing newline.
85 The hostname can be changed by writing to this file.
86 A trailing newline will be stripped from the hostname being written.
87 .It Pa hz
88 the frequency of the system clock (decimal ASCII).
89 .It Pa ipsecsa
90 the directory that contains IPsec security associations (SA) in
91 .Dv PF_KEY
92 format.
93 Filenames are SPI in decimal number.
94 The content of files can be inspected by using
95 .Xr setkey 8 .
96 .It Pa ipsecsp
97 the directory that contains IPsec security policies in
98 .Dv PF_KEY
99 format.
100 Filenames are security policy ID in decimal number.
101 The content of files can be inspected by using
102 .Xr setkey 8 .
103 .It Pa loadavg
104 the 1, 5 and 15 minute load average in kernel fixed-point format.
105 The final integer is the fix-point scaling factor.
106 All numbers are in decimal ASCII.
107 .It Pa msgbuf
108 the kernel message buffer, also read by
109 .Xr syslogd 8 ,
110 through the
111 .Pa log
112 device, and by
113 .Xr dmesg 8 .
114 .It Pa pagesize
115 the machine pagesize (decimal ASCII).
116 .It Pa physmem
117 the number of pages of physical memory in the machine (decimal ASCII).
118 .\" .It Pa root
119 .\" the system root directory.
120 .\" In a chroot'ed environment,
121 .\" .Nm
122 .\" can be used to create a new
123 .\" .Pa /kern
124 .\" mount point.
125 .\" .Pa /kern/root
126 .\" will then refer to the system global root, not the current process root.
127 .It Pa rootdev
128 the root device.
129 .It Pa rrootdev
130 the raw root device.
131 .It Pa time
132 the second and microsecond value of the system clock.
133 Both numbers are in decimal ASCII.
134 .It Pa version
135 the kernel version string.
136 The head line for
137 .Pa /etc/motd
138 can be generated by running:
139 .Dq Ic "sed 1q /kern/version"
141 .Sh SEE ALSO
142 .Xr mount 2 ,
143 .Xr unmount 2 ,
144 .Xr ipsec 4 ,
145 .Xr fstab 5 ,
146 .Xr dmesg 8 ,
147 .Xr mount 8 ,
148 .Xr setkey 8 ,
149 .Xr syslogd 8
150 .Sh HISTORY
153 utility first appeared in
154 .Bx 4.4 .
155 .Sh BUGS
156 This filesystem may not be NFS-exported.
158 .Xr lkm 4
159 version does not support IPsec-related files/directories.