xref: /freebsd/sbin/clri/clri.8 (revision 4543ef516683042d46f3bd3bb8a4f3f746e00499)
1.\" Copyright (c) 1980, 1993
2.\"	The Regents of the University of California.  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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd October 5, 2016
29.Dt CLRI 8
30.Os
31.Sh NAME
32.Nm clri
33.Nd clear an inode
34.Sh SYNOPSIS
35.Nm
36.Ar special_device inode_number ...
37.Sh DESCRIPTION
38.Bf -symbolic
39The
40.Nm
41utility is obsoleted for normal file system repair work by
42.Xr fsck 8 .
43.Ef
44.Pp
45The
46.Nm
47utility zeroes out the inodes with the specified inode number(s)
48on the file system residing on the given
49.Ar special_device .
50The
51.Xr fsck 8
52utility is usually run after
53.Nm
54to reclaim the zeroed inode(s) and the
55blocks previously claimed by those inode(s).
56Both read and write permission are required on the specified
57.Ar special_device .
58.Pp
59The primary purpose of this routine
60is to remove a file which
61for some reason is not being properly handled by
62.Xr fsck 8 .
63Once removed,
64it is anticipated that
65.Xr fsck 8
66will be able to clean up the resulting mess.
67.Sh SEE ALSO
68.Xr fsck 8 ,
69.Xr fsdb 8
70.Sh HISTORY
71The
72.Nm
73utility first appeared in
74.At v6 .
75.Sh BUGS
76If the file is open, the work of
77.Nm
78will be lost when the inode is written back to disk from the inode cache.
79