xref: /illumos-gate/usr/src/man/man4fs/hsfs.4fs (revision 3580e26c24814e4d892b1eae539b8761388f79f1)
1.\"
2.\" Copyright (c) 2006, Sun Microsystems, Inc.
3.\" Copyright 2021 Oxide Computer Company
4.\"
5.\" The contents of this file are subject to the terms of the
6.\" Common Development and Distribution License (the "License").
7.\" You may not use this file except in compliance with the License.
8.\"
9.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10.\" or http://www.opensolaris.org/os/licensing.
11.\" See the License for the specific language governing permissions
12.\" and limitations under the License.
13.\"
14.\" When distributing Covered Code, include this CDDL HEADER in each
15.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16.\" If applicable, add the following below this CDDL HEADER, with the
17.\" fields enclosed by brackets "[]" replaced with your own identifying
18.\" information: Portions Copyright [yyyy] [name of copyright owner]
19.\"
20.Dd March 30, 2022
21.Dt HSFS 4FS
22.Os
23.Sh NAME
24.Nm hsfs
25.Nd High Sierra & ISO 9660 CD-ROM file system
26.Sh DESCRIPTION
27.Nm
28is a file system type that allows users to access files on High Sierra or ISO
299660 format CD-ROM disks from within the SunOS operating system.
30Once mounted, a
31.Nm
32file system provides standard read-only file system operations and semantics,
33meaning that you can read and list files in a directory on a High Sierra or ISO
349660 CD-ROM and applications can use standard UNIX system calls on these files
35and directories.
36.Pp
37This file system contains support for Rock Ridge, ISO 9660 Version 2 and Joliet
38extensions.
39These extensions provide support for file names with a length of at least 207
40bytes, but only Rock Ridge extensions
41.Pq with the exception of writability and hard links
42can provide file system semantics and file types as they are found in UFS.
43The presence of Rock Ridge, ISO 9660 Version 2, and Joliet is autodetected and
44the best-suitable available extension is used by the HSFS driver for file name
45and attribute lookup.
46.Pp
47If your
48.Pa /etc/vfstab
49file contains a line similar to the following:
50.Bd -literal
51/dev/dsk/c0t6d0s0 - /hsfs hsfs - no ro
52.Ed
53.Pp
54and
55.Pa /hsfs
56exists, you can mount an
57.Nm
58file system with either of the following commands:
59.Bd -literal -offset indent
60mount -F hsfs -o ro device-special directory-name
61.Ed
62or
63.Bd -literal -offset indent
64mount /hsfs
65.Ed
66.Pp
67By default, Rock Ridge extensions are used if available, otherwise ISO 9660
68Version 2, then Joliet are used.
69If neither extension is present HSFS defaults to the standard capabilities of
70ISO 9660.
71Since so-called hybrid CD-ROMs that contain multiple extensions are possible,
72you can use the following mount options to deliberately disable the search for a
73specific extension or to force the use of a specific extension even if a
74preferable type is present:
75.Bd -literal
76mount -F hsfs -o ro,nrr device-special directory-name
77.Ed
78.Pp
79Mount options are:
80.Bl -tag -width Ds
81.It rr
82Request HSFS to use Rock Ridge extensions, if present.
83This is the default behavior and does not need to be explicitly specified.
84.It nrr
85Disable detection and use of Rock Ridge extensions, even if present.
86.It vers2
87Request HSFS to use ISO 9660 Version 2 extensions, even if Rock Ridge is
88available.
89.It novers2
90Disable detection and use of ISO 9660 Version 2 extensions.
91.It joliet
92Request HSFS to use Joliet extensions, even if Rock Ridge or ISO 9660 Version 2
93extensions are available.
94.It nojoliet
95Disable detection and use of Joliet extensions.
96.El
97.Pp
98Files on a High Sierra or ISO 9660 CD-ROM disk have names of the form
99.Pa filename.ext;versio ,
100where
101.Fa filename
102and the optional
103.Fa ext
104consist of a sequence of uppercase alphanumeric characters
105.Po
106including
107.Sq _
108.Pc ,
109while the
110.Fa version
111consists of a sequence of digits, representing the version number of the file.
112.Nm
113converts all the uppercase characters in a file name to lowercase, and truncates
114the
115.Sq ;
116and version information.
117If more than one version of a file is present on the CD-ROM, only the file with
118the highest version number is accessible.
119.Pp
120Conversion of uppercase to lowercase characters may be disabled by using the
121.Fl o
122.Ar nomaplcase
123option to
124.Xr mount 8 .
125See
126.Xr mount_hsfs 8 .
127.Pp
128If the CD-ROM contains Rock Ridge, ISO 9660 version 2 or Joliet extensions, the
129file names and directory names may contain any character supported under
130.Xr ufs 4FS .
131The names may also be upper and/or lower case and are case sensitive.
132File name lengths can be as long as those of
133.Xr ufs 4FS .
134.Pp
135Files accessed through
136.Nm
137have mode 555
138.Pq owner, group and world readable and executable ,
139uid 0 and gid 3. If a directory on the CD-ROM has read permission,
140.Nm
141grants execute permission to the directory, allowing it to be searched.
142.Pp
143With Rock Ridge extensions, files and directories can have any permissions that
144are supported on a
145.Xr ufs 4FS
146file system.
147However, under all write permissions, the file system is read-only, with
148.Er EROFS
149returned to any write operations.
150.Pp
151Like High Sierra and ISO 9660 CD-ROMs, HSFS supports only regular files and
152directories.
153A Rock Ridge CD-ROM can support regular files, directories, and symbolic links,
154as well as device nodes, such as block, character, and FIFO.
155.Sh EXAMPLES
156.Sy Example 1
157Sample Display of File System Files
158.Pp
159If there is a file
160.Pa BIG.BAR
161on a High Sierra or ISO 9660 format CD-ROM it will show up as
162.Pa big.bar
163when listed on a
164.Nm
165file system.
166.Pp
167If there are three files
168Pa BAR.BAZ;1 ,
169Pa BBAR.BAZ;2 ,
170and
171.Pa BAR.BAZ;3
172on a High Sierra or ISO 9660 format CD-ROM, only the file
173.Pa BAR.BAZ;3
174will be accessible.
175It will be listed as
176.Pa bar.baz .
177.Sh DIAGNOSTICS
178.Bl -tag -width Ds
179.It "hsfs: Warning: the file system...  does not conform to the ISO-9660 spec"
180The specific reason appears on the following line.
181You might be attempting to mount a CD-ROM containing a different file system,
182such as
183.Xr ufs 4FS
184.It "hsfs: Warning: the file system... contains a file [with an] unsupported"
185type"
186The
187.Nm
188file system does not support the format of some file or directory on the CD-ROM,
189for example a record structured file.
190.It "hsfs: hsnode table full, %d nodes allocated"
191There are not enough
192.Nm
193internal data structure elements to handle all the files currently open.
194This problem may be overcome by adding a line of the form
195.Ql set hsfs:nhsnode=number
196to the
197.Pa /etc/system
198system configuration file and rebooting.
199See
200.Xr system 5 .
201.El
202.Sh SEE ALSO
203.Xr vfstab 5 ,
204.Xr mount 8 ,
205.Xr mount_hsfs 8
206.Pp
207.Rs
208.%A N. V. Phillips
209.%A Sony Corporation
210.%T System Description Compact Disc Digital Audio, ("Red Book")
211.Re
212.Rs
213.%A N. V. Phillips
214.%A Sony Corporation
215.%T System Description of Compact Disc Read Only Memory, ("Yellow Book")
216.Re
217.Rs
218.%T Volume and File Structure of CD-ROM for Information Interchange
219.%N ISO 9660:1988(E)
220.Re
221.Sh WARNINGS
222Do not physically eject a CD-ROM while the device is still mounted as a
223.Nm
224file system.
225.Pp
226Under MS-DOS
227.Pq for which CD-ROMs are frequently targeted ,
228files with no extension may be represented either as:
229.Pa filename\&.
230or
231.Pa filename
232that is, with or without a trailing period.
233These names are not equivalent under UNIX systems.
234For example, the names:
235.Pa BAR\&.
236and
237.Pa BAR
238are not names for the same file under the UNIX system.
239This may cause confusion if you are consulting documentation for CD-ROMs
240originally intended for MS-DOS systems.
241.Pp
242Use of the
243.Fl o
244.Ar notraildot
245option to
246.Xr mount 8
247makes it optional to specify the trailing dot.
248See
249.Xr mount_hsfs 8 .
250.Sh NOTES
251No translation of any sort is done on the contents of High Sierra or ISO 9660
252format CD-ROMs; only directory and file names are subject to interpretation by
253.Nm .
254