New command -modesty_on_drive, new -as cdrecord -immed, minbuf=, modesty_on_drive=

This commit is contained in:
2015-07-31 16:23:08 +00:00
parent a29ed10c14
commit e65ab7648a
16 changed files with 2936 additions and 2722 deletions

View File

@ -9,7 +9,7 @@
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH XORRISO 1 "Version 1.4.1, Mai 17, 2015"
.TH XORRISO 1 "Version 1.4.1, Jul 30, 2015"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@ -216,7 +216,7 @@ for \fBxorriso\fR.
.br
Closed is the state of DVD\-ROM media and of multi\-session media which were
written with command \-close on. If the drive is read\-only hardware then it will
probably show any media as closed CD\-ROM resp. DVD\-ROM.
probably show any media as closed CD\-ROM or DVD\-ROM.
.br
Overwriteable media assume this state in such read\-only drives or if they
contain unrecognizable data in the first 32 data blocks.
@ -778,7 +778,7 @@ If an ISO image was written onto a partition with offset of 640000 blocks of
512 bytes, then it can be loaded from the base device by \-displacement 160000.
.br
In both cases, the ISO sessions should be self contained, i.e. not add\-on
sessions to an ISO image outside their track resp. partition.
sessions to an ISO image outside their track or partition.
.TP
\fB\-drive_class\fR "harmless"|"banned"|"caution"|"clear_list" disk_pattern
Add a drive path pattern to one of the safety lists or make those lists empty.
@ -991,7 +991,8 @@ for substantial time after they have been used for reading. This reduces
the startup time for the next drive operation but can be loud and waste
energy if no i/o with the drive is expected to happen soon.
.br
Modes "in", "out", "all" immediately calm down \-indev, \-outdev, resp. both.
Modes "in", "out", "all" immediately calm down \-indev, \-outdev, or both,
respectively.
Mode "revoke" immediately alerts both.
Mode "on" causes \-calm_drive to be performed automatically after each \-dev,
\-indev, and \-outdev. Mode "off" disables this.
@ -1121,7 +1122,7 @@ as files to add, if they are not parameters to appropriate commands.
\fB\-path_list\fR disk_path
Like \-add but read the parameter words from file disk_path
or standard input if disk_path is "\-".
The list must contain exactly one pathspec resp. disk_path pattern per line.
The list must contain exactly one pathspec or disk_path pattern per line.
.TP
\fB\-quoted_path_list\fR disk_path
Like \-path_list but with quoted input reading rules. Lines get split into
@ -1248,7 +1249,7 @@ In case of collision merge directories with existing ones, but do not overwrite
existing ISO file objects.
.br
The rules for generating the copy addresses are the same as with
command \-cpr (see above) resp. shell command cp \-r. Other than with \-cpr,
command \-cpr (see above) or 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
@ -1333,7 +1334,7 @@ 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 parameter for \-not_paths resp. \-not_leaf.
handled as one parameter for \-not_paths or \-not_leaf.
.TP
\fB\-follow\fR occasion[:occasion[...]]
Enable or disable resolution of symbolic links and mountpoints under
@ -1426,7 +1427,7 @@ 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.
only if they are smaller than 2 GiB or in other cases 4 GiB.
.br
Default is 0 which will exclude files larger than \-file_size_limit by a
FAILURE event.
@ -1558,8 +1559,8 @@ ACL entries are separated by comma or newline. If an entry is empty text or
begins with "#" then it will be ignored. A valid entry has to begin
by a letter out of {ugom} for "user", "group", "other", "mask". It has to
contain two colons ":". A non\-empty text between those ":" gives a user id
resp. group id. After the second ":" there may be letters out of {rwx\- #}.
The first three give read, write resp. execute permission.
or group id. After the second ":" there may be letters out of {rwx\- #}.
The first three give read, write, or execute permission.
Letters "\-", " " and TAB are ignored. "#" causes the rest of the entry to
be ignored. Letter "X" or any other letters are not supported. Examples:
.br
@ -1812,7 +1813,7 @@ All applicable \-compliance rules are taken into respect.
Rule "omit_version" is always enabled, because else
namespaces "joliet" and "ecma119" would cause changes with every
non\-directory name.
Consider to also enable rules "no_force_dots" resp. "no_j_force_dots".
Consider to also enable rules "no_force_dots" and "no_j_force_dots".
.br
The namespaces use different character sets and apply further restrictions
to name length, permissible characters, and mandatory name components.
@ -1840,7 +1841,7 @@ If this test is reached then the evaluation ends immediately and action
is performed if the decision is "yes" or "true". See operator \-if.
.br
\fB\-true\fR and \fB\-false\fR :
Always match resp. match not. Evaluation goes on.
Always match or match not, respectively. Evaluation goes on.
.br
\fB\-sort_lba\fR :
Always match. This causes \-find to perform its action in a sequence sorted by
@ -2288,7 +2289,7 @@ burn programs but you may well try some of those listed below
under SEE ALSO.
.TP
\fB\-eject\fR "in"|"out"|"all"
Eject the medium in \-indev, resp. \-outdev, resp. both drives.
Eject the medium in \-indev, \-outdev, or both drives, respectively.
Note: It is not possible yet to effectively eject disk files.
.TP
\fB\-commit_eject\fR "in"|"out"|"all"|"none"
@ -2424,9 +2425,9 @@ Only if the drive reports contradicting speed information there will appear
\-speed 0, if it deviates from "Write speed H".
.br
"Read speed L" and "Read speed H" tell the minimum and maximum read speeds,
as reported by the drive. They would be chosen by \-read_speed "min" resp.
"max" if they undercut resp. surpass the built\-in limits. These are "1x"
resp. "52xCD", "24xDVD", "20xBD".
as reported by the drive. They would be chosen by \-read_speed "min" or
"max" if they undercut or surpass the built\-in limits. These are "1x",
"52xCD", "24xDVD", "20xBD".
.TP
\fB\-close_damaged\fR "as_needed"|"force"
Try to close the upcomming track and session if the drive reported the medium
@ -2445,7 +2446,8 @@ No image changes are allowed to be pending before this command is performed.
After closing was attempted, both drives are given up.
.TP
\fB\-list_profiles\fR "in"|"out"|"all"
Put out a list of media types supported by \-indev, resp. \-outdev, resp. both.
Put out a list of media types supported by \-indev, \-outdev, or both,
respectively.
The currently recognized type is marked by text "(current)".
.TP
.B Settings for result writing:
@ -2837,6 +2839,44 @@ or BD media. A number of 64 KB may improve throughput with bus systems which
show latency problems. The default depends on media type, on command
\-stream_recording , and on compile time options.
.TP
\fB\-modesty_on_drive\fR parameter[:parameters]
Control whether the drive buffer shall be kept from getting completely filled.
Parameter "on" (or "1") keeps the program from trying to write to the burner
drive while its buffer is in danger to be filled over a given limit.
If this limit is exceeded then the program will wait until the filling
reaches a given low percentage value.
.br
This can ease the load on operating system and drive controller and thus help
with achieving better input bandwidth if disk and burner are not on independent
controllers (like hda and hdb). It may also help with simultaneous burns on
different burners with Linux kernels like 3.16. On the other hand it increases
the risk of buffer underflow and thus reduced write speed.
.br
Some burners are not suitable because they
report buffer fill with granularity too coarse in size or time,
or expect their buffer to be filled to the top before they go to full speed.
.br
Parameters "off" or "0" disable this feature.
.br
The threshhold for beginning to wait is given by parameter "max_percent=".
Parameter "min_percent=" defines the threshhold for resuming transmission.
Percentages are permissible in the range of 25 to 100. Numbers in this
range without a prepended name are interpreted as "on:min_percent=".
.br
E.g.: \-modesty_on_drive 75
.br
The optimal values depend on the buffer behavior of the drive.
.br
There are also timing parameters "timeout_sec=", "min_usec=", "max_usec=".
Read the description of burn_drive_set_buffer_waiting() in libburn.h,
before setting them to non\-default values.
.br
Parameters, which are not mentioned with a \-modesty_on_drive command,
stay unchanged.
Default is:
.br
\-modesty_on_drive off:min_percent=65:max_percent=95
.TP
\fB\-stdio_sync\fR "on"|"off"|"end"|number
Set the number of bytes after which to force output to stdio: pseudo drives.
This forcing keeps the memory from being clogged with lots of
@ -3306,8 +3346,8 @@ This is mutually exclusive with production of other boot blocks like MBR.
.br
\fBmips_discard\fR, \fBsparc_discard\fR, \fBhppa_discard\fR,
\fBalpha_discard\fR
revoke any boot file declarations made for mips, mipsel, sparc, hppa,
resp. alpha.
revoke any boot file declarations made for mips/mipsel, sparc, hppa,
or alpha, respectively.
This removes the ban on production of other boot blocks.
.br
\fBhfsplus_serial=\fRhexstring sets a string of 16 digits "0" to "9"
@ -3726,7 +3766,7 @@ before ending the program.
With setting "tree" the reassuring prompt will appear for an eventual
directory only once and not for each file in its whole subtree.
.br
Setting "off" silently kills any kind of image file object resp. performs
Setting "off" silently kills any kind of image file object and performs
above irrevocable actions.
.br
To really produce user prompts, command \-dialog needs to be set to "on".
@ -3842,7 +3882,7 @@ address.
"%sbsector%" will be substituted by the session start sector.
.br
"%track%", "%session%", "%volid%" will be substituted by track number,
session number, resp. volume id of the depicted session.
session number, or volume id of the depicted session.
.TP
\fB\-print_size\fR
Print the foreseeable consumption of 2048 byte blocks
@ -3966,8 +4006,8 @@ File type 'e' indicates the El Torito boot catalog.
.br
If the file has non\-trivial ACL, then a '+' is appended to the permission info.
If the file is hidden, then 'I' for "iso_rr", 'J' for "joliet", 'A'
for "hfsplus", resp. 'H' for multiple hiding gets appended.
Together with ACL it is 'i', 'j', 'a', resp. 'h'.
for "hfsplus", 'H' for multiple hiding gets appended.
Together with ACL it is 'i', 'j', 'a', 'h'.
.TP
\fB\-lsdl\fR iso_rr_pattern [***]
Like \-lsd but also list some of the file attributes.
@ -4578,7 +4618,7 @@ commands \-mkdir, \-cp_clone, \-find update_merge, and \-find rm_merge.
\-root and \-old\-root set command \-disk_dev_ino to "ino_only" and \-md5 to "on",
by default.
\-disk_dev_ino can be set to "off" by \-\-old\-root\-no\-ino
resp. to "on" by \-\-old\-root\-devno .
or to "on" by \-\-old\-root\-devno .
\-md5 can be set to "off" by \-\-old\-root\-no\-md5 .
.br
Not original mkisofs options are \-\-quoted_path_list ,
@ -4741,7 +4781,7 @@ character device.
If list_path is not empty then the record will also be appended to the
data file given by this path.
.br
Program scdbackup_verify will recognize and verify tag resp. record.
Program scdbackup_verify will recognize and verify tag and file record.
.TP
.B Scripting, dialog and program control features:
.TP
@ -4886,7 +4926,7 @@ result and info channel. An empty text will cause no output at all.
\fB\-prompt\fR text
Show text at beginning of output line and
wait for the user to hit the Enter key
resp. to send a line via stdin.
or to send a line via stdin.
.TP
\fB\-sleep\fR seconds
Wait for the given number of seconds before perfoming the next command.
@ -4916,7 +4956,7 @@ 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.
(on GNU/Linux) or \-s (on FreeBSD) from date or volume ID.
.br
Record format is: timestamp start_lba size volume\-id
.br
@ -5115,7 +5155,7 @@ or be "\-" to leave the according standard i/o channel unreplaced.
.br
xorriso will open the stdin pipe, read and execute dialog lines from it
until the sender closes the pipe. The output pipes get opened depending on
mode "buffered" resp. "direct". After all lines are executed, xorriso will
mode "buffered" or "direct". After all lines are executed, xorriso will
close its side of the pipes and enter a new cycle of opening, reading and
executing.
.br
@ -5602,7 +5642,7 @@ sums against the current file content on hard disk. This is usually much faster
than the default which compares both contents directly.
.br
With \fBmount\fR option \fB\-o "sbsector="\fR on GNU/Linux
resp. \fB\-s\fR on FreeBSD or NetBSD
or \fB\-s\fR on FreeBSD or NetBSD
it is possible to access the session trees which represent the older backup
versions. With CD media, GNU/Linux mount accepts session numbers directly by
its option "session=".
@ -5690,7 +5730,7 @@ $ xorriso \-abort_on NEVER \-indev /dev/sr0 \\
This can be repeated several times, if necessary with \-eject or with other
\-indev drives. See the human readable part of "$HOME"/dvd_copy.map for
addresses which can be used on "$HOME"/dvd_copy with mount option \-o sbsector=
resp. \-s.
or \-s.
.SH FILES
.SS
.B Program alias names:
@ -5775,7 +5815,7 @@ please send electronic mail to the public list <bug\-xorriso@gnu.org>.
If more privacy is desired, mail to <scdbackup@gmx.net>.
.br
Please describe what you expect \fBxorriso\fR to do,
the program arguments resp. commands by which you tried to achieve it,
the program arguments or dialog commands by which you tried to achieve it,
the messages of \fBxorriso\fR, and the undesirable outcome of your
program run.
.br