libburnia/libisoburn
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Some adjustments in xorriso man page

Browse Source
This commit is contained in:
Thomas Schmitt
2012-02-24 20:20:22 +00:00
parent 3c0bc5bc16
commit 67836d9721
3 changed files with 155 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
xorriso/xorriso.texi
View File

@ -526,7 +526,7 @@ makes such an image bootable. For details see option -boot_image.
@*
@cindex MBR, _definiton
It is possible to make ISO images bootable from USB stick or other
hard-disk-like media by -boot_image argument system_area= . This installs
hard-disk-like media by -boot_image parameter system_area= . This installs
a Master Boot Record which may get adjusted according to the needs
of GRUB resp. ISOLINUX.
An @strong{MBR} contains boot code and a partition table. It does not hamper
@ -606,7 +606,7 @@ or an end of an input line.
@sp 1
At program start the list delimiter is the word "@minus{}@minus{}".
This may be changed by option -list_delimiter in order to allow
"@minus{}@minus{}" as argument in a list of variable length.
"@minus{}@minus{}" as parameter in a list of variable length.
It is advised to reset the delimiter to "@minus{}@minus{}" immediately
afterwards.
@*
@ -615,7 +615,7 @@ throughout this text.
@*
The list delimiter is silently tolerated if it appears after the parameters of
a command with a fixed list length. It is handled as normal text if it
appears among the arguments of such a command.
appears among the parameters of such a command.
@c man .PP
@sp 1
@cindex Pattern expansion, _definition
@ -628,7 +628,7 @@ and respects '/' as separator which may only be matched literally.
@*
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 may use pattern expansion all have variable argument
Commands which may use pattern expansion all have variable parameter
lists which are marked in this man page by "[***]" rather than "[...]".
@*
Some other commands perform pattern matching unconditionally.
@ -1231,7 +1231,7 @@ The commands in this section alter the ISO image and not the local filesystem.
@item -disk_pattern "on"|"ls"|"off"
@kindex -disk_pattern controls pattern expansion
@cindex Pattern expansion, for disk paths, -disk_pattern
Set the pattern expansion mode for the disk_path arguments of several
Set the pattern expansion mode for the disk_path parameters of several
commands which support this feature.
@*
Setting "off" disables this feature for all commands which are marked in this
@ -1313,7 +1313,7 @@ Like -map, but if disk_path is a directory then its sub tree is not inserted.
@item -map_l disk_prefix iso_rr_prefix disk_path [***]
@kindex -map_l inserts paths from disk file
@cindex Insert, paths from disk file, -map_l
Perform -map with each of the disk_path arguments. iso_rr_path will be
Perform -map with each of the disk_path parameters. iso_rr_path will be
composed from disk_path by replacing disk_prefix by iso_rr_prefix.
@c man .TP
@item -update disk_path iso_rr_path
@ -1347,7 +1347,7 @@ exist, then iso_rr_path gets deleted.
@item -update_l disk_prefix iso_rr_prefix disk_path [***]
@kindex -update_l inserts paths if different
@cindex Insert, if different, -update_l
Perform -update_r with each of the disk_path arguments. iso_rr_path will be
Perform -update_r with each of the disk_path parameters. iso_rr_path will be
composed from disk_path by replacing disk_prefix by iso_rr_prefix.
@c man .TP
@item -cut_out disk_path byte_offset byte_count iso_rr_path
@ -1440,7 +1440,7 @@ command -cpr (see above) resp. shell command cp -r. Other than with -cpr,
relative iso_rr_path_original will get prepended the -cd path and not
the -cdx path. Consider to -mkdir iso_rr_path_dest before -cp_clone
so the copy address does not depend on the number of iso_rr_path_original
arguments.
parameters.
@end table
@c man .TP
@c man .B Settings for file insertion:
@ -1530,14 +1530,14 @@ made.
@item -not_list disk_path
@kindex -not_list sets exclusions from disk file
@cindex Insert, file exclusion from file, -not_list
Read lines from disk_path and use each of them either as -not_paths argument,
Read lines from disk_path and use each of them either as -not_paths parameter,
if they contain a / character, or as -not_leaf pattern.
@c man .TP
@item -quoted_not_list disk_path
@kindex -quoted_not_list sets exclusions
@cindex Insert, file exclusion, -quoted_not_list
Like -not_list but with quoted input reading rules. Each word is
handled as one argument for -not_paths resp. -not_leaf.
handled as one parameter for -not_paths resp. -not_leaf.
@c man .TP
@item -follow occasion[:occasion[...]]
@kindex -follow softlinks and mount points
@ -1663,7 +1663,7 @@ E.g: /file/part_1_of_3_at_0_with_2047m_of_5753194821
@*
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.
parameter and their contents may not overlap.
@end table
@c man .TP
@c man .B File manipulations:
@ -1679,7 +1679,7 @@ they stem from the loaded image or were newly inserted.
@item -iso_rr_pattern "on"|"ls"|"off"
@kindex -iso_rr_pattern controls pattern expansion
@cindex Pattern expansion, for ISO paths, -iso_rr_pattern
Set the pattern expansion mode for the iso_rr_path arguments of several
Set the pattern expansion mode for the iso_rr_path parameters of several
commands which support this feature.
@*
Setting "off" disables pattern expansion for all commands which are marked
@ -1719,9 +1719,9 @@ Delete empty directories.
@kindex -mv renames file in ISO image
@cindex Rename, in ISO image, -mv
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.
parameter in the list. Use the same rules as with shell command mv.
@*
If pattern expansion is enabled and if the last argument contains wildcard
If pattern expansion is enabled and if the last parameter contains wildcard
characters then it must match exactly one existing file address, or else the
command fails with a FAILURE event.
@c man .TP
@ -1942,7 +1942,7 @@ Rather use: -boot_image "any" "cat_hidden=on"
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.
@*
If not used as last command in the line then the argument list
If not used as last command in the line then the parameter list
needs to get terminated by "@minus{}@minus{}".
@*
Tests are optional. If they are omitted then action is applied to all file
@ -2107,7 +2107,7 @@ prints file information like shell command ls -dl.
@*
@item compare
performs command -compare with the found file address as
iso_rr_path and the corresponding file address below its argument
iso_rr_path and the corresponding file address below its parameter
disk_path_start. For this the iso_rr_path of the -find command gets
replaced by the disk_path_start.
@*
@ -2997,7 +2997,7 @@ Define the handling of a set of El Torito boot images which
has been read from an existing ISO image or define how to make a prepared
boot image file set bootable. Such file sets get produced by ISOLINUX or GRUB.
@*
Each -boot_image command has two arguments: type and setting. More than one
Each -boot_image command has two parameters: type and setting. More than one
-boot_image command may be used to define the handling of one or more boot
images. Sequence matters.
@*
@ -3594,7 +3594,8 @@ file content stems from the loaded ISO image and is not filtered.
@item -dialog "on"|"off"|"single_line"
@kindex -dialog enables dialog mode
@cindex Dialog, enable dialog mode, -dialog
Enable or disable to enter dialog mode after all arguments are processed.
Enable or disable to enter dialog mode after all program arguments are
processed.
In dialog mode input lines get prompted via readline or from stdin.
@*
If no -abort_on severity was set when dialog starts, then "NEVER" is set
@ -3948,7 +3949,7 @@ Similar to shell command du -sk.
Like -find but operating on local filesystem and not on the ISO image.
This is subject to the settings of -follow.
@*
-findx accepts the same -type arguments as -find. Additionally it recognizes
-findx accepts the same -type parameters as -find. Additionally it recognizes
type "mountpoint" (or "m") which matches subdirectories which reside on a
different device than their parent. It never matches the disk_path
given as start address for -findx.
@ -4023,7 +4024,7 @@ and whether both counterparts match.
@item -compare_l disk_prefix iso_rr_prefix disk_path [***]
@kindex -compare_l reports ISO/disk differences
@cindex Verify, compare ISO and disk, -compare_l
Perform -compare_r with each of the disk_path arguments. iso_rr_path will be
Perform -compare_r with each of the disk_path parameters. iso_rr_path will be
composed from disk_path by replacing disk_prefix by iso_rr_prefix.
@c man .TP
@item -show_stream iso_rr_path [***]
@ -4348,7 +4349,7 @@ restored.
@item -extract_l iso_rr_prefix disk_prefix iso_rr_path [***]
@kindex -extract_l copies files to disk
@cindex Restore, copy files to disk, -extract_l
Perform -extract with each of the iso_rr_path arguments. disk_path will be
Perform -extract with each of the iso_rr_path parameters. disk_path will be
composed from iso_rr_path by replacing iso_rr_prefix by disk_prefix.
@c man .TP
@item -extract_cut iso_rr_path byte_offset byte_count disk_path
@ -4506,15 +4507,15 @@ Not original mkisofs options are @minus{}@minus{}quoted_path_list ,
@minus{}@minus{}hardlinks , @minus{}@minus{}acl ,
@minus{}@minus{}xattr , @minus{}@minus{}md5 , @minus{}@minus{}stdio_sync .
They work like the @command{xorriso} options with the
same name and hardcoded argument "on", e.g. -acl "on".
Explicit arguments are expected by @minus{}@minus{}stdio_sync
same name and hardcoded parameter "on", e.g. -acl "on".
Explicit parameters are expected by @minus{}@minus{}stdio_sync
and @minus{}@minus{}scdbackup_tag.
@*
The capability to preserve multi-session history on overwriteable media
gets disabled by default. It can be enabled by using @minus{}@minus{}emul-toc
with the first session. See -compliance no_emul_toc.
@*
@minus{}@minus{}sort-weight gets as arguments a number and an iso_rr_path.
@minus{}@minus{}sort-weight gets as parameters a number and an iso_rr_path.
The number becomes the LBA sorting weight of regular file iso_rr_path or
of all regular files underneath directory iso_rr_path.
(See -find -exec sort_weight).
@ -4561,7 +4562,7 @@ and "@strong{genisofs}" are aliases for "mkisofs".
If @command{xorriso} is started with one of the leafnames "xorrisofs",
"genisofs",
"mkisofs", or "genisoimage", then it performs -read_mkisofsrc and prepends
-as "genisofs" to the command line arguments.
-as "genisofs" to the program arguments.
I.e. all arguments will be interpreted mkisofs style until "@minus{}@minus{}"
is encountered.
From then on, options are interpreted as @command{xorriso} options.
@ -4611,7 +4612,7 @@ are aliases for "cdrecord".
@*
If @command{xorriso} is started with one of the leafnames "xorrecord",
"cdrskin", "cdrecord", or "wodim", then it automatically prepends -as "cdrskin"
to the command line arguments. I.e. all arguments will be interpreted cdrecord
to the program arguments. I.e. all arguments will be interpreted cdrecord
style until "@minus{}@minus{}" is encountered.
From then on, options are interpreted as @command{xorriso} options.
@*
@ -4677,7 +4678,7 @@ Program scdbackup_verify will recognize and verify tag resp. record.
@kindex -no_rc disables startup files
@cindex Process, disable startup files, -no_rc
@*
Only if used as first command line argument this option
Only if used as first program argument this option
prevents reading and interpretation of startup files. See section FILES below.
@c man .TP
@item -options_from_file fileaddress
@ -4685,7 +4686,7 @@ prevents reading and interpretation of startup files. See section FILES below.
@cindex Process, read command file, -options_from_file
Read quoted input from fileaddress and execute it like dialog lines.
Empty lines and lines which begin by # are ignored. Normally one line
should hold one @command{xorriso} command and all its arguments.
should hold one @command{xorriso} command and all its parameters.
Nevertheless lines may be concatenated by a trailing backslash.
@*
See also section "Command processing", paragraph "Quoted input".
@ -4857,7 +4858,7 @@ begin with "-" is used as path for a file to append the log lines.
@*
Problematic files can be recorded multiple times during one program run.
If the program run aborts then the list might not be complete because
some input file arguments might not have been processed at all.
some input files might not have been processed at all.
@*
The errfile paths are transported as messages of very low severity "ERRFILE".
This transport becomes visible with -report_about "ALL".
@ -4932,7 +4933,7 @@ a blank follows the payload text.
@*
Example:
@*
I:1: enter option and arguments :
I:1: enter option and parameters :
@c man .TP
@item -logfile channel fileaddress
@kindex -logfile logs output channels to file
@ -5086,7 +5087,7 @@ $ xorriso -outdev /dev/sr2 \
Note that '/pictures/*private*' is a pattern for iso_rr_paths
while pictures/confidential/work* gets expanded by the shell
with addresses from the hard disk. Options -add and -map have different
argument rules but finally the same effect: they put files into the image.
parameter rules but finally the same effect: they put files into the image.
@c man .SS
@c man .B A dialog session doing about the same
@c man .br