Some polishing of xorriso documentation
This commit is contained in:
parent
f3c4f142c2
commit
9a85568c29
15
test/README
15
test/README
@ -21,8 +21,8 @@ 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
|
formatter program nor an external burn program for CD or DVD but rather
|
||||||
incorporates the libraries of libburnia-project.org .
|
incorporates the libraries of libburnia-project.org .
|
||||||
|
|
||||||
By using this software you agree to the disclaimer at the end of this text
|
By using this software you agree to the disclaimer at the end of this text:
|
||||||
"This software is provided as is. There is no warranty implied and ..."
|
"... without even the implied warranty ..."
|
||||||
|
|
||||||
|
|
||||||
Compilation, First Glimpse, Installation
|
Compilation, First Glimpse, Installation
|
||||||
@ -31,8 +31,8 @@ The most simple way to get xorriso is the xorriso standalone tarball.
|
|||||||
|
|
||||||
Prerequisites:
|
Prerequisites:
|
||||||
The tarball contains anything that is needed except libc and libpthread.
|
The tarball contains anything that is needed except libc and libpthread.
|
||||||
libreadline and the libreadline-development headers will make dialog mode
|
libreadline and the libreadline-dev headers will make dialog mode
|
||||||
more convenient but are not mandatory.
|
more convenient, but are not mandatory.
|
||||||
|
|
||||||
Obtain xorriso-0.1.0.tar.gz, take it to a directory of your choice and do:
|
Obtain xorriso-0.1.0.tar.gz, take it to a directory of your choice and do:
|
||||||
|
|
||||||
@ -60,12 +60,13 @@ For general concepts, options and usage examples see
|
|||||||
|
|
||||||
This man page is part of the tarball as
|
This man page is part of the tarball as
|
||||||
xorriso/xorriso.1
|
xorriso/xorriso.1
|
||||||
It gets installed with "make install" but may also be place manually in the
|
|
||||||
./man1 directory below one of the the directories mentioned in environment
|
|
||||||
variable $MANPATH.
|
|
||||||
You may get a first glimpse by
|
You may get a first glimpse by
|
||||||
man ./xorriso/xorriso.1
|
man ./xorriso/xorriso.1
|
||||||
|
|
||||||
|
It gets installed with "make install" but may also be placed manually in the
|
||||||
|
./man1 directory below one of the directories mentioned in environment
|
||||||
|
variable $MANPATH.
|
||||||
|
|
||||||
|
|
||||||
Drives and Disk File Objects
|
Drives and Disk File Objects
|
||||||
|
|
||||||
|
@ -108,7 +108,7 @@ Adding a session to an existing ISO image is in this text referred as
|
|||||||
The multi-session model of the MMC standard does not apply to all media
|
The multi-session model of the MMC standard does not apply to all media
|
||||||
types. But program growisofs by Andy Polyakov showed how to extend this
|
types. But program growisofs by Andy Polyakov showed how to extend this
|
||||||
functionality to overwriteable media or disk files which carry valid ISO 9660
|
functionality to overwriteable media or disk files which carry valid ISO 9660
|
||||||
filesystems. This expansion method is referred as as emulated growing.
|
filesystems. This expansion method is referred as emulated growing.
|
||||||
.PP
|
.PP
|
||||||
xorriso provides both ways of growing as well as an own method named
|
xorriso provides both ways of growing as well as an own method named
|
||||||
\fBmodifying\fR which produces a completely new ISO image from the old
|
\fBmodifying\fR which produces a completely new ISO image from the old
|
||||||
@ -466,6 +466,8 @@ Setting "on" enables it for all those commands.
|
|||||||
.br
|
.br
|
||||||
Setting "ls" enables it only for those which are marked by
|
Setting "ls" enables it only for those which are marked by
|
||||||
"disk_pattern [***]".
|
"disk_pattern [***]".
|
||||||
|
.br
|
||||||
|
Default is "ls".
|
||||||
.TP
|
.TP
|
||||||
\fB\-add\fR pathspec [...] | disk_path [***]
|
\fB\-add\fR pathspec [...] | disk_path [***]
|
||||||
Insert the given files or directory trees from filesystem
|
Insert the given files or directory trees from filesystem
|
||||||
@ -624,7 +626,7 @@ may have specific parameters. See also their particular descriptions.
|
|||||||
"chgrp" and "chgrp_r" change the group attribute and get the group id as param.
|
"chgrp" and "chgrp_r" change the group attribute and get the group id as param.
|
||||||
E.g.:
|
E.g.:
|
||||||
.br
|
.br
|
||||||
-find / name 'news*' -type d --exec chgrp_r staff
|
-find / name 'news*' -type d -exec chgrp_r staff
|
||||||
.br
|
.br
|
||||||
"chmod" and "chmod_r" change access permissions and get a mode string as param.
|
"chmod" and "chmod_r" change access permissions and get a mode string as param.
|
||||||
E.g.:
|
E.g.:
|
||||||
@ -676,7 +678,7 @@ Switch from eventual modifiying mode to growing mode.
|
|||||||
(A subsequent -outdev will activate modification mode.)
|
(A subsequent -outdev will activate modification mode.)
|
||||||
-commit is performed automatically at end of program if there
|
-commit is performed automatically at end of program if there
|
||||||
are uncommitted manipulations pending.
|
are uncommitted manipulations pending.
|
||||||
So to perform a final write operation with no new -dev
|
So, to perform a final write operation with no new -dev
|
||||||
and no new loading of image, rather execute option -end.
|
and no new loading of image, rather execute option -end.
|
||||||
To suppress a final write, execute -rollback -end.
|
To suppress a final write, execute -rollback -end.
|
||||||
.br
|
.br
|
||||||
@ -688,7 +690,7 @@ minutes after all data have been transmitted.
|
|||||||
xorriso and the drives are in a client-server relationship.
|
xorriso and the drives are in a client-server relationship.
|
||||||
The drives have much freedom about what to do with the media.
|
The drives have much freedom about what to do with the media.
|
||||||
Some combinations of drives and media simply do not work,
|
Some combinations of drives and media simply do not work,
|
||||||
despite the promises by vendors of drives and media.
|
despite the promises by their vendors.
|
||||||
If writing fails - or even the drive gets stuck and you need
|
If writing fails - or even the drive gets stuck and you need
|
||||||
to reboot - then try other media or another drive. The reason
|
to reboot - then try other media or another drive. The reason
|
||||||
for such failure is hardly ever in the code of the various
|
for such failure is hardly ever in the code of the various
|
||||||
@ -849,7 +851,7 @@ Set the burn speed. Default is 0 = maximum speed.
|
|||||||
Speed can be given in media dependent numbers or as a
|
Speed can be given in media dependent numbers or as a
|
||||||
desired throughput per second in MMC compliant kB (= 1000)
|
desired throughput per second in MMC compliant kB (= 1000)
|
||||||
or MB (= 1000 kB). Media x-speed factor can be set explicity
|
or MB (= 1000 kB). Media x-speed factor can be set explicity
|
||||||
by "c" for CD and "d" for "DVD". Example speeds:
|
by "c" for CD and "d" for DVD. Example speeds:
|
||||||
.br
|
.br
|
||||||
706k = 706kB/s = 4c = 4xCD
|
706k = 706kB/s = 4c = 4xCD
|
||||||
.br
|
.br
|
||||||
@ -1047,15 +1049,15 @@ Recursively list size of directories and files in the ISO image
|
|||||||
which match one of the patterns.
|
which match one of the patterns.
|
||||||
similar to shell command du -k.
|
similar to shell command du -k.
|
||||||
.TP
|
.TP
|
||||||
\fB\-dux\fR disk_pattern [***]
|
|
||||||
Recursively list size of directories and files in the local filesystem
|
|
||||||
which match one of the patterns, similar to shell command du -k.
|
|
||||||
.TP
|
|
||||||
\fB\-dus\fR iso_rr_pattern [***]
|
\fB\-dus\fR iso_rr_pattern [***]
|
||||||
List size of directories and files in the ISO image
|
List size of directories and files in the ISO image
|
||||||
which match one of the patterns.
|
which match one of the patterns.
|
||||||
Similar to shell command du -sk.
|
Similar to shell command du -sk.
|
||||||
.TP
|
.TP
|
||||||
|
\fB\-dux\fR disk_pattern [***]
|
||||||
|
Recursively list size of directories and files in the local filesystem
|
||||||
|
which match one of the patterns, similar to shell command du -k.
|
||||||
|
.TP
|
||||||
\fB\-dusx\fR disk_pattern [***]
|
\fB\-dusx\fR disk_pattern [***]
|
||||||
List size of directories and files in the local filesystem
|
List size of directories and files in the local filesystem
|
||||||
which match one of the patterns.
|
which match one of the patterns.
|
||||||
|
@ -124,7 +124,7 @@ Provides navigation commands for interactive ISO image manipulation.
|
|||||||
</P>
|
</P>
|
||||||
|
|
||||||
<P>
|
<P>
|
||||||
<H2>Commands:</H2>
|
<H2>Command Examples:</H2>
|
||||||
<DL>
|
<DL>
|
||||||
<DT>Get an overview of drives and their addresses</DT>
|
<DT>Get an overview of drives and their addresses</DT>
|
||||||
<DD>#<KBD> xorriso -devices</KBD></DD>
|
<DD>#<KBD> xorriso -devices</KBD></DD>
|
||||||
@ -173,7 +173,7 @@ write it to media, eject media.
|
|||||||
<DD><KBD> -rm_r /sounds/indecent '/pictures/*private*' -- \</KBD></DD>
|
<DD><KBD> -rm_r /sounds/indecent '/pictures/*private*' -- \</KBD></DD>
|
||||||
<DD><KBD> -add /pictures/private/horses=/home/me/pictures/private/horses -- \</KBD></DD>
|
<DD><KBD> -add /pictures/private/horses=/home/me/pictures/private/horses -- \</KBD></DD>
|
||||||
<DD><KBD> -chmod_r a+r,a-w / -- \</KBD></DD>
|
<DD><KBD> -chmod_r a+r,a-w / -- \</KBD></DD>
|
||||||
<DD><KBD> -find / -type d -exec chmod a+x \</KBD></DD>
|
<DD><KBD> -find / -type d -exec chmod a+x -- \</KBD></DD>
|
||||||
<DD><KBD> -volid SOUNDS_PICS_2008_01_16 \</KBD></DD>
|
<DD><KBD> -volid SOUNDS_PICS_2008_01_16 \</KBD></DD>
|
||||||
<DD><KBD> -commit -eject all</KBD></DD>
|
<DD><KBD> -commit -eject all</KBD></DD>
|
||||||
|
|
||||||
@ -216,6 +216,23 @@ Important: -indev and -outdev have to be different drives.
|
|||||||
<HR>
|
<HR>
|
||||||
</DT>
|
</DT>
|
||||||
|
|
||||||
|
<DT>Dialog mode accepts one or more options per line. An option and all its
|
||||||
|
arguments have to be given in one single line. Command -end stops a program
|
||||||
|
run. It would write eventually pending changes to media, if that had not
|
||||||
|
already been done by -commit.</DT>
|
||||||
|
<DD>$<KBD> xorriso -dialog on</KBD></DD>
|
||||||
|
<DD><KBD>enter option and arguments :</KBD></DD>
|
||||||
|
<DD><KBD><B>-dev /dev/sr0 -pathspecs on</B></KBD></DD>
|
||||||
|
<DD><KBD>enter option and arguments :</KBD></DD>
|
||||||
|
<DD><KBD><B>-add /sounds=/home/me/prepared_for_dvd/sounds_dummy /movies=/home/me/prepared_for_dvd/movies</B></KBD></DD>
|
||||||
|
<DD>Available navigation commands: -cd, -ls, -du, -find</DD>
|
||||||
|
<DD><KBD>enter option and arguments :</KBD></DD>
|
||||||
|
<DD><KBD><B>-commit -eject all -end</B></KBD></DD>
|
||||||
|
|
||||||
|
<DT>
|
||||||
|
<HR>
|
||||||
|
</DT>
|
||||||
|
|
||||||
<DT>Get overview of the options:</DT>
|
<DT>Get overview of the options:</DT>
|
||||||
<DD>$<KBD> <A HREF="xorriso_help">xorriso -help</A></KBD></DD>
|
<DD>$<KBD> <A HREF="xorriso_help">xorriso -help</A></KBD></DD>
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user