diff options
author | Pali Rohár <pali.rohar@gmail.com> | 2018-01-16 23:47:19 +0100 |
---|---|---|
committer | Pali Rohár <pali.rohar@gmail.com> | 2018-01-16 23:47:19 +0100 |
commit | 05fce0a970fe98a114b56719b046d783c7c28062 (patch) | |
tree | e218684ae5e81477e5672ee7828096c291a1c724 /doc |
Import udftools_2.0.orig.tar.gz
[dgit import orig udftools_2.0.orig.tar.gz]
Diffstat (limited to 'doc')
-rw-r--r-- | doc/HOWTO.udf | 149 | ||||
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/Makefile.in | 584 | ||||
-rw-r--r-- | doc/UDF-Specifications | 9 | ||||
-rw-r--r-- | doc/cdrwtool.1 | 151 | ||||
-rw-r--r-- | doc/mkfs.udf.8 | 1 | ||||
-rw-r--r-- | doc/mkudffs.8 | 446 | ||||
-rw-r--r-- | doc/pktsetup.8 | 100 | ||||
-rw-r--r-- | doc/udfinfo.1 | 204 | ||||
-rw-r--r-- | doc/udflabel.8 | 202 | ||||
-rw-r--r-- | doc/wrudf.1 | 60 |
11 files changed, 1908 insertions, 0 deletions
diff --git a/doc/HOWTO.udf b/doc/HOWTO.udf new file mode 100644 index 0000000..5c652dc --- /dev/null +++ b/doc/HOWTO.udf @@ -0,0 +1,149 @@ +udftools +=================== + +Kernel support for packet writing +--------------------------------- + +Packet writing is a technique by which a writable medium (typically a +CD or DVD) can be used just like a USB stick or a directory on the +hard disc: Files and directories can be created/renamed/removed +freely, and no separate "burning" step is necessary to write the data +to the medium. Packet writing is possible both with write-once media +(CD-R, DVD+R, DVD-R) and rewritable media (CD-RW, DVD+RW, +DVD-RW). Obviously, with write-once media the free space on the +filesystem will not increase if you delete files. + +In order to do packet writing under Linux, your kernel needs +both support for UDF (Universal Disc Format) filesystems and for +packet writing. This is the case for kernels later than about 2.6.10. +This package tries to support both old-style packet writing +(kernel <2.6.8), and the newer variant (>=2.6.10), with and without +udev. Use a recent 2.6 kernel for optimum results! + + +Formatting and using a UDF DVD-RW or CD-RW for packet writing +------------------------------------------------------------- + +The commands differ depending on whether you are using DVD or CD +media. + +1) Edit /etc/udftools.conf and add your drive for packet writing. +For example, if your CD/DVD writer is /dev/hdc and you want it +available as the default /dev/pktcdvd/0, then use the setting +"DEVICES=/dev/hdc". Execute "/etc/rc.d/rc.udftools start" afterwards to +register the device. + +If the device name /dev/hdc differs on your system, adjust the +following commands as appropriate. + +2) Prepare the medium in restricted overwrite mode: + +DVD-RW: dvd+rw-format -force /dev/hdc + CD-RW: Do nothing, skip this step! + +3) Write an empty session spanning the whole medium. It seems that +without this step, any attempt to create the UDF filesystem will fail. + +DVD-RW: growisofs -Z /dev/hdc=/dev/zero + CD-RW: cdrwtool -d /dev/hdc -q + +4) Format the packet device in UDF format. + +DVD-RW: mkudffs --udfrev=0x0150 --spartable=2 --media-type=dvdrw /dev/pktcdvd/0 + CD-RW: mkudffs --udfrev=0x0150 --spartable=2 --media-type=cdrw /dev/pktcdvd/0 + +The parameters require some more explanation: For --udfrev, use either +0x0150 for UDF version 1.50, or 0x0201 for UDF version 2.01. The +version decision has mostly to do with compatibility: + - Windows 98/ME can read up to v1.02 + - Windows 2000, Mac OS 9, Linux 2.4 can read up to v1.50 + - Windows 2003/XP can read up to v2.01 + - Linux 2.6 can read up to v2.60 +For normal data, UDF 1.50 is OK. UDF 2.00 and 2.01 introduce +additional functionality for streaming audio/video. + +Possible values for --media-type are: hd dvdram dvdrw worm mo cdrw cdr. +Use the one appropriate for your medium/device. + +5) Mount the disc. The "noatime" option is important: It will reduce +the amount of writes to the device and thus increase its lifetime. You +may first have to create the mount directory using "mkdir +/media/dvd0": + + mount -t udf -o rw,noatime /dev/pktcdvd/0 /media/dvd0 + +The "sync" mount option might also be useful, but will typically cause +an increased number of write accesses to the medium. From now on, the +root user can access the filesystem under /media/dvd0 using read and +write operations. + +6) If regular users should also have write access, modify the +permissions as follows _while the filesystem is mounted_: + + chgrp plugdev /media/dvd0 # Set group ownership to "plugdev" + chmod g+rwx /media/dvd0 # Give full read/write access to group + +Now all users who should have access to the disc need to be added to +the "plugdev" group using "adduser <username> plugdev". + +To also allow these users to mount and unmount/eject the medium, you +can use either of these two routes: + + - Install the "pmount" package and add the device to the list of + allowed devices using "echo /dev/pktcdvd/0 >>/etc/pmount.allow". + All members of the group "plugdev" will then be able to mount the + disc using "pmount /dev/pktcdvd/0 dvd0" and unmount it using + "pumount /media/dvd0". + + - Add a line like the following to /etc/fstab: + /dev/pktcdvd/0 /media/dvd0 udf rw,noatime,users,noauto 0 0 + This will enable _all_ users to mount the disc using + "mount /media/dvd0" and unmount it with + "umount /media/dvd0". However, with the permissions from step 5) + above, only the members of group "plugdev" ought to be able to + write to it. + + +Support for UDF filesystems +--------------------------- + +UDF (not packet writing) support in Linux 2.4 and later kernels is +sufficient to read from and write to UDF filesystems. For example, you +can create a regular file, "format" it using mkudffs, and then +loop-mount it. To do this, execute the following commands as root: +(After "count=", supply the required size in MB of the filesystem.) + + dd if=/dev/zero of=udfimage bs=1M count=10 + mkudffs udfimage + mkdir udfmnt + mount -o loop -t udf udfimage udfmnt + +You need Linux 2.4+ with UDF read *and* write support enabled. Now you +can copy data to the "udfmnt" directory. After an "umount udfmnt", the +file "udfimage" could theoretically be written to a CD-R(W) or +DVD-R(W). In practice, you will not want to do that, as the whole +point of using UDF is to do packet writing. + + +"/dev/pktcdvd0" not present? +---------------------------- + +The "pktsetup" tool requires a device like /dev/pktcdvd0, +/dev/pktcdvd1 etc. If the device is not present on your system, this +means one of two things: + + - You are using devfs (the file /dev/.devfsd is present). In this + case, just try to use the device, and the appropriate driver should + be loaded automatically. + + - You are not using devfs now, but it was being used at the time the + udftools package was installed. In this case, you need to create + the devices as root now, using the command: + + dpkg-reconfigure udftools + + - You are using udev, and there is no packet writing support in your + kernel. + + + -- Richard Atterer <atterer@debian.org> Wed, 22 Nov 2006 23:38:16 +0100 diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..dd76ca5 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,2 @@ +dist_man_MANS = cdrwtool.1 udfinfo.1 wrudf.1 mkfs.udf.8 mkudffs.8 pktsetup.8 udflabel.8 +dist_doc_DATA = HOWTO.udf UDF-Specifications diff --git a/doc/Makefile.in b/doc/Makefile.in new file mode 100644 index 0000000..f00ffbb --- /dev/null +++ b/doc/Makefile.in @@ -0,0 +1,584 @@ +# Makefile.in generated by automake 1.15 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994-2014 Free Software Foundation, Inc. + +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +VPATH = @srcdir@ +am__is_gnu_make = { \ + if test -z '$(MAKELEVEL)'; then \ + false; \ + elif test -n '$(MAKE_HOST)'; then \ + true; \ + elif test -n '$(MAKE_VERSION)' && test -n '$(CURDIR)'; then \ + true; \ + else \ + false; \ + fi; \ +} +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ + esac; \ + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = doc +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +DIST_COMMON = $(srcdir)/Makefile.am $(dist_doc_DATA) \ + $(am__DIST_COMMON) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/include/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = +SOURCES = +DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = f=`echo $$p | sed -e 's|^.*/||'`; +am__install_max = 40 +am__nobase_strip_setup = \ + srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*|]/\\\\&/g'` +am__nobase_strip = \ + for p in $$list; do echo "$$p"; done | sed -e "s|$$srcdirstrip/||" +am__nobase_list = $(am__nobase_strip_setup); \ + for p in $$list; do echo "$$p $$p"; done | \ + sed "s| $$srcdirstrip/| |;"' / .*\//!s/ .*/ ./; s,\( .*\)/[^/]*$$,\1,' | \ + $(AWK) 'BEGIN { files["."] = "" } { files[$$2] = files[$$2] " " $$1; \ + if (++n[$$2] == $(am__install_max)) \ + { print $$2, files[$$2]; n[$$2] = 0; files[$$2] = "" } } \ + END { for (dir in files) print dir, files[dir] }' +am__base_list = \ + sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ + sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + test -z "$$files" \ + || { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && rm -f $$files; }; \ + } +man1dir = $(mandir)/man1 +am__installdirs = "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man8dir)" \ + "$(DESTDIR)$(docdir)" +man8dir = $(mandir)/man8 +NROFF = nroff +MANS = $(dist_man_MANS) +DATA = $(dist_doc_DATA) +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) +am__DIST_COMMON = $(dist_man_MANS) $(srcdir)/Makefile.in +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DLLTOOL = @DLLTOOL@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +GREP = @GREP@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +LT_SYS_LIBRARY_PATH = @LT_SYS_LIBRARY_PATH@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MKDIR_P = @MKDIR_P@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +RANLIB = @RANLIB@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +runstatedir = @runstatedir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +dist_man_MANS = cdrwtool.1 udfinfo.1 wrudf.1 mkfs.udf.8 mkudffs.8 pktsetup.8 udflabel.8 +dist_doc_DATA = HOWTO.udf UDF-Specifications +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +install-man1: $(dist_man_MANS) + @$(NORMAL_INSTALL) + @list1=''; \ + list2='$(dist_man_MANS)'; \ + test -n "$(man1dir)" \ + && test -n "`echo $$list1$$list2`" \ + || exit 0; \ + echo " $(MKDIR_P) '$(DESTDIR)$(man1dir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(man1dir)" || exit 1; \ + { for i in $$list1; do echo "$$i"; done; \ + if test -n "$$list2"; then \ + for i in $$list2; do echo "$$i"; done \ + | sed -n '/\.1[a-z]*$$/p'; \ + fi; \ + } | while read p; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; echo "$$p"; \ + done | \ + sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ + sed 'N;N;s,\n, ,g' | { \ + list=; while read file base inst; do \ + if test "$$base" = "$$inst"; then list="$$list $$file"; else \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man1dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man1dir)/$$inst" || exit $$?; \ + fi; \ + done; \ + for i in $$list; do echo "$$i"; done | $(am__base_list) | \ + while read files; do \ + test -z "$$files" || { \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man1dir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(man1dir)" || exit $$?; }; \ + done; } + +uninstall-man1: + @$(NORMAL_UNINSTALL) + @list=''; test -n "$(man1dir)" || exit 0; \ + files=`{ for i in $$list; do echo "$$i"; done; \ + l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + sed -n '/\.1[a-z]*$$/p'; \ + } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ + dir='$(DESTDIR)$(man1dir)'; $(am__uninstall_files_from_dir) +install-man8: $(dist_man_MANS) + @$(NORMAL_INSTALL) + @list1=''; \ + list2='$(dist_man_MANS)'; \ + test -n "$(man8dir)" \ + && test -n "`echo $$list1$$list2`" \ + || exit 0; \ + echo " $(MKDIR_P) '$(DESTDIR)$(man8dir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(man8dir)" || exit 1; \ + { for i in $$list1; do echo "$$i"; done; \ + if test -n "$$list2"; then \ + for i in $$list2; do echo "$$i"; done \ + | sed -n '/\.8[a-z]*$$/p'; \ + fi; \ + } | while read p; do \ + if test -f $$p; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; echo "$$p"; \ + done | \ + sed -e 'n;s,.*/,,;p;h;s,.*\.,,;s,^[^8][0-9a-z]*$$,8,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,' | \ + sed 'N;N;s,\n, ,g' | { \ + list=; while read file base inst; do \ + if test "$$base" = "$$inst"; then list="$$list $$file"; else \ + echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man8dir)/$$inst'"; \ + $(INSTALL_DATA) "$$file" "$(DESTDIR)$(man8dir)/$$inst" || exit $$?; \ + fi; \ + done; \ + for i in $$list; do echo "$$i"; done | $(am__base_list) | \ + while read files; do \ + test -z "$$files" || { \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(man8dir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(man8dir)" || exit $$?; }; \ + done; } + +uninstall-man8: + @$(NORMAL_UNINSTALL) + @list=''; test -n "$(man8dir)" || exit 0; \ + files=`{ for i in $$list; do echo "$$i"; done; \ + l2='$(dist_man_MANS)'; for i in $$l2; do echo "$$i"; done | \ + sed -n '/\.8[a-z]*$$/p'; \ + } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^8][0-9a-z]*$$,8,;x' \ + -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \ + dir='$(DESTDIR)$(man8dir)'; $(am__uninstall_files_from_dir) +install-dist_docDATA: $(dist_doc_DATA) + @$(NORMAL_INSTALL) + @list='$(dist_doc_DATA)'; test -n "$(docdir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(docdir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(docdir)" || exit 1; \ + fi; \ + for p in $$list; do \ + if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; \ + done | $(am__base_list) | \ + while read files; do \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(docdir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(docdir)" || exit $$?; \ + done + +uninstall-dist_docDATA: + @$(NORMAL_UNINSTALL) + @list='$(dist_doc_DATA)'; test -n "$(docdir)" || list=; \ + files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \ + dir='$(DESTDIR)$(docdir)'; $(am__uninstall_files_from_dir) +tags TAGS: + +ctags CTAGS: + +cscope cscopelist: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile $(MANS) $(DATA) +installdirs: + for dir in "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man8dir)" "$(DESTDIR)$(docdir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-dist_docDATA install-man + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: install-man1 install-man8 + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-dist_docDATA uninstall-man + +uninstall-man: uninstall-man1 uninstall-man8 + +.MAKE: install-am install-strip + +.PHONY: all all-am check check-am clean clean-generic clean-libtool \ + cscopelist-am ctags-am distclean distclean-generic \ + distclean-libtool distdir dvi dvi-am html html-am info info-am \ + install install-am install-data install-data-am \ + install-dist_docDATA install-dvi install-dvi-am install-exec \ + install-exec-am install-html install-html-am install-info \ + install-info-am install-man install-man1 install-man8 \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic mostlyclean \ + mostlyclean-generic mostlyclean-libtool pdf pdf-am ps ps-am \ + tags-am uninstall uninstall-am uninstall-dist_docDATA \ + uninstall-man uninstall-man1 uninstall-man8 + +.PRECIOUS: Makefile + + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/doc/UDF-Specifications b/doc/UDF-Specifications new file mode 100644 index 0000000..0bc0537 --- /dev/null +++ b/doc/UDF-Specifications @@ -0,0 +1,9 @@ +The UDF Specifications are available as free PDF files from OSTA at: + +http://www.osta.org/specs/ + +Many IEC/ISO standards that they reference are co-published by ECMA. +For example, Ecma publication ECMA-167 is also approved as ISO/IEC 13346. +They are available as free PDF files from ECMA at: + +http://www.ecma-international.org/publications/ diff --git a/doc/cdrwtool.1 b/doc/cdrwtool.1 new file mode 100644 index 0000000..b93a8ee --- /dev/null +++ b/doc/cdrwtool.1 @@ -0,0 +1,151 @@ +.\" Copyright 2002 Paul Thompson <set@pobox.com> +.\" +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" The GNU General Public License's references to "object code" +.\" and "executables" are to be interpreted as the output of any +.\" document formatting or typesetting system, including +.\" intermediate and printed output. +.\" +.\" This manual is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public +.\" License along with this manual; if not, write to the Free +.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, +.\" USA. +.\" +.\" References consulted: +.\" udf-0.9.5 source +.\" +.\" +.TH CDRWTOOL 1 "udftools" "Commands" + +.SH NAME +cdrwtool \- perform various actions on a CD-R, CD-RW, and DVD-R + +.SH SYNOPSIS +.BI "cdrwtool \-d " device " \-i | \-g" +.PP +.BI "cdrwtool \-d " device " \-s [ " write-parameters " ]" +.PP +.BI "cdrwtool \-d " device " \-q [ " write-parameters " ]" +.PP +.BI "cdrwtool \-d " device " \-m " offset " [ " write-parameters " ]" +.PP +.BI "cdwrtool \-d " device " \-u " blocks " [ " write-parameters " ]" +.PP +.BI "cdrwtool \-d " device " \-b " b_mode " [ " write-parameters " ]" +.PP +.BI "cdrwtool \-d " device " \-c " blocks " [ " write-parameters " ]" +.PP +.BI "cdwrtool \-d " device " \-f " filename " [ " write-parameters " ]" +.PP +.BI "cdwrtool \-d " device " \-r " track " [ " write-parameters " ]" +.PP +.BI "cdrwtool \-h" + +.SH DESCRIPTION +The \fBcdwrtool\fP command can perform certain actions on a CD-R, +CD-RW, or DVD-R device. Mainly these are blanking the media, +formatting it for use with the packet-cd device, and applying an +UDF filesystem. +.PP +The most common usage is probably the `quick setup' option: +.IP +.BI "cdrwtool \-d " device " \-q" +.PP +which will blank the disc, format it as one large track, and +write the UDF filesystem structures. +.PP +Other options get and set various parameters of how the device is +set up, and provide for different offsets, modes and settings +from the defaults. +.PP +The usefulness of most of the options is not explained. + +.SH OPTIONS +Main directives: +.IP "\fB\-d \fIdevice\fP" +Specify the device to use. eg. \fI/dev/sr0\fP + +.IP \fB\-i\fP +Print disc track info. + +.IP \fB\-g\fP +Print write parameters. + +.IP "\fB\-u \fIlength\fP" +Make a UDF filesystem using \fIlength\fP number of blocks. + +.IP "\fB\-q\fP" +`Quick setup': blank the disc, format it as one large track and write a UDF filesystem. + +.IP "\fB\-m \fIoffset\fP" +Format the disc at \fIoffset\fP number of blocks. + +.IP "\fB\-b \fImode\fP" +Blank the disk using a \fImode\fP of `full' or `fast'. + +.IP "\fB\-f \fIfilename\fP" +Write file. + +.IP "\fB\-c \fItrack\fP" +Close track. +.IP "\fB\-r \fItrack\fP" +Reserve track. + +.IP "\fB\-z \fIlength\fP" +Fixed packet length. + + +.IP \fB\-s\fP +Set write parameters determined by +.BR "\-l" , " \-w" ", and" " \-p" +options for the disc. + +.IP "\fB\-v \fIversion\fP" +Specify the udf revision to use. Valid revisions are 0x0201, 0x0200, 0x0150, +and 0x0102. If omitted, +.B mkudffs +udf-version is 0x0150. + +.IP \fB\-h\fP +Prints a sparse help message. +.PP + +Write parameters: +.IP "\fB\-t \fIspeed\fP" +Set write speed. (Defaults to 12x ?) +.IP "\fB\-l \fItype\fP" +Set multi\-session field. Either `0' (default), `1', or `3', corresponding to +`No B0 pointer. Next Session not allowed', +`B0 pointer = FF:FF:FF. Next session not allowed', and +`Next session allowed. B0 pointer = next possible program area' respectively. +.IP "\fB\-w \fImode\fP" +Set write mode. Either `mode1' or `mode2' (default). +.IP "\fB\-p \fItype\fP" +Set packet type. Either `0' or `1' (default), corresponding to +variable and fixed packet sizes respectively. +.IP "\fB\-o \fIoffset\fP" +Set write offset. + +.SH AUTHORS +.nf +Jens Axboe <axboe@suse.de> +Ben Fennema <bfennema@falcon.csc.calpoly.edu> +Some additions by Richard Atterer <atterer@debian.org> +.fi + +.SH AVAILABILITY +.B cdrwtool +is part of the udftools package and is available from +https://github.com/pali/udftools/. + +.SH "SEE ALSO" +.BR pktsetup (8) diff --git a/doc/mkfs.udf.8 b/doc/mkfs.udf.8 new file mode 100644 index 0000000..969d6be --- /dev/null +++ b/doc/mkfs.udf.8 @@ -0,0 +1 @@ +.so mkudffs.8 diff --git a/doc/mkudffs.8 b/doc/mkudffs.8 new file mode 100644 index 0000000..0dd88bc --- /dev/null +++ b/doc/mkudffs.8 @@ -0,0 +1,446 @@ +'\" t -*- coding: UTF-8 -*- +.\" Copyright 2002 Paul Thompson <set@pobox.com> +.\" Copyright 2014-2017 Pali Rohár <pali.rohar@gmail.com> +.\" +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" The GNU General Public License's references to "object code" +.\" and "executables" are to be interpreted as the output of any +.\" document formatting or typesetting system, including +.\" intermediate and printed output. +.\" +.\" This manual is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" 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 MKUDFFS 8 "udftools" "System Management Commands" + +.SH NAME +mkudffs \- create an UDF filesystem + +.SH SYNOPSIS +.BI "mkudffs [ options ] " device " [ " blocks\-count " ] " + +.SH DESCRIPTION +\fBmkudffs\fP is used to create a UDF filesystem on a device (usually a disk). +\fIdevice\fP is the special file corresponding to the device (e.g. +\fI/dev/hdX\fP) or file image. \fIblocks\-count\fP is the number of blocks on +the device. If omitted, \fBmkudffs\fP automagically figures the filesystem size. +The order of options matters. Encoding option must be first and options to +override default settings implied by the media type or UDF revision should be +after the option they are overriding. + +.SH OPTIONS +.TP +.B \-h,\-\-help +Display the usage and list of options. + +.TP +.BI \-l,\-\-label= " label " +Specify the UDF label. UDF label is synonym for specifying both \fB\-\-lvid\fP +and \fB\-\-vid\fP options. If omitted, \fBmkudffs\fP label is \fILinuxUDF\fP. +(Option available since mkudffs 1.1) + +.TP +.BI \-u,\-\-uuid= " uuid " +Specify the UDF uuid. Must be exactly 16 hexadecimal lowercase digits and is +used for first 16 characters of \fB\-\-fullvsid\fP option. If omitted, +\fBmkudffs\fP uuid is generated from local time and random number. +(Option available since mkudffs 1.1) + +.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, \fBmkudffs\fP block\-size is set to device logical block +(sector) size. If logical block (sector) size is unknown (e.g. when creating +disk image) then for \fB\-\-media\-type\fP=\fIhd\fP is used block\-size 512 and +for other media types 2048. + +.TP +.BI \-m,\-\-media\-type= " media\-type " +Specify the media type. Must be specified before \fB\-\-udfrev\fP. +Valid media types are: +.RS 1.2i +.TP 1.6i +hd (default) +HD (Hard Disk) +.TP +worm +WORM (Write Once Read Many) +.TP +mo +MO (Magneto Optical) +.TP +cd +CD\-ROM (CD Read\-Only Memory) +.TP +cdr +CD\-R (CD Recordable) +.TP +cdrw +CD\-RW (CD Read\-Write) +.TP +dvd +DVD\-ROM (DVD Read\-Only Memory) +.TP +dvdr +DVD\-R (DVD Recordable) +.TP +dvdrw +DVD\-RW (DVD Read\-Write) +.TP +dvdram +DVD\-RAM (DVD Random Access Memory) +.TP +bdr +BD\-R (Blu\-ray Disc Recordable) +.RE + +.RS +(Short option variant \fB\-m\fP and values \fIcd\fP, \fIdvdr\fP, \fIbdr\fP are +available since mkudffs 2.0) +.RE + +.TP +.BI \-r,\-\-udfrev= " udf\-revision " +Specify the UDF revision to use, either in hexadecimal (e.g. 0x0201) or decimal +(e.g. 2.01) format. Valid revisions arei 1.02, 1.50, 2.00, 2.01, 2.50 and 2.60. +If omitted, \fBmkudffs\fP udf\-revision is \fI2.01\fP, except for Blu-ray Discs +which is \fI2.50\fP. UDF revisions higher then 2.01 are experimental. Option +must be specified after \fB\-\-media\-type\fP. (Values in decimal format and +revisions higher then 2.01 are supported since mkudffs 2.0) + +.TP +.B \-n,\-\-no-write +Not really, do not write to \fIdevice\fP. Just simulate and display what would +happen with \fIdevice\fP. Useful for determining calculated location of +different UDF blocks. +(Option available since mkudffs 2.0) + +.TP +.B \-\-new\-file +Create a new image file specified by \fIdevice\fP with \fIblocks\-count\fP and +fail if file already exists. If omitted, \fBmkudffs\fP creates a new image file +only in case it does not exist yet. +(Option available since mkudffs 2.0) + +.TP +.BI \-\-lvid= " logical\-volume\-identifier " +Specify the \fILogical Volume Identifier\fP. If omitted, \fBmkudffs\fP +logical\-volume\-identifier is \fILinuxUDF\fP. Most UDF implementations uses +this identifier as a disk label. + +.TP +.BI \-\-vid= " volume\-identifier " +Specify the \fIVolume Identifier\fP. If omitted, \fBmkudffs\fP +volume\-identifier is \fILinuxUDF\fP. + +.TP +.BI \-\-vsid= " volume\-set\-identifier " +Specify the 17.-127. character of \fIVolume Set Identifier\fP. If omitted, +\fBmkudffs\fP volume\-set\-identifier is \fILinuxUDF\fP. + +.TP +.BI \-\-fsid= " file\-set\-identifier " +Specify the \fIFile Set Identifier\fP. If omitted, \fBmkudffs\fP +file\-set\-identifier is \fILinuxUDF\fP. + +.TP +.BI \-\-fullvsid= " full\-volume\-set\-identifier " +Specify the full \fIVolume Set Identifier\fP. Overwrite previous \fB\-\-uuid\fP +and \fB\-\-vsid\fP options. (Option available since mkudffs 1.1) + +.TP +.BI \-\-uid= " uid " +Specify the uid of the root (/) directory. If omitted, \fBmkudffs\fP uid is +\fI0\fP. Special value \fI-1\fP means invalid or not specified uid. +(Option available since mkudffs 1.1) + +.TP +.BI \-\-gid= " gid " +Specify the gid of the root (/) directory. If omitted, \fBmkudffs\fP gid is +\fI0\fP. Special value \fI-1\fP means invalid or not specified gid. +(Option available since mkudffs 1.1) + +.TP +.BI \-\-mode= " mode " +Specify permissions in octal mode bits of the root (/) directory. If omitted, +\fBmkudffs\fP mode is \fI0755\fP. (Option available since mkudffs 2.0) + +.TP +.BI \-\-bootarea= " fill " +Specify how to fill UDF boot area which is first 32kB of disk and is not used by +UDF itself. Option \fImbr\fP make sense only when running mkudffs on whole disk, +not on just one partition. Valid options are: +.RS 1.2i +.TP 1.6i +preserve +preserve existing UDF boot area, do not touch it (default for media type +different from hd) +.TP +erase +erase existing UDF boot area, fill it by zeros (default for hd media type on +partitions and on removable disks) +.TP +mbr +put MBR table with one partition which starts at sector 0 (includes MBR itself) +and spans whole disk device, needed only for non-removable hard disks used on +Microsoft Windows systems (default for hd media type on non-removable hard disk +without partitions), see section \fBWHOLE DISK VS PARTITION\fP +.RE + +.RS +(Option available since mkudffs 2.0) +.RE + +.TP +.BI \-\-strategy= " strategy " +Specify the allocation strategy to use. Valid strategies are 4 and 4096. If +omitted, \fBmkudffs\fP strategy is based on the \fB\-\-media\-type\fP. + +.TP +.BI \-\-spartable,\ \-\-spartable= " spartable\-number " +Enable usage Sparing Table. Optionally specify also the number of sparing +tables. Valid numbers are 1-4. When spartable\-number is omitted then two tables +are written to disc. If option is omitted then usage of Sparing Table depends on +media type. (Option prior to mkudffs 2.0 was available only for cdrw media type) + +.TP +.BI \-\-sparspace= " num\-of\-entires " +Specify the number of entries in Sparing Table. If omitted, default number of +entries is 1024, but depends on media type. (Option available since mkudffs 2.0) + +.TP +.BI \-\-packetlen= " length " +Packet length in number of blocks for Sparing Table. It specify also size of the +Sparing Space. If omitted, default value for DVD discs 16 blocks, otherwise 32. + +.TP +.B \-\-vat +Enable usage of Virtual Allocation Table (VAT). If omitted, usage depends on +media type. (Option available since mkudffs 2.0) + +.TP +.B \-\-closed +Close disc with Virtual Allocation Table. AVDP is written also to the end of +disc. By default disc with Virtual Allocation Table is not closed. + +.TP +.BI \-\-space= " space " +Specify the Space Set. \fIUnallocated\fP Space Set is used for media which +blocks may be allocated immediately. \fIFreed\fP Space Set is used for media +which blocks needs to be specially prepared/erased before allocation. In Space +\fITable\fP is stored list of unallocated extents. In Space \fIBitmap\fP is +stored bitmap of unallocated blocks. Not used for VAT. +.RS 1.2i +.TP 1.6i +freedbitmap +Freed Bitmap +.TP +freedtable +Freed Table +.TP +unallocbitmap +Unallocated Bitmap (default) +.TP +unalloctable +Unallocated Table +.RE + +.TP +.BI \-\-ad= " ad " +Specify the Allocation Descriptors of the root (/) directory. +.RS 1.2i +.TP 1.6i +inicb +Allocation Descriptors in ICB (default) +.TP +short +Short Allocation Descriptors +.TP +long +Long Allocation Descriptors +.RE + +.TP +.B \-\-noefe +Don't Use Extended File Entries for the root (/) directory. Affects only +UDF 2.00 or higher. Must be specified after \fB\-\-udfrev\fP. + +.TP +.B \-\-locale +Treat identifier string options as strings encoded according to current locale +settings (default). Must be specified as first argument. +(Option available since mkudffs 2.0) + +.TP +.B \-\-u8 +Treat identifier string options as strings encoded in 8-bit OSTA Compressed +Unicode format, equivalent to Latin1 (ISO-8859-1). Must be specified as first +argument. + +.TP +.B \-\-u16 +Treat identifier string options as strings encoded in 16-bit OSTA Compressed +Unicode format, equivalent to UCS-2BE. Note that it is not possible to include +zero byte in command line options, therefore any character which has at least +one zero byte cannot be supplied (this applies to all Latin1 characters). Must +be specified as first argument. + +.TP +.B \-\-utf8 +Treat identifier string options as strings encoded in UTF-8. Must be specified +as first argument. + +.SH COMPATIBILITY + +.SS "OPERATING SYSTEMS SUPPORT" +UDF filesystem is natively supported by large amount of operating systems. See +following compatibility table: + +.TS +box; +c s|c s +c|c|c|c +l|l|c|c. +Operating system Maximum UDF revision for +_ +Name Version read write += +Linux 2.3.17 - 2.4.5 2.00 2.00 +\^ 2.4.6 - 2.6.25 2.01 2.01 +\^ 2.6.26 (and new) 2.50 2.01 +_ +Windows 98/Me 1.02 none +\^ 2000 1.50 none +\^ XP 2.01 none +\^ Vista (and new) 2.60 2.50 +_ +Mac OS 8.1 - 8.5 1.02 none +\^ 8.6 - 9.2 1.50 1.50 +_ +Mac OS X 10.0 - 10.3 1.50 1.50 +\^ 10.4 2.01 2.01 +\^ 10.5 (and new) 2.60 2.50 +_ +FreeBSD 5 (and new) 1.50 none +_ +NetBSD 4.0 2.60 none +\^ 5.0 (and new) 2.60 2.60 +_ +OpenBSD 3.8 - 3.9 1.02 none +\^ 4.0 - 4.6 1.50 \^ +\^ 4.7 (and new) 2.60 \^ +_ +Solaris 7 (and new) 1.50 1.50 +_ +AIX 5.2 (and new) 2.01 2.01 +.TE + + +Note that Windows 98 and Windows Me can read UDF filesystem only from CD and DVD +optical discs, not from hard disks. + +.SS "BLOCK SIZE" +In most cases operating systems are unable to mount UDF filesystem if UDF block +size differs from logical sector size of device. Typically hard disks have +sector size 512 bytes and optical media 2048 bytes. Therefore UDF block size +must match logical sector size of device. + +Linux kernel prior to version 2.6.30 used hardcoded UDF block size of 2048 bytes +independently of logical sector size, therefore it was not able to automatically +mount UDF filesystem if block size differed from 2048. Since 2.6.30 and prior to +4.11 Linux kernel used logical sector size of device as UDF block size, plus it +tried fallback to 2048. Since 4.11 it uses logical sector size and fallbacks to +any valid block size between logical sector size and 4096. Therefore since +version 2.6.30 Linux kernel can automatically mount UDF filesystems correctly if +UDF block size matches device logical sector size and since version 4.11 can +automatically also mount devices which sector size does not match UDF block +size. In any case and also for Linux kernel prior to version 2.6.30, different +UDF block size (which is not autodetected) can be manually specified via +\fBbs\fP=\fIblocksize\fP mount parameter. + +.SS "WHOLE DISK VS PARTITION" +UDF filesystem is supposed to be formatted on the whole media and not to the +partitioned hard disk. Mac OS X systems enforce this rule and reject to +automatically mount UDF filesystem unless it is formatted on the whole +unpartitioned hard disk. Possible partition table (e.g. MBR or GPT) on disk with +valid UDF filesystem is ignored. On the other hand Microsoft Windows systems are +unable to detect non-removable hard disks without MBR or GPT partition table. +Removable disks do not have this restriction. Consequence is that non-removable +hard disks formatted to UDF by Windows Vista+ are not recognized by Mac OS X +systems and vice-versa. Note that manual mount of UDF partition on partitioned +hard disk on Mac OS X system is possible and working (e.g. by running commands +mkdir /Volumes/DriveName && mount_udf /dev/disk1s1 /Volumes/DriveName). But +there is no known way to mount unpartitioned non-removable disk on Windows +system. + +Thanks to reserved and unused UDF boot area (first 32kB of UDF filesystem) it is +possible to deal with this problem, by putting MBR on such non-removable hard +disk just for compatibility reasons with Windows. Such MBR table would contain +one partition which starts at sector 0 (includes MBR itself) and span whole disk +device. So the whole disk device and also first partition on disk points to same +sectors. Therefore UDF filesystem can be mounted either from whole disk device +(needed for Mac OS X systems) or from first partition (needed for Microsoft +Windows systems). + +Linux kernel ignores MBR table if contains partition which starts at sector 0. +Normally Linux kernel can detect and mount UDF filesystem either on partition or +on whole disk device. It does not have any restrictions. + +\fBmkudffs\fP option \fB\-\-bootarea\fP=\fImbr\fP put such MBR table for +compatibility with Microsoft Windows systems into disk when formatting. + +.SS "LINUX LABEL BUGS" +In most cases \fILogical Volume Identifier\fP is used as UDF label. But Linux +libblkid prior to version 2.26 used \fIVolume Identifier\fP. Therefore +\fBmkudffs\fP \fB\-\-label\fP for compatibility reasons set both \fILogical +Volume Identifier\fP and \fIVolume Identifier\fP. + +Linux libblkid prior to version 2.30 incorrectly processed non-ASCII identifier +strings encoded in 8-bit OSTA Compressed Unicode format. Therefore \fBmkudffs\fP +since version 2.0 for compatibility reasons tries to encode non-ASCII identifier +strings in 16-bit OSTA Compressed Unicode format and then fallbacks to 8-bit +format. + +For more information about UDF Label and UUID see \fBudflabel\fP(8) section +\fBUDF LABEL AND UUID\fP. + +.SH "EXIT STATUS" +\fBmkudffs\fP returns 0 if successful, non-zero if there are problems. + +.SH LIMITATIONS +\fBmkudffs\fP cannot create UDF 2.50 Metadata partition, therefore it does not +support UDF revisions higher then 2.01 for non Write Once media yet. So there +is no support for Blu\-ray discs which needs UDF 2.50 (except for Blu\-ray Disc +Recordable which does not require Metadata partition). + +.SH BUGS +\fBmkudffs\fP prior to version 1.1 was unable to process non-ASCII characters +from identifier strings in \fB\-\-utf8\fP mode, \fB\-\-vsid\fP option was +completely broken and \fB\-\-blocksize\fP must have been manually specified for +hard disks as default value was hardcoded for optical disks. \fBmkudffs\fP prior +to version 2.0 generated broken and unreadable cdr disc images. + +.SH AUTHOR +.nf +Ben Fennema <bfennema@falcon.csc.calpoly.edu> +Pali Rohár <pali.rohar@gmail.com> +.fi + +.SH AVAILABILITY +\fBmkudffs\fP is part of the udftools package and is available from +https://github.com/pali/udftools/. + +.SH SEE ALSO +\fBpktsetup\fP(8), \fBudflabel\fP(8), \fBcdrwtool\fP(1), \fBudfinfo\fP(1), +\fBwrudf\fP(1) diff --git a/doc/pktsetup.8 b/doc/pktsetup.8 new file mode 100644 index 0000000..cb5c0c3 --- /dev/null +++ b/doc/pktsetup.8 @@ -0,0 +1,100 @@ +.\" Copyright 2002 Paul Thompson <set@pobox.com> +.\" +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" The GNU General Public License's references to "object code" +.\" and "executables" are to be interpreted as the output of any +.\" document formatting or typesetting system, including +.\" intermediate and printed output. +.\" +.\" This manual is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public +.\" License along with this manual; if not, write to the Free +.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, +.\" USA. +.\" +.\" References consulted: +.\" losetup.8 +.\" udftools src +.\" +.TH PKTSETUP 8 "udftools" "System Management Commands" + +.SH NAME +pktsetup \- set up and tear down packet device associations + +.SH SYNOPSIS +.ad l +.B pktsetup +.I packet_device block_device +.br +.B pktsetup +.B \-d +.I packet_device +.br +.B pktsetup +.B \-s +.ad b +.SH DESCRIPTION +.B Pktsetup +is used to associate packet devices with CD or DVD block devices, +so that the packet device can then be mounted and potentially +used as a read/write filesystem. This requires kernel support for +the packet device, and the UDF filesystem. +.PP +See: HOWTO.udf (in the udftools documents directory) + +.SH EXIT STATUS +.B Pktsetup +returns 0 on success, nonzero on failure. + +.SH OPTIONS +.IP "\fB\-d \fIpacket-device\fP" +Delete the association between the specified \fIpacket-device\fP +and its block device. + +.IP "\fB\-s\fP" +Show the current device mapping, one device per line, in the format + \fIname\fP : \fIpktdevid\fP -> \fIblkdevid\fP +.br +(e.g. "0 : 253:0 -> 22:0") + +.SH EXAMPLE +The following commands provide an example of using the +packet device. +.nf +.IP +cdrwtool \-d /dev/sr0 \-q +pktsetup 0 /dev/sr0 + +mount \-t udf /dev/pktcdvd0 /mnt + ... +umount /dev/pktcdvd0 +pktsetup \-d 0 +.fi +.LP + +.SH FILES +.nf +/dev/pktcdvd0,/dev/pktcdvd1,... CD/DVD packet devices +.fi + +.SH AUTHOR +.nf +Jens Axboe <axboe@suse.de> +Some additions by Richard Atterer <atterer@debian.org> +.fi + +.SH AVAILABILITY +.B pktsetup +is part of the udftools package and is available from +https://github.com/pali/udftools/. + +.SH "SEE ALSO" +.BR cdrwtool (1) diff --git a/doc/udfinfo.1 b/doc/udfinfo.1 new file mode 100644 index 0000000..83d7920 --- /dev/null +++ b/doc/udfinfo.1 @@ -0,0 +1,204 @@ +'\" t -*- coding: UTF-8 -*- +.\" Copyright (C) 2017 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 +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" 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 + +.SH SYNOPSIS +.BI "udfinfo [ options ] " device + +.SH DESCRIPTION +\fBudfinfo\fP shows various information about a UDF filesystem stored either on +the block device or in the disk file image. The output from the \fBudfinfo\fP is +suitable for parsing by external applications or scripts. + +.SH OPTIONS +.TP +.B \-h,\-\-help +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. + +.TP +.BI \-\-vatblock= " vat\-block " +Specify the block location of the Virtual Allocation Table. Virtual Allocation +Table is present only on UDF disks with Virtual Partition Map and must be at the +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. + +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. + +.TP +.B \-\-locale +Encode UDF string identifiers on output according to current locale settings +(default). + +.TP +.B \-\-u8 +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 +format, equivalent to UCS-2BE. + +.TP +.B \-\-utf8 +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. + +.SH "OUTPUT FORMAT" +First part of the \fBudfinfo\fP standard output contains information in +\fIkey\fP=\fIvalue\fP format. List of all keys with their meaning are in the +following table: + +.RS +.TP 1.6i +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 +.TP +uuid +UUID are first 16 hexadecimal lowercase digits of \fIfullvsid\fP, but see +\fBudflabel\fP(8) section \fBUDF LABEL AND UUID\fP +.TP +lvid +UDF Logical Volume Identifier stored in UDF Logical Volume Descriptor +.TP +vid +UDF Volume Identifier stored in UDF Primary Volume Descriptor +.TP +vsid +\fIfullvsid\fP after \fIuuid\fP part, typically 17.-127. character +.TP +fsid +UDF File Set Identifier stored in UDF File Set Descriptor +.TP +fullvsid +UDF Volume Set Identifier stored in UDF Primary Volume Descriptor +.TP +winserialnum +Windows specific Volume Serial Number +.TP +blocksize +UDF block size +.TP +blocks +Number of all blocks on the selected block device or disk file image +.TP +usedblocks +Number of used space blocks on UDF disk for data storage +.TP +freeblocks +Number of free space blocks on UDF disk for data storage +.TP +behindblocks +Number of blocks which are behind the last block used by UDF disk +.TP +numfiles +Number of stored files on UDF disk +.TP +numdirs +Number of stored directories on UDF disk +.TP +udfrev +UDF revision needed for reading UDF disk +.TP +udfwriterev +UDF revision needed for writing or modifying UDF disk +.TP +vatblock +UDF block location of the Virtual Allocation Table (visible only when available) +.TP +integrity +UDF integrity of Logical Volume, one of: \fIopened\fP, \fIclosed\fP, +\fIunknown\fP +.TP +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. + +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, +\fB\-\-u16\fP and \fB\-\-utf8\fP controls how are identifiers encoded on output. + +All newline characters from the UDF string identifiers are removed, so it is +guaranteed that the newline character is present only as a separator. + +Second part of the \fBudfinfo\fP standard output contains list of UDF block +types stored on device, one per line in the following format: + +.RS +start=\fIblock\-num\fP, blocks=\fIblock\-count\fP, type=\fIblock\-type\fP +.RE + +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 +(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. + +.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. + +.SH AUTHOR +.nf +Pali Rohár <pali.rohar@gmail.com> +.fi + +.SH AVAILABILITY +\fBudfinfo\fP is part of the udftools package since version 2.0 and is available +from https://github.com/pali/udftools/. + +.SH "SEE ALSO" +\fBmkudffs\fP(8), \fBpktsetup\fP(8), \fBudflabel\fP(8), \fBcdrwtool\fP(1), +\fBwrudf\fP(1) diff --git a/doc/udflabel.8 b/doc/udflabel.8 new file mode 100644 index 0000000..81ec038 --- /dev/null +++ b/doc/udflabel.8 @@ -0,0 +1,202 @@ +'\" t -*- coding: UTF-8 -*- +.\" Copyright (C) 2017 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 +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" 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 UDFLABEL 8 "udftools" "Commands" + +.SH NAME +udflabel \- show or change UDF filesystem label + +.SH SYNOPSIS +.BI "udflabel [encoding-options] [block-options] [identifier-options] " device " [" new-label "]" + +.SH DESCRIPTION +When \fBudflabel\fP is invoked without \fBidentifier-options\fP and without +specifying \fInew-label\fP then it show current label of UDF filesystem on +\fIdevice\fP to standard output terminated by new line. Otherwise it update +UDF filesystem (up to the revision 2.60) on \fIdevice\fP with new specified +identifiers from \fBidentifier-options\fP. Specifying \fInew-label\fP is synonym +for both \fI\-\-lvid\fP and \fI\-\-vid\fP, see section \fBUDF LABEL AND UUID\fP. + +.SH OPTIONS + +.SS "GENERAL OPTIONS" +.TP +.B \-h,\-\-help +Display the usage and the list of options. + +.SS "BLOCK 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, \fBudflabel\fP tries to autodetect block size. It tries logical +(sector) size and then all valid block sizes. + +.TP +.BI \-\-vatblock= " vat\-block " +Specify the block location of the Virtual Allocation Table. Virtual Allocation +Table is present only on UDF disks with Virtual Partition Map and must be at the +last written/recorded disk block. + +If omitted, \fBudflabel\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. + +Virtual Allocation Table on disks with UDF revisions higher then 1.50 contains +Logical Volume Identifier (UDF Label). + +.TP +.B \-\-force +Force updating UDF disks without write support. Some media, like CD-ROM, DVD-ROM +or BD-ROM are read-only. Other media, like CD-RW or DVD-RW are write-once. UDF +is designed also for such media where updating Label or Identifiers is not +possible. But in some rare cases it could make sense to try overwrite existing +Label or Identifiers also for UDF filesystem which has Access Type either +Read-Only or Recordable (Write-Once). This is possible only if underlaying media +supports overwriting. E.g. UDF image of CD-ROM stored on hard disk or Read-Only +UDF image burned to DVD-RAM or BD-RE discs. Option \fI\-\-force\fP ignores UDF +Access Type and treat it as Overwritable. + +.TP +.B \-n,\-\-no-write +Not really, do not write to \fIdevice\fP. Just simulate and display what would +happen with \fIdevice\fP. Useful for determining which UDF blocks would be +overwritten. + +.SS "IDENTIFIER OPTIONS" +.TP +.BI \-u,\-\-uuid= " uuid " +Specify the UDF uuid. Must be exactly 16 hexadecimal lowercase digits and is +used for first 16 characters of \fB\-\-fullvsid\fP option. Special value +\fBrandom\fP generates new uuid from local time and random number. See section +\fBUDF LABEL AND UUID\fP. + +.TP +.BI \-\-lvid= " new\-logical\-volume\-identifier " +Specify the new Logical Volume Identifier. + +.TP +.BI \-\-vid= " new\-volume\-identifier " +Specify the new Volume Identifier. + +.TP +.BI \-\-vsid= " new\-volume\-set\-identifier " +Specify the new 17.-127. character of Volume Set Identifier. See section +\fBUDF LABEL AND UUID\fP. + +.TP +.BI \-\-fsid= " new\-file\-set\-identifier " +Specify the new File Set Identifier. + +.TP +.BI \-\-fullvsid= " new\-full\-volume\-set\-identifier " +Specify the new Volume Set identifier. Overwrite previous \fB\-\-uuid\fP and +\fB\-\-vsid\fP options. See section \fBUDF LABEL AND UUID\fP. + +.SS ENCODING OPTIONS +.TP +.B \-\-locale +Treat identifier string options as strings encoded according to current locale +settings (default). Must be specified as first argument. + +.TP +.B \-\-u8 +Treat identifier string options as strings encoded in 8-bit OSTA Compressed +Unicode format, equivalent to Latin1 (ISO-8859-1). Must be specified as first +argument. + +.TP +.B \-\-u16 +Treat identifier string options as strings encoded in 16-bit OSTA Compressed +Unicode format, equivalent to UCS-2BE. Note that it is not possible to include +zero byte in command line options, therefore any character which has at least +one zero byte cannot be supplied (this applies to all Latin1 characters). Must +be specified as first argument. + +.TP +.B \-\-utf8 +Treat identifier string options as strings encoded in UTF-8. Must be specified +as first argument. + +.SH "UDF LABEL AND UUID" +UDF specification does not say anything about a disk label but describe that UDF +Logical Volume Identifier is extremely important field for media identification +in a jukebox as that field is displayed to the user. And based on this statement +it is a common practice for majority of UDF implementations to use UDF Logical +Volume Identifier as a UDF disk label. + +UDF specification does not have concept of disk UUID like other filesystems. But +mandates that the first 16 characters of UDF Volume Set Identifier are unique, +a non-fixed and a non-trivial value. Plus first eight characters are hexadecimal +digits. Windows application format.exe and Mac OS X application newfs_udf are +known to violates this requirement and set only the first 8 characters as unique +(others are fixed). Because there are still lot of UDF implementations which use +in the first 16 characters only hexadecimal digits and all compliant UDF +implementations have hexadecimal digits in the first 8 characters, the following +algorithm for generating stable UUID was informally chosen and now is used by +udftools, util-linux, grub2 and other projects: + +.RS +0. If Volume Set Identifier has less then 8 characters then stop with empty UUID +.br +1. Take the first 16 bytes from UTF-8 encoded string of Volume Set Identifier +.br +2. If all bytes are hexadecimal digits then use their lowercase form as UUID +.br +3. If first 8 bytes are not all hexadecimal digits then convert those 8 bytes to +their hexadecimal representation (resulting in 16 bytes) and use as UUID +.br +4. Otherwise, compose UUID from two 8 byte parts: +.RS +1. part: Use lowercase form of the first 8 bytes (which are hexadecimal digits) +.br +2. part: Convert next 4 bytes (9.-12. pos.) to their hexadecimal representation +.RE +.RE + +Which means that this generated UUID has always 16 hexadecimal lowercase digits. +In most cases this UUID matches case-insensitively the first 16 characters of +UDF Volume Set Identifier and for all disks compliant to the UDF specification +the first 8 bytes of UUID matches case-insensitively the first 8 characters of +UDF Volume Set Identifier. In that algorithm was chosen UTF-8 encoding because +it is the only commonly used Unicode transformation to bytes with fixed points +in all hexadecimal digits. + +.SH "EXIT STATUS" +\fBudflabel\fP returns 0 if successful, non-zero if there are problems like block +device does not contain UDF filesystem or updating failed. + +.SH LIMITATIONS +\fBudflabel\fP is not able to set new Label, Logical Volume Identifier and File +Set Identifier for disks with Metadata Partition (used by UDF revisions higher +then 2.01) or Virtual Allocation Table (used by Write Once media). Also is not +able to read Label correctly if disk has Virtual Allocation Table stored outside +of Information Control Block. + +.SH AUTHOR +.nf +Pali Rohár <pali.rohar@gmail.com> +.fi + +.SH AVAILABILITY +\fBudflabel\fP is part of the udftools package since version 2.0 and is available +from https://github.com/pali/udftools/. + +.SH "SEE ALSO" +\fBmkudffs\fP(8), \fBpktsetup\fP(8), \fBcdrwtool\fP(1), \fBudfinfo\fP(1), +\fBwrudf\fP(1) diff --git a/doc/wrudf.1 b/doc/wrudf.1 new file mode 100644 index 0000000..6de99ca --- /dev/null +++ b/doc/wrudf.1 @@ -0,0 +1,60 @@ +.\" Text automatically generated by txt2man +.TH wrudf 1 "udftools" "Linux Reference Manual" +.SH NAME +\fBwrudf \fP- Maintain an UDF filesystem. +.SH SYNOPSIS +.nf +.fam C +\fBwrudf\fP \fIdevice\fP +\fBwrudf\fP \fB--help\fP | \fB-help\fP | \fB-h\fP +.fam T +.fi +.fam T +.fi +.SH DESCRIPTION +\fBwrudf\fP provides an interactive shell with operations on existing UDF filesystem: cp, rm, mkdir, rmdir, ls, cd. +.SS COMMANDS +.TP +.B +cp +copy +.TP +.B +rm +remove +.TP +.B +mkdir +make directory +.TP +.B +rmdir +remove directory +.TP +.B +lsc +list files (Compact disc version) +.TP +.B +lsh +list files (Hard disc version) +.TP +.B +cdc +change working directory (Compact disc) +.TP +.B +cdh +change working directory (Hard disc) +.TP +.B +quit +quit \fBwrudf\fP +.TP +.B +exit +quit \fBwrudf\fP +.SH AVAILABILITY +\fBwrudf\fP is part of the udftools package and is available from https://github.com/pali/udftools/. +.SH SEE ALSO +\fBcdrwtool\fP(1), \fBmkudffs\fP(8), \fBpktsetup\fP(8) |