From 8cb8c11ede227b8c3709751731d4363424c9c9d5 Mon Sep 17 00:00:00 2001
From: Thomas Schmitt
Date: Tue, 18 Nov 2008 22:46:39 +0000
Subject: [PATCH] Mentioned FreeBSD peculiarities in our docs
---
libisoburn/trunk/README | 3 ++-
libisoburn/trunk/xorriso/README | 3 ++-
libisoburn/trunk/xorriso/xorriso.1 | 33 ++++++++++++++---------
libisoburn/trunk/xorriso/xorriso_eng.html | 8 +++++-
4 files changed, 31 insertions(+), 16 deletions(-)
diff --git a/libisoburn/trunk/README b/libisoburn/trunk/README
index e062e582..0bc1ee6e 100644
--- a/libisoburn/trunk/README
+++ b/libisoburn/trunk/README
@@ -18,7 +18,8 @@ The price for that is thorough specialization on data files in ISO-9660
filesystem images. So libisoburn is not suitable for audio (CD-DA) or any
other CD layout which does not entirely consist of ISO-9660 sessions.
-Currently it is only supported on Linux with kernels >= 2.4.
+Currently it is supported on Linux with kernels >= 2.4 and on FreeBSD versions
+with ATAPI/CAM support enabled in the kernel, see atapicam(4).
By using this software you agree to the disclaimer at the end of this text:
"... without even the implied warranty ..."
diff --git a/libisoburn/trunk/xorriso/README b/libisoburn/trunk/xorriso/README
index 7e599b52..48185887 100644
--- a/libisoburn/trunk/xorriso/README
+++ b/libisoburn/trunk/xorriso/README
@@ -16,7 +16,8 @@ information of existing ISO images and it writes the session results to
optical media or to filesystem objects.
Vice versa xorriso is able to restore file objects from ISO 9660 filesystems.
-Currently it is only supported on Linux with kernels >= 2.4.
+Currently it is supported on Linux with kernels >= 2.4 and on FreeBSD versions
+with ATAPI/CAM support enabled in the kernel, see atapicam(4).
A special property of xorriso is that it needs neither an external ISO 9660
formatter program nor an external burn program for CD or DVD but rather
diff --git a/libisoburn/trunk/xorriso/xorriso.1 b/libisoburn/trunk/xorriso/xorriso.1
index b1f0af29..5da17141 100644
--- a/libisoburn/trunk/xorriso/xorriso.1
+++ b/libisoburn/trunk/xorriso/xorriso.1
@@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
-.TH XORRISO 1 "Nov 13, 2008"
+.TH XORRISO 1 "Nov 17, 2008"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@@ -100,7 +100,8 @@ The data content of the session is called filesystem
The written image in its session can then be mounted by the operating system
for being used read-only. Linux is able to mount ISO images from block devices,
which may represent optical media, other media or via a loop device even
-from regular disk files.
+from regular disk files. FreeBSD mounts ISO images from devices that represent
+arbitrary media or from regular disk files.
.PP
This session usage model has been extended on CD media by the concept of
.B multi-session ,
@@ -258,8 +259,6 @@ program is desired. -C $msc1,$msc2 is equivalent to:
Input drive, i.e. source of an existing or empty ISO image, can be any random
access readable libburn drive: optical media with readable data,
blank optical media, regular files, block devices.
-.br
-Rock Ridge info will be generated by the program unconditionally.
.PP
Output drive, i.e. target for writing, can be any libburn drive.
Some drive types do not support the method of growing but only the methods
@@ -277,6 +276,12 @@ the path of their block device or of their generic character device. E.g.
.br
-dev /dev/sg2
.br
+On FreeBSD the device files have names like
+.br
+ -dev /dev/cd0
+.br
+ -dev /dev/acd0
+.br
Get a list of accessible drives by command
.br
-devices
@@ -367,10 +372,10 @@ The MBR of a follow-up session can get in effect only on overwriteable media.
Commands are either actions or settings. They consist of a command word,
followed by zero or more parameter words. If the list of parameter words
is of variable length (indicated by "[...]" or "[***]") then it has to be
-terminated by either the list delimiter, or the end of argument list, or an
-end of an input line.
+terminated by either the \fBlist delimiter\fR, or the end of argument list,
+or an end of an input line.
.PP
-At program start the \fBlist delimiter\fR is the word "--". This may be changed
+At program start the list delimiter is the word "--". This may be changed
by option -list_delimiter in order to allow "--" as argument in a list of
variable length. It is advised to reset the delimiter to "--" immediately
afterwards.
@@ -2356,8 +2361,8 @@ This transport becomes visible with -report_about "ALL".
\fB\-session_log\fR path
If path is not empty it gives the address of a plain text file where
a log record gets appended after each session. This log can be used to
-determine the start_lba of a session for mount option sbsector= from
-date or volume id.
+determine the start_lba of a session for mount options -o sbsector=
+resp. -s from date or volume id.
.br
Record format is: timestamp start_lba size volume-id
.br
@@ -2743,9 +2748,10 @@ This makes sense if the full backup leaves substantial remaining capacity
on media and if the expected changes are much smaller than the full backup.
An update run will probably save no time but last longer than a full backup.
.br
-With \fBmount\fR option \fB"sbsector="\fR it is possible to access the session
-trees which represent the older backup versions. With CD media, Linux mount
-accepts session numbers directly by its option "session=".
+With \fBmount\fR option -o \fB"sbsector="\fR on Linux resp. \fB-s\fR on FreeBSD
+it is possible to access the session trees which represent the older backup
+versions. With CD media, Linux mount accepts session numbers directly by
+its option "session=".
.br
Multi-session media and most overwriteable media written by xorriso can tell
the sbsectors of their sessions by xorriso option -toc.
@@ -2799,7 +2805,8 @@ Avoid to eventually create /home/thomas/restored without rwx-permission.
.br
This can be repeated several times, eventually with -eject or with other
-indev drives. See the human readable part of "$HOME"/dvd_copy.map for
-addresses which can be used on "$HOME"/dvd_copy with mount option sbsector=.
+addresses which can be used on "$HOME"/dvd_copy with mount option -o sbsector=
+resp. -s.
.br
If you want to make the newest session the default mount session, you
may add option "patch_lba0=on" to the final -check_media run.
diff --git a/libisoburn/trunk/xorriso/xorriso_eng.html b/libisoburn/trunk/xorriso/xorriso_eng.html
index 96a5aceb..3483db64 100644
--- a/libisoburn/trunk/xorriso/xorriso_eng.html
+++ b/libisoburn/trunk/xorriso/xorriso_eng.html
@@ -48,6 +48,10 @@ and to MMC-5 for DVD or BD).
Linux with kernel 2.4 or higher (and libc, of course) :
With kernel 2.4 an ATA drive has to be under ide-scsi emulation.
With kernel 2.6 the drive should not be under ide-scsi.
+
libpthread
is supposed to be a standard system component.
libreadline and libreadline-dev
@@ -79,7 +83,9 @@ cdrecord and mkisofs.
-This program system has been tested on Intel/AMD Linux systems only.
+This program has been tested on Intel/AMD Linux
+
+only.
For ports to other usable systems contact us.