Documented GVF_SAVE_VAR alongside other flags, and removed a query/doubt
[AROS.git] / rom / filesys / SFS / SFSformat / SFSformat.txt
blob927ec80563826bc6d34e21a25393601c71ef959b
1 SFSformat can be used to quick format an SFS partition.  The
2 normal format command has special options for FastFilesystem
3 (FFS, DIRCACHE and so on) -- SFSformat has special options
4 for Smart Filesystem.
6 SFSformat currently only has one option, which can be used
7 to format a SFS disk with case sensitive file and directory
8 names (ala UNIX).
10 It's command line syntax is:
12  DEVICE=DRIVE/A/K,NAME/K/A,CASESENSITIVE/S,NORECYCLED/S,
13  SHOWRECYCLED/S
16 DEVICE or DRIVE
18 The SFS drive you wish to quick format.  SFSformat can only
19 be used to quick format an SFS drive.  Other filesystems
20 will be unaffected.
23 NAME
25 The name of the newly formatted partition.  
28 CASESENSITIVE
30 Specify this on the command line to get case sensitive file
31 and directory names.  If you specify this option, then SFS
32 will treat the files 'foo', 'Foo' and 'FOO' as three
33 distinct files.  Without this option they would be treated
34 as one and the same file (FFS behaviour).
37 NORECYCLED
39 When specified the disk will be formatted without creating a
40 Recycled directory.  You can't create this directory later
41 on (atleast not for now), so choose carefully.
44 SHOWRECYCLED
46 By default the Recycled directory is hidden and won't show
47 up in directory listings.  You can override this behaviour
48 with this switch.
52 When starting SFSformat it will ask you to confirm the
53 format.  Press Return to format, or Ctrl + C to abort.
56 Examples
57 --------
59 SFSformat drive SFS: name Empty casesensitive
61 -> Quick formats drive SFS: and gives it the name 'Empty'.
62    File and directory names on this drive will be case
63    sensitive.
66 SFSformat drive HD0: name MyDrive
68 -> Quick formats drive HD0: and gives it the name 'MyDrive'.
69    File and directory names on this drive will be treated
70    case insensitively (like under FFS).