Mon Jan 12 19:50:47 2015 UTC ()
reflect reality about filesystems supported.


(christos)
diff -r1.6 -r1.7 src/usr.sbin/makefs/README
cvs diff -r1.6 -r1.7 src/usr.sbin/makefs/README (expand / switch to unified diff)

--- src/usr.sbin/makefs/README 2014/10/18 08:33:31 1.6
+++ src/usr.sbin/makefs/README 2015/01/12 19:50:47 1.7
@@ -1,53 +1,59 @@ @@ -1,53 +1,59 @@
1$NetBSD: README,v 1.6 2014/10/18 08:33:31 snj Exp $ 1$NetBSD: README,v 1.7 2015/01/12 19:50:47 christos Exp $
2 2
3makefs - build a file system image from a directory tree 3makefs - build a file system image from a directory tree
4 4
5NOTES: 5NOTES:
6 6
7 * This tool uses modified local copies of source found in other 7 * This tool uses modified local copies of source found in other
8 parts of the tree. This is intentional. 8 parts of the tree. This is intentional.
9 9
10 * makefs is a work in progress, and subject to change. 10 * makefs is a work in progress, and subject to change.
11 11
12 12
13user overview: 13user overview:
14-------------- 14--------------
15 15
16makefs creates a file system image from a given directory tree. 16makefs creates a file system image from a given directory tree.
17the following file system types can be built: 17the following file system types can be built:
18 ffs BSD fast file system 18
19 cd9660 ISO 9660 file system 19 cd9660 ISO 9660 file system
 20 chfs "Chip" file system, for flash devices
 21 ffs BSD fast file system
 22 msdos MS-DOS `FAT' file system (FAT12, FAT16, FAT32)
 23 udf Universal Disk Format file system
20 v7fs 7th edition(V7) file system 24 v7fs 7th edition(V7) file system
21 25
22Support for the following file systems maybe be added in the future 26Support for the following file systems maybe be added in the future
 27
23 ext2fs Linux EXT2 file system 28 ext2fs Linux EXT2 file system
24 fat MS-DOS `FAT' file system (FAT12, FAT16, FAT32) 
25 29
26Various file system independent parameters and contraints can be 30Various file system independent parameters and contraints can be
27specified, such as: 31specified, such as:
 32
28 - minimum file system size (in KB) 33 - minimum file system size (in KB)
29 - maximum file system size (in KB) 34 - maximum file system size (in KB)
30 - free inodes 35 - free inodes
31 - free blocks (in KB) 36 - free blocks (in KB)
32 - mtree(8) specification file containing permissions and ownership 37 - mtree(8) specification file containing permissions and ownership
33 to use in image, overridding the settings in the directory tree 38 to use in image, overridding the settings in the directory tree
34 - file containing list of files to specifically exclude or include 39 - file containing list of files to specifically exclude or include
35 - fnmatch(3) pattern of filenames to exclude or include 40 - fnmatch(3) pattern of filenames to exclude or include
36 - endianness of target file system 41 - endianness of target file system
37 42
38File system specific parameters can be given as well, with a command 43File system specific parameters can be given as well, with a command
39line option such as "-o fsspeccific-options,comma-separated". 44line option such as "-o fsspeccific-options,comma-separated".
40For example, ffs would allow tuning of: 45For example, ffs would allow tuning of:
 46
41 - block & fragment size 47 - block & fragment size
42 - cylinder groups 48 - cylinder groups
43 - number of blocks per inode 49 - number of blocks per inode
44 - minimum free space 50 - minimum free space
45 51
46Other file systems might have controls on how to "munge" file names to 52Other file systems might have controls on how to "munge" file names to
47fit within the constraints of the target file system. 53fit within the constraints of the target file system.
48 54
49Exit codes: 55Exit codes:
50 0 all ok 56 0 all ok
51 1 fatal error 57 1 fatal error
52 2 some files couldn't be added during image creation 58 2 some files couldn't be added during image creation
53 (bad perms, missing file, etc). image will continue 59 (bad perms, missing file, etc). image will continue