Adjust some comments with reality.
[dragonfly.git] / sbin / fsirand / fsirand.8
1 .\" Copyright (c) 1997 Todd C. Miller <Todd.Miller@courtesan.com>
2 .\" 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 acknowledgment:
14 .\"     This product includes software developed by Todd C. Miller.
15 .\" 4. The name of the author may not be used to endorse or promote products
16 .\"    derived from this software without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
19 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
20 .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
21 .\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24 .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
27 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 .\"
29 .\"     $OpenBSD: fsirand.8,v 1.6 1997/02/23 03:58:26 millert Exp $
30 .\" $FreeBSD: src/sbin/fsirand/fsirand.8,v 1.10.2.4 2003/02/23 20:17:15 trhodes Exp $
31 .\" $DragonFly: src/sbin/fsirand/fsirand.8,v 1.2 2003/06/17 04:27:32 dillon Exp $
32 .\"
33 .Dd January 25, 1997
34 .Dt FSIRAND 8
35 .Os
36 .Sh NAME
37 .Nm fsirand
38 .Nd randomize inode generation numbers
39 .Sh SYNOPSIS
40 .Nm
41 .Op Fl b
42 .Op Fl f
43 .Op Fl p
44 .Ar special
45 .Op Ar "special ..."
46 .Sh DESCRIPTION
47 The
48 .Nm
49 utility installs random generation numbers on all the inodes for
50 each file system specified on the command line by
51 .Ar special .
52 This increases the security of NFS-exported file systems by making
53 it difficult to ``guess'' filehandles.
54 .Pp
55 .Em Note :
56 .Xr newfs 8
57 now does the equivalent of
58 .Nm
59 itself so it is no longer necessary to
60 run
61 .Nm
62 by hand on a new file system.  It is only used to
63 re-randomize or report on an existing file system.
64 .Pp
65 The
66 .Nm
67 utility should only be used on an unmounted file system that
68 has been checked with
69 .Xr fsck 8
70 or a file system that is mounted read-only.
71 The
72 .Nm
73 utility may be used on the root file system in single-user mode
74 but the system should be rebooted via ``reboot -n'' afterwards.
75 .Sh OPTIONS
76 .Bl -tag -width indent
77 The available options are as follows:
78 .It Fl b
79 Use the default block size (usually 512 bytes) instead
80 of the value gleaned from the disklabel.
81 .It Fl f
82 Force
83 .Nm
84 to run even if the file system on
85 .Ar special
86 is not marked as clean.
87 .It Fl p
88 Print the current generation numbers for all inodes instead of
89 generating new ones.
90 .El
91 .Sh CAVEATS
92 Since
93 .Nm
94 allocates enough memory to hold all the inodes in
95 a given cylinder group it may use a large amount
96 of memory for large disks with few cylinder groups.
97 .Sh SEE ALSO
98 .Xr fs 5 ,
99 .Xr fsck 8 ,
100 .Xr newfs 8
101 .Sh HISTORY
102 The
103 .Nm
104 utility appeared in SunOS 3.x.
105 .Pp
106 This version of
107 .Nm
108 first appeared in
109 .Ox 2.1 .
110 .Pp
111 A
112 .Fx
113 version first appeared in
114 .Fx 2.2.5 .
115 .Sh AUTHORS
116 .An Todd C. Miller Aq Todd.Miller@courtesan.com