diff options
Diffstat (limited to 'manpages')
| -rw-r--r-- | manpages/dump.exfat.8 | 17 | ||||
| -rw-r--r-- | manpages/exfat2img.8 | 36 | ||||
| -rw-r--r-- | manpages/exfatlabel.8 | 34 | ||||
| -rw-r--r-- | manpages/fsck.exfat.8 | 88 | ||||
| -rw-r--r-- | manpages/mkfs.exfat.8 | 131 | ||||
| -rw-r--r-- | manpages/tune.exfat.8 | 58 |
6 files changed, 364 insertions, 0 deletions
diff --git a/manpages/dump.exfat.8 b/manpages/dump.exfat.8 new file mode 100644 index 0000000..4c6f589 --- /dev/null +++ b/manpages/dump.exfat.8 @@ -0,0 +1,17 @@ +.TH dump.exfat 8 +.SH NAME +dump.exfat \- Show on-disk information of exfat filesystem +.SH SYNOPSIS +.B dump.exfat +.I device +.br +.B dump.exfat \-V +.SH DESCRIPTION +.B dump.exfat +Print on-disk information from given device that formatted by exFAT filesystem. + +.PP +.SH OPTIONS +.TP +.B \-V +Prints the version number and exits. diff --git a/manpages/exfat2img.8 b/manpages/exfat2img.8 new file mode 100644 index 0000000..bceaa08 --- /dev/null +++ b/manpages/exfat2img.8 @@ -0,0 +1,36 @@ +.TH exfat2img 8 +.SH NAME +exfat2img \- dump metadata of an exFAT filesystem +.SH SYNOPSIS +.B exfat2img +[ +.B \-o \fIpath\fB\ +] [ +.B \-V +] +.I device +.br +.B exfat2img \-V +.SH DESCRIPTION +.B exfat2img +dump metadata of exFAT filesystems for debugging. \fBexfat2img\fP dump boot sector, File Allcation Table, Bitmap and all metadata which can reach from root directory. + +.SH OPTIONS +.TP +.BI \-o\ \-\-output +Specify output result file. If filesystem to which output file is written does not support sparse file, you should use '-' in place of \fIpath\fP. +Because a dump image generated from stdout has a special format, when restoring a partition from it, exfat2img should be used. See Examples. +.TP +.B \-V +Prints the version number and exits. + +.SH EXAMPLES +.PP +Dump metadata into a sparse file. +.EX +.RB "$" " exfat2img -o sda1.dump /dev/sda1 + +Dump metadata into standard out and restore a partition +.EX +.RB "$" " exfat2img -o - /dev/sda1 | bzip2 > sda1.dump.bz2" +.RB "$" " bzip2 -dc sda1.dump.bz2 | exfat2img -o /dev/sdb1 -" diff --git a/manpages/exfatlabel.8 b/manpages/exfatlabel.8 new file mode 100644 index 0000000..40c8d56 --- /dev/null +++ b/manpages/exfatlabel.8 @@ -0,0 +1,34 @@ +.TH exfatlabel 8 +.SH NAME +exfatlabel \- Get or Set volume label or volume serial of an exFAT filesystem +.SH SYNOPSIS +.B exfatlabel +[ +.B \-i +] [ +.B \-V +] +.I device +[ +.I label_string or serial_value +] +.br +.B exfatlabel \-V +.SH DESCRIPTION +.B exfatlabel +Print or set volume label of an existing exFAT filesystem. + +If there is a +.I label_string +in the argument of exfatlabel, it will be written to the volume +label field on a given device. If not, exfatlabel will just print +it after reading the volume label field from the given device. If -i +or --volume-serial is given, it will switch to volume serial mode. +.PP +.SH OPTIONS +.TP +.BI \-i\ \-\-volume-serial +Switch to volume serial mode. +.TP +.B \-V +Prints the version number and exits. diff --git a/manpages/fsck.exfat.8 b/manpages/fsck.exfat.8 new file mode 100644 index 0000000..5faecf0 --- /dev/null +++ b/manpages/fsck.exfat.8 @@ -0,0 +1,88 @@ +.TH fsck.exfat 8 +.SH NAME +fsck.exfat \- check an exFAT filesystem +.SH SYNOPSIS +.B fsck.exfat +[ +.B \-a +] [ +.B \-n +] [ +.B \-r +] [ +.B \-v +] [ +.B \-y +] [ +.B \-b +] [ +.B \-v +] +.I device +.br +.B fsck.exfat \-V +.SH DESCRIPTION +.B fsck.exfat +checks an exFAT filesystem and repairs the filesystem +depending on the options passed. The following corruptions can be repaired, and see the option, '-s'. +.IP - +Boot sector has invalid parameters. If backup boot sector is valid, replace the boot sector with it. +.IP - +Cluster is marked as free but belonged to a file, or vise versa. The bitmap for the cluster is marked properly. +.IP - +File size is abnormally large considering the count of clusters. The size is changed. +.IP - +File size is abnormally small considering the count of clusters. The remaining clusters are deleted. +.IP - +File's cluster chain has an invalid cluster number. The number are changed to EOF, and the file size is also changed. +.IP - +File's cluster chain contains a loop. The loop is broken. +.IP - +Files share the same cluster. Cluster chains for files except one are broken. +.IP - +Start cluster number is invalid. The cluster number and file size are changed to 0. +.IP - +Checksum value of directory entry set is invalid. Directory entry set is deleted. +.IP - +Bad hash value of a file name. The hash value is changed properly. +.IP - +Fields of directory entry set have invalid values. Directory entry set is deleted. +.PP +.SH OPTIONS +.TP +.BI \-a +This option does the same thing as the -p option. It is provided for backwards compatibility only; it is suggested that people use -p option whenever possible. +.TP +.BI \-n +Check the filesystem but do not attempt to repair the filesystem. +.TP +.BI \-p +Repair the filesystem without user interaction if it can be done safely. +.TP +.BI \-r +Repair the filesystem interactively. +.TP +.BI \-s +Create files in /LOST+FOUND for orphan clusters. These files have clusters allocated but not belonged to any files when reparing the filesystem. clusters unused and contiguous in bitmap are allocated to the same file. +.TP +.BI \-v +Prints verbose debugging information while checking the exFAT filesystem. +.TP +.BI \-V +Prints the version number and exits. +.TP +.B \-y +Repair the filesystem answering yes to all questions. +.TP +.B \-b +Try to repair the filesystem even if the exFAT filesystem is not found. + +.SH EXAMPLES +.PP +repair a corrupted device and create files in /LOST+FOUND, which have clusters allocated but not belonged to any files when reparing the device. +.EX +.RB "$" " fsck.exfat -p -s /dev/sda1" + +.SH SEE ALSO +.BR fsck (8), +.BR fstab (5), diff --git a/manpages/mkfs.exfat.8 b/manpages/mkfs.exfat.8 new file mode 100644 index 0000000..76a0065 --- /dev/null +++ b/manpages/mkfs.exfat.8 @@ -0,0 +1,131 @@ +.TH mkfs.exfat 8 +.SH NAME +mkfs.exfat \- create an exFAT filesystem +.SH SYNOPSIS +.B mkfs.exfat +[ +.B \-b +.I boundary_alignment +] [ +.B \-c +.I cluster_size +] [ +.B \-f +] [ +.B \-h +] [ +.B \-L +.I volume_label +] [ +.B \-U +.I volume_guid +] [ +.B \-\-pack\-bitmap +] [ +.B \-v +] +.I device +.br +.B mkfs.exfat \-V +.SH DESCRIPTION +.B mkfs.exfat +creates an exFAT filesystem by writing on a special +file using the values found in the arguments of the command line. +It is invoked automatically by +.BR mkfs (8) +when it is given the +.B \-t exfat +option. +.PP +As an example, to make a filesystem on the first partition on the first +SCSI disk, use: +.IP +.B mkfs.exfat /dev/sda1 +.PP +.SH OPTIONS +.TP +.BR \-b ", " \-\-boundary\-align =\fIalignment\fR +Specifies the alignment for the FAT and the start of the cluster heap. +The \fIalignment\fR argument is specified in bytes or may be specified with +\fBm\fR/\fBM\fR suffix for mebibytes or \fBk\fR/\fBK\fR suffix for kibibytes +and should be a power of two. +Some media like SD cards need this for optimal performance and endurance, +in which case \fIalignment\fR should be set to half of the card's native +boundary unit size. +If the card's native boundary unit size is not known, refer to the following +table of boundary unit sizes recommended by the SD Card Association. +.\" source: SD Specifications Part 2: File System Specification Version 3.00 +.TS +center; +cb1s6cbcb,nnnn. +Card Capacity Range Cluster Size Boundary Unit +_ + \[<=]8 MiB 8 KiB 8 KiB +>8 MiB \[<=]64 MiB 16 KiB 16 KiB +>64 MiB \[<=]256 MiB 16 KiB 32 KiB +>256 MiB \[<=]1 GiB 16 KiB 64 KiB +>1 GiB \[<=]2 GiB 32 KiB 64 KiB +>2 GiB \[<=]32 GiB 32 KiB 4 MiB +>32 GiB \[<=]128 GiB 128 KiB 16 MiB +>128 GiB \[<=]512 GiB 256 KiB 32 MiB +>512 GiB \[<=]2 TiB 512 KiB 64 MiB +.TE +The default is always 1 MiB. +.TP +.BR \-c ", " \-\-cluster\-size =\fIsize\fR +Specifies the cluster size of the exFAT file system. +The \fIsize\fR argument is specified in bytes or may be specified with +\fBm\fR/\fBM\fR suffix for mebibytes or \fBk\fR/\fBK\fR suffix for kibibytes +and must be a power of two. +The default value is described in the following table: +.TS +center; +cb1s6cb,nnn. +Card Capacity Range Cluster Size +_ + \[<=]256 MiB 4 KiB +>256 MiB \[<=]32 GiB 32 KiB +>32 GiB 128 KiB +.TE +.TP +.BR \-f ", " \-\-full\-format +Performs a full format. +This zeros the entire disk device while creating the exFAT filesystem. +.TP +.BR \-h ", " \-\-help +Prints the help and exit. +.TP +.BR \-L ", " \-\-volume\-label =\fIlabel\fR +Specifies the volume label to be associated with the exFAT filesystem. +.TP +.BR \-U ", " \-\-volume\-guid =\fIguid\fR +Specifies the volume GUID to be associated with the exFAT filesystem. +.TP +.B \-\-pack\-bitmap +Attempts to relocate the exFAT allocation bitmap so that it ends at the +alignment boundary immediately following the FAT rather than beginning at that +boundary. +This strictly violates the SD card specification but may improve performance +and endurance on SD cards and other flash media not designed for use with exFAT +by allowing file-system metadata updates to touch fewer flash allocation units. +Furthermore, many SD cards and other flash devices specially optimize the +allocation unit where the FAT resides so as to support tiny writes with reduced +write amplification but expect only larger writes in subsequent allocation +units \[em] where the exFAT bitmap would be placed by default. +Specifying \fB\-\-pack\-bitmap\fR attempts to avoid the potential problems +associated with issuing many small writes to the bitmap by making it share an +allocation unit with the FAT. +If there is insufficient space for the bitmap there, then this option will have +no effect, and the bitmap will be aligned at the boundary as by default. +.TP +.BR \-q ", " \-\-quiet +Prints only error messages while creating the exFAT filesystem. +.TP +.BR \-v ", " \-\-verbose +Prints verbose debugging information while creating the exFAT filesystem. +.TP +.BR \-V ", " \-\-version +Prints the version number and exits. +.SH SEE ALSO +.BR mkfs (8), +.BR mount (8), diff --git a/manpages/tune.exfat.8 b/manpages/tune.exfat.8 new file mode 100644 index 0000000..b57c746 --- /dev/null +++ b/manpages/tune.exfat.8 @@ -0,0 +1,58 @@ +.TH tune.exfat 8 +.SH NAME +tune.exfat \- adjust tunable filesystem parameters on an exFAT filesystem +.SH SYNOPSIS +.B tune.exfat +[ +.B \-l +.I print-label +] [ +.B \-L +.I set-label +] [ +.B \-u +.I print-guid +] [ +.B \-U +.I set-guid +] [ +.B \-i +.I print-serial +] [ +.B \-I +.I set-serial +] [ +.B \-v +] +.I device +.br +.B tune.exfat \-V +.SH DESCRIPTION +.B tune.exfat +adjust tunable ondisk parameters of an existing exFAT filesystem. +.PP +.SH OPTIONS +.TP +.BI \-l " print-label" +Print the volume label of the exFAT filesystem. +.TP +.BI \-L " set-label" +Set the volume label of the filesystem to the provided argument. +.TP +.BI \-u " print-guid" +Print the volume GUID of the exFAT filesystem. +.TP +.BI \-U " set-guid" +Set the volume GUID of the filesystem to the provided argument. +.TP +.BI \-i " print-serial" +Print the volume serial of the exFAT filesystem. +.TP +.BI \-I " set-serial" +Set the volume serial of the filesystem to the provided argument. +.TP +.BI \-v +Prints verbose debugging information while extracting or tuning parameters of the exFAT filesystem. +.TP +.B \-V +Prints the version number and exits. |