summaryrefslogtreecommitdiff
path: root/doc/udfinfo.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/udfinfo.1')
-rw-r--r--doc/udfinfo.1104
1 files changed, 53 insertions, 51 deletions
diff --git a/doc/udfinfo.1 b/doc/udfinfo.1
index 83d7920..83a6967 100644
--- a/doc/udfinfo.1
+++ b/doc/udfinfo.1
@@ -1,5 +1,5 @@
'\" t -*- coding: UTF-8 -*-
-.\" Copyright (C) 2017 Pali Rohár <pali.rohar@gmail.com>
+.\" Copyright (C) 2017-2018 Pali Rohár <pali.rohar@gmail.com>
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
@@ -14,11 +14,11 @@
.\" You should have received a copy of the GNU General Public License along
.\" with this program; if not, write to the Free Software Foundation, Inc.,
.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
+.\"
.TH UDFINFO 1 "udftools" "Commands"
.SH NAME
-udfinfo \- show information about UDF filesystem
+udfinfo \(em show information about UDF filesystem
.SH SYNOPSIS
.BI "udfinfo [ options ] " device
@@ -36,9 +36,9 @@ Display the usage and the list of options.
.TP
.BI \-b,\-\-blocksize= " block\-size "
Specify the size of blocks in bytes. Valid block size for a UDF filesystem is
-power of two in range from 512 to 32768 and must match a device logical (sector)
-size. If omitted, \fBudfinfo\fP tries to autodetect block size. It tries logical
-(sector) size and then all valid block sizes.
+a power of two in the range from \fI512\fP to \fI32768\fP and must match a
+device logical (sector) size. If omitted, \fBudfinfo\fP tries to autodetect
+block size. First it tries logical (sector) size and then all valid block sizes.
.TP
.BI \-\-vatblock= " vat\-block "
@@ -48,14 +48,13 @@ last written/recorded disk block.
If omitted, \fBudfinfo\fP for optical disc tries to detect the last recorded
block with fallback to the last block of block device or disk file image. In
-most cases this fallback does not have to work and for disk file images with
-Virtual Allocation Table is necessary to specify correct location.
+most cases, this fallback does not have to work and for disk file images with
+Virtual Allocation Table is necessary to specify the correct location.
Virtual Allocation Table contains locations of UDF disk blocks needed to read
data storage, determinate used and free space blocks, read File Set Identifier
-and calculate Windows specific Volume Serial Number. Also on disks with UDF
-revisions higher then 1.50 it contains Logical Volume Identifier and overwrite
-one stored in Logical Volume Descriptor.
+and calculate Windows-specific Volume Serial Number. Also, it contains Logical
+Volume Identifier and overwrite previously stored in Logical Volume Descriptor.
.TP
.B \-\-locale
@@ -64,13 +63,13 @@ Encode UDF string identifiers on output according to current locale settings
.TP
.B \-\-u8
-Encode UDF string identifiers on output to 8 bit OSTA Compressed Unicode format,
+Encode UDF string identifiers on output to 8-bit OSTA Compressed Unicode format,
equivalent to Latin1 (ISO-8859-1). This will work only for strings which Unicode
code points are below U+100.
.TP
.B \-\-u16
-Encode UDF string identifiers on output to 16 bit OSTA Compressed Unicode
+Encode UDF string identifiers on output to 16-bit OSTA Compressed Unicode
format, equivalent to UCS-2BE.
.TP
@@ -78,8 +77,8 @@ format, equivalent to UCS-2BE.
Encode UDF string identifiers on output to UTF-8.
.SH "EXIT STATUS"
-\fBudfinfo\fP returns 0 if successful, non-zero if there are problems like block
-device does not contain UDF filesystem.
+\fBudfinfo\fP returns 0 if successful, non-zero if there are problems like a
+block device does not contain UDF filesystem.
.SH "OUTPUT FORMAT"
First part of the \fBudfinfo\fP standard output contains information in
@@ -88,76 +87,76 @@ following table:
.RS
.TP 1.6i
-filename
+.I filename
File name of the selected block device or disk file image
.TP
-label
-label is an alias for \fIlvid\fP, see \fBudflabel\fP(8) section \fBUDF LABEL AND
-UUID\fP
+.I label
+label is an alias for \fIlvid\fP, see \fBudflabel\fP(8) section
+\fBUDF LABEL AND UUID\fP
.TP
-uuid
+.I uuid
UUID are first 16 hexadecimal lowercase digits of \fIfullvsid\fP, but see
\fBudflabel\fP(8) section \fBUDF LABEL AND UUID\fP
.TP
-lvid
+.I lvid
UDF Logical Volume Identifier stored in UDF Logical Volume Descriptor
.TP
-vid
+.I vid
UDF Volume Identifier stored in UDF Primary Volume Descriptor
.TP
-vsid
-\fIfullvsid\fP after \fIuuid\fP part, typically 17.-127. character
+.I vsid
+\fIfullvsid\fP after \fIuuid\fP part, typically 17.\(en127. character
.TP
-fsid
+.I fsid
UDF File Set Identifier stored in UDF File Set Descriptor
.TP
-fullvsid
+.I fullvsid
UDF Volume Set Identifier stored in UDF Primary Volume Descriptor
.TP
-winserialnum
-Windows specific Volume Serial Number
+.I winserialnum
+Windows-specific Volume Serial Number
.TP
-blocksize
+.I blocksize
UDF block size
.TP
-blocks
+.I blocks
Number of all blocks on the selected block device or disk file image
.TP
-usedblocks
+.I usedblocks
Number of used space blocks on UDF disk for data storage
.TP
-freeblocks
+.I freeblocks
Number of free space blocks on UDF disk for data storage
.TP
-behindblocks
+.I behindblocks
Number of blocks which are behind the last block used by UDF disk
.TP
-numfiles
+.I numfiles
Number of stored files on UDF disk
.TP
-numdirs
+.I numdirs
Number of stored directories on UDF disk
.TP
-udfrev
+.I udfrev
UDF revision needed for reading UDF disk
.TP
-udfwriterev
+.I udfwriterev
UDF revision needed for writing or modifying UDF disk
.TP
-vatblock
+.I vatblock
UDF block location of the Virtual Allocation Table (visible only when available)
.TP
-integrity
+.I integrity
UDF integrity of Logical Volume, one of: \fIopened\fP, \fIclosed\fP,
\fIunknown\fP
.TP
-accesstype
+.I accesstype
UDF Access Type, one of: \fIoverwritable\fP, \fIrewritable\fP, \fIwriteonce\fP,
\fIreadonly\fP, \fIpseudo\-overwritable\fP, \fIunknown\fP
.RE
When UDF integrity is not \fIclosed\fP it means that the UDF disk was not
-properly unmounted, is in inconsistent state and needs repairing.
+properly unmounted, is in an inconsistent state and needs repairing.
All UDF string identifiers are stored on UDF disk in Unicode, therefore they are
locale or code page agnostic. Options \fB\-\-locale\fP, \fB\-\-u8\fP,
@@ -176,19 +175,22 @@ start=\fIblock\-num\fP, blocks=\fIblock\-count\fP, type=\fIblock\-type\fP
With meaning that \fIblock\-type\fP starts at UDF block \fIblock\-num\fP and
span \fIblock\-count\fP blocks on device.
-Windows specific \fIVolume Serial Number\fP is a non-standard 32 bit checksum,
-calculated as four separate 8 bit XOR checksums of 512 bytes long UDF File Set
-Descriptor. Therefore it cannot be set or changed as opposite to UUID which is
-moreover 64 bit long. This non-standard checksum is used only by Windows systems
+Windows-specific \fIVolume Serial Number\fP is a non-standard 32-bit checksum,
+calculated as four separate 8-bit XOR checksums of 512 bytes long UDF File Set
+Descriptor. Therefore, it cannot be set or changed as opposed to UUID which is
+64-bit long. This non-standard checksum is used only by Windows systems
(since Windows 98 era when it was introduced) and can be displayed on Windows
-systems by applications like \fBvol\fP, \fBdir\fP or \fBfsutil\fP.
+systems by applications like \fBvol\fP, \fBdir\fP or \fBfsutil.exe\fP.
.SH LIMITATIONS
-\fBudfinfo\fP is not able to read Metadata Partition and Virtual Allocation
-Table stored outside of Information Control Block yet. Therefore determining
-used and free space blocks, reading File Set Identifier and calculating Windows
-specific Volume Serial Number may not be available for some Write Once media
-and disks with UDF revisions higher then 2.01 which have Metadata Partition.
+\fBudfinfo\fP is not able to read Metadata Partition yet. Therefore, determining
+used and free space blocks, reading File Set Identifier and calculating
+Windows-specific Volume Serial Number may not be available for disks with UDF
+revisions higher than 2.01 which have Metadata Partition.
+
+\fBudfinfo\fP prior to version 2.1 was unable to read Virtual Allocation Table
+stored outside of Information Control Block. Therefore above limitation applied
+also for some Write Once media.
.SH AUTHOR
.nf