[PATCH] Update udf documentation to reflect current state of read/write support
[linux-2.6.git] / Documentation / filesystems / udf.txt
1 *
2 * Documentation/filesystems/udf.txt
3 *
4 UDF Filesystem version 0.9.8.1
5
6 If you encounter problems with reading UDF discs using this driver,
7 please report them to linux_udf@hpesjro.fc.hp.com, which is the
8 developer's list.
9
10 Write support requires a block driver which supports writing.  Currently
11 dvd+rw drives and media support true random sector writes, and so a udf
12 filesystem on such devices can be directly mounted read/write.  CD-RW
13 media however, does not support this.  Instead the media can be formatted
14 for packet mode using the utility cdrwtool, then the pktcdvd driver can
15 be bound to the underlying cd device to provide the required buffering
16 and read-modify-write cycles to allow the filesystem random sector writes
17 while providing the hardware with only full packet writes.  While not
18 required for dvd+rw media, use of the pktcdvd driver often enhances
19 performance due to very poor read-modify-write support supplied internally
20 by drive firmware.
21
22 -------------------------------------------------------------------------------
23 The following mount options are supported:
24
25         gid=            Set the default group.
26         umask=          Set the default umask.
27         uid=            Set the default user.
28         bs=             Set the block size.
29         unhide          Show otherwise hidden files.
30         undelete        Show deleted files in lists.
31         adinicb         Embed data in the inode (default)
32         noadinicb       Don't embed data in the inode
33         shortad         Use short ad's
34         longad          Use long ad's (default)
35         nostrict        Unset strict conformance
36         iocharset=      Set the NLS character set
37
38 The uid= and gid= options need a bit more explaining.  They will accept a
39 decimal numeric value which will be used as the default ID for that mount.
40 They will also accept the string "ignore" and "forget".  For files on the disk
41 that are owned by nobody ( -1 ), they will instead look as if they are owned
42 by the default ID.  The ignore option causes the default ID to override all
43 IDs on the disk, not just -1.  The forget option causes all IDs to be written
44 to disk as -1, so when the media is later remounted, they will appear to be
45 owned by whatever default ID it is mounted with at that time.
46
47 For typical desktop use of removable media, you should set the ID to that
48 of the interactively logged on user, and also specify both the forget and
49 ignore options.  This way the interactive user will always see the files
50 on the disk as belonging to him.
51
52 The remaining are for debugging and disaster recovery:
53
54         novrs           Skip volume sequence recognition 
55
56 The following expect a offset from 0.
57
58         session=        Set the CDROM session (default= last session)
59         anchor=         Override standard anchor location. (default= 256)
60         volume=         Override the VolumeDesc location. (unused)
61         partition=      Override the PartitionDesc location. (unused)
62         lastblock=      Set the last block of the filesystem/
63
64 The following expect a offset from the partition root.
65
66         fileset=        Override the fileset block location. (unused)
67         rootdir=        Override the root directory location. (unused)
68                         WARNING: overriding the rootdir to a non-directory may
69                                 yield highly unpredictable results.
70 -------------------------------------------------------------------------------
71
72
73 For the latest version and toolset see:
74         http://linux-udf.sourceforge.net/
75
76 Documentation on UDF and ECMA 167 is available FREE from:
77         http://www.osta.org/
78         http://www.ecma-international.org/
79
80 Ben Fennema <bfennema@falcon.csc.calpoly.edu>