summaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2002-01-18 16:46:43 +0000
committerru <ru@FreeBSD.org>2002-01-18 16:46:43 +0000
commitd5f45c8902a6431902e91d2e0a8648c20586e283 (patch)
treefbb220aafc4eb7930a06765d4c2097e8c934edac /share
parent5af46cb092054958ba43259d5fd3ce8375563d70 (diff)
downloadFreeBSD-src-d5f45c8902a6431902e91d2e0a8648c20586e283.zip
FreeBSD-src-d5f45c8902a6431902e91d2e0a8648c20586e283.tar.gz
mdoc(7) police: tidy up.
Reviewed by: chris
Diffstat (limited to 'share')
-rw-r--r--share/man/man7/ffs.7116
1 files changed, 62 insertions, 54 deletions
diff --git a/share/man/man7/ffs.7 b/share/man/man7/ffs.7
index f8a64d6..6fe172d 100644
--- a/share/man/man7/ffs.7
+++ b/share/man/man7/ffs.7
@@ -1,12 +1,12 @@
.\" Copyright (c) 2001 Networks Associates Technologies, Inc.
.\" All rights reserved.
-.\"
+.\"
.\" This software was developed for the FreeBSD Project by Chris
.\" Costello at Safeport Network Services and NAI Labs, the Security
.\" Research Division of Network Associates, Inc. under DARPA/SPAWAR
.\" contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
.\" research program.
-.\"
+.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
@@ -18,7 +18,7 @@
.\" 3. The name of the author may not be used to endorse or promote
.\" products derived from this software without specific prior written
.\" permission.
-.\"
+.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -30,8 +30,9 @@
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
-.\"
+.\"
.\" $FreeBSD$
+.\"
.Dd December 26, 2001
.Dt FFS 4
.Sh NAME
@@ -39,40 +40,43 @@
.Nd Berkeley fast file system
.Sh SYNOPSIS
In the kernel configuration file:
-.Cd options ENABLE_VFS_IOOPT
-.Cd options FFS
-.Cd options QUOTA
-.Cd options SOFTUPDATES
-.Cd options SUIDDIR
-.Cd options UFS_ACL
-.Cd options UFS_DIRHASH
-.Cd options UFS_EXTATTR
-.Cd options UFS_EXTATTR_AUTOSTART
+.Cd "options ENABLE_VFS_IOOPT"
+.Cd "options FFS"
+.Cd "options QUOTA"
+.Cd "options SOFTUPDATES"
+.Cd "options SUIDDIR"
+.Cd "options UFS_ACL"
+.Cd "options UFS_DIRHASH"
+.Cd "options UFS_EXTATTR"
+.Cd "options UFS_EXTATTR_AUTOSTART"
.Pp
In
-.Pa /etc/fstab :
-.Cd /dev/disk0s1a /mnt ufs rw 1 1
+.Xr fstab 5 :
+.Bd -literal -compact
+/dev/disk0a /mnt ufs rw 1 1
+.Ed
.Sh DESCRIPTION
The Berkeley fast file system
provides facilities to store file system data onto a disk device.
-.Nm ffs
+.Nm
has been optimized over the years
for speed and reliability
and is the default
.Fx
file system.
-.Pp
.Ss VFS I/O optimization
.Bl -tag -width 2n
-.It Cd options ENABLE_VFS_IOOPT
-This option enables the IO optimization through the VM system,
+.It Cd "options ENABLE_VFS_IOOPT"
+This option enables the I/O optimization through the VM system,
using VM operations instead of copying operations when possible.
-This option adds a sysctl MIB,
-.Em vfs.ioopt .
+This option adds a
+.Xr sysctl 8
+MIB,
+.Va vfs.ioopt .
The following are values and effects for
-.Em vfs.ioopt :
+.Va vfs.ioopt :
.Pp
-.Bl -tag -width "Value" -offset indent -compact
+.Bl -tag -width ".Em Value" -offset indent -compact
.It Em Value
.Em Effect
.It Li 0
@@ -85,13 +89,13 @@ Aggressive optimization (VM used as much as possible)
.El
.Ss Quotas
.Bl -tag -width 2n
-.It Cd options QUOTA
+.It Cd "options QUOTA"
This option allows system administrators
to set limits on disk usage
on a per-user basis.
Quotas can be used only on file systems
mounted with the
-.Sq quota
+.Cm quota
option;
see
.Xr quota 1
@@ -100,44 +104,47 @@ and
.El
.Ss Soft Updates
.Bl -tag -width 2n
-.It Cd options SOFTUPDATES
+.It Cd "options SOFTUPDATES"
The soft updates feature tracks writes to the disk
and enforces metadata update dependencies
-(e.g. updating free block maps)
+(e.g., updating free block maps)
to ensure that the file system remains consistent.
.Pp
To enable soft updates on an
.Em unmounted
file system, use the following command:
.Pp
-.Dl Ic tunefs -n enable Sy /foo
+.D1 Nm tunefs Fl n Cm enable Ar fs
.Pp
-.Dq Sy foo
+.Ar fs
can be either a mount point listed in
-.Pa /etc/fstab
-(e.g.
+.Xr fstab 5
+(e.g.,
.Pa /usr ) ,
or a disk device
-(e.g.
-.Pa /dev/da0s1a ) .
+(e.g.,
+.Pa /dev/da0a ) .
.El
.Ss File Ownership Inheritance
.Bl -tag -width 2n
-.It Cd options SUIDDIR
+.It Cd "options SUIDDIR"
For use in file sharing environments
-on networks including Microsoft Windows
-and Apple Macintosh computers,
+on networks including
+.Tn "Microsoft Windows"
+and
+.Tn "Apple Macintosh"
+computers,
this option allows files on file systems
mounted with the
-.Sq suiddir
+.Cm suiddir
option
to inherit the ownership of its directory,
-i.e.
-.Dq "If it's my directory, it must be my file."
+i.e.,
+.Dq "if it's my directory, it must be my file."
.El
.Ss Access Control Lists
.Bl -tag -width 2n
-.It Cd options UFS_ACL
+.It Cd "options UFS_ACL"
Access control lists allow the association of
fine-grained discretionary access control information
with files and directories.
@@ -153,10 +160,10 @@ In order to enable support for ACLs,
two extended attributes must be available in the
.Dv EXTATTR_NAMESPACE_SYSTEM
namespace:
-.Dq Li posix1e.acl_access ,
+.Pa posix1e.acl_access ,
which holds the access ACL,
and
-.Dq Li posix1e.acl_default ,
+.Pa posix1e.acl_default ,
which holds the default ACL for directories.
If you are using file system extended attributes,
the following commands may be used to
@@ -166,7 +173,6 @@ In these examples, the root file system is used;
see
.Sx "Extended Attributes"
for more details.
-.Pp
.Bd -literal -offset indent
mkdir -p /.attribute/system
cd /.attribute/system
@@ -176,27 +182,29 @@ extattrctl initattr -p / 388 posix1e.acl_default
.Pp
On the next mount of the root file system,
the attributes will be automatically started
-(if UFS_EXTATTR_AUTOSTART is included in the kernel configuration),
+(if
+.Dv UFS_EXTATTR_AUTOSTART
+is included in the kernel configuration),
and ACLs will be enabled.
.Ss Directory Hashing
.Bl -tag -width 2n
-.It Cd options UFS_DIRHASH
+.It Cd "options UFS_DIRHASH"
Implements a hash-based lookup scheme for directories
in order to speed up accesses to very large directories.
.El
.Ss Extended Attributes
.Bl -tag -width 2n
-.It Cd options UFS_EXTATTR
+.It Cd "options UFS_EXTATTR"
Extended attributes allow the association of
additional arbitrary metadata with files and directories,
which can be assigned and retrieved from userland
as well as from within the kernel; see
.Xr extattrctl 8 .
-.It Cd options UFS_EXTATTR_AUTOSTART
+.It Cd "options UFS_EXTATTR_AUTOSTART"
If this option is defined,
-.Nm ffs
+.Nm
will search for a
-.Dq Pa .attribute
+.Pa .attribute
subdirectory of the file system root during the mount operation.
If found, extended attribute support will be
automatically started for that file system.
@@ -205,13 +213,13 @@ automatically started for that file system.
The following
.Xr sysctl 8
MIBs are defined for use with
-.Nm ffs :
-.Bl -hang -width "vfs.ffs.doreallocblk"
-.It Em vfs.ffs.doasyncfree
+.Nm :
+.Bl -hang -width ".Va vfs.ffs.doreallocblk"
+.It Va vfs.ffs.doasyncfree
Asynchronously write out modified i-node and indirect blocks
upon reallocating file system blocks to be contiguous.
(Default: 1.)
-.It Em vfs.ffs.doreallocblks
+.It Va vfs.ffs.doreallocblks
Enable support for the rearrangement of blocks
to be contiguous.
(Default: 1.)
@@ -222,7 +230,7 @@ to be contiguous.
.Xr extattr 3 ,
.Xr edquota 8 ,
.Xr extattrctl 8 ,
-.Xr sysctl 8 ,
+.Xr sysctl 8
.Rs
.%A M. McKusick
.%A W. Joy
OpenPOWER on IntegriCloud