hfs-195.tar.gz

[apple/hfs.git] / hfs_util / hfs.util.8

diff --git a/hfs_util/hfs.util.8 b/hfs_util/hfs.util.8
index 7770aceadc4f29316babf67e319975069dfd3257..05efbcdc0cd6eed1953aab3256cc2917d0db3a6e 100644 (file)
--- a/hfs_util/hfs.util.8
+++ b/hfs_util/hfs.util.8
@@ -1,4 +1,4 @@
-.\""Copyright (c) 2001 Apple Computer, Inc. All Rights Reserved.
+.\""Copyright (c) 2001-2008 Apple Inc. All Rights Reserved.

 .\"The contents of this file constitute Original Code as defined in and are 
 .\"subject to the Apple Public Source License Version 1.2 (the 'License'). 
 .\"You may not use this file except in compliance with the
 .\"The contents of this file constitute Original Code as defined in and are 
 .\"subject to the Apple Public Source License Version 1.2 (the 'License'). 
 .\"You may not use this file except in compliance with the


@@ -12,49 +12,110 @@
 .\"WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
 .\"QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the 
 .\"specific language governing rights and limitations under the License."
 .\"WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
 .\"QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the 
 .\"specific language governing rights and limitations under the License."

-.Dd March 24, 2001
+.Dd July 16, 2003

 .Dt HFS.UTIL 8 
 .Os Darwin
 .Sh NAME
 .Nm hfs.util
 .Dt HFS.UTIL 8 
 .Os Darwin
 .Sh NAME
 .Nm hfs.util

-.Nd helps mount, probe, and unmount hfs filesystems
+.Nd HFS/HFS+ file system utility

 .Sh SYNOPSIS
 .Nm
 .Sh SYNOPSIS
 .Nm

-.Op Fl m Ar mountflag1 mountflag2 mountflag3 mountflag4
-.Ar device mount_point
+.Fl m
+.Ar device  mountpoint 
+.Op Ar mountflag1
+.Op Ar mountflag2
+.Op Ar mountflag3
+.Op Ar mountflag4

 .Pp
 .Nm
 .Pp
 .Nm

-.Op Fl p Ar mountflag1 mountflag2 mountflag3 mountflag4
+.Fl p

 .Ar device
 .Ar device

+.Op Ar mountflag1
+.Op Ar mountflag2
+.Op Ar mountflag3
+.Op Ar mountflag4

 .Pp
 .Nm
 .Pp
 .Nm

-.Op Fl aksu 
+.Fl J
+.Op Ar size
+.Ar mountpoint
+.Pp
+.Nm
+.Fl U
+.Ar mountpoint
+.Pp
+.Nm
+.Fl N
+.Ar device
+.Pp
+.Nm
+.Fl I
+.Ar mountpoint
+.Pp
+.Nm
+.Op Fl aksu

 .Ar device
 .Sh DESCRIPTION
 .Ar device
 .Sh DESCRIPTION

+The

 .Nm
 .Nm

-helps to coordinate the mounting, probing, and unmounting of hfs filesystems.  It essentially wraps
-.Xr mount 8
-and it's ilk in one interface that is generic enough for the disk mounter to work with, so that the underlying mount commands do not have to fit into one mold.  This allows us to more easily port mount commands without forcing us to reorder or redo the command itself or the disk mounter to understand each specific mount command.
+command supports the mounting, probing, and unmounting of HFS file systems.

 .Pp
 Options:
 .Pp
 Options:

-.Bl -tag -width -indent "a"
+.Bl -tag -compact -offset indent

 .It Fl a 
 .It Fl a 

-adopt permissions
+Adopt permissions for the HFS file system at
+.Ar device
+.It Fl I 
+Print out status information about the journal on the HFS 
+file system at
+.Ar mountpoint
+.It Fl J Op Ar size
+Enable journaling on the HFS file system mounted on
+.Ar mountpoint .
+An optional size may
+be specified (e.g. 32M for a 32 megabyte journal).

 .It Fl k 
 .It Fl k 

-get UUID key
-.It Fl m Ar mountflag1 mountflag2 mountflag3 mountflag4
-mount
-.It Fl p Ar mountflag1 mountflag2 mountflag3 mountflag4
-probe for mounting
+Get the UUID key for the HFS file system at
+.Ar device .
+.It Fl m
+Mount the HFS file system located on
+.Ar device
+onto
+.Ar mountpoint
+with the flags
+.Ar mountflag1 mountflag2 mountflag3 mountflag4
+.It Fl M
+Force mount the HFS file system located on
+.Ar device
+onto
+.Ar mountpoint
+with the flags
+.Ar mountflag1 mountflag2 mountflag3 mountflag4 .
+This is a deprecated option.
+.It Fl N
+Disable journaling on a HFS+ file system located at 
+.Ar device
+.It Fl p
+Probe the
+.Ar device
+for an HFS file system using the flags
+.Ar mountflag1 mountflag2 mountflag3 mountflag4

 .It Fl s 
 .It Fl s 

-set UUID key
+Set the UUID key (generates a new UUID value) for the
+HFS file system at
+.Ar device

 .It Fl u 
 .It Fl u 

-unmount
+Unmount the HFS file system located at
+.Ar device
+.It Fl U 
+Disable journaling on the HFS+ file system mounted on
+.Ar mountpoint

 .El
 .Pp
 .El
 .Pp

+The

 .Ar mountflags 
 .Ar mountflags 

-above are either:
-.Bl -bullet -indent
+referenced above are either:
+.Bl -bullet -compact -offset indent

 .It
 .Ar removable 
 or
 .It
 .Ar removable 
 or


@@ -72,11 +133,13 @@ or
 or
 .Ar nodev
 .El
 or
 .Ar nodev
 .El

+.Pp
+Note that for the 
+.Ar device
+references above, you must only supply the last component of the path to the 
+device in question, such as disk0s2 rather than /dev/disk0s2. 
+

 .Sh SEE ALSO 
 .Sh SEE ALSO 

-.Xr autodiskmount 8 , 
-.Xr cd9660.util 8 ,
-.Xr msdos.util 8 ,
-.Xr udf.util 8 ,
-.Xr ufs.util 8
+.Xr diskarbitrationd 8

 .Sh HISTORY
 .Sh HISTORY

-Derived from the Openstep Workspace Manager filesystem utility programs.
+Derived from the Openstep Workspace Manager file system utility programs.