[apple/hfs.git] / mount_hfs / mount_hfs.8

.\" Copyright (c) 2002 Apple Computer, 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.1 (the
.\" "License").  You may not use this file except in compliance with the
.\" License.  Please obtain a copy of the License at
.\" http://www.apple.com/publicsource and read it before using this file.
.\" 
.\" This Original Code and all software distributed under the License are
.\" distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
.\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
.\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
.\" FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
.\" License for the specific language governing rights and limitations
.\" under the License.
.\" 
.\"     @(#)mount_hfs.8
.Dd March 14, 2001
.Dt MOUNT_HFS 8
.Os "Mac OS X"
.Sh NAME
.Nm mount_hfs
.Nd mount an HFS/HFS+ file system
.Sh SYNOPSIS
.Nm mount_hfs
.Op Fl e Ar encoding
.Op Fl u Ar user
.Op Fl g Ar group
.Op Fl m Ar mask
.Op Fl o Ar options
.Op Fl j
.Op Fl c
.Op Fl w
.Op Fl x
.Ar special 
.Ar directory
.Sh DESCRIPTION
The
.Nm mount_hfs
command attaches the HFS file system residing on the device
.Pa special
to the global file system namespace at the location indicated by
.Pa directory .
This command is normally executed by
.Xr mount 8
at boot time.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl e Ar encoding (standard HFS volumes only)
Specify the Macintosh encoding. The following encodings are supported:
.Pp
Arabic, ChineseSimp, ChineseTrad, Croatian, Cyrillic, Greek, Hebrew,
Icelandic, Japanese, Korean, Roman (default), Romanian, Thai, Turkish
.It Fl u Ar user
Set the owner of the files in the file system to
.Pa user . 
The default owner is the owner of the directory on which
the file system is being mounted.
The
.Pa user
may be a user-name, or a numeric value.
.It Fl g Ar group
Set the group of the files in the file system to
.Pa group . 
The default group is the group of the directory on which
the file system is being mounted.
The
.Pa group
may be a group-name, or a numeric value.
.It Fl m Ar mask
Specify the maximum file permissions for files in the file system.
(For example, a
.Pa mask
of 755 specifies that, by default, the owner should have read, write,
and execute permissions for files, but others should only have read
and execute permissions.  See chmod(1) for more information about
octal file modes.)  Only the nine low-order bits of
.Pa mask
are used.  The default
.Pa mask
is taken from the directory on which the file system is being mounted.
.It Fl o
Options are specified with a
.Fl o
flag followed by a comma separated string of options.
See the
.Xr mount 8
man page for possible options and their meanings.
.It Fl j
Ignore the journal for this mount.
.It Fl c
Disable group commit for journaling.
.It Fl w
Mount the HFS wrapper volume.
.It Fl x
Disable execute permissions on a standard HFS file system.
.El
.Sh SEE ALSO
.Xr mount 2 ,
.Xr unmount 2 ,
.Xr fstab 5 ,
.Xr mount 8
.Sh BUGS
Some HFS file systems with highly fragmented catalog files may not mount.
.Sh HISTORY
The
.Nm mount_hfs
utility first appeared in Mac OS X Server 1.0.
Commit	Line	Data
51e135ce A	1	.\" Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
	2	.\"
	3	.\" The contents of this file constitute Original Code as defined in and
	4	.\" are subject to the Apple Public Source License Version 1.1 (the
	5	.\" "License"). You may not use this file except in compliance with the
	6	.\" License. Please obtain a copy of the License at
	7	.\" http://www.apple.com/publicsource and read it before using this file.
	8	.\"
	9	.\" This Original Code and all software distributed under the License are
	10	.\" distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	11	.\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	12	.\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	13	.\" FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	14	.\" License for the specific language governing rights and limitations
	15	.\" under the License.
	16	.\"
	17	.\" @(#)mount_hfs.8
	18	.Dd March 14, 2001
	19	.Dt MOUNT_HFS 8
	20	.Os "Mac OS X"
	21	.Sh NAME
	22	.Nm mount_hfs
	23	.Nd mount an HFS/HFS+ file system
	24	.Sh SYNOPSIS
	25	.Nm mount_hfs
	26	.Op Fl e Ar encoding
	27	.Op Fl u Ar user
	28	.Op Fl g Ar group
	29	.Op Fl m Ar mask
	30	.Op Fl o Ar options
	31	.Op Fl j
c7ca4fb3	32	.Op Fl c
51e135ce A	33	.Op Fl w
	34	.Op Fl x
	35	.Ar special
	36	.Ar directory
	37	.Sh DESCRIPTION
	38	The
	39	.Nm mount_hfs
	40	command attaches the HFS file system residing on the device
	41	.Pa special
	42	to the global file system namespace at the location indicated by
	43	.Pa directory .
	44	This command is normally executed by
	45	.Xr mount 8
	46	at boot time.
	47	.Pp
	48	The options are as follows:
	49	.Bl -tag -width indent
	50	.It Fl e Ar encoding (standard HFS volumes only)
	51	Specify the Macintosh encoding. The following encodings are supported:
	52	.Pp
	53	Arabic, ChineseSimp, ChineseTrad, Croatian, Cyrillic, Greek, Hebrew,
	54	Icelandic, Japanese, Korean, Roman (default), Romanian, Thai, Turkish
	55	.It Fl u Ar user
	56	Set the owner of the files in the file system to
	57	.Pa user .
	58	The default owner is the owner of the directory on which
	59	the file system is being mounted.
	60	The
	61	.Pa user
	62	may be a user-name, or a numeric value.
	63	.It Fl g Ar group
	64	Set the group of the files in the file system to
	65	.Pa group .
	66	The default group is the group of the directory on which
	67	the file system is being mounted.
	68	The
	69	.Pa group
	70	may be a group-name, or a numeric value.
	71	.It Fl m Ar mask
	72	Specify the maximum file permissions for files in the file system.
	73	(For example, a
	74	.Pa mask
	75	of 755 specifies that, by default, the owner should have read, write,
	76	and execute permissions for files, but others should only have read
	77	and execute permissions. See chmod(1) for more information about
	78	octal file modes.) Only the nine low-order bits of
	79	.Pa mask
	80	are used. The default
	81	.Pa mask
	82	is taken from the directory on which the file system is being mounted.
	83	.It Fl o
	84	Options are specified with a
	85	.Fl o
	86	flag followed by a comma separated string of options.
	87	See the
	88	.Xr mount 8
	89	man page for possible options and their meanings.
	90	.It Fl j
	91	Ignore the journal for this mount.
c7ca4fb3 A	92	.It Fl c
c7ca4fb3 A	93	Disable group commit for journaling.
51e135ce A	94	.It Fl w
	95	Mount the HFS wrapper volume.
	96	.It Fl x
	97	Disable execute permissions on a standard HFS file system.
	98	.El
	99	.Sh SEE ALSO
	100	.Xr mount 2 ,
	101	.Xr unmount 2 ,
	102	.Xr fstab 5 ,
	103	.Xr mount 8
	104	.Sh BUGS
	105	Some HFS file systems with highly fragmented catalog files may not mount.
	106	.Sh HISTORY
	107	The
	108	.Nm mount_hfs
	109	utility first appeared in Mac OS X Server 1.0.