Corrections in xorriso manual. Proposed by Paul Menzel.

This commit is contained in:
2012-11-05 09:37:47 +00:00
parent b0f8246ff2
commit 7353d3534e
3 changed files with 226 additions and 215 deletions

View File

@ -102,7 +102,7 @@ with Rock Ridge extensions.
* Extras:: Rock Ridge, POSIX, X/Open, El Torito, ACL, xattr
* Processing:: Command processing
* Dialog:: Dialog, Readline, Result pager
* Options:: Reference of commands
* Commands:: Reference of commands
* Examples:: Examples
* Files:: Files
* Seealso:: See also
@ -696,7 +696,7 @@ The program ends either by command -end, or by the end of program arguments
if dialog mode has not been enabled at that point, or by a problem
event which triggers the threshold of command -abort_on.
@c man .SS
@node Dialog, Options, Processing, top
@node Dialog, Commands, Processing, top
@chapter Dialog, Readline, Result pager
@c man .B Dialog, Readline, Result pager:
@c man .br
@ -742,8 +742,8 @@ Some actions apply paging to their info output, too.
@*
The request to abort may or may not be obeyed by the current action.
All actions try to abort as soon as possible.
@node Options, Examples, Dialog, top
@chapter Options
@node Commands, Examples, Dialog, top
@chapter Commands
@c man .br
@c man .SH OPTIONS
@c man .br
@ -778,7 +778,7 @@ inner dashes are interpreted as underscores.
* Frontend:: Support for frontend programs via stdin and stdout
@end menu
@c man .TP
@node ArgSort, AqDrive, Options, Options
@node ArgSort, AqDrive, Commands, Commands
@section Execution order of program arguments
@c man .B Execution order of program arguments:
@c man .PP
@ -820,7 +820,7 @@ well make sense, though.
@end table
@c man .PP
@c man .TP
@node AqDrive, Loading, ArgSort, Options
@node AqDrive, Loading, ArgSort, Commands
@section Acquiring source and target drive
@c man .B Acquiring source and target drive:
@c man .PP
@ -896,7 +896,7 @@ begins. The output drive is given up when writing is done.
@end table
@c man .TP
@c man .B Influencing the behavior of image loading:
@node Loading, Insert, AqDrive, Options
@node Loading, Insert, AqDrive, Commands
@section Influencing the behavior of image loading
@c man .PP
The following commands should normally be performed before loading an image
@ -995,8 +995,8 @@ have to deny its rw-permissions in the filesystem.
@c man .TP
@item -assert_volid pattern severity
@kindex -assert_volid rejects undesired images
@cindex Image, demand volume id, -assert_volid
Refuse to load ISO images with volume ids which do not match the given
@cindex Image, demand volume ID, -assert_volid
Refuse to load ISO images with volume IDs which do not match the given
search pattern. When refusing an image, give up the input drive and issue
an event of the given severity (like FAILURE, see -abort_on). An empty search
pattern accepts any image.
@ -1235,7 +1235,7 @@ Currently the default is 32 tiles of 32 blocks = 2 MiB.
@end table
@c man .TP
@c man .B Inserting files into ISO image:
@node Insert, SetInsert, Loading, Options
@node Insert, SetInsert, Loading, Commands
@section Inserting files into ISO image
@c man .PP
The following commands expect file addresses of two kinds:
@ -1502,7 +1502,7 @@ parameters.
@end table
@c man .TP
@c man .B Settings for file insertion:
@node SetInsert, Manip, Insert, Options
@node SetInsert, Manip, Insert, Commands
@section Settings for file insertion
@c man .TP
@table @asis
@ -1725,7 +1725,7 @@ parameter and their contents may not overlap.
@end table
@c man .TP
@c man .B File manipulations:
@node Manip, CmdFind, SetInsert, Options
@node Manip, CmdFind, SetInsert, Commands
@section File manipulations
@c man .PP
The following commands manipulate files in the ISO image, regardless whether
@ -1992,7 +1992,7 @@ Rather use: -boot_image "any" "cat_hidden=on"
@end table
@c man .TP
@c man .B Tree traversal command -find:
@node CmdFind, Filter, Manip, Options
@node CmdFind, Filter, Manip, Commands
@section Tree traversal command -find
@c man .PP
@table @asis
@ -2387,7 +2387,7 @@ E.g.:
@c man .TP
@c man .B Filters for data file content:
@c man .PP
@node Filter, Writing, CmdFind, Options
@node Filter, Writing, CmdFind, Commands
@section Filters for data file content
@cindex Filter, _definition
@strong{Filters} may be installed between data files in the ISO image and their
@ -2505,7 +2505,7 @@ Like -set_filter but affecting all data files below eventual directories.
@end table
@c man .TP
@c man .B Writing the result, drive control:
@node Writing, SetWrite, Filter, Options
@node Writing, SetWrite, Filter, Commands
@section Writing the result, drive control
@c man .PP
(see also paragraph about settings below)
@ -2730,7 +2730,7 @@ The currently recognized type is marked by text "(current)".
@end table
@c man .TP
@c man .B Settings for result writing:
@node SetWrite, Bootable, Writing, Options
@node SetWrite, Bootable, Writing, Commands
@section Settings for result writing
@c man .PP
Rock Ridge info will be generated by default.
@ -2924,20 +2924,25 @@ The name must not contain a '/' character and must not be longer than
@item -volid text
@kindex -volid sets volume id
@cindex Image, set volume id, -volid
Specify the volume ID. @command{xorriso} accepts any text up to 32 characters,
Specify the volume ID, which can be considered to be the name of the image.
@command{xorriso} accepts any text up to 32 characters,
but according to rarely obeyed specs stricter rules apply:
@*
ECMA-119 demands ASCII characters out of [A-Z0-9_]. Like: "IMAGE_23"
ECMA-119 demands ASCII characters out of [A-Z0-9_]. Like:
@*
Joliet allows 16 UCS-2 characters. Like: "Windows name"
"IMAGE_23"
@*
Be aware that the volume id might get used automatically as name of the
Joliet allows 16 UCS-2 characters. Like:
@*
"Windows name"
@*
Be aware that the volume id might get used automatically as the name of the
mount point when the medium is inserted into a playful computer system.
@*
If an ISO image gets loaded while the volume ID is set to default "ISOIMAGE"
or to "", then the volume ID of the loaded image will become the effective
volume id for the next write run. But as soon as command -volid is performed
afterwards, this pending id is overridden by the new setting.
afterwards, this pending ID is overridden by the new setting.
@*
Consider this when setting -volid "ISOIMAGE" before executing -dev, -indev,
or -rollback.
@ -2946,14 +2951,14 @@ If you insist in -volid "ISOIMAGE", set it again after those commands.
@item -volset_id text
@kindex -volset_id sets volume set id
@cindex Image, set volume set id, -volset_id
Set the volume set id string to be written with the next -commit.
Set the volume set ID string to be written with the next -commit.
Permissible are up to 128 characters. This setting gets overridden by
image loading.
@c man .TP
@item -publisher text
@kindex -publisher sets publisher id
@cindex Image, set publisher id, -publisher
Set the publisher id string to be written with the next -commit. This may
Set the publisher ID string to be written with the next -commit. This may
identify the person or organisation who specified what shall be recorded.
Permissible are up to 128 characters. This setting gets overridden by
image loading.
@ -2961,20 +2966,20 @@ image loading.
@item -application_id text
@kindex -application_id sets application id
@cindex Image, set application id, -application_id
Set the application id string to be written with the next -commit. This may
Set the application ID string to be written with the next -commit. This may
identify the specification of how the data are recorded.
Permissible are up to 128 characters. This setting gets overridden by
image loading.
@*
The special text "@@xorriso@@" gets converted to the id string of
The special text "@@xorriso@@" gets converted to the ID string of
@command{xorriso}
which is normally written as -preparer_id. It is a wrong tradition to write
the program id as -application_id.
the program ID as -application_id.
@c man .TP
@item -system_id text
@kindex -system_id sets system id
@cindex Image, set system id, -system_id
Set the system id string to be written with the next -commit. This may
Set the system ID string to be written with the next -commit. This may
identify the system which can recognize and act upon the content of the
System Area in image blocks 0 to 15.
Permissible are up to 32 characters. This setting gets overridden by
@ -3039,16 +3044,16 @@ image loading.
@item -preparer_id
@kindex -preparer_id sets preparer id
@cindex Image, set preparer id, -preparer_id
Set the preparer id string to be written with the next -commit. This may
Set the preparer ID string to be written with the next -commit. This may
identify the person or other entity which controls the preparation of the data
which shall be recorded. Normally this should be the id of @command{xorriso}
which shall be recorded. Normally this should be the ID of @command{xorriso}
and not of the person or program which operates @command{xorriso}.
Please avoid to change it. Permissible are up to 128 characters.
@*
The special text "@@xorriso@@" gets converted to the id string of
The special text "@@xorriso@@" gets converted to the ID string of
@command{xorriso} which is default at program startup.
@*
Unlike other id strings, this setting is not influenced by image loading.
Unlike other ID strings, this setting is not influenced by image loading.
@c man .TP
@item -out_charset character_set_name
@kindex -out_charset sets output character set
@ -3195,7 +3200,7 @@ The same effect is achieved by -padding mode "included".
@end table
@c man .TP
@c man .B Bootable ISO images:
@node Bootable, Jigdo, SetWrite, Options
@node Bootable, Jigdo, SetWrite, Commands
@section Bootable ISO images
@c man .PP
Contrary to published specifications many BIOSes will load an El Torito
@ -3541,7 +3546,7 @@ lower valid one.
@end table
@c man .TP
@c man .B Jigdo Template Extraction:
@node Jigdo, Charset, Bootable, Options
@node Jigdo, Charset, Bootable, Commands
@section Jigdo Template Extraction
@c man .PP
@cindex Jigdo Template Extraction, _definition
@ -3649,7 +3654,7 @@ Alias: -checksum_algorithm_template
@end table
@c man .TP
@c man .B Character sets:
@node Charset, Exception, Jigdo, Options
@node Charset, Exception, Jigdo, Commands
@section Character sets
@c man .PP
@cindex Character Set, _definition
@ -3713,7 +3718,7 @@ If this appears necessary, one should consider to set -backslash_codes to
@end table
@c man .TP
@c man .B Exception processing:
@node Exception, DialogCtl, Charset, Options
@node Exception, DialogCtl, Charset, Commands
@section Exception processing
@c man .PP
Since the tasks of @command{xorriso} are manifold and prone to external
@ -3874,7 +3879,7 @@ file content stems from the loaded ISO image and is not filtered.
@end table
@c man .TP
@c man .B Dialog mode control:
@node DialogCtl, Inquiry, Exception, Options
@node DialogCtl, Inquiry, Exception, Commands
@section Dialog mode control
@table @asis
@c man .TP
@ -3949,7 +3954,7 @@ use -rollback to revoke the whole session.
@end table
@c man .TP
@c man .B Drive and media related inquiry actions:
@node Inquiry, Navigate, DialogCtl, Options
@node Inquiry, Navigate, DialogCtl, Commands
@section Drive and media related inquiry actions
@table @asis
@c man .TP
@ -4073,13 +4078,13 @@ subtracting already foreseeable consumption by next -commit.
@item -pvd_info
@kindex -pvd_info shows image id strings
@cindex Image, show id strings, -pvd_info
Print various id strings which can be found in loaded ISO images. Some of
Print various ID strings which can be found in loaded ISO images. Some of
them may be changed by commands like -volid or -publisher. For these
ids -pvd_info reports what would be written with the next -commit.
IDs -pvd_info reports what would be written with the next -commit.
@end table
@c man .TP
@c man .B Navigation in ISO image and disk filesystem:
@node Navigate, Verify, Inquiry, Options
@node Navigate, Verify, Inquiry, Commands
@section Navigation in ISO image and disk filesystem
@table @asis
@c man .TP
@ -4345,7 +4350,7 @@ Like -show_stream but working recursively.
@end table
@c man .TP
@c man .B Evaluation of readability and recovery:
@node Verify, Restore, Navigate, Options
@node Verify, Restore, Navigate, Commands
@section Evaluation of readability and recovery
@c man .PP
It is not uncommon that optical media produce read errors. The reasons may be
@ -4490,7 +4495,7 @@ and their start block addresses, followed by binary bitmap data.
@*
@item map_with_volid="on"
examines tracks whether they are ISO images and
prints their volume ids into the human readable TOC of sector_map=.
prints their volume IDs into the human readable TOC of sector_map=.
@*
@item patch_lba0="on"
transfers within the data_to= file a copy of the currently
@ -4552,7 +4557,7 @@ Only mismatching data files will be reported.
@end table
@c man .TP
@c man .B osirrox ISO-to-disk restore commands:
@node Restore, Emulation, Verify, Options
@node Restore, Emulation, Verify, Commands
@section osirrox ISO-to-disk restore commands
@c man .PP
Normally @command{xorriso} only writes to disk files which were given as stdio:
@ -4714,7 +4719,7 @@ reachable as /bin/mount or /sbin/mount.
@end table
@c man .TP
@c man .B Command compatibility emulations:
@node Emulation, Scripting, Restore, Options
@node Emulation, Scripting, Restore, Commands
@section Command compatibility emulations (cdrtools)
@c man .PP
Writing of ISO 9660 on CD is traditionally done by program mkisofs
@ -4963,7 +4968,7 @@ Program scdbackup_verify will recognize and verify tag resp. record.
@end table
@c man .TP
@c man .B Scripting, dialog and program control features:
@node Scripting, Frontend, Emulation, Options
@node Scripting, Frontend, Emulation, Commands
@section Scripting, dialog and program control features
@table @asis
@c man .TP
@ -5163,11 +5168,11 @@ This transport becomes visible with -report_about "ALL".
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 options -o sbsector=
resp. -s from date or volume id.
resp. -s from date or volume ID.
@*
Record format is: timestamp start_lba size volume-id
@*
The first three items are single words, the rest of the line is the volume id.
The first three items are single words, the rest of the line is the volume ID.
@c man .TP
@item -scsi_log "on"|"off"
@kindex -scsi_log reports SCSI commands
@ -5203,7 +5208,7 @@ Do not execute the line but store it in readline history.
@end table
@c man .TP
@c man .B Support for frontend programs via stdin and stdout:
@node Frontend, ExDevices, Scripting, Options
@node Frontend, ExDevices, Scripting, Commands
@section Support for frontend programs via stdin and stdout
@table @asis
@c man .TP
@ -5252,7 +5257,7 @@ Use text as name of this program in subsequent messages
Use text as name of this program and perform -help.
@end table
@c man .br
@node Examples, Files, Options, Top
@node Examples, Files, Commands, Top
@chapter Examples
@c man .SH EXAMPLES
@c man .SS
@ -5758,7 +5763,7 @@ accordingly.
@*
ACL, xattr, hard links and MD5 checksums will be recorded.
Accelerated comparison is enabled at the expense of potentially larger backup
size. Only media with the expected volume id or blank media are accepted.
size. Only media with the expected volume ID or blank media are accepted.
Files with names matching *.o or *.swp get excluded explicitly.
@*
When done with writing the new session gets checked by its recorded MD5.