xref: /freebsd/sbin/fsdb/fsdb.8 (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
1.\"	$NetBSD: fsdb.8,v 1.2 1995/10/08 23:18:08 thorpej Exp $
2.\"
3.\" Copyright (c) 1995 John T. Kohl
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. The name of the author may not be used to endorse or promote products
15.\"    derived from this software without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
21.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27.\" POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\"	$Id: fsdb.8,v 1.7 1997/04/15 09:02:43 joerg Exp $
30.\"
31.Dd September 14, 1995
32.Dt FSDB 8
33.Os FreeBSD
34.Sh NAME
35.Nm fsdb
36.Nd FFS debugging/editing tool
37.Sh SYNOPSIS
38.Nm fsdb
39.Op Fl d
40.Op Fl f
41.Op Fl r
42.Ar fsname
43.Sh DESCRIPTION
44.Nm Fsdb
45opens
46.Ar fsname
47(usually a raw disk partition) and runs a command loop
48allowing manipulation of the file system's inode data.  You are prompted
49to enter a command with
50.Ic "fsdb (inum X)>"
51where
52.Va X
53is the currently selected i-number.  The initial selected inode is the
54root of the filesystem (i-number 2).
55The command processor uses the
56.Xr libedit 3
57library, so you can use command line editing to reduce typing if desired.
58When you exit the command loop, the file system superblock is marked
59dirty and any buffered blocks are written to the file system.
60.Pp
61The following options are available:
62.Bl -tag -width indent
63.It Fl d
64Enable additional debugging output (which comes primarily from
65.Xr fsck 8 -derived
66code).
67.It Fl f
68Left for historical reasons and has no meaning.
69.It Fl r
70Open the filesystem read/only, and disables all commands that would
71write to it.
72.El
73.Sh COMMANDS
74Besides the built-in
75.Xr libedit 3
76commands,
77.Nm
78supports these commands:
79.Pp
80.Bl -tag -width indent -compact
81.It Cm help
82Print out the list of accepted commands.
83.Pp
84.It Cm inode Ar i-number
85Select inode
86.Ar i-number
87as the new current inode.
88.Pp
89.It Cm back
90Revert to the previously current inode.
91.Pp
92.It Cm clri
93Clear the current inode.
94.Pp
95.It Cm lookup Ar name
96.It Cm cd Ar name
97Find
98.Ar name
99in the current directory and make its inode the current inode.
100.Ar Name
101may be a multi-component name or may begin with slash to indicate that
102the root inode should be used to start the lookup.  If some component
103along the pathname is not found, the last valid directory encountered is
104left as the active inode.
105.br
106This command is valid only if the starting inode is a directory.
107.Pp
108.It Cm active
109.It Cm print
110Print out the active inode.
111.Pp
112.It Cm uplink
113Increment the active inode's link count.
114.Pp
115.It Cm downlink
116Decrement the active inode's link count.
117.Pp
118.It Cm linkcount Ar number
119Set the active inode's link count to
120.Ar number .
121.Pp
122.It Cm ls
123List the current inode's directory entries.  This command is valid only
124if the current inode is a directory.
125.Pp
126.It Cm rm Ar name
127.It Cm del Ar name
128Remove the entry
129.Ar name
130from the current directory inode.  This command is valid only
131if the current inode is a directory.
132.Pp
133.It Cm ln Ar ino Ar name
134Create a link to inode
135.Ar ino
136under the name
137.Ar name
138in the current directory inode.  This command is valid only
139if the current inode is a directory.
140.Pp
141.It Cm chinum Ar dirslot Ar inum
142Change the i-number in directory entry
143.Ar dirslot
144to
145.Ar inum .
146.Pp
147.It Cm chname Ar dirslot Ar name
148Change the name in directory entry
149.Ar dirslot
150to
151.Ar name .
152This command cannot expand a directory entry.  You can only rename an
153entry if the name will fit into the existing directory slot.
154.Pp
155.It Cm chtype Ar type
156Change the type of the current inode to
157.Ar type .
158.Ar Type
159may be one of:
160.Em file ,
161.Em dir ,
162.Em socket ,
163or
164.Em fifo .
165.Pp
166.It Cm chmod Ar mode
167Change the mode bits of the current inode to
168.Ar mode .
169You cannot change the file type with this subcommand; use
170.Ic chtype
171to do that.
172.Pp
173.It Cm chflags Ar flags
174Change the file flags of the current inode to
175.Ar flags .
176.Pp
177.It Cm chown Ar uid
178Change the owner of the current inode to
179.Ar uid .
180.Pp
181.It Cm chgrp Ar gid
182Change the group of the current inode to
183.Ar gid .
184.Pp
185.It Cm chgen Ar gen
186Change the generation number of the current inode to
187.Ar gen .
188.Pp
189.It Cm mtime Ar time
190.It Cm ctime Ar time
191.It Cm atime Ar time
192Change the modification, change, or access time (respectively) on the
193current inode to
194.Ar time .
195.Ar Time
196should be in the format
197.Em YYYYMMDDHHMMSS[.nsec]
198where
199.Em nsec
200is an optional nanosecond specification.  If no nanoseconds are specified, the
201.Va mtimensec ,
202.Va ctimensec ,
203or
204.Va atimensec
205field will be set to zero.
206.Pp
207.It Cm quit, Cm q, Cm exit, Em <EOF>
208Exit the program.
209.El
210.Sh SEE ALSO
211.Xr libedit 3 ,
212.Xr fs 5 ,
213.Xr clri 8 ,
214.Xr fsck 8
215.Sh BUGS
216Manipulation of ``short'' symlinks doesn't work (in particular, don't
217try changing a symlink's type).
218.br
219You must specify modes as numbers rather than symbolic names.
220.br
221There are a bunch of other things that you might want to do which
222.Nm
223doesn't implement.
224.br
225The
226.Xr libedit 3
227reference page is not yet written.
228.Sh HISTORY
229.Nm Fsdb
230uses the source code for
231.Xr fsck 8
232to implement most of the file system manipulation code.  The remainder of
233.Nm
234first appeared in
235.Bx Net ,
236written by
237.An John T. Kohl .
238.br
239.An Peter Wemm
240ported it to
241.Bx Free .
242.Sh WARNING
243Use this tool with extreme caution--you can damage an FFS file system
244beyond what
245.Xr fsck 8
246can repair.
247