Restructured xorriso documentation and added index
This commit is contained in:
parent
0baacd4da8
commit
cdd8b8a814
@ -56,10 +56,13 @@ then
|
||||
-e 's/<b>Dialog, Readline, Result pager:<\/b>/\ <BR><b>Dialog, Readline, Result pager:<\/b>/' \
|
||||
-e 's/<b>Aquiring source and target drive:<\/b>/\ <BR><b>Aquiring source and target drive:<\/b><BR>\ <BR>/' \
|
||||
-e 's/<b>Influencing the behavior of image/\ <BR><b>Influencing the behavior of image/' \
|
||||
-e 's/<b>Inserting files into ISO image:<\/b>/\ <BR><b>Inserting files into ISO image:<\/b><BR>\ <BR>/' \
|
||||
-e 's/<b>File manipulations:<\/b>/\ <BR><b>File manipulations:<\/b><BR>\ <BR>/' \
|
||||
-e 's/<b>Tree traversal command -find:<\/b>/\ <BR><b>Tree traversal command -find:<\/b><BR>\ <BR>/' \
|
||||
-e 's/^<p><b>−iso_rr_pattern/<p>\ <BR><b>\−iso_rr_pattern/' \
|
||||
-e 's/EXAMPLES):<br>/<A HREF="#EXAMPLES">EXAMPLES<\/A>):<br>/' \
|
||||
-e 's/<b>Writing the result, drive control:<\/b>/\ <BR><b>Writing the result, drive control:<\/b><BR>/' \
|
||||
-e 's/<b>Filters for data file content:<\/b>/\ <BR><b>Filters for data file content:<\/b><BR>\ <BR>/' \
|
||||
-e 's/<b>Writing the result, drive control:<\/b>/\ <BR><b>Writing the result, drive control:<\/b><BR>\ <BR>/' \
|
||||
-e 's/^-find \/ /\ \ -find \/ /' \
|
||||
-e 's/<b>Settings for file insertion:<\/b>/\ <BR><b>Settings for file insertion:<\/b><BR>\ <BR>/' \
|
||||
-e 's/^$<\/b> ln -s/\ \ $<\/b> ln -s/' \
|
||||
|
@ -3,7 +3,8 @@
|
||||
# Produce man page xorriso/xorriso.1 and info file xorriso/xorriso.info
|
||||
# from base file xorris/xorriso.texi.
|
||||
|
||||
xorriso/make_xorriso_1 -auto
|
||||
|
||||
( cd xorriso ; makeinfo ./xorriso.texi )
|
||||
|
||||
xorriso/make_xorriso_1 -auto
|
||||
|
||||
|
||||
|
@ -442,7 +442,13 @@ a command with a fixed list length. It is handled as normal text if it
|
||||
appears among the arguments of such a command.
|
||||
.PP
|
||||
\fBPattern expansion\fR
|
||||
is a property of some particular commands and not a general
|
||||
converts a list of pattern words into a list of existing file addresses.
|
||||
Eventual unmatched pattern words appear themselves in that result list, though.
|
||||
.br
|
||||
Pattern matching supports the usual shell parser wildcards '*' '?' '[xyz]'
|
||||
and respects '/' as separator which may only be matched literally.
|
||||
.br
|
||||
It is a property of some particular commands and not a general
|
||||
feature. It gets controlled by commands -iso_rr_pattern and -disk_pattern.
|
||||
Commands which eventually use pattern expansion all have variable argument
|
||||
lists which are marked in this man page by "[***]" rather than "[...]".
|
||||
@ -828,7 +834,7 @@ Allow for writing only the usage of MMC optical drives. Disallow
|
||||
to write the result into files of nearly arbitrary type.
|
||||
Once set, this command cannot be revoked.
|
||||
.TP
|
||||
.B File manipulations:
|
||||
.B Inserting files into ISO image:
|
||||
.PP
|
||||
The following commands expect file addresses of two kinds:
|
||||
.br
|
||||
@ -859,27 +865,6 @@ eventual existing target directory rather than attempting to replace it.
|
||||
.PP
|
||||
The commands in this section alter the ISO image and not the local filesystem.
|
||||
.TP
|
||||
\fB\-iso_rr_pattern\fR "on"|"ls"|"off"
|
||||
Set the pattern expansion mode for the iso_rr_path arguments of several
|
||||
commands which support this feature.
|
||||
.br
|
||||
\fBPattern expansion\fR
|
||||
converts a list of pattern words into a list of existing file addresses.
|
||||
Eventual unmatched pattern words appear themselves in that result list, though.
|
||||
.br
|
||||
Pattern matching supports the usual shell parser wildcards '*' '?' '[xyz]'
|
||||
and respects '/' as separator which may only be matched literally.
|
||||
.br
|
||||
Setting "off" disables this feature for all commands which are marked in this
|
||||
man page by "iso_rr_path [***]" or "iso_rr_pattern [***]".
|
||||
.br
|
||||
Setting "on" enables it for all those commands.
|
||||
.br
|
||||
Setting "ls" enables it only for those which are marked by
|
||||
"iso_rr_pattern [***]".
|
||||
.br
|
||||
Default is "on".
|
||||
.TP
|
||||
\fB\-disk_pattern\fR "on"|"ls"|"off"
|
||||
Set the pattern expansion mode for the disk_path arguments of several
|
||||
commands which support this feature.
|
||||
@ -1031,6 +1016,226 @@ get the same type as the disk_path.
|
||||
If a disk_path does not begin with '/' then -cdx is prepended.
|
||||
If the iso_rr_path does not begin with '/' then -cd is prepended.
|
||||
.TP
|
||||
\fB\-mkdir\fR iso_rr_path [...]
|
||||
Create empty directories if they do not exist yet.
|
||||
Existence as directory generates a WARNING event, existence as
|
||||
other file causes a FAILURE event.
|
||||
.TP
|
||||
.B Settings for file insertion:
|
||||
.TP
|
||||
\fB\-file_size_limit\fR value [value [...]] --
|
||||
Set the maximum permissible size for a single data file. The values get
|
||||
summed up for the actual limit. If the only value is "off" then the file
|
||||
size is not limited by xorriso. Default is a limit of 100 extents, 4g -2k each:
|
||||
.br
|
||||
-file_size_limit 400g -200k --
|
||||
.br
|
||||
When mounting ISO 9660 filesystems, old operating systems can handle only files
|
||||
up to 2g -1 --. Newer ones are good up to 4g -1 --.
|
||||
You need quite a new Linux kernel to read correctly the final bytes
|
||||
of a file >= 4g if its size is not aligned to 2048 byte blocks.
|
||||
.br
|
||||
xorriso's own data read capabilities are not affected by eventual
|
||||
operating system size limits. They apply to mounting only. Nevertheless,
|
||||
the target filesystem of an -extract must be able to take the file size.
|
||||
.TP
|
||||
\fB\-not_mgt\fR code[:code[...]]
|
||||
Control the behavior of the exclusion lists.
|
||||
.br
|
||||
Exclusion processing happens before disk_paths get mapped to the ISO image
|
||||
and before disk files get compared with image files.
|
||||
The absolute disk path of the source is matched against the -not_paths list.
|
||||
The leafname of the disk path is matched against the patterns in the -not_leaf
|
||||
list. If a match is detected then the disk path will not be regarded as an
|
||||
existing file and not be added to the ISO image.
|
||||
.br
|
||||
Several codes are defined.
|
||||
The _on/_off settings persist until they are revoked by their_off/_on
|
||||
counterparts.
|
||||
.br
|
||||
"erase" empties the lists which were accumulated by -not_paths and -not_leaf.
|
||||
.br
|
||||
"reset" is like "erase" but also re-installs default behavior.
|
||||
.br
|
||||
"off" disables exclusion processing temporarily without invalidating
|
||||
the lists and settings.
|
||||
.br
|
||||
"on" re-enables exclusion processing.
|
||||
.br
|
||||
"param_off" applies exclusion processing only to paths below disk_path
|
||||
parameter of commands. I.e. explicitly given disk_paths are exempted
|
||||
from exclusion processing.
|
||||
.br
|
||||
"param_on" applies exclusion processing to command parameters as well as
|
||||
to files below such parameters.
|
||||
.br
|
||||
"subtree_off" with "param_on" excludes parameter paths only if they
|
||||
match a -not_paths item exactly.
|
||||
.br
|
||||
"subtree_on" additionally excludes parameter paths which lead to a file
|
||||
address below any -not_paths item.
|
||||
.br
|
||||
"ignore_off" treats excluded disk files as if they were missing. I.e. they
|
||||
get reported with -compare and deleted from the image with -update.
|
||||
.br
|
||||
"ignore_on" keeps excluded files out of -compare or -update activities.
|
||||
.TP
|
||||
\fB\-not_paths\fR disk_path [***]
|
||||
Add the given paths to the list of excluded absolute disk paths. If a given
|
||||
path is relative, then the current -cdx is prepended to form an absolute path.
|
||||
Eventual pattern matching happens at definition time and not when exclusion
|
||||
checks are made.
|
||||
.br
|
||||
(Do not forget to end the list of disk_paths by "--")
|
||||
.TP
|
||||
\fB\-not_leaf\fR pattern
|
||||
Add a single shell parser style pattern to the list of exclusions for
|
||||
disk leafnames. These patterns are evaluated when the exclusion checks are
|
||||
made.
|
||||
.TP
|
||||
\fB\-not_list\fR disk_path
|
||||
Read lines from disk_path and use each of them either as -not_paths argument,
|
||||
if they contain a / character, or as -not_leaf pattern.
|
||||
.TP
|
||||
\fB\-quoted_not_list\fR disk_path
|
||||
Like -not_list but with quoted input reading rules. Each word is
|
||||
handled as one argument for -not_paths resp. -not_leaf.
|
||||
.TP
|
||||
\fB\-follow\fR occasion[:occasion[...]]
|
||||
Enable or disable resolution of symbolic links and mountpoints under
|
||||
disk_paths. This applies to actions -add, -du*x, -ls*x, -findx,
|
||||
and to -disk_pattern expansion.
|
||||
.br
|
||||
There are two kinds of follow decisison to be made:
|
||||
.br
|
||||
"link" is the hop from a symbolic link to its target file object.
|
||||
If enabled then symbolic links are handled as their target file objects,
|
||||
else symbolic links are handled as themselves.
|
||||
.br
|
||||
"mount" is the hop from one filesystem to another subordinate filesystem.
|
||||
If enabled then mountpoint directories are handled as any other directory,
|
||||
else mountpoints are handled as empty directories if they are encountered in
|
||||
directory tree traversals.
|
||||
.br
|
||||
Less general than above occasions:
|
||||
.br
|
||||
"pattern" is mount and link hopping, but only during -disk_pattern expansion.
|
||||
.br
|
||||
"param" is link hopping for parameter words (after eventual pattern expansion).
|
||||
If enabled then -ls*x will show the link targets rather than the links
|
||||
themselves. -du*x, -findx, and -add will process the link targets but not
|
||||
follow links in an eventual directory tree below the targets (unless "link"
|
||||
is enabled).
|
||||
.br
|
||||
Occasions can be combined in a colon separated list. All occasions
|
||||
mentioned in the list will then lead to a positive follow decision.
|
||||
.br
|
||||
"off" prevents any positive follow decision. Use it if no other occasion
|
||||
applies.
|
||||
.br
|
||||
Shortcuts:
|
||||
.br
|
||||
"default" is equivalent to "pattern:mount:limit=100".
|
||||
.br
|
||||
"on" always decides positive. Equivalent to "link:mount".
|
||||
.br
|
||||
|
||||
Not an occasion but an optional setting is:
|
||||
.br
|
||||
"limit="<number> which sets the maximum number of link hops.
|
||||
A link hop consists of a sequence of symbolic links and a final target
|
||||
of different type. Nevertheless those hops can loop. Example:
|
||||
.br
|
||||
$ ln -s .. uploop
|
||||
.br
|
||||
Link hopping has a built-in loop detection which stops hopping at the first
|
||||
repetition of a link target. Then the repeated link is handled as itself
|
||||
and not as its target.
|
||||
Regrettably one can construct link networks which
|
||||
cause exponential workload before their loops get detected.
|
||||
The number given with "limit=" can curb this workload at the risk of truncating
|
||||
an intentional sequence of link hops.
|
||||
.TP
|
||||
\fB\-pathspecs\fR "on"|"off"
|
||||
Control parameter interpretation with xorriso actions -add and -path_list.
|
||||
.br
|
||||
"on" enables pathspecs of the form
|
||||
\fBtarget=source\fR
|
||||
like with program mkisofs -graft-points.
|
||||
It also disables -disk_pattern expansion for command -add.
|
||||
.br
|
||||
"off" disables pathspecs of the form target=source
|
||||
and eventually enables -disk_pattern expansion.
|
||||
.TP
|
||||
\fB\-overwrite\fR "on"|"nondir"|"off"
|
||||
Allow or disallow to overwrite existing files in the
|
||||
ISO image by files with the same name.
|
||||
.br
|
||||
With setting "off", name collisions cause FAILURE events.
|
||||
With setting "nondir", only directories are protected by such events, other
|
||||
existing file types get treated with -rm before the new file gets added.
|
||||
Setting "on" allows automatic -rm_r. I.e. a non-directory can replace an
|
||||
existing directory and all its subordinates.
|
||||
.br
|
||||
If restoring of files is enabled, then the overwrite rule applies to the
|
||||
target file objects on disk as well, but "on" is downgraded to "nondir".
|
||||
.TP
|
||||
\fB\-split_size\fR number["k"|"m"]
|
||||
Set the threshold for automatic splitting of regular files. Such splitting
|
||||
maps a large disk file onto a ISO directory with several part files in it.
|
||||
This is necessary if the size of the disk file exceeds -file_size_limit.
|
||||
Older operating systems can handle files in mounted ISO 9660 filesystems
|
||||
only if they are smaller than 2 GiB resp. 4 GiB.
|
||||
.br
|
||||
Default is 0 which will exclude files larger than -file_size_limit by a
|
||||
FAILURE event.
|
||||
A well tested -split_size is 2047m. Sizes above -file_size_limit are not
|
||||
permissible.
|
||||
.br
|
||||
While option -split_size is set larger than 0 such a directory with split
|
||||
file pieces will be recognized and handled like a regular file by options
|
||||
-compare* , -update*, and in overwrite situations. There are -ossirox
|
||||
options "concat_split_on" and "concat_split_off" which control the handling
|
||||
when files get restored to disk.
|
||||
.br
|
||||
In order to be recognizable, the names of the part files have to
|
||||
describe the splitting by 5 numbers:
|
||||
.br
|
||||
part_number,total_parts,byte_offset,byte_count,disk_file_size
|
||||
.br
|
||||
which are embedded in the following text form:
|
||||
.br
|
||||
part_#_of_#_at_#_with_#_of_#
|
||||
.br
|
||||
Scaling characters like "m" or "k" are taken into respect.
|
||||
All digits are interpreted as decimal, even if leading zeros are present.
|
||||
.br
|
||||
E.g: /file/part_1_of_3_at_0_with_2047m_of_5753194821
|
||||
.br
|
||||
No other files are allowed in the directory. All parts have to be present and
|
||||
their numbers have to be plausible. E.g. byte_count must be valid as -cut_out
|
||||
argument and their contents may not overlap.
|
||||
.TP
|
||||
.B File manipulations:
|
||||
.PP
|
||||
The following commands manipulate files in the ISO image, regardless whether
|
||||
they stem from the loaded image or were newly inserted.
|
||||
.PP
|
||||
.TP
|
||||
\fB\-iso_rr_pattern\fR "on"|"ls"|"off"
|
||||
Set the pattern expansion mode for the iso_rr_path arguments of several
|
||||
commands which support this feature.
|
||||
.br
|
||||
Setting "off" disables pattern expansion for all commands which are marked
|
||||
in this man page by "iso_rr_path [***]" or "iso_rr_pattern [***]".
|
||||
.br
|
||||
Setting "on" enables it for all those commands.
|
||||
.br
|
||||
Setting "ls" enables it only for those which are marked by
|
||||
"iso_rr_pattern [***]".
|
||||
.br
|
||||
Default is "on".
|
||||
.TP
|
||||
\fB\-rm\fR iso_rr_path [***]
|
||||
Delete the given files from the ISO image.
|
||||
.br
|
||||
@ -1044,6 +1249,9 @@ media in modification mode.
|
||||
Delete the given files or directory trees from the ISO image.
|
||||
See also the note with option -rm.
|
||||
.TP
|
||||
\fB\-rmdir\fR iso_rr_path [***]
|
||||
Delete empty directories.
|
||||
.TP
|
||||
\fB\-mv\fR iso_rr_path [***] iso_rr_path
|
||||
Rename the given file objects in the ISO tree to the last
|
||||
argument in the list. Use the same rules as with shell command mv.
|
||||
@ -1170,96 +1378,6 @@ whitespace after the end quote will be ignored. Non-printables bytes and quotes
|
||||
must be represented as \\XYZ by their octal ASCII code XYZ.
|
||||
Use code \\000 for 0-bytes.
|
||||
.TP
|
||||
\fB\-external_filter\fR name option[:option] program_path [arguments] --
|
||||
Register a content filter by associating a name with a program path,
|
||||
program arguments, and some behavioral options. Once registered it can be
|
||||
applied to multiple data files in the ISO image, regardless whether their
|
||||
content resides in the loaded ISO image or in the local filesystem.
|
||||
External filter processes may produce synthetic file content by reading the
|
||||
original content from stdin and writing to stdout whatever they want.
|
||||
They must deliver the same output on the same input in repeated runs.
|
||||
.br
|
||||
Options are:
|
||||
.br
|
||||
"default" means that no other option is intended.
|
||||
.br
|
||||
"suffix=..." sets a file name suffix. If it is not empty then it will be
|
||||
appended to the file name or removed from it.
|
||||
.br
|
||||
"remove_suffix" will remove an eventual file name suffix
|
||||
rather than appending it.
|
||||
.br
|
||||
"if_nonempty" will leave 0-sized files unfiltered.
|
||||
.br
|
||||
"if_reduction" will try filtering and revoke it if the content size does not
|
||||
shrink.
|
||||
.br
|
||||
"if_block_reduction" will revoke if the number of 2 kB blocks does not shrink.
|
||||
.br
|
||||
"used=..." is ignored. Command -status shows it with the number of
|
||||
files which currently have the filter applied.
|
||||
.br
|
||||
Examples:
|
||||
.br
|
||||
-external_filter bzip2 suffix=.bz2:if_block_reduction \\
|
||||
.br
|
||||
/usr/bin/bzip2 --
|
||||
.br
|
||||
-external_filter bunzip2 suffix=.bz2:remove_suffix \\
|
||||
.br
|
||||
/usr/bin/bunzip2 --
|
||||
.TP
|
||||
\fB\-unregister_filter\fR name
|
||||
Remove an -external_filter registration. This is only possible if the filter
|
||||
is not applied to any file in the ISO image.
|
||||
.TP
|
||||
\fB\-close_filter_list\fR
|
||||
Irrevocably ban commands -external_filter and -unregister_filter,
|
||||
but not -set_filter. Use this to prevent external filtering in general or
|
||||
when all intended filters are registered.
|
||||
External filters may also be banned totally at compile time of xorriso.
|
||||
By default they are banned if xorriso runs under setuid permission.
|
||||
.TP
|
||||
\fB\-set_filter\fR name iso_rr_path [***]
|
||||
Apply an -external_filter or a built-in filter to the given data files in the
|
||||
ISO image.
|
||||
If the filter suffix is not empty , then it will be applied to the file name.
|
||||
Renaming only happens if the filter really gets attached and is not revoked by
|
||||
its options.
|
||||
By default files which already bear the suffix will not get filtered. The
|
||||
others will get the suffix appended to their names.
|
||||
If the filter has option "remove_suffix", then the filter will only be
|
||||
applied if the suffix is present and can be removed.
|
||||
Name oversize or collision caused by suffix change will prevent filtering.
|
||||
.br
|
||||
With most filter types this command will immediately run the filter once for
|
||||
each file in order to determine the output size.
|
||||
Content reading operations like -extract , -compare and image generation will
|
||||
perform further filter runs and deliver filtered content.
|
||||
.br
|
||||
At image generation time the filter output must still be the same as the
|
||||
output from the first run. Filtering for image generation does not happen
|
||||
with files from the loaded ISO image if the write method of growing is in
|
||||
effect (i.e -indev and -outdev are identical).
|
||||
.br
|
||||
The reserved filter name "--remove-all-filters" revokes
|
||||
filtering. This will revoke eventual suffix renamings as well.
|
||||
Use "--remove-all-filters+" to
|
||||
prevent any suffix renaming.
|
||||
.br
|
||||
Built-in filters are "--zisofs" and
|
||||
"--zisofs-decode". The former is to be
|
||||
applied via -set_filter, the latter is automatically applied if zisofs
|
||||
compressed content is detected with a file when loading the ISO image.
|
||||
.br
|
||||
Another built-in filter pair is "--gzip"
|
||||
and "--gunzip" with suffix ".gz".
|
||||
They behave about like external gzip and gunzip but avoid forking a process
|
||||
for each single file. So they are much faster if there are many small files.
|
||||
.TP
|
||||
\fB\-set_filter_r\fR name iso_rr_path [***]
|
||||
Like -set_filter but affecting all data files below eventual directories.
|
||||
.TP
|
||||
\fB\-alter_date\fR type timestring iso_rr_path [***]
|
||||
Alter the date entries of a file in the ISO image. type is
|
||||
one of "a", "m", "b" for access time, modification time,
|
||||
@ -1299,6 +1417,9 @@ where "A0" is year 2000, "B0" is 2010, etc.
|
||||
\fB\-alter_date_r\fR type timestring iso_rr_path [***]
|
||||
Like -alter_date but affecting all files below eventual directories.
|
||||
.TP
|
||||
.B Tree traversal command -find:
|
||||
.PP
|
||||
.TP
|
||||
\fB\-find\fR iso_rr_path [test [op] [test ...]] [-exec action [params]] --
|
||||
A restricted substitute for shell command find in the ISO image.
|
||||
It performs an action on matching file objects at or below iso_rr_path.
|
||||
@ -1522,24 +1643,111 @@ E.g.:
|
||||
.br
|
||||
-find / -name '???' -type d -exec find -name '[abc]*' -exec chmod a-w,a+r --
|
||||
.TP
|
||||
\fB\-mkdir\fR iso_rr_path [...]
|
||||
Create empty directories if they do not exist yet.
|
||||
Existence as directory generates a WARNING event, existence as
|
||||
other file causes a FAILURE event.
|
||||
.B Filters for data file content:
|
||||
.PP
|
||||
\fBFilters\fR may be installed between data files in the ISO image and their
|
||||
content source outside the image. They may also be used vice versa between
|
||||
data content in the image and target files on disk.
|
||||
.br
|
||||
Built-in filters are "--zisofs" and
|
||||
"--zisofs-decode". The former is to be
|
||||
applied via -set_filter, the latter is automatically applied if zisofs
|
||||
compressed content is detected with a file when loading the ISO image.
|
||||
.br
|
||||
Another built-in filter pair is "--gzip"
|
||||
and "--gunzip" with suffix ".gz".
|
||||
They behave about like external gzip and gunzip but avoid forking a process
|
||||
for each single file. So they are much faster if there are many small files.
|
||||
.PP
|
||||
.TP
|
||||
\fB\-rmdir\fR iso_rr_path [***]
|
||||
Delete empty directories.
|
||||
\fB\-external_filter\fR name option[:option] program_path [arguments] --
|
||||
Register a content filter by associating a name with a program path,
|
||||
program arguments, and some behavioral options. Once registered it can be
|
||||
applied to multiple data files in the ISO image, regardless whether their
|
||||
content resides in the loaded ISO image or in the local filesystem.
|
||||
External filter processes may produce synthetic file content by reading the
|
||||
original content from stdin and writing to stdout whatever they want.
|
||||
They must deliver the same output on the same input in repeated runs.
|
||||
.br
|
||||
Options are:
|
||||
.br
|
||||
"default" means that no other option is intended.
|
||||
.br
|
||||
"suffix=..." sets a file name suffix. If it is not empty then it will be
|
||||
appended to the file name or removed from it.
|
||||
.br
|
||||
"remove_suffix" will remove an eventual file name suffix
|
||||
rather than appending it.
|
||||
.br
|
||||
"if_nonempty" will leave 0-sized files unfiltered.
|
||||
.br
|
||||
"if_reduction" will try filtering and revoke it if the content size does not
|
||||
shrink.
|
||||
.br
|
||||
"if_block_reduction" will revoke if the number of 2 kB blocks does not shrink.
|
||||
.br
|
||||
"used=..." is ignored. Command -status shows it with the number of
|
||||
files which currently have the filter applied.
|
||||
.br
|
||||
Examples:
|
||||
.br
|
||||
-external_filter bzip2 suffix=.bz2:if_block_reduction \\
|
||||
.br
|
||||
/usr/bin/bzip2 --
|
||||
.br
|
||||
-external_filter bunzip2 suffix=.bz2:remove_suffix \\
|
||||
.br
|
||||
/usr/bin/bunzip2 --
|
||||
.TP
|
||||
\fB\-rollback\fR
|
||||
Discard the manipulated ISO image and reload it from -indev.
|
||||
\fB\-unregister_filter\fR name
|
||||
Remove an -external_filter registration. This is only possible if the filter
|
||||
is not applied to any file in the ISO image.
|
||||
.TP
|
||||
\fB\-rollback_end\fR
|
||||
Discard the manipulated ISO image. End program without loading a new image.
|
||||
\fB\-close_filter_list\fR
|
||||
Irrevocably ban commands -external_filter and -unregister_filter,
|
||||
but not -set_filter. Use this to prevent external filtering in general or
|
||||
when all intended filters are registered.
|
||||
External filters may also be banned totally at compile time of xorriso.
|
||||
By default they are banned if xorriso runs under setuid permission.
|
||||
.TP
|
||||
\fB\-set_filter\fR name iso_rr_path [***]
|
||||
Apply an -external_filter or a built-in filter to the given data files in the
|
||||
ISO image.
|
||||
If the filter suffix is not empty , then it will be applied to the file name.
|
||||
Renaming only happens if the filter really gets attached and is not revoked by
|
||||
its options.
|
||||
By default files which already bear the suffix will not get filtered. The
|
||||
others will get the suffix appended to their names.
|
||||
If the filter has option "remove_suffix", then the filter will only be
|
||||
applied if the suffix is present and can be removed.
|
||||
Name oversize or collision caused by suffix change will prevent filtering.
|
||||
.br
|
||||
With most filter types this command will immediately run the filter once for
|
||||
each file in order to determine the output size.
|
||||
Content reading operations like -extract , -compare and image generation will
|
||||
perform further filter runs and deliver filtered content.
|
||||
.br
|
||||
At image generation time the filter output must still be the same as the
|
||||
output from the first run. Filtering for image generation does not happen
|
||||
with files from the loaded ISO image if the write method of growing is in
|
||||
effect (i.e -indev and -outdev are identical).
|
||||
.br
|
||||
The reserved filter name "--remove-all-filters" revokes
|
||||
filtering. This will revoke eventual suffix renamings as well.
|
||||
Use "--remove-all-filters+" to
|
||||
prevent any suffix renaming.
|
||||
.TP
|
||||
\fB\-set_filter_r\fR name iso_rr_path [***]
|
||||
Like -set_filter but affecting all data files below eventual directories.
|
||||
.TP
|
||||
.B Writing the result, drive control:
|
||||
.PP
|
||||
(see also paragraph about settings below)
|
||||
.TP
|
||||
\fB\-rollback\fR
|
||||
Discard the manipulated ISO image and reload it from -indev.
|
||||
(Use -rollback_end if immediate program end is desired.)
|
||||
.TP
|
||||
\fB\-commit\fR
|
||||
Perform the write operation. Afterwards eventually make the
|
||||
-outdev the new -dev and load the image from there.
|
||||
@ -1672,208 +1880,14 @@ Smaller format size with DVD-RAM, BD-RE, or BD-R means more reserve space.
|
||||
Put out a list of media types supported by -indev, resp. -outdev, resp. both.
|
||||
The currently recognized type is marked by text "(current)".
|
||||
.TP
|
||||
.B Settings for file insertion:
|
||||
.TP
|
||||
\fB\-file_size_limit\fR value [value [...]] --
|
||||
Set the maximum permissible size for a single data file. The values get
|
||||
summed up for the actual limit. If the only value is "off" then the file
|
||||
size is not limited by xorriso. Default is a limit of 100 extents, 4g -2k each:
|
||||
.br
|
||||
-file_size_limit 400g -200k --
|
||||
.br
|
||||
When mounting ISO 9660 filesystems, old operating systems can handle only files
|
||||
up to 2g -1 --. Newer ones are good up to 4g -1 --.
|
||||
You need quite a new Linux kernel to read correctly the final bytes
|
||||
of a file >= 4g if its size is not aligned to 2048 byte blocks.
|
||||
.br
|
||||
xorriso's own data read capabilities are not affected by eventual
|
||||
operating system size limits. They apply to mounting only. Nevertheless,
|
||||
the target filesystem of an -extract must be able to take the file size.
|
||||
.TP
|
||||
\fB\-not_mgt\fR code[:code[...]]
|
||||
Control the behavior of the exclusion lists.
|
||||
.br
|
||||
Exclusion processing happens before disk_paths get mapped to the ISO image
|
||||
and before disk files get compared with image files.
|
||||
The absolute disk path of the source is matched against the -not_paths list.
|
||||
The leafname of the disk path is matched against the patterns in the -not_leaf
|
||||
list. If a match is detected then the disk path will not be regarded as an
|
||||
existing file and not be added to the ISO image.
|
||||
.br
|
||||
Several codes are defined.
|
||||
The _on/_off settings persist until they are revoked by their_off/_on
|
||||
counterparts.
|
||||
.br
|
||||
"erase" empties the lists which were accumulated by -not_paths and -not_leaf.
|
||||
.br
|
||||
"reset" is like "erase" but also re-installs default behavior.
|
||||
.br
|
||||
"off" disables exclusion processing temporarily without invalidating
|
||||
the lists and settings.
|
||||
.br
|
||||
"on" re-enables exclusion processing.
|
||||
.br
|
||||
"param_off" applies exclusion processing only to paths below disk_path
|
||||
parameter of commands. I.e. explicitly given disk_paths are exempted
|
||||
from exclusion processing.
|
||||
.br
|
||||
"param_on" applies exclusion processing to command parameters as well as
|
||||
to files below such parameters.
|
||||
.br
|
||||
"subtree_off" with "param_on" excludes parameter paths only if they
|
||||
match a -not_paths item exactly.
|
||||
.br
|
||||
"subtree_on" additionally excludes parameter paths which lead to a file
|
||||
address below any -not_paths item.
|
||||
.br
|
||||
"ignore_off" treats excluded disk files as if they were missing. I.e. they
|
||||
get reported with -compare and deleted from the image with -update.
|
||||
.br
|
||||
"ignore_on" keeps excluded files out of -compare or -update activities.
|
||||
.TP
|
||||
\fB\-not_paths\fR disk_path [***]
|
||||
Add the given paths to the list of excluded absolute disk paths. If a given
|
||||
path is relative, then the current -cdx is prepended to form an absolute path.
|
||||
Eventual pattern matching happens at definition time and not when exclusion
|
||||
checks are made.
|
||||
.br
|
||||
(Do not forget to end the list of disk_paths by "--")
|
||||
.TP
|
||||
\fB\-not_leaf\fR pattern
|
||||
Add a single shell parser style pattern to the list of exclusions for
|
||||
disk leafnames. These patterns are evaluated when the exclusion checks are
|
||||
made.
|
||||
.TP
|
||||
\fB\-not_list\fR disk_path
|
||||
Read lines from disk_path and use each of them either as -not_paths argument,
|
||||
if they contain a / character, or as -not_leaf pattern.
|
||||
.TP
|
||||
\fB\-quoted_not_list\fR disk_path
|
||||
Like -not_list but with quoted input reading rules. Each word is
|
||||
handled as one argument for -not_paths resp. -not_leaf.
|
||||
.TP
|
||||
\fB\-follow\fR occasion[:occasion[...]]
|
||||
Enable or disable resolution of symbolic links and mountpoints under
|
||||
disk_paths. This applies to actions -add, -du*x, -ls*x, -findx,
|
||||
and to -disk_pattern expansion.
|
||||
.br
|
||||
There are two kinds of follow decisison to be made:
|
||||
.br
|
||||
"link" is the hop from a symbolic link to its target file object.
|
||||
If enabled then symbolic links are handled as their target file objects,
|
||||
else symbolic links are handled as themselves.
|
||||
.br
|
||||
"mount" is the hop from one filesystem to another subordinate filesystem.
|
||||
If enabled then mountpoint directories are handled as any other directory,
|
||||
else mountpoints are handled as empty directories if they are encountered in
|
||||
directory tree traversals.
|
||||
.br
|
||||
Less general than above occasions:
|
||||
.br
|
||||
"pattern" is mount and link hopping, but only during -disk_pattern expansion.
|
||||
.br
|
||||
"param" is link hopping for parameter words (after eventual pattern expansion).
|
||||
If enabled then -ls*x will show the link targets rather than the links
|
||||
themselves. -du*x, -findx, and -add will process the link targets but not
|
||||
follow links in an eventual directory tree below the targets (unless "link"
|
||||
is enabled).
|
||||
.br
|
||||
Occasions can be combined in a colon separated list. All occasions
|
||||
mentioned in the list will then lead to a positive follow decision.
|
||||
.br
|
||||
"off" prevents any positive follow decision. Use it if no other occasion
|
||||
applies.
|
||||
.br
|
||||
Shortcuts:
|
||||
.br
|
||||
"default" is equivalent to "pattern:mount:limit=100".
|
||||
.br
|
||||
"on" always decides positive. Equivalent to "link:mount".
|
||||
.br
|
||||
|
||||
Not an occasion but an optional setting is:
|
||||
.br
|
||||
"limit="<number> which sets the maximum number of link hops.
|
||||
A link hop consists of a sequence of symbolic links and a final target
|
||||
of different type. Nevertheless those hops can loop. Example:
|
||||
.br
|
||||
$ ln -s .. uploop
|
||||
.br
|
||||
Link hopping has a built-in loop detection which stops hopping at the first
|
||||
repetition of a link target. Then the repeated link is handled as itself
|
||||
and not as its target.
|
||||
Regrettably one can construct link networks which
|
||||
cause exponential workload before their loops get detected.
|
||||
The number given with "limit=" can curb this workload at the risk of truncating
|
||||
an intentional sequence of link hops.
|
||||
.TP
|
||||
\fB\-pathspecs\fR "on"|"off"
|
||||
Control parameter interpretation with xorriso actions -add and -path_list.
|
||||
.br
|
||||
"on" enables pathspecs of the form
|
||||
\fBtarget=source\fR
|
||||
like with program mkisofs -graft-points.
|
||||
It also disables -disk_pattern expansion for command -add.
|
||||
.br
|
||||
"off" disables pathspecs of the form target=source
|
||||
and eventually enables -disk_pattern expansion.
|
||||
.TP
|
||||
\fB\-overwrite\fR "on"|"nondir"|"off"
|
||||
Allow or disallow to overwrite existing files in the
|
||||
ISO image by files with the same name.
|
||||
.br
|
||||
With setting "off", name collisions cause FAILURE events.
|
||||
With setting "nondir", only directories are protected by such events, other
|
||||
existing file types get treated with -rm before the new file gets added.
|
||||
Setting "on" allows automatic -rm_r. I.e. a non-directory can replace an
|
||||
existing directory and all its subordinates.
|
||||
.br
|
||||
If restoring of files is enabled, then the overwrite rule applies to the
|
||||
target file objects on disk as well, but "on" is downgraded to "nondir".
|
||||
.TP
|
||||
\fB\-split_size\fR number["k"|"m"]
|
||||
Set the threshold for automatic splitting of regular files. Such splitting
|
||||
maps a large disk file onto a ISO directory with several part files in it.
|
||||
This is necessary if the size of the disk file exceeds -file_size_limit.
|
||||
Older operating systems can handle files in mounted ISO 9660 filesystems
|
||||
only if they are smaller than 2 GiB resp. 4 GiB.
|
||||
.br
|
||||
Default is 0 which will exclude files larger than -file_size_limit by a
|
||||
FAILURE event.
|
||||
A well tested -split_size is 2047m. Sizes above -file_size_limit are not
|
||||
permissible.
|
||||
.br
|
||||
While option -split_size is set larger than 0 such a directory with split
|
||||
file pieces will be recognized and handled like a regular file by options
|
||||
-compare* , -update*, and in overwrite situations. There are -ossirox
|
||||
options "concat_split_on" and "concat_split_off" which control the handling
|
||||
when files get restored to disk.
|
||||
.br
|
||||
In order to be recognizable, the names of the part files have to
|
||||
describe the splitting by 5 numbers:
|
||||
.br
|
||||
part_number,total_parts,byte_offset,byte_count,disk_file_size
|
||||
.br
|
||||
which are embedded in the following text form:
|
||||
.br
|
||||
part_#_of_#_at_#_with_#_of_#
|
||||
.br
|
||||
Scaling characters like "m" or "k" are taken into respect.
|
||||
All digits are interpreted as decimal, even if leading zeros are present.
|
||||
.br
|
||||
E.g: /file/part_1_of_3_at_0_with_2047m_of_5753194821
|
||||
.br
|
||||
No other files are allowed in the directory. All parts have to be present and
|
||||
their numbers have to be plausible. E.g. byte_count must be valid as -cut_out
|
||||
argument and their contents may not overlap.
|
||||
.TP
|
||||
.B Settings for result writing:
|
||||
.PP
|
||||
Rock Ridge info will be generated by the program unconditionally.
|
||||
ACLs will be written according to the setting of option -acl.
|
||||
.TP
|
||||
\fB\-joliet\fR "on"|"off"
|
||||
If enabled by "on", generate Joliet info additional to Rock Ridge info.
|
||||
If enabled by "on", generate Joliet tree additional to ISO 9660 + Rock Ridge
|
||||
tree.
|
||||
.TP
|
||||
\fB\-compliance\fR rule[:rule...]
|
||||
Adjust the compliance to specifications of ISO 9660 and its contemporary
|
||||
@ -3245,7 +3259,10 @@ of xorriso begin. Only "-scsi_log" with dash "-" is recognized that way.
|
||||
.TP
|
||||
\fB\-end\fR
|
||||
.br
|
||||
End program immediately
|
||||
End program after writing eventually pending changes.
|
||||
.TP
|
||||
\fB\-rollback_end\fR
|
||||
Discard pending changes. End program immediately.
|
||||
.TP
|
||||
\fB#\fR any text
|
||||
Only in dialog or file execution mode, and only as first
|
||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1 +1 @@
|
||||
#define Xorriso_timestamP "2010.03.18.101202"
|
||||
#define Xorriso_timestamP "2010.03.20.165317"
|
||||
|
Loading…
Reference in New Issue
Block a user