xref: /illumos-gate/usr/src/man/man4fs/udfs.4fs (revision f137b22e)
1.\"
2.\" Copyright (c) 1999 Sun Microsystems, Inc.
3.\" All Rights Reserved.
4.\" Copyright 2021 Oxide Computer Company
5.\"
6.\" The contents of this file are subject to the terms of the
7.\" Common Development and Distribution License (the "License").
8.\" You may not use this file except in compliance with the License.
9.\"
10.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
11.\" or http://www.opensolaris.org/os/licensing.
12.\" See the License for the specific language governing permissions
13.\" and limitations under the License.
14.\"
15.\" When distributing Covered Code, include this CDDL HEADER in each
16.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
17.\" If applicable, add the following below this CDDL HEADER, with the
18.\" fields enclosed by brackets "[]" replaced with your own identifying
19.\" information: Portions Copyright [yyyy] [name of copyright owner]
20.\"
21.Dd June 20, 2021
22.Dt UDFS 4FS
23.Os
24.Sh NAME
25.Nm udfs
26.Nd universal disk format file system
27.Sh DESCRIPTION
28The
29.Nm
30file system is a file system type that allows user access to files on Universal
31Disk Format (UDF) disks from within illumos.
32Once mounted, a
33.Nm
34file system provides standard file system operations and semantics.
35That is, users can read files, write files, and list files in a directory on a
36UDF device and applications can use standard UNIX system calls on these files
37and directories.
38.Pp
39Because
40.Nm
41is a platform-independent file system, the same media can be written to and read
42from by any operating system or vendor.
43.Ss "Mounting File Systems"
44.Nm
45file systems are mounted using:
46.Bd -literal -offset indent
47mount -F udfs -o rw/ro device-special
48.Ed
49.Pp
50Use:
51.Bd -literal -offset indent
52mount /udfs
53.Ed
54if the
55.Nm
56and device special file
57.Pa /dev/dsk/c0t6d0s0
58are valid and the following line
59.Pq or similar line
60appears in your
61Pa /etc/vfstab
62file:
63.Bd -literal -offset indent
64/dev/dsk/c0t6d0s0 - /udfs udfs - no ro
65.Ed
66.Pp
67The
68.Nm
69file system provides read-only support for ROM, RAM, and sequentially-recordable
70media and read-write support on RAM media.
71.Pp
72The
73.Nm
74file system also supports regular files, directories, and symbolic links, as
75well as device nodes such as block, character, FIFO, and Socket.
76.Sh SEE ALSO
77.Xr vfstab 5 ,
78.Xr mount 8 ,
79.Xr mount_udfs 8
80.Sh NOTES
81Invalid characters such as
82.Dq \e0
83and
84.Dq /
85and invalid file names
86such as
87.Dq \ .
88.Dq \&.
89and
90.Dq \&.\&.
91will be translated according to the following rule:
92.Pp
93Replace the invalid character with an
94.Dq _ ,
95then append the file name with
96.Dq #
97followed by a 4 digit hex representation of the 16-bit CRC of the original
98.Sy FileIdentifier .
99For example, the file name
100.Dq \&.\&.
101will become
102.Dq __#4C05 .
103