No empty .Rs/.Re
[netbsd-mini2440.git] / sbin / mount_lfs / mount_lfs.8
blobb729baef03331c7e85c5d15e942f366479864c32
1 .\"     $NetBSD: mount_lfs.8,v 1.14 2005/03/31 03:07:38 xtraeme Exp $
2 .\"
3 .\" Copyright (c) 1993, 1994
4 .\"     The Regents of the University of California.  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. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)mount_lfs.8 8.5 (Berkeley) 3/30/94
31 .\"
32 .Dd March 31, 2005
33 .Dt MOUNT_LFS 8
34 .Os
35 .Sh NAME
36 .Nm mount_lfs
37 .Nd mount a log-structured file system
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl bdins
41 .Op Fl N Ar nsegs
42 .Op Fl o Ar options
43 .Ar special
44 .Ar node
45 .Sh DESCRIPTION
46 The
47 .Nm
48 command attaches a log-structured file system
49 .Ar special
50 device on to the file system tree at the point
51 .Ar node .
52 Both
53 .Ar special
54 and
55 .Ar node
56 are converted to absolute paths before use.
57 In addition, the
58 .Xr lfs_cleanerd 8
59 utility is invoked to clean the file system periodically.
60 .Pp
61 This command is normally executed by
62 .Xr mount 8
63 at boot time.
64 .Pp
65 The options are as follows:
66 .Bl -tag -width Ds
67 .It Fl b
68 Instruct the cleaner to count bytes written, rather than segments read,
69 to determine how many segments to clean at once.
70 .It Fl d
71 Run
72 .Xr lfs_cleanerd 8
73 in debug mode.
74 .It Fl i
75 Instruct the cleaner to use filesystem idle time as the criterion
76 for aggressive cleaning, instead of system load.
77 .It Fl o
78 Options are specified with a
79 .Fl o
80 flag followed by a comma separated string of options.
81 See the
82 .Xr mount 8
83 man page for possible options and their meanings.
84 .It Fl N Ar nsegs
85 Clean
86 .Ar nsegs
87 segments (or bytes' worth of segments if
88 .Fl b
89 is also specified) at a time.
90 .It Fl n
91 Don't start
92 .Xr lfs_cleanerd 8
93 on the file system.
94 .It Fl s
95 Cause
96 .Xr lfs_cleanerd 8
97 to read data in small chunks when cleaning the file system.
98 .El
99 .Sh SEE ALSO
100 .Xr mount 2 ,
101 .Xr unmount 2 ,
102 .Xr fstab 5 ,
103 .Xr dump_lfs 8 ,
104 .Xr lfs_cleanerd 8 ,
105 .Xr mount 8 ,
106 .Xr newfs_lfs 8
108 .%A Ousterhout and Douglis
109 .%D 1989
110 .%T "Beating the I/O Bottleneck: A Case for Log-structured File Systems"
111 .%J "Operating Systems Review"
112 .%V Vol. 23
113 .%N No. 1
114 .%P pp. 11-27
115 .%O "also available as Technical Report UCB/CSD 88/467"
118 .%A Rosenblum and Ousterhout
119 .%D 1991
120 .%T "The Design and Implementation of a Log-Structured File System"
121 .%J "ACM SIGOPS Operating Systems Review"
122 .%V Vol. 25
123 .%N No. 5
126 .%A Seltzer
127 .%D 1992
128 .%T "File System Performance and Transaction Support"
129 .%B "PhD Thesis, University of California, Berkeley"
130 .%O "also available as Technical Report UCB/ERL M92"
133 .%A Seltzer, Bostic, McKusick and Staelin
134 .%D 1993
135 .%T "An Implementation of a Log-Structured File System for UNIX"
136 .%J "Proc. of the Winter 1993 USENIX Conf."
137 .%P pp. 315-331
139 .Sh HISTORY
142 function first appeared in
143 .Bx 4.4 .