Changed xorriso.texi according to proposals by Tony Mancill
This commit is contained in:
@ -454,70 +454,71 @@ is among them.
|
||||
.br
|
||||
Commands 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 \fBlist delimiter\fR, or the end of argument list,
|
||||
or an end of an input line.
|
||||
is of variable length (indicated by "[...]" or "[***]") then it must be
|
||||
terminated by either the \fBlist delimiter\fR, occur at the end of
|
||||
the argument list, or occur at the end of an input line.
|
||||
.PP
|
||||
At program start the list delimiter is the word "\-\-".
|
||||
This may be changed by option \-list_delimiter in order to allow
|
||||
"\-\-" as parameter in a list of variable length.
|
||||
It is advised to reset the delimiter to "\-\-" immediately
|
||||
afterwards.
|
||||
At program start the list delimiter is the string "\-\-".
|
||||
This may be changed with the \-list_delimiter option in order to allow
|
||||
"\-\-" as parameter in a variable length list.
|
||||
However, it is advised to reset the delimiter to "\-\-"
|
||||
immediately afterwards.
|
||||
.br
|
||||
For brevity the list delimiter is referred as "\-\-"
|
||||
throughout this text.
|
||||
.br
|
||||
The list delimiter is silently tolerated if it appears after the parameters of
|
||||
The list delimiter is silently ignored 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 parameters of such a command.
|
||||
.PP
|
||||
\fBPattern expansion\fR
|
||||
converts a list of pattern words into a list of existing file addresses.
|
||||
Unmatched pattern words appear themselves in that result list, though.
|
||||
Unmatched pattern words will appear unaltered in that result list.
|
||||
.br
|
||||
Pattern matching supports the usual shell parser wildcards '*' '?' '[xyz]'
|
||||
and respects '/' as separator which may only be matched literally.
|
||||
and respects '/' as the path 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 may use pattern expansion all have variable parameter
|
||||
lists which are marked in this man page by "[***]" rather than "[...]".
|
||||
Pattern expansion is a property of some particular commands and not a general
|
||||
feature. It is controlled by commands \-iso_rr_pattern and \-disk_pattern.
|
||||
Commands which use pattern expansion all have variable parameter
|
||||
lists which are specified in this text by "[***]" rather than "[...]".
|
||||
.br
|
||||
Some other commands perform pattern matching unconditionally.
|
||||
.PP
|
||||
Command and parameter words are either read from program arguments, where one
|
||||
argument is one word, or from quoted input lines where words are recognized
|
||||
Command and parameter words are either read from the program arguments, where
|
||||
one argument is one word, or from quoted input lines where words are recognized
|
||||
similar to the quotation rules of a shell parser.
|
||||
.br
|
||||
\fBxorriso\fR is not a shell, although it might appear so on first glimpse.
|
||||
\fBxorriso\fR is not a shell, although it might appear so at first glimpse.
|
||||
Be aware that the interaction of quotation marks and pattern symbols like "*"
|
||||
differs from the usual shell parsers. In \fBxorriso\fR, a quotation mark
|
||||
does not make a pattern symbol literal.
|
||||
.PP
|
||||
\fBQuoted input\fR
|
||||
converts whitespace separated text pieces into words.
|
||||
converts whitespace\-separated text into words.
|
||||
The double quotation mark " and the single quotation mark ' can be used to
|
||||
enclose whitespace and make it part of words (e.g. of file names). Each mark
|
||||
type can enclose the marks of the other type. A trailing backslash \\ outside
|
||||
quotations or an open quotation cause the next input line to be appended.
|
||||
.br
|
||||
Quoted input accepts any ASCII character except NUL (0) as content of quotes.
|
||||
Quoted input accepts any ASCII character except NUL (0) as the content of
|
||||
the quotes.
|
||||
Nevertheless it can be cumbersome for the user to produce those characters
|
||||
at all. Therefore quoted input and program arguments allow optional
|
||||
directly. Therefore quoted input and program arguments allow optional
|
||||
\fBBackslash Interpretation\fR
|
||||
which can represent all ASCII characters except NUL (0) by backslash codes
|
||||
which can represent all ASCII characters except NUL (0) via backslash codes
|
||||
as in $'...' of bash.
|
||||
.br
|
||||
It is not enabled by default. See option \-backslash_codes.
|
||||
This is not enabled by default. See option \-backslash_codes.
|
||||
.PP
|
||||
When the program starts then it first looks for argument \-no_rc. If this is
|
||||
not present then it looks for its startup files and
|
||||
reads their content as command input lines. Then it interprets
|
||||
the program arguments as commands and parameters. Finally it enters
|
||||
dialog mode if command \-dialog "on" was executed up to then.
|
||||
dialog mode if command \-dialog "on" has been executed by this point.
|
||||
.PP
|
||||
The program ends either by command \-end, or by the end of program arguments
|
||||
if not dialog was enabled up to that moment, or by a problem
|
||||
if dialog mode has not been enabled at that point, or by a problem
|
||||
event which triggers the threshold of command \-abort_on.
|
||||
.SS
|
||||
.B Dialog, Readline, Result pager:
|
||||
@ -526,39 +527,39 @@ Dialog mode prompts for a quoted input line, parses it into words, and performs
|
||||
them as commands with their parameters. It provides assisting services
|
||||
to make dialog more comfortable.
|
||||
.PP
|
||||
Readline is an enhancement for the input line. You may know it already from
|
||||
Readline is an enhancement for the input line. You may already know it from
|
||||
the bash shell. Whether it is available in \fBxorriso\fR depends on the
|
||||
availability
|
||||
of package readline\-dev at the time when \fBxorriso\fR was built from
|
||||
its sourcecode.
|
||||
.br
|
||||
It allows to move the cursor over the text in the line by help of the
|
||||
Leftward and the Rightward arrow key.
|
||||
Readline allows to move the cursor over the text in the line by help of the
|
||||
Left and the Right arrow keys.
|
||||
Text may be inserted at the cursor position. The Delete key removes the
|
||||
character under the cursor. Upward and Downward arrow keys navigate through
|
||||
character under the cursor. Up and Down arrow keys navigate through
|
||||
the history of previous input lines.
|
||||
.br
|
||||
See man readline
|
||||
for more info about libreadline.
|
||||
.PP
|
||||
Option \-page activates a built\-in result text pager which may be convenient in
|
||||
dialog. After an action has put out the given number of terminal lines,
|
||||
dialog mode. After an action has output the given number of terminal lines,
|
||||
the pager prompts the user for a line of input.
|
||||
.br
|
||||
An empty line lets \fBxorriso\fR resume work until the next page is put out.
|
||||
An empty line lets \fBxorriso\fR resume work until the next page is output.
|
||||
.br
|
||||
The single character "@" disables paging for the current action.
|
||||
.br
|
||||
"@@@", "x", "q", "X", or "Q" urge the current action to abort and suppress
|
||||
further result output.
|
||||
"@@@", "x", "q", "X", or "Q" request that the current action aborts and
|
||||
suppress further result output.
|
||||
.br
|
||||
Any other line will be interpreted as new dialog line. The current action
|
||||
is urged to abort. Afterwards, the input line is executed.
|
||||
Any other line input will be interpreted as new dialog line. The current action
|
||||
is requested to abort. Afterwards, the input line is executed.
|
||||
.PP
|
||||
Some actions apply paging to their info output, too.
|
||||
.br
|
||||
The urge to abort may or may not be obeyed by the current action. All actions
|
||||
try to abort as soon as possible.
|
||||
The request to abort may or may not be obeyed by the current action.
|
||||
All actions try to abort as soon as possible.
|
||||
.br
|
||||
.SH OPTIONS
|
||||
.br
|
||||
@ -576,35 +577,37 @@ sequence of commands which get performed exactly in the given order.
|
||||
This requires the user to write commands for desired settings before the
|
||||
commands which shall be influenced by those settings.
|
||||
.br
|
||||
Many other programs allow to hand over options as program arguments
|
||||
in an arbitrary sequence and perform settings and actions in a sequence
|
||||
of their own discretion. xorriso provides an option to enable such a behavior
|
||||
at the cost of losing freedom of expression.
|
||||
Many other programs support program arguments in an arbitrary ordering
|
||||
and perform settings and actions in a sequence at their own discretion.
|
||||
xorriso provides an option to enable such a behavior
|
||||
at the cost of loss of expressivity.
|
||||
.TP
|
||||
\fB\-x\fR
|
||||
Enable automatic sorting of program arguments to a sequence that most likely
|
||||
makes some sense. This command may be given at any position among the commands
|
||||
Enable automatic sorting of program arguments into a sequence that
|
||||
(most likely) is sensible.
|
||||
This command may be given at any position among the commands
|
||||
which are handed over as program arguments.
|
||||
.br
|
||||
It works only if it is given as program argument, and with a single dash.
|
||||
I.e. not in startup files, not with \-options_from_file, not in dialog mode,
|
||||
not as "x" and not as "\-\-x". It affects only the commands given
|
||||
as program arguments.
|
||||
Note: It works only if it is given as program argument and
|
||||
with a single dash (i.e. "\-x"). It will not work in startup files, nor with
|
||||
\-options_from_file, nor in dialog mode, nor as "x" and finally not as
|
||||
"\-\-x".
|
||||
It affects only the commands given as program arguments.
|
||||
.TP
|
||||
\fB\-list_arg_sorting\fR
|
||||
List all xorriso commands in the order which applies if option \-x is in effect.
|
||||
.br
|
||||
This list may also be helpful without \-x, for a user who ponders over the
|
||||
sequence in which to put commands. Deviations from the sorting order may
|
||||
This list may also be helpful without \-x for a user who ponders over the
|
||||
sequence in which to put commands. Deviations from the listed sorting order may
|
||||
well make sense, though.
|
||||
.PP
|
||||
.TP
|
||||
.B Aquiring source and target drive:
|
||||
.B Acquiring source and target drive:
|
||||
.PP
|
||||
The effect of aquiring a drive may depend on several options in the
|
||||
The effect of acquiring a drive may depend on several options in the
|
||||
next paragraph "Influencing the behavior of image loading".
|
||||
If desired, their enabling commands have to be performed before the
|
||||
commands which aquire the drive.
|
||||
commands which acquire the drive.
|
||||
.TP
|
||||
\fB\-dev\fR address
|
||||
Set input and output drive to the same address and load an ISO image if it
|
||||
@ -620,7 +623,7 @@ Special address string "\-" means standard output, to which several restrictions
|
||||
apply. See above paragraph "Libburn drives".
|
||||
.br
|
||||
An empty address string "" gives up the current device
|
||||
without aquiring a new one.
|
||||
without acquiring a new one.
|
||||
.TP
|
||||
\fB\-indev\fR address
|
||||
Set input drive and load an ISO image if present.
|
||||
@ -644,7 +647,7 @@ Special address string "\-" means standard output, to which several restrictions
|
||||
apply. See above paragraph "Libburn drives".
|
||||
.br
|
||||
An empty address string "" gives up the current output drive
|
||||
without aquiring a new one. No writing is possible without an output drive.
|
||||
without acquiring a new one. No writing is possible without an output drive.
|
||||
.TP
|
||||
\fB\-grow_blindly\fR "off"|predicted_nwa
|
||||
If predicted_nwa is a non\-negative number then perform blind growing rather
|
||||
@ -664,7 +667,7 @@ begins. The output drive is given up when writing is done.
|
||||
.B Influencing the behavior of image loading:
|
||||
.PP
|
||||
The following options should normally be performed before loading an image
|
||||
by aquiring an input drive. In rare cases it is desirable to activate
|
||||
by acquiring an input drive. In rare cases it is desirable to activate
|
||||
them only after image loading.
|
||||
.TP
|
||||
\fB\-load\fR entity id
|
||||
@ -700,7 +703,7 @@ for which the image was prepared. This affects only loading of ISO images
|
||||
and reading of their files. The multi\-session method of growing is not allowed
|
||||
as long as \-displacement is non\-zero. I.e. \-indev and \-outdev must be
|
||||
different. The displacement gets reset to 0 before the drive
|
||||
gets re\-aquired after writing.
|
||||
gets re\-acquired after writing.
|
||||
.br
|
||||
Examples:
|
||||
.br
|
||||
@ -910,7 +913,7 @@ can hamper reading of partly damaged media. Setting "off:emul_off" disables
|
||||
the elsewise trustworthy table\-of\-content scan for those media.
|
||||
.br
|
||||
To be in effect, the \-rom_toc_scan setting has to be made before the \-*dev
|
||||
command which aquires drive and medium.
|
||||
command which acquires drive and medium.
|
||||
.TP
|
||||
\fB\-calm_drive\fR "in"|"out"|"all"|"revoke"|"on"|"off"
|
||||
Reduce drive noise until it is actually used again. Some drives stay alert
|
||||
@ -2153,7 +2156,7 @@ and eventually override the list of other speed offers.
|
||||
Try to close the upcomming track and session if the drive reported the medium
|
||||
as damaged. This may apply to CD\-R, CD\-RW, DVD\-R, DVD\-RW, DVD+R, DVD+R DL,
|
||||
or BD\-R media. It is indicated by warning messages when the drive gets
|
||||
aquired, and by a remark "but next track is damaged" with the line
|
||||
acquired, and by a remark "but next track is damaged" with the line
|
||||
"Media status :" of command \-toc.
|
||||
.br
|
||||
The setting of option \-close determines whether the medium stays appendable.
|
||||
@ -3922,7 +3925,7 @@ The scope is only a single data track per session to be written
|
||||
to blank, overwriteable, or appendable media. The medium gets closed if
|
||||
closing is applicable and not option \-multi is present.
|
||||
.br
|
||||
If an input drive was aquired, then it is given up.
|
||||
If an input drive was acquired, then it is given up.
|
||||
This is only allowed if no image changes are pending.
|
||||
.br
|
||||
dev= must be given as \fBxorriso\fR device address. Addresses like 0,0,0
|
||||
@ -4269,7 +4272,7 @@ $ xorriso \-device_links
|
||||
2 \-dev '/dev/cdrw3' rwrw\-\- : 'HL\-DT\-ST' 'BDDVDRW_GGC\-H20L'
|
||||
.SS
|
||||
.B Blank medium and compose a new ISO image as batch run
|
||||
Aquire drive /dev/sr2, make medium ready for writing a new image,
|
||||
Acquire drive /dev/sr2, make medium ready for writing a new image,
|
||||
fill the image with the files from hard disk directories /home/me/sounds
|
||||
and /home/me/pictures.
|
||||
.br
|
||||
@ -4404,7 +4407,7 @@ $ xorriso \-dev /dev/sr2 \\
|
||||
.SS
|
||||
.B Copy modified ISO image from one medium to another
|
||||
Load image from input drive. Do the same manipulations as in the previous
|
||||
example. Aquire output drive and blank it. Burn the modified image as
|
||||
example. Acquire output drive and blank it. Burn the modified image as
|
||||
first and only session to the output drive.
|
||||
.br
|
||||
$ xorriso \-indev /dev/sr2 \\
|
||||
|
||||
Reference in New Issue
Block a user