Sync usage with man page.
[netbsd-mini2440.git] / sbin / fsirand / fsirand.8
blob89bd9c00bbb923a175532f4ab020a0fa7ba09e8f
1 .\"     $NetBSD: fsirand.8,v 1.8 2005/06/14 14:02:12 peter Exp $
2 .\"
3 .\" Copyright (c) 1997 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Christos Zoulas.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
29 .\"
30 .Dd November 16, 2001
31 .Dt FSIRAND 8
32 .Os
33 .Sh NAME
34 .Nm fsirand
35 .Nd install random inode generation numbers in a filesystem
36 .Sh SYNOPSIS
37 .Nm
38 .Op Fl F
39 .Op Fl p
40 .Op Fl x Ar constant
41 .Ar special
42 .Sh DESCRIPTION
43 .Nm
44 writes random inode generation numbers for all the inodes on device
45 .Ar special .
46 These random numbers make the NFS filehandles less predictable, increasing
47 security of exported filesystems.
48 .Pp
49 .Nm
50 should be run on a clean and unmounted filesystem.
51 .Pp
52 The options are as follows:
53 .Bl -tag -width indent
54 .It Fl F
55 Indicates that
56 .Ar special
57 is a file system image, rather than a device name.
58 .Ar special
59 will be accessed
60 .Sq as-is ,
61 without requiring that it is a raw character device and without
62 attempting to read a disklabel.
63 .It Fl p
64 Print the current inode generation numbers; the filesystem is not modified.
65 .It Fl x Ar constant
66 Exclusive-or the given constant with the random number used in the generation
67 process.
68 .El
69 .Pp
70 .Nm
71 exits zero on success, non-zero on failure.
72 .Pp
74 .Nm
75 receives a
76 .Dv SIGINFO
77 signal, statistics on the amount of work completed and estimated
78 completion time (in minutes:seconds) will be written to the standard
79 error output.
80 .Sh SEE ALSO
81 .Xr fsck_ffs 8 ,
82 .Xr newfs 8