From c6869a0925a0bf3e06920081aa61b9510ad6331d Mon Sep 17 00:00:00 2001 From: Thomas Schmitt Date: Mon, 5 Mar 2012 12:13:37 +0000 Subject: [PATCH] Revised the use of "option" and "ASCII" in xorriso.texi --- xorriso/man_xorriso_to_html.sh | 2 +- xorriso/xorriso.1 | 214 +++++++------- xorriso/xorriso.info | 515 +++++++++++++++++---------------- xorriso/xorriso.texi | 220 +++++++------- 4 files changed, 480 insertions(+), 471 deletions(-) diff --git a/xorriso/man_xorriso_to_html.sh b/xorriso/man_xorriso_to_html.sh index 14953732..c7c70566 100755 --- a/xorriso/man_xorriso_to_html.sh +++ b/xorriso/man_xorriso_to_html.sh @@ -86,7 +86,7 @@ then -e 's/Navigation in ISO image/\ 
<\/A>Navigation in ISO image/' \ -e 's/^filesystem:<\/b>/filesystem:<\/b>
\ 
/' \ -e 's/Evaluation of readability and recovery:<\/b>/\ 
<\/A>Evaluation of readability and recovery:<\/b>
\ 
/' \ - -e 's/osirrox ISO-to-disk restore options:<\/b>/\ 
<\/A>osirrox ISO-to-disk restore options:<\/b>
\ 
/' \ + -e 's/osirrox ISO-to-disk restore commands:<\/b>/\ 
<\/A>osirrox ISO-to-disk restore commands:<\/b>
\ 
/' \ -e 's/Command compatibility emulations:<\/b>/\ 
<\/A>Command compatibility emulations:<\/b>
\ 
/' \ -e 's/^

−as\ 
\−asScripting, dialog and/\ 
<\/A>Scripting, dialog and/' \ diff --git a/xorriso/xorriso.1 b/xorriso/xorriso.1 index b2cff449..216f1807 100644 --- a/xorriso/xorriso.1 +++ b/xorriso/xorriso.1 @@ -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.2.1, Feb 03, 2012" +.TH XORRISO 1 "Version 1.2.1, Feb 05, 2012" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -169,11 +169,11 @@ There are two families of media in the MMC standard: .br \fBMulti\-session media\fR are CD\-R, CD\-RW, DVD\-R, DVD+R, DVD+R/DL, BD\-R, and unformatted DVD\-RW. These media provide a table of content which -describes their existing sessions. See option \fB\-toc\fR. +describes their existing sessions. See command \fB\-toc\fR. .br Similar to multi\-session media are DVD\-R DL and minimally blanked DVD\-RW. They allow only a single session of which the size must be known in advance. -\fBxorriso\fR will write onto them only if option \-close is set to "on". +\fBxorriso\fR will write onto them only if command \-close is set to "on". .br \fBOverwriteable media\fR are DVD\-RAM, DVD+RW, BD\-RE, and formatted DVD\-RW. They allow random write access but do not provide information about their @@ -204,13 +204,13 @@ media, or to apply mandatory formatting to new media if necessary. multi\-session media in appendable state, or they are overwriteable media which contain an ISO image suitable for \fBxorriso\fR. .br -Appendable is the state after writing a session with option \-close off. +Appendable is the state after writing a session with command \-close off. .br \fBClosed\fR media cannot be written. They may contain an ISO image suitable for \fBxorriso\fR. .br Closed is the state of DVD\-ROM media and of multi\-session media which were -written with option \-close on. If the drive is read\-only hardware then it will +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. .br Overwriteable media assume this state in such read\-only drives or if they @@ -218,14 +218,14 @@ contain unrecognizable data in the first 32 data blocks. .br Read\-only drives may or may not show session histories of multi\-session media. Often only the first and the last session are visible. Sometimes -not even that. Option \-rom_toc_scan might or might not help in such cases. +not even that. Command \-rom_toc_scan might or might not help in such cases. .SS .B Creating, Growing, Modifying, Blind Growing: .br A new empty ISO image gets \fBcreated\fR if there is no input drive with a valid ISO 9660 image when the first time -an output drive is defined. This is achieved by option \-dev on blank media -or by option \-outdev on media in any state. +an output drive is defined. This is achieved by command \-dev on blank media +or by command \-outdev on media in any state. .br The new empty image can be populated with directories and files. Before it can be written, the medium in the output drive must get into @@ -242,7 +242,7 @@ ISO 9660 + Rock Ridge directory tree. It is possible to hide files from previous sessions but they still exist on the medium and with many types of optical media it is quite easy to recover them by mounting older sessions. .br -Growing is achieved by option \-dev. +Growing is achieved by command \-dev. .PP The write method of \fBmodifying\fR produces compact filesystem images with no outdated files or directory trees. Modifying can write its @@ -256,10 +256,10 @@ So for this method one needs either two optical drives or has to work with filesystem objects as source and/or target medium. .br Modifying takes place if input drive and output drive are not the same and -if option \-grow_blindly is set to its default "off". -This is achieved by options \-indev and \-outdev. +if command \-grow_blindly is set to its default "off". +This is achieved by commands \-indev and \-outdev. .PP -If option \-grow_blindly is set to a non\-negative number and if \-indev and +If command \-grow_blindly is set to a non\-negative number and if \-indev and \-outdev are both set to different drives, then \fBblind growing\fR is performed. It produces an add\-on session which is ready for being written to the given block address. This is the usage model of @@ -354,13 +354,13 @@ device by using its path with the "stdio:" prefix. By default any address in the /dev tree without prefix "stdio:" will work only if it leads to a MMC drive. .br -One may use option +One may use command \fB\-ban_stdio_write\fR to surely prevent this risk and to allow only MMC drives. .br One may prepend "mmc:" to a path to surely disallow any automatic "stdio:". .br -By option \-drive_class one may ban certain paths or allow access without +By command \-drive_class one may ban certain paths or allow access without prefix "stdio:" to other paths. .SS .B Rock Ridge, POSIX, X/Open, El Torito, ACL, xattr: @@ -387,7 +387,7 @@ The content of the boot image files is not in the scope of El Torito. .br Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images. \fBxorriso\fR is able to create or maintain an El Torito object which -makes such an image bootable. For details see option \-boot_image. +makes such an image bootable. For details see command \-boot_image. .br It is possible to make ISO images bootable from USB stick or other hard\-disk\-like media by \-boot_image parameter system_area= . This installs @@ -409,7 +409,7 @@ EFI, MIPS Big Endian (SGI), MIPS Little Endian (DEC), SUN SPARC. are an advanced way of controlling access permissions to file objects. Neither ISO 9660 nor Rock Ridge specify a way to record ACLs. So libisofs has introduced a standard conformant extension named AAIP for that purpose. -It uses this extension if enabled by option +It uses this extension if enabled by command \fB\-acl\fR. .br AAIP enhanced images are supposed to be mountable normally, but one cannot @@ -434,7 +434,7 @@ pairs which have names out of the user namespace. I.e. those which begin with "user.", like "user.x" or "user.whatever". Name has to be a 0 terminated string. Value may be any array of bytes which does not exceed the size of 4095 bytes. -xattr processing happens only if it is enabled by option +xattr processing happens only if it is enabled by command \fB\-xattr\fR. .br As with ACL, currently only \fBxorriso\fR is able to retrieve xattr @@ -448,7 +448,7 @@ only on GNU/Linux and FreeBSD, where they are known as extattr. .br Commands are either actions which happen immediately or settings which influence following actions. So their sequence does matter, unless they are -given as program arguments and option +given as program arguments and command \fB\-x\fR is among them. .br @@ -459,7 +459,7 @@ 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 string "\-\-". -This may be changed with the \-list_delimiter option in order to allow +This may be changed with the \-list_delimiter command in order to allow "\-\-" as parameter in a variable length list. However, it is advised to reset the delimiter to "\-\-" immediately afterwards. @@ -501,15 +501,15 @@ 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 the content of +Quoted input accepts any 8\-bit character except NUL (0) as the content of the quotes. Nevertheless it can be cumbersome for the user to produce those characters directly. Therefore quoted input and program arguments allow optional \fBBackslash Interpretation\fR -which can represent all ASCII characters except NUL (0) via backslash codes +which can represent all 8\-bit characters except NUL (0) via backslash codes as in $'...' of bash. .br -This is not enabled by default. See option \-backslash_codes. +This is not enabled by default. See command \-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 @@ -542,7 +542,7 @@ the history of previous input lines. See man readline for more info about libreadline. .PP -Option \-page activates a built\-in result text pager which may be convenient in +Command \-page activates a built\-in result text pager which may be convenient in dialog mode. After an action has output the given number of terminal lines, the pager prompts the user for a line of input. .br @@ -564,8 +564,8 @@ All actions try to abort as soon as possible. .SH OPTIONS .br All command words are shown with a leading dash although this dash is not -mandatory for the option to be recognized. Nevertheless within option \-as -the dashes of the emulated options are mandatory. +mandatory for the command to be recognized. Nevertheless within command \-as +the dashes of the emulated commands are mandatory. .br Normally any number of leading dashes is ignored with command words and inner dashes are interpreted as underscores. @@ -595,7 +595,8 @@ with a single dash (i.e. "\-x"). It will not work in startup files, nor with 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. +List all xorriso commands in the order which applies if command \-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 listed sorting order may @@ -604,7 +605,7 @@ well make sense, though. .TP .B Acquiring source and target drive: .PP -The effect of acquiring a drive may depend on several options in the +The effect of acquiring a drive may depend on several commands in the next paragraph "Influencing the behavior of image loading". If desired, their enabling commands have to be performed before the commands which acquire the drive. @@ -666,13 +667,13 @@ begins. The output drive is given up when writing is done. .TP .B Influencing the behavior of image loading: .PP -The following options should normally be performed before loading an image +The following commands should normally be performed before loading an image by acquiring an input drive. In rare cases it is desirable to activate them only after image loading. .TP \fB\-load\fR entity id Load a particular (possibly outdated) ISO session from \-dev or \-indev. -Usually all available sessions are shown with option \-toc. +Usually all available sessions are shown with command \-toc. .br entity depicts the kind of addressing. id depicts the particular address. The following entities are defined: @@ -758,7 +759,7 @@ 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. .br -This option does not hamper the creation of an empty image from blank +This command does not hamper the creation of an empty image from blank input media and does not discard an already loaded image. .TP \fB\-in_charset\fR character_set_name @@ -822,12 +823,12 @@ If enabled, then \fBxorriso\fR will obtain ACLs from disk file objects, store ACLs in the ISO image using the libisofs specific AAIP format, load AAIP data from ISO images, test ACL during file comparison, and restore ACLs to disk files when extracting them from ISO images. -See also options \-getfacl, \-setfacl. +See also commands \-getfacl, \-setfacl. .TP \fB\-xattr\fR "on"|"off" Enable or disable processing of xattr attributes in user namespace. If enabled, then \fBxorriso\fR will handle xattr similar to ACL. -See also options \-getfattr, \-setfattr and above paragraph about xattr. +See also commands \-getfattr, \-setfattr and above paragraph about xattr. .TP \fB\-md5\fR "on"|"all"|"off"|"load_check_off" Enable or disable processing of MD5 checksums for the overall session and for @@ -836,7 +837,7 @@ only if the tags of superblock and directory tree match properly. The MD5 checksums of data files and whole session get loaded from the image if there are any. .br -With options \-compare and \-update the recorded MD5 of a file +With commands \-compare and \-update the recorded MD5 of a file will be used to avoid content reading from the image. Only the disk file content will be read and compared with that MD5. This can save much time if \-disk_dev_ino "on" is not suitable. @@ -859,7 +860,7 @@ option \-M is performed. .br The test can be re\-enabled by mode "load_check_on". .br -Checksums can be exploited via options \-check_md5, \-check_md5_r, via find +Checksums can be exploited via commands \-check_md5, \-check_md5_r, via find actions get_md5, check_md5, and via \-check_media. .TP \fB\-for_backup\fR @@ -1052,7 +1053,7 @@ composed from disk_path by replacing disk_prefix by iso_rr_prefix. Compare file object disk_path with file object iso_rr_path. If they do not match, then perform the necessary image manipulations to make iso_rr_path a matching copy of disk_path. By default this comparison will imply lengthy -content reading before a decision is made. Options \-disk_dev_ino or \-md5 may +content reading before a decision is made. Commands \-disk_dev_ino or \-md5 may accelerate comparison if they were already in effect when the loaded session was recorded. .br @@ -1066,7 +1067,7 @@ addresses get compared whether they have counterparts below the other address and whether both counterparts match. If there is a mismatch then the necessary update manipulation is done. .br -Note that the comparison result may depend on option \-follow. Its setting +Note that the comparison result may depend on command \-follow. Its setting should always be the same as with the first adding of disk_path as iso_rr_path. .br If iso_rr_path does not exist yet, then it gets added. If disk_path does not @@ -1104,12 +1105,12 @@ E.g: .br /file/part_3_of_3_at_4094m_with_2047m_of_5753194821 .br -While option \-split_size is set larger than 0, and if all pieces of a file +While command \-split_size is set larger than 0, and if all pieces of a file reside in the same ISO directory with no other files, and if the names look like above, then their ISO directory will be recognized and handled like a -regular file. This affects options \-compare*, \-update*, and overwrite +regular file. This affects commands \-compare*, \-update*, and overwrite situations. -See option \-split_size for details. +See command \-split_size for details. .TP \fB\-cpr\fR disk_path [***] iso_rr_path Insert the given files or directory trees from filesystem @@ -1331,10 +1332,10 @@ 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 +While command \-split_size is set larger than 0 such a directory with split +file pieces will be recognized and handled like a regular file by commands \-compare* , \-update*, and in overwrite situations. There are \-ossirox -options "concat_split_on" and "concat_split_off" which control the handling +parameters "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 @@ -1386,7 +1387,7 @@ medium in modification mode. .TP \fB\-rm_r\fR iso_rr_path [***] Delete the given files or directory trees from the ISO image. -See also the note with option \-rm. +See also the note with command \-rm. .TP \fB\-rmdir\fR iso_rr_path [***] Delete empty directories. @@ -1489,7 +1490,7 @@ Only names from the user namespace are allowed. I.e. a name has to begin with "user.", like "user.x" or "user.whatever". .br Values and names undergo the normal input processing of \fBxorriso\fR. -See also option \-backslash_codes. Other than with option \-setfattr_list, +See also command \-backslash_codes. Other than with command \-setfattr_list, the byte value 0 cannot be expressed via \-setfattr. .TP \fB\-setfattr_r\fR [-]name value iso_rr_path [***] @@ -1514,7 +1515,7 @@ Name must be from user namespace. I.e. user.xyz where xyz should consist of printable characters only. The separator "=" is not allowed in names. Value may contain any kind of bytes. It must be in quotes. Trailing whitespace after the end quote will be ignored. Non\-printables bytes and quotes -must be represented as \\XYZ by their octal ASCII code XYZ. +must be represented as \\XYZ by their octal 8\-bit code XYZ. Use code \\000 for 0\-bytes. .TP \fB\-alter_date\fR type timestring iso_rr_path [***] @@ -1780,7 +1781,7 @@ prints access permissions in ACL text form to the result channel. .br \fBsetfacl\fR attaches ACLs after removing existing ones. The new -ACL is given in text form as defined with option \-setfacl. +ACL is given in text form as defined with command \-setfacl. .br E.g.: \-exec setfacl u:lisa:rw,u::rw,g::r,o::\-,m::rw \-\- .br @@ -1807,7 +1808,7 @@ Mode "b" prints backslash encoding. Not suitable for shell parsing. .br E.g. \-exec list_extattr e \-\- .br -Option \-backslash_codes does not affect the output. +Command \-backslash_codes does not affect the output. .br \fBget_md5\fR prints the MD5 sum, if recorded, together with file path. @@ -2014,7 +2015,7 @@ Switch to growing mode. are uncommitted manipulations pending. .br So, to perform a final write operation with no new \-dev -and no new loading of image, rather execute option \-end. +and no new loading of image, rather execute command \-end. If you want to go on without image loading, execute \-commit_eject "none". To eject after write without image loading, use \-commit_eject "all". .br @@ -2068,7 +2069,7 @@ but produces media which are only suitable for a single session. Some drives announce this state by not offering feature 21h, but some drives offer it anyway. If feature 21h is missing, then \fBxorriso\fR -will refuse to write on DVD\-RW if not option \-close is set to "on". +will refuse to write on DVD\-RW if not command \-close is set to "on". .br The progress reports issued by some drives while blanking are quite unrealistic. Do not conclude success or failure from the @@ -2090,7 +2091,7 @@ unformatted BD\-R. Other media are left untouched. .br "fast" does the same as "full" but tries to be quicker. .br -"by_index_" selects a format out of the descriptor list issued by option +"by_index_" selects a format out of the descriptor list issued by command \-list_formats. The index number from that list is to be appended to the mode word. E.g: "by_index_3". .br @@ -2159,7 +2160,7 @@ or BD\-R media. It is indicated by warning messages when the drive gets 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. +The setting of command \-close determines whether the medium stays appendable. .br Mode "as_needed" gracefully refuses on media which are not reported as damaged. Mode "force" attempts the close operation even with media which @@ -2175,7 +2176,7 @@ The currently recognized type is marked by text "(current)". .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. +ACLs will be written according to the setting of command \-acl. .TP \fB\-joliet\fR "on"|"off" If enabled by "on", generate Joliet tree additional to ISO 9660 + Rock Ridge @@ -2188,7 +2189,7 @@ cases it is worth to deviate a bit in order to circumvent bugs of the intended reader system or to get unofficial extra features. .br There are several adjustable rules which have a keyword each. If they -are mentioned with this option then their rule gets added to the relaxation +are mentioned with this command then their rule gets added to the relaxation list. This list can be erased by rules "strict" or "clear". It can be reset to its start setting by "default". All of the following relaxation rules can be revoked individually by appending "_off". Like "deep_paths_off". @@ -2223,11 +2224,12 @@ not 8.3. .br "lowercase" allows lowercase characters in ISO file names. .br -"full_ascii" allows all ASCII characters in ISO file names. +"full_ascii" allows all 8\-bit characters except 0x0 and '/' +in ISO file names. .br "untranslated_names" might be dangerous for inadverted reader programs which rely on the restriction to at most 37 characters in ISO file names. -This option allows ISO file names up to 96 characters with no character +This rule allows ISO file names up to 96 characters with no character conversion. If a file name has more characters, then image production will fail deliberately. .br @@ -2348,7 +2350,7 @@ It is supposed to match this GRUB line: .br E.g. 2010040711405800 is 7 Apr 2010 11:40:58 (+0 centiseconds). .br -Timestrings for the other types may be given as with option \-alter_date. +Timestrings for the other types may be given as with command \-alter_date. They are prone to timezone computations. The timestrings "default" or "overridden" cause default settings: "c" and "m" will show the current time of image creation. "x" and "f" will be marked as insignificant. @@ -2402,7 +2404,7 @@ Group id to be used for all files when the new ISO tree gets written to media. \fB\-zisofs\fR option[:options] Set global parameters for zisofs compression. This data format is recognized and transparently uncompressed by some Linux kernels. It is to be applied -via option \-set_filter with built\-in filter "\-\-zisofs". +via command \-set_filter with built\-in filter "\-\-zisofs". Parameters are: .br "level="[0\-9] zlib compression: 0=none, 1=fast,..., 9=slow @@ -2453,7 +2455,7 @@ written and writing of file content blocks begins. GNU/Linux specific: Set the number of bytes to be transmitted with each write operation to DVD 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 option +show latency problems. The default depends on media type, on command \-stream_recording , and on compile time options. .TP \fB\-stdio_sync\fR "on"|"off"|number @@ -2477,7 +2479,7 @@ which means unit is kiB (= 1024) or MiB (= 1024 kiB). If "on" then mark the written medium as not appendable any more (if possible at all with the given type of target media). .br -This is the contrary of cdrecord, wodim, cdrskin option \-multi, +This is the contrary of cdrecord, wodim, cdrskin command \-multi, and is one aspect of growisofs option \-dvd\-compat. .TP \fB\-padding\fR number["k"|"m"]|"included"|"appended" @@ -2727,7 +2729,7 @@ Only a single boot file can be declared by mipsel_path=. \fBsparc_label=\fRtext causes the production of a SUN Disk Label with the given text as ASCII label. This boot block format allows to append images for partitions 2 to 8. Partition 1 will always be the ISO image. -See option \-append_partition. +See command \-append_partition. The first 512 bytes of any data provided by system_area= will be overwritten. .br \fBmips_discard\fR and \fBsparc_discard\fR revoke any boot file @@ -2888,7 +2890,7 @@ convert byte codes. There is an input conversion from input character set to the local character set which applies when an ISO image gets loaded. A conversion from local character set to the output character set is performed when an -image tree gets written. The sets can be defined independently by options +image tree gets written. The sets can be defined independently by commands \-in_charset and \-out_charset. Normally one will have both identical, if ever. .br If conversions are desired then \fBxorriso\fR needs to know the name of the @@ -2904,7 +2906,7 @@ filesystem names and emerging names in the image. The situation stays ambigous and the reader has to riddle what character set was used. .br -By option \-auto_charset it is possible to attribute the output charset name +By command \-auto_charset it is possible to attribute the output charset name to the image. This makes the situation unambigous. But if your terminal character set does not match the character set of the local file names, then this attribute can become plainly wrong and cause problems at read time. @@ -2966,10 +2968,10 @@ Set the severity threshold for events to abort the program. Useful: "NEVER", "ABORT", "FATAL", "FAILURE" , "MISHAP", "SORRY" .br It may become necessary to abort the program anyway, despite -the setting by this option. Expect not many "ABORT" events to +the setting by this command. Expect not many "ABORT" events to be ignorable. .br -A special property of this option is that it works preemptive if given as +A special property of this command is that it works preemptive if given as program start argument. I.e. the first \-abort_on setting among the start arguments is in effect already when the first operations of \fBxorriso\fR begin. Only "\-abort_on" with dash "\-" is recognized that way. @@ -3008,7 +3010,7 @@ Event messages are sent to the info channel "I" which is usually stderr but may be influenced by command \-pkt_output. Info messages which belong to no event get attributed severity "NOTE". .br -A special property of this option is that the first \-report_about setting +A special property of this command is that the first \-report_about setting among the start arguments is in effect already when the first operations of \fBxorriso\fR begin. Only "\-report_about" with dash "\-" is recognized that way. @@ -3040,7 +3042,7 @@ kill \-9 then imposes the risk that the drive is left in unusable state and needs poweroff to be reset. So during burning, blanking, and formatting wait for at least their normal run time before killing externally. .br -A special property of this option is that the first \-signal_handling setting +A special property of this command is that the first \-signal_handling setting among the start arguments is in effect already when the first operations of \fBxorriso\fR begin. Only "\-signal_handling" with dash "\-" is recognized that way. @@ -3049,12 +3051,12 @@ recognized that way. Control the program behavior at problem event occasions. For now this applies to occasions "image_loading" which is given while an image tree is read from the input device, and to "file_extraction" which -is given with osirrox options like \-extract. +is given with osirrox commands like \-extract. .br With "image_loading" there are three behaviors available: .br "best_effort" goes on with reading after events with severity below FAILURE -if the threshold of option \-abort_on allows this. +if the threshold of command \-abort_on allows this. .br "failure" aborts image tree reading on first event of at least SORRY. It issues an own FAILURE event. @@ -3124,9 +3126,9 @@ directory only once and not for each file in its whole subtree. Setting "off" silently kills any kind of image file object resp. performs above irrevocable actions. .br -To really produce user prompts, option \-dialog needs to be set to "on". +To really produce user prompts, command \-dialog needs to be set to "on". Note that the prompt does not appear in situations where file removal -is forbidden by option \-overwrite. \-reassure only imposes an additional +is forbidden by command \-overwrite. \-reassure only imposes an additional curb for removing existing file objects. .br Be aware that file objects get deleted from the ISO image immediately @@ -3141,7 +3143,7 @@ Show list of available MMC drives with the addresses of their libburn standard device files. .br This is only possible when no ISO image changes are pending. -After this option was executed, there is no drive current +After this command was executed, there is no drive current and no image loaded. .br In order to be visible, a device has to offer rw\-permissions @@ -3177,7 +3179,7 @@ with only one or two sessions on it. The last of these sessions is supposed to be the most recent real session then. .br Some read\-only drives and media show no usable session history at all. -Option \-rom_toc_scan might help. +Command \-rom_toc_scan might help. .TP \fB\-mount_cmd\fR drive entity id path Emit an appropriate command line for mounting the ISO session @@ -3195,7 +3197,7 @@ as id. .br path will be used as mount point and must already exist as a directory on disk. .br -The command gets printed to the result channel. See option \-mount +The command gets printed to the result channel. See command \-mount for direct execution of this command. .TP \fB\-mount_opts\fR option[:option...] @@ -3228,9 +3230,9 @@ session number, resp. volume id of the depicted session. \fB\-print_size\fR Print the foreseeable consumption of 2048 byte blocks by next \-commit. This can last a while as a \-commit gets -prepared and only in last moment is revoked by this option. +prepared and only in last moment is revoked by this command. The result depends on several settings and also on the kind of output device. -If no \-jidgo options are given and not command \-as "mkisofs" was used, +If no \-jidgo options are set and not command \-as "mkisofs" was used, then \-padding (300 kB by default) is not counted as part of the image size. .TP \fB\-tell_media_space\fR @@ -3239,7 +3241,7 @@ subtracting already foreseeable consumption by next \-commit. .TP \fB\-pvd_info\fR Print various id strings which can be found in loaded ISO images. Some of -them may be changed by options like \-volid or \-publisher. For these +them may be changed by commands like \-volid or \-publisher. For these ids \-pvd_info reports what would be written with the next \-commit. .TP .B Navigation in ISO image and disk filesystem: @@ -3318,7 +3320,7 @@ Output format resembles shell command ls \-dln. Print the access permissions of the given files in the ISO image using the format of shell command getfacl. If a file has no ACL then it gets fabricated from the \-chmod settings. A file may have a real ACL if it was introduced into -the ISO image while option \-acl was set to "on". +the ISO image while command \-acl was set to "on". .TP \fB\-getfacl_r\fR iso_rr_pattern [***] Like \-gefacl but listing recursively the whole file trees underneath eventual @@ -3461,7 +3463,7 @@ according to their read speed, save them to a file, and keep track of successfuly saved blocks for further tries on the same medium. .br -By option \-md5 checksums may get recorded with data files and whole +By command \-md5 checksums may get recorded with data files and whole sessions. These checksums are reachable only via indev and a loaded image. They work independently of the media type and can detect transmission errors. .TP @@ -3470,9 +3472,9 @@ Try to read data blocks from the indev drive, optionally copy them to a disk file, and finally report about the encountered quality. Several options may be used to modify the default behavior. .br -The options given with this command override the default settings which -may have been changed by option \-check_media_defaults. See there for a -description of options. +The parameters given with this command override the default settings which +may have been changed by command \-check_media_defaults. See there for a +description of available options. .br The result list tells intervals of 2 KiB blocks with start address, number of blocks and quality. Qualities which begin with "+" are @@ -3618,10 +3620,10 @@ This gets rounded down to full blocks of 2048 bytes. 0 means automatic size. Compare the data content of the given files in the loaded image with their recorded MD5 checksums, if there are any. In case of any mismatch an event of the given severity is issued. It may then be handled by appropriate settings of -options \-abort_on or \-return_with which both can cause non\-zero exit values +commands \-abort_on or \-return_with which both can cause non\-zero exit values of the program run. Severity ALL suppresses that event. .br -This option reports match and mismatch of data files to the result channel. +This command reports match and mismatch of data files to the result channel. Non\-data files cause NOTE events. There will also be UPDATE events from data reading. .br @@ -3633,7 +3635,7 @@ if there are older sessions. Like \-check_md5 but checking all data files underneath the given paths. Only mismatching data files will be reported. .TP -.B osirrox ISO-to-disk restore options: +.B osirrox ISO-to-disk restore commands: .PP Normally \fBxorriso\fR only writes to disk files which were given as stdio: pseudo\-drives or as log files. @@ -3759,7 +3761,7 @@ ownership and group as in ISO image. \fB\-paste_in\fR iso_rr_path disk_path byte_offset byte_count Read the content of a ISO data file and write it into a data file on disk beginning at the byte_offset. Write at most byte_count bytes. -This is the inverse of option \-cut_out. +This is the inverse of command \-cut_out. .TP \fB\-mount\fR drive entity id path Produce the same line as \-mount_cmd and then execute it as external program run @@ -3807,7 +3809,7 @@ persists until things happen like \-commit, \-rollback, \-dev, or end of \-pacifier gets set to "mkisofs" if files are added to the image. .br \-graft\-points is equivalent to \-pathspecs on. Note that pathspecs without "=" -are interpreted differently than with \fBxorriso\fR option \-add. +are interpreted differently than with \fBxorriso\fR command \-add. Directories get merged with the root directory of the ISO image, other filetypes get mapped into that root directory. @@ -3816,7 +3818,7 @@ If pathspecs are given and if no output file was chosen before or during the "mkisofs" option list, then standard output (\-outdev "\-") will get into effect. If \-o points to a regular file, then it will be truncated to 0 bytes when finally writing begins. This truncation does not happen if the drive -is chosen by \fBxorriso\fR options before \-as mkisofs or after its +is chosen by \fBxorriso\fR commands before \-as mkisofs or after its list delimiter. Directories and symbolic links are no valid \-o targets. .br Writing to stdout is possible only if \-as "mkisofs" was among the start @@ -3845,7 +3847,7 @@ resp. to "on" by \-\-old\-root\-devno . Not original mkisofs options are \-\-quoted_path_list , \-\-hardlinks , \-\-acl , \-\-xattr , \-\-md5 , \-\-stdio_sync . -They work like the \fBxorriso\fR options with the +They work like the \fBxorriso\fR commands with the same name and hardcoded parameter "on", e.g. \-acl "on". Explicit parameters are expected by \-\-stdio_sync and \-\-scdbackup_tag. @@ -3882,7 +3884,7 @@ instead of \-G to apply the effect of \-boot_image isolinux partition_table=on. \-partition_offset number is \-boot_image any partition_offset=number. .br -Option \-append_partition is supported. +Command \-append_partition is supported. .br \-untranslated_name_len number is \-compliance untranslated_name_len=number. @@ -3890,7 +3892,7 @@ Option \-append_partition is supported. \-\-old\-empty is \-compliance old_empty. .br The options of genisoimage Jigdo Template Extraction are recognized and -performed via \fBxorriso\fR option \-jigdo. See the "Alias:" names there +performed via \fBxorriso\fR command \-jigdo. See the "Alias:" names there for the meaning of the genisoimage options. .br @@ -3903,7 +3905,7 @@ If \fBxorriso\fR is started with one of the leafnames "xorrisofs", \-as "genisofs" to the program arguments. I.e. all arguments will be interpreted mkisofs style until "\-\-" is encountered. -From then on, options are interpreted as \fBxorriso\fR options. +From then on, arguments are interpreted as \fBxorriso\fR commands. .br \-\-no_rc as first argument of such a program start prevents interpretation of startup files. See section FILES below. @@ -3949,7 +3951,7 @@ If \fBxorriso\fR is started with one of the leafnames "xorrecord", "cdrskin", "cdrecord", or "wodim", then it automatically prepends \-as "cdrskin" to the program arguments. I.e. all arguments will be interpreted cdrecord style until "\-\-" is encountered. -From then on, options are interpreted as \fBxorriso\fR options. +From then on, arguments are interpreted as \fBxorriso\fR commands. .br \-\-no_rc as first argument of such a program start prevents interpretation of \fBxorriso\fR startup files. @@ -4001,7 +4003,7 @@ Program scdbackup_verify will recognize and verify tag resp. record. .TP \fB\-no_rc\fR .br -Only if used as first program argument this option +Only if used as first program argument this command prevents reading and interpretation of startup files. See section FILES below. .TP \fB\-options_from_file\fR fileaddress @@ -4099,8 +4101,8 @@ With the start program arguments there is mode: .br Mode "encode_output" encodes output characters. It combines "encode_results" with "encode_infos". Inside single or double quotation marks encoding applies -to ASCII characters octal 001 to 037 , 177 to 377 and to backslash(134). -Outside quotation marks some harmless control characters stay unencoded: +to 8\-bit characters octal 001 to 037 , 177 to 377 and to backslash(134). +Outside quotation marks some harmless ASCII control characters stay unencoded: bell(007), backspace(010), tab(011), linefeed(012), formfeed(014), carriage_return(015). .br @@ -4169,7 +4171,7 @@ Mode "on" enables very verbous logging of SCSI commands and drive replies. Logging messages get printed to stderr, not to any of the \fBxorriso\fR output channels. .br -A special property of this option is that the first \-scsi_log setting +A special property of this command is that the first \-scsi_log setting among the start arguments is in effect already when the first operations of \fBxorriso\fR begin. Only "\-scsi_log" with dash "\-" is recognized that way. @@ -4319,7 +4321,7 @@ $ xorriso \-outdev /dev/sr2 \\ .br 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 +with addresses from the hard disk. Commands \-add and \-map have different parameter rules but finally the same effect: they put files into the image. .SS .B A dialog session doing about the same @@ -4327,8 +4329,8 @@ parameter rules but finally the same effect: they put files into the image. Some settings are already given as start argument. The other activities are done as dialog input. The pager gets set to 20 lines of 80 characters. .br -The drive is acquired by option \-dev rather than \-outdev in order to see -the message about its current content. By option \-blank this content is +The drive is acquired by command \-dev rather than \-outdev in order to see +the message about its current content. By command \-blank this content is made ready for being overwritten and the loaded ISO image is made empty. .br In order to be able to eject the medium, the session needs to be committed @@ -4438,7 +4440,7 @@ the same files gets added with converted file names. In order to avoid any weaknesses of the local character set, this command pretends that it uses already the final target set UTF\-8. Therefore strange file names may appear in messages, which -will be made terminal\-safe by option \-backslash_codes. +will be made terminal\-safe by command \-backslash_codes. .br $ xorriso \-in_charset ISO\-8859\-1 \-local_charset UTF\-8 \\ .br @@ -4631,13 +4633,13 @@ the old one. This makes sense if the full backup leaves substantial remaining capacity on media and if the expected changes are much smaller than the full backup. To apply zisofs compression to those data files which get newly copied from -the local filesystem, insert these options immediately before \-commit : +the local filesystem, insert these commands immediately before \-commit : .br \-hardlinks perform_update \\ .br \-find / \-type f \-pending_data \-exec set_filter \-\-zisofs \-\- \\ .br -Options \-disk_dev_ino and \-for_backup depend on stable device and inode numbers +Commands \-disk_dev_ino and \-for_backup depend on stable device and inode numbers on disk. Without them, an update run may use \-md5 "on" to match recorded MD5 sums against the current file content on hard disk. This is usually much faster than the default which compares both contents directly. @@ -4649,13 +4651,13 @@ versions. With CD media, GNU/Linux mount accepts session numbers directly by its option "session=". .br Multi\-session media and most overwriteable media written by \fBxorriso\fR -can tell the sbsectors of their sessions by \fBxorriso\fR option \-toc. -Used after \-commit the following option prints the matching mount command for +can tell the sbsectors of their sessions by \fBxorriso\fR command \-toc. +Used after \-commit the following command prints the matching mount command for the newly written session (here for mount point /mnt): .br \-mount_cmd "indev" "auto" "auto" /mnt .br -Options \-mount_cmd and \-mount are also able to produce the mount commands for +Commands \-mount_cmd and \-mount are also able to produce the mount commands for older sessions in the table\-of\-content. E.g. as superuser: .br # osirrox \-mount /dev/sr0 "volid" '*2008_12_05*' /mnt @@ -4746,7 +4748,7 @@ program name pre\-select certain settings: \fBxorrecord\fR starts \fBxorriso\fR with \-as cdrecord emulation. .br \fBosirrox\fR starts with \-osirrox "on:o_excl_off" which allows -to copy files from ISO image to disk and to apply option \-mount to +to copy files from ISO image to disk and to apply command \-mount to one or more of the existing ISO sessions. .SS .B Startup files: diff --git a/xorriso/xorriso.info b/xorriso/xorriso.info index a7e9971e..0b230aa7 100644 --- a/xorriso/xorriso.info +++ b/xorriso/xorriso.info @@ -149,11 +149,11 @@ File: xorriso.info, Node: Media, Next: Methods, Prev: Model, Up: Top There are two families of media in the MMC standard: *Multi-session media* are CD-R, CD-RW, DVD-R, DVD+R, DVD+R/DL, BD-R, and unformatted DVD-RW. These media provide a table of content which -describes their existing sessions. See option *-toc*. +describes their existing sessions. See command *-toc*. Similar to multi-session media are DVD-R DL and minimally blanked DVD-RW. They allow only a single session of which the size must be -known in advance. `xorriso' will write onto them only if option -close -is set to "on". +known in advance. `xorriso' will write onto them only if command +-close is set to "on". *Overwriteable media* are DVD-RAM, DVD+RW, BD-RE, and formatted DVD-RW. They allow random write access but do not provide information about their session history. If they contain one or more ISO 9660 sessions @@ -181,18 +181,18 @@ formatting to new media if necessary. *Appendable* media accept further sessions. Either they are MMC multi-session media in appendable state, or they are overwriteable media which contain an ISO image suitable for `xorriso'. -Appendable is the state after writing a session with option -close off. +Appendable is the state after writing a session with command -close off. *Closed* media cannot be written. They may contain an ISO image suitable for `xorriso'. Closed is the state of DVD-ROM media and of multi-session media which -were written with option -close on. If the drive is read-only hardware +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. Overwriteable media assume this state in such read-only drives or if they contain unrecognizable data in the first 32 data blocks. Read-only drives may or may not show session histories of multi-session media. Often only the first and the last session are visible. Sometimes -not even that. Option -rom_toc_scan might or might not help in such +not even that. Command -rom_toc_scan might or might not help in such cases.  @@ -203,8 +203,8 @@ File: xorriso.info, Node: Methods, Next: Drives, Prev: Media, Up: Top A new empty ISO image gets *created* if there is no input drive with a valid ISO 9660 image when the first time an output drive is defined. -This is achieved by option -dev on blank media or by option -outdev on -media in any state. +This is achieved by command -dev on blank media or by command -outdev +on media in any state. The new empty image can be populated with directories and files. Before it can be written, the medium in the output drive must get into blank state if it was not blank already. @@ -220,7 +220,7 @@ existing ISO 9660 + Rock Ridge directory tree. It is possible to hide files from previous sessions but they still exist on the medium and with many types of optical media it is quite easy to recover them by mounting older sessions. -Growing is achieved by option -dev. +Growing is achieved by command -dev. The write method of *modifying* produces compact filesystem images with no outdated files or directory trees. Modifying can write its @@ -232,10 +232,10 @@ media but to blank media only. So for this method one needs either two optical drives or has to work with filesystem objects as source and/or target medium. Modifying takes place if input drive and output drive are not the same -and if option -grow_blindly is set to its default "off". This is -achieved by options -indev and -outdev. +and if command -grow_blindly is set to its default "off". This is +achieved by commands -indev and -outdev. - If option -grow_blindly is set to a non-negative number and if + If command -grow_blindly is set to a non-negative number and if -indev and -outdev are both set to different drives, then *blind growing* is performed. It produces an add-on session which is ready for being written to the given block address. This is the usage model of @@ -312,10 +312,10 @@ Use of backdoors can cause severe memory and/or tty corruption. file or device by using its path with the "stdio:" prefix. By default any address in the /dev tree without prefix "stdio:" will work only if it leads to a MMC drive. -One may use option *-ban_stdio_write* to surely prevent this risk and +One may use command *-ban_stdio_write* to surely prevent this risk and to allow only MMC drives. One may prepend "mmc:" to a path to surely disallow any automatic -"stdio:". By option -drive_class one may ban certain paths or allow +"stdio:". By command -drive_class one may ban certain paths or allow access without prefix "stdio:" to other paths.  @@ -343,7 +343,7 @@ ISO image. The content of the boot image files is not in the scope of El Torito. Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images. `xorriso' is able to create or maintain an El Torito object -which makes such an image bootable. For details see option -boot_image. +which makes such an image bootable. For details see command -boot_image. It is possible to make ISO images bootable from USB stick or other hard-disk-like media by -boot_image parameter system_area= . This installs a Master Boot Record which may get adjusted according to the @@ -359,7 +359,7 @@ Endian (SGI), MIPS Little Endian (DEC), SUN SPARC. *ACL* are an advanced way of controlling access permissions to file objects. Neither ISO 9660 nor Rock Ridge specify a way to record ACLs. So libisofs has introduced a standard conformant extension named AAIP -for that purpose. It uses this extension if enabled by option *-acl*. +for that purpose. It uses this extension if enabled by command *-acl*. AAIP enhanced images are supposed to be mountable normally, but one cannot expect that the mounted filesystem will show and respect the ACLs. For now, only `xorriso' is able to retrieve those ACLs. It can @@ -378,7 +378,7 @@ be attached to file objects. AAIP is able to represent them and the user namespace. I.e. those which begin with "user.", like "user.x" or "user.whatever". Name has to be a 0 terminated string. Value may be any array of bytes which does not exceed the size of 4095 bytes. xattr -processing happens only if it is enabled by option *-xattr*. +processing happens only if it is enabled by command *-xattr*. As with ACL, currently only `xorriso' is able to retrieve xattr from AAIP enhanced images, to restore them to xattr capable file systems, or to print them. @@ -393,7 +393,7 @@ File: xorriso.info, Node: Processing, Next: Dialog, Prev: Extras, Up: Top Commands are either actions which happen immediately or settings which influence following actions. So their sequence does matter, unless they -are given as program arguments and option *-x* is among them. +are given as program arguments and command *-x* is among them. 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 must be terminated by either the *list @@ -401,7 +401,7 @@ delimiter*, occur at the end of the argument list, or occur at the end of an input line. At program start the list delimiter is the string "--". This may be -changed with the -list_delimiter option in order to allow "--" as +changed with the -list_delimiter command in order to allow "--" as parameter in a variable length list. However, it is advised to reset the delimiter to "--" immediately afterwards. For brevity the list delimiter is referred as "--" throughout this text. @@ -437,13 +437,13 @@ 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. -Quoted input accepts any ASCII character except NUL (0) as the content +Quoted input accepts any 8-bit character except NUL (0) as the content of the quotes. Nevertheless it can be cumbersome for the user to produce those characters directly. Therefore quoted input and program arguments allow optional *Backslash Interpretation* which can represent -all ASCII characters except NUL (0) via backslash codes as in $'...' of +all 8-bit characters except NUL (0) via backslash codes as in $'...' of bash. -This is not enabled by default. See option -backslash_codes. +This is not enabled by default. See command -backslash_codes. 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 @@ -475,7 +475,7 @@ position. The Delete key removes the character under the cursor. Up and Down arrow keys navigate through the history of previous input lines. See info readline for more info about libreadline. - Option -page activates a built-in result text pager which may be + Command -page activates a built-in result text pager which may be convenient in dialog mode. After an action has output the given number of terminal lines, the pager prompts the user for a line of input. An empty line lets `xorriso' resume work until the next page is output. @@ -497,8 +497,8 @@ File: xorriso.info, Node: Options, Next: Examples, Prev: Dialog, Up: Top ********* All command words are shown with a leading dash although this dash is -not mandatory for the option to be recognized. Nevertheless within -option -as the dashes of the emulated options are mandatory. +not mandatory for the command to be recognized. Nevertheless within +command -as the dashes of the emulated commands are mandatory. Normally any number of leading dashes is ignored with command words and inner dashes are interpreted as underscores. @@ -522,7 +522,7 @@ inner dashes are interpreted as underscores. * Inquiry:: Drive and media related inquiry actions * Navigate:: Navigation in ISO image and disk filesystem * Verify:: Evaluation of readability and recovery -* Restore:: osirrox ISO-to-disk restore options +* Restore:: osirrox ISO-to-disk restore commands * Emulation:: Command compatibility emulations (cdrtools) * Scripting:: Scripting, dialog and program control features * Frontend:: Support for frontend programs via stdin and stdout @@ -554,7 +554,7 @@ loss of expressivity. program arguments. -list_arg_sorting - List all xorriso commands in the order which applies if option -x + List all xorriso commands in the order which applies if command -x is in effect. This list may also be helpful without -x for a user who ponders over the sequence in which to put commands. Deviations from the @@ -566,7 +566,7 @@ File: xorriso.info, Node: AqDrive, Next: Loading, Prev: ArgSort, Up: Options 9.2 Acquiring source and target drive ===================================== -The effect of acquiring a drive may depend on several options in the +The effect of acquiring a drive may depend on several commands in the next paragraph "Influencing the behavior of image loading". If desired, their enabling commands have to be performed before the commands which acquire the drive. @@ -626,13 +626,14 @@ File: xorriso.info, Node: Loading, Next: Insert, Prev: AqDrive, Up: Options 9.3 Influencing the behavior of image loading ============================================= -The following options should normally be performed before loading an +The following commands should normally be performed before loading an image by acquiring an input drive. In rare cases it is desirable to activate them only after image loading. -load entity id Load a particular (possibly outdated) ISO session from -dev or - -indev. Usually all available sessions are shown with option -toc. + -indev. Usually all available sessions are shown with command + -toc. entity depicts the kind of addressing. id depicts the particular address. The following entities are defined: "auto" with any id addresses the last session in -toc. This is the @@ -707,7 +708,7 @@ activate them only after image loading. 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. - This option does not hamper the creation of an empty image from + This command does not hamper the creation of an empty image from blank input media and does not discard an already loaded image. -in_charset character_set_name @@ -766,13 +767,13 @@ activate them only after image loading. will obtain ACLs from disk file objects, store ACLs in the ISO image using the libisofs specific AAIP format, load AAIP data from ISO images, test ACL during file comparison, and restore ACLs to - disk files when extracting them from ISO images. See also options - -getfacl, -setfacl. + disk files when extracting them from ISO images. See also + commands -getfacl, -setfacl. -xattr "on"|"off" Enable or disable processing of xattr attributes in user namespace. If enabled, then `xorriso' will handle xattr similar to ACL. See - also options -getfattr, -setfattr and above paragraph about xattr. + also commands -getfattr, -setfattr and above paragraph about xattr. -md5 "on"|"all"|"off"|"load_check_off" Enable or disable processing of MD5 checksums for the overall @@ -780,7 +781,7 @@ activate them only after image loading. checksum tags get loaded only if the tags of superblock and directory tree match properly. The MD5 checksums of data files and whole session get loaded from the image if there are any. - With options -compare and -update the recorded MD5 of a file will + With commands -compare and -update the recorded MD5 of a file will be used to avoid content reading from the image. Only the disk file content will be read and compared with that MD5. This can save much time if -disk_dev_ino "on" is not suitable. @@ -800,7 +801,7 @@ activate them only after image loading. checksum tag of the first session. Therefore load_check_off is in effect when `xorriso' -as mkisofs option -M is performed. The test can be re-enabled by mode "load_check_on". - Checksums can be exploited via options -check_md5, -check_md5_r, + Checksums can be exploited via commands -check_md5, -check_md5_r, via find actions get_md5, check_md5, and via -check_media. -for_backup @@ -986,7 +987,7 @@ filesystem. they do not match, then perform the necessary image manipulations to make iso_rr_path a matching copy of disk_path. By default this comparison will imply lengthy content reading before a decision is - made. Options -disk_dev_ino or -md5 may accelerate comparison if + made. Commands -disk_dev_ino or -md5 may accelerate comparison if they were already in effect when the loaded session was recorded. If disk_path is a directory and iso_rr_path does not exist yet, then the whole subtree will be inserted. Else only directory @@ -997,7 +998,7 @@ filesystem. both addresses get compared whether they have counterparts below the other address and whether both counterparts match. If there is a mismatch then the necessary update manipulation is done. - Note that the comparison result may depend on option -follow. Its + Note that the comparison result may depend on command -follow. Its setting should always be the same as with the first adding of disk_path as iso_rr_path. If iso_rr_path does not exist yet, then it gets added. If @@ -1027,11 +1028,11 @@ filesystem. /file/part_2_of_3_at_2047m_with_2047m_of_5753194821 \ -cut_out /my/disk/file 4094m 2047m \ /file/part_3_of_3_at_4094m_with_2047m_of_5753194821 - While option -split_size is set larger than 0, and if all pieces + While command -split_size is set larger than 0, and if all pieces of a file reside in the same ISO directory with no other files, and if the names look like above, then their ISO directory will be - recognized and handled like a regular file. This affects options - -compare*, -update*, and overwrite situations. See option + recognized and handled like a regular file. This affects commands + -compare*, -update*, and overwrite situations. See command -split_size for details. -cpr disk_path [***] iso_rr_path @@ -1225,10 +1226,10 @@ File: xorriso.info, Node: SetInsert, Next: Manip, Prev: Insert, Up: Options 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. - While option -split_size is set larger than 0 such a directory + While command -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 + regular file by commands -compare* , -update*, and in overwrite + situations. There are -ossirox parameters "concat_split_on" and "concat_split_off" which control the handling when files get restored to disk. In order to be recognizable, the names of the part files have to @@ -1274,7 +1275,7 @@ whether they stem from the loaded image or were newly inserted. -rm_r iso_rr_path [***] Delete the given files or directory trees from the ISO image. See - also the note with option -rm. + also the note with command -rm. -rmdir iso_rr_path [***] Delete empty directories. @@ -1365,7 +1366,7 @@ whether they stem from the loaded image or were newly inserted. Only names from the user namespace are allowed. I.e. a name has to begin with "user.", like "user.x" or "user.whatever". Values and names undergo the normal input processing of `xorriso'. - See also option -backslash_codes. Other than with option + See also command -backslash_codes. Other than with command -setfattr_list, the byte value 0 cannot be expressed via -setfattr. -setfattr_r [-]name value iso_rr_path [***] @@ -1389,7 +1390,7 @@ whether they stem from the loaded image or were newly inserted. allowed in names. Value may contain any kind of bytes. It must be in quotes. Trailing 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. + \XYZ by their octal 8-bit code XYZ. Use code \000 for 0-bytes. -alter_date type timestring iso_rr_path [***] Alter the date entries of a file in the ISO image. type is one of @@ -1606,7 +1607,7 @@ File: xorriso.info, Node: CmdFind, Next: Filter, Prev: Manip, Up: Options channel. setfacl attaches ACLs after removing existing ones. The new ACL is - given in text form as defined with option -setfacl. + given in text form as defined with command -setfacl. E.g.: -exec setfacl u:lisa:rw,u::rw,g::r,o::-,m::rw -- getfattr prints xattr name-value pairs from user namespace to the @@ -1628,7 +1629,7 @@ File: xorriso.info, Node: CmdFind, Next: Filter, Prev: Manip, Up: Options safe. Mode "b" prints backslash encoding. Not suitable for shell parsing. E.g. -exec list_extattr e - - Option -backslash_codes does not affect the output. + Command -backslash_codes does not affect the output. get_md5 prints the MD5 sum, if recorded, together with file path. check_md5 @@ -1806,7 +1807,7 @@ File: xorriso.info, Node: Writing, Next: SetWrite, Prev: Filter, Up: Options mode or blind growing.) -commit is performed automatically at end of program if there are uncommitted manipulations pending. So, to perform a final write operation with no new -dev and no new - loading of image, rather execute option -end. If you want to go + loading of image, rather execute command -end. If you want to go on without image loading, execute -commit_eject "none". To eject after write without image loading, use -commit_eject "all". To suppress a final write, execute -rollback_end. @@ -1851,7 +1852,7 @@ File: xorriso.info, Node: Writing, Next: SetWrite, Prev: Filter, Up: Options but produces media which are only suitable for a single session. Some drives announce this state by not offering feature 21h, but some drives offer it anyway. If feature 21h is missing, then - `xorriso' will refuse to write on DVD-RW if not option -close is + `xorriso' will refuse to write on DVD-RW if not command -close is set to "on". The progress reports issued by some drives while blanking are quite unrealistic. Do not conclude success or failure from the @@ -1870,7 +1871,7 @@ File: xorriso.info, Node: Writing, Next: SetWrite, Prev: Filter, Up: Options unformatted BD-R. "fast" does the same as "full" but tries to be quicker. "by_index_" selects a format out of the descriptor list issued by - option -list_formats. The index number from that list is to be + command -list_formats. The index number from that list is to be appended to the mode word. E.g: "by_index_3". "fast_by_index_" does the same as "by_index_" but tries to be quicker. @@ -1928,7 +1929,7 @@ File: xorriso.info, Node: Writing, Next: SetWrite, Prev: Filter, Up: Options DVD-RW, DVD+R, DVD+R DL, or BD-R media. It is indicated by warning messages when the drive gets acquired, and by a remark "but next track is damaged" with the line "Media status :" of command -toc. - The setting of option -close determines whether the medium stays + The setting of command -close determines whether the medium stays appendable. Mode "as_needed" gracefully refuses on media which are not reported as damaged. Mode "force" attempts the close operation @@ -1948,7 +1949,7 @@ File: xorriso.info, Node: SetWrite, Next: Bootable, Prev: Writing, Up: Optio ================================ Rock Ridge info will be generated by the program unconditionally. ACLs -will be written according to the setting of option -acl. +will be written according to the setting of command -acl. -joliet "on"|"off" If enabled by "on", generate Joliet tree additional to ISO 9660 + @@ -1960,7 +1961,7 @@ will be written according to the setting of option -acl. bit in order to circumvent bugs of the intended reader system or to get unofficial extra features. There are several adjustable rules which have a keyword each. If - they are mentioned with this option then their rule gets added to + they are mentioned with this command then their rule gets added to the relaxation list. This list can be erased by rules "strict" or "clear". It can be reset to its start setting by "default". All of the following relaxation rules can be revoked individually by @@ -1988,10 +1989,11 @@ will be written according to the setting of option -acl. "no_j_force_dots" does not add a dot to Joliet file names which have none. "lowercase" allows lowercase characters in ISO file names. - "full_ascii" allows all ASCII characters in ISO file names. + "full_ascii" allows all 8-bit characters except 0x0 and '/' in ISO + file names. "untranslated_names" might be dangerous for inadverted reader programs which rely on the restriction to at most 37 characters in - ISO file names. This option allows ISO file names up to 96 + ISO file names. This rule allows ISO file names up to 96 characters with no character conversion. If a file name has more characters, then image production will fail deliberately. "untranslated_name_len="number enables untranslated_names with a @@ -2092,7 +2094,7 @@ will be written according to the setting of option -acl. GMT. It is supposed to match this GRUB line: search --fs-uuid --set YYYY-MM-DD-hh-mm-ss-cc E.g. 2010040711405800 is 7 Apr 2010 11:40:58 (+0 centiseconds). - Timestrings for the other types may be given as with option + Timestrings for the other types may be given as with command -alter_date. They are prone to timezone computations. The timestrings "default" or "overridden" cause default settings: "c" and "m" will show the current time of image creation. "x" and "f" @@ -2146,7 +2148,7 @@ will be written according to the setting of option -acl. -zisofs option[:options] Set global parameters for zisofs compression. This data format is recognized and transparently uncompressed by some Linux kernels. - It is to be applied via option -set_filter with built-in filter + It is to be applied via command -set_filter with built-in filter "--zisofs". Parameters are: "level="[0-9] zlib compression: 0=none, 1=fast,..., 9=slow "block_size="32k|64k|128k size of compression blocks @@ -2186,7 +2188,7 @@ will be written according to the setting of option -acl. GNU/Linux specific: Set the number of bytes to be transmitted with each write operation to DVD 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 option -stream_recording , + The default depends on media type, on command -stream_recording , and on compile time options. -stdio_sync "on"|"off"|number @@ -2209,7 +2211,7 @@ will be written according to the setting of option -acl. -close "on"|"off" If "on" then mark the written medium as not appendable any more (if possible at all with the given type of target media). - This is the contrary of cdrecord, wodim, cdrskin option -multi, + This is the contrary of cdrecord, wodim, cdrskin command -multi, and is one aspect of growisofs option -dvd-compat. -padding number["k"|"m"]|"included"|"appended" @@ -2416,8 +2418,8 @@ filesystem and announced by an MBR partition table entry. *sparc_label=*text causes the production of a SUN Disk Label with the given text as ASCII label. This boot block format allows to append images for partitions 2 to 8. Partition 1 will always be - the ISO image. See option -append_partition. The first 512 bytes - of any data provided by system_area= will be overwritten. + the ISO image. See command -append_partition. The first 512 + bytes of any data provided by system_area= will be overwritten. *mips_discard* and *sparc_discard* revoke any boot file declarations made by mips_path= or mipsel_path=. They also disable production of SUN Disk Label. This removes the ban on production @@ -2551,7 +2553,7 @@ There is an input conversion from input character set to the local character set which applies when an ISO image gets loaded. A conversion from local character set to the output character set is performed when an image tree gets written. The sets can be defined independently by -options -in_charset and -out_charset. Normally one will have both +commands -in_charset and -out_charset. Normally one will have both identical, if ever. If conversions are desired then `xorriso' needs to know the name of the local character set. `xorriso' can inquire the same info as shell @@ -2562,7 +2564,7 @@ The default output charset is the local character set of the terminal where `xorriso' runs. So by default no conversion happens between local filesystem names and emerging names in the image. The situation stays ambigous and the reader has to riddle what character set was used. -By option -auto_charset it is possible to attribute the output charset +By command -auto_charset it is possible to attribute the output charset name to the image. This makes the situation unambigous. But if your terminal character set does not match the character set of the local file names, then this attribute can become plainly wrong and cause @@ -2614,9 +2616,9 @@ failed unexpectedly. Set the severity threshold for events to abort the program. Useful: "NEVER", "ABORT", "FATAL", "FAILURE" , "MISHAP", "SORRY" It may become necessary to abort the program anyway, despite the - setting by this option. Expect not many "ABORT" events to be + setting by this command. Expect not many "ABORT" events to be ignorable. - A special property of this option is that it works preemptive if + A special property of this command is that it works preemptive if given as program start argument. I.e. the first -abort_on setting among the start arguments is in effect already when the first operations of `xorriso' begin. Only "-abort_on" with dash "-" is @@ -2647,7 +2649,7 @@ failed unexpectedly. Event messages are sent to the info channel "I" which is usually stderr but may be influenced by command -pkt_output. Info messages which belong to no event get attributed severity "NOTE". - A special property of this option is that the first -report_about + A special property of this command is that the first -report_about setting among the start arguments is in effect already when the first operations of `xorriso' begin. Only "-report_about" with dash "-" is recognized that way. @@ -2674,7 +2676,7 @@ failed unexpectedly. that the drive is left in unusable state and needs poweroff to be reset. So during burning, blanking, and formatting wait for at least their normal run time before killing externally. - A special property of this option is that the first + A special property of this command is that the first -signal_handling setting among the start arguments is in effect already when the first operations of `xorriso' begin. Only "-signal_handling" with dash "-" is recognized that way. @@ -2683,10 +2685,10 @@ failed unexpectedly. Control the program behavior at problem event occasions. For now this applies to occasions "image_loading" which is given while an image tree is read from the input device, and to "file_extraction" - which is given with osirrox options like -extract. + which is given with osirrox commands like -extract. With "image_loading" there are three behaviors available: "best_effort" goes on with reading after events with severity - below FAILURE if the threshold of option -abort_on allows this. + below FAILURE if the threshold of command -abort_on allows this. "failure" aborts image tree reading on first event of at least SORRY. It issues an own FAILURE event. This is the default. "fatal" acts like "failure" but issues the own event as FATAL. @@ -2744,9 +2746,9 @@ File: xorriso.info, Node: DialogCtl, Next: Inquiry, Prev: Exception, Up: Opt subtree. Setting "off" silently kills any kind of image file object resp. performs above irrevocable actions. - To really produce user prompts, option -dialog needs to be set to + To really produce user prompts, command -dialog needs to be set to "on". Note that the prompt does not appear in situations where - file removal is forbidden by option -overwrite. -reassure only + file removal is forbidden by command -overwrite. -reassure only imposes an additional curb for removing existing file objects. Be aware that file objects get deleted from the ISO image immediately after confirmation. They are gone even if the running @@ -2764,7 +2766,7 @@ File: xorriso.info, Node: Inquiry, Next: Navigate, Prev: DialogCtl, Up: Opti Show list of available MMC drives with the addresses of their libburn standard device files. This is only possible when no ISO image changes are pending. - After this option was executed, there is no drive current and no + After this command was executed, there is no drive current and no image loaded. In order to be visible, a device has to offer rw-permissions with its libburn standard device file. Thus it might be only the @@ -2792,7 +2794,7 @@ File: xorriso.info, Node: Inquiry, Next: Navigate, Prev: DialogCtl, Up: Opti or DVD-ROM with only one or two sessions on it. The last of these sessions is supposed to be the most recent real session then. Some read-only drives and media show no usable session history at - all. Option -rom_toc_scan might help. + all. Command -rom_toc_scan might help. -mount_cmd drive entity id path Emit an appropriate command line for mounting the ISO session @@ -2807,7 +2809,7 @@ File: xorriso.info, Node: Inquiry, Next: Navigate, Prev: DialogCtl, Up: Opti volume id, or "auto" with any text as id. path will be used as mount point and must already exist as a directory on disk. - The command gets printed to the result channel. See option -mount + The command gets printed to the result channel. See command -mount for direct execution of this command. -mount_opts option[:option...] @@ -2836,9 +2838,9 @@ File: xorriso.info, Node: Inquiry, Next: Navigate, Prev: DialogCtl, Up: Opti -print_size Print the foreseeable consumption of 2048 byte blocks by next -commit. This can last a while as a -commit gets prepared and only - in last moment is revoked by this option. The result depends on + in last moment is revoked by this command. The result depends on several settings and also on the kind of output device. If no - -jidgo options are given and not command -as "mkisofs" was used, + -jidgo options are set and not command -as "mkisofs" was used, then -padding (300 kB by default) is not counted as part of the image size. @@ -2848,7 +2850,7 @@ File: xorriso.info, Node: Inquiry, Next: Navigate, Prev: DialogCtl, Up: Opti -pvd_info Print various id strings which can be found in loaded ISO images. - Some of them may be changed by options like -volid or -publisher. + 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. @@ -2925,7 +2927,7 @@ File: xorriso.info, Node: Navigate, Next: Verify, Prev: Inquiry, Up: Options Print the access permissions of the given files in the ISO image using the format of shell command getfacl. If a file has no ACL then it gets fabricated from the -chmod settings. A file may have - a real ACL if it was introduced into the ISO image while option + a real ACL if it was introduced into the ISO image while command -acl was set to "on". -getfacl_r iso_rr_pattern [***] @@ -3052,7 +3054,7 @@ indicate error. `xorriso' can scan a medium for readable data blocks, classify them according to their read speed, save them to a file, and keep track of successfuly saved blocks for further tries on the same medium. -By option -md5 checksums may get recorded with data files and whole +By command -md5 checksums may get recorded with data files and whole sessions. These checksums are reachable only via indev and a loaded image. They work independently of the media type and can detect transmission errors. @@ -3061,9 +3063,10 @@ transmission errors. Try to read data blocks from the indev drive, optionally copy them to a disk file, and finally report about the encountered quality. Several options may be used to modify the default behavior. - The options given with this command override the default settings - which may have been changed by option -check_media_defaults. See - there for a description of options. + The parameters given with this command override the default + settings which may have been changed by command + -check_media_defaults. See there for a description of available + options. The result list tells intervals of 2 KiB blocks with start address, number of blocks and quality. Qualities which begin with "+" are supposed to be valid readable data. Qualities with "-" are @@ -3189,12 +3192,12 @@ transmission errors. Compare the data content of the given files in the loaded image with their recorded MD5 checksums, if there are any. In case of any mismatch an event of the given severity is issued. It may then - be handled by appropriate settings of options -abort_on or + be handled by appropriate settings of commands -abort_on or -return_with which both can cause non-zero exit values of the program run. Severity ALL suppresses that event. - This option reports match and mismatch of data files to the result - channel. Non-data files cause NOTE events. There will also be - UPDATE events from data reading. + This command reports match and mismatch of data files to the + result channel. Non-data files cause NOTE events. There will also + be UPDATE events from data reading. If no iso_rr_path is given then the whole loaded session is compared with its MD5 sum. Be aware that this covers only one session and not the whole image if there are older sessions. @@ -3206,8 +3209,8 @@ transmission errors.  File: xorriso.info, Node: Restore, Next: Emulation, Prev: Verify, Up: Options -9.19 osirrox ISO-to-disk restore options -======================================== +9.19 osirrox ISO-to-disk restore commands +========================================= Normally `xorriso' only writes to disk files which were given as stdio: pseudo-drives or as log files. But its alter ego osirrox is able to @@ -3326,7 +3329,7 @@ The directory permissions on disk have to allow rwx. -paste_in iso_rr_path disk_path byte_offset byte_count Read the content of a ISO data file and write it into a data file on disk beginning at the byte_offset. Write at most byte_count - bytes. This is the inverse of option -cut_out. + bytes. This is the inverse of command -cut_out. -mount drive entity id path Produce the same line as -mount_cmd and then execute it as @@ -3372,15 +3375,15 @@ said programs trigger comparable actions. of `xorriso'. -pacifier gets set to "mkisofs" if files are added to the image. -graft-points is equivalent to -pathspecs on. Note that pathspecs - without "=" are interpreted differently than with `xorriso' option - -add. Directories get merged with the root directory of the ISO - image, other filetypes get mapped into that root directory. + without "=" are interpreted differently than with `xorriso' + command -add. Directories get merged with the root directory of + the ISO image, other filetypes get mapped into that root directory. If pathspecs are given and if no output file was chosen before or during the "mkisofs" option list, then standard output (-outdev "-") will get into effect. If -o points to a regular file, then it will be truncated to 0 bytes when finally writing begins. This truncation does not happen if the drive is chosen by `xorriso' - options before -as mkisofs or after its list delimiter. + commands before -as mkisofs or after its list delimiter. Directories and symbolic links are no valid -o targets. Writing to stdout is possible only if -as "mkisofs" was among the start arguments or if other start arguments pointed the output @@ -3402,9 +3405,9 @@ said programs trigger comparable actions. -md5 can be set to "off" by --old-root-no-md5 . Not original mkisofs options are --quoted_path_list , --hardlinks , --acl , --xattr , --md5 , --stdio_sync . They work like the - `xorriso' options with the same name and hardcoded parameter "on", - e.g. -acl "on". Explicit parameters are expected by --stdio_sync - and --scdbackup_tag. + `xorriso' commands with the same name and hardcoded parameter + "on", e.g. -acl "on". Explicit parameters are expected by + --stdio_sync and --scdbackup_tag. The capability to preserve multi-session history on overwriteable media gets disabled by default. It can be enabled by using --emul-toc with the first session. See -compliance no_emul_toc. @@ -3428,12 +3431,12 @@ said programs trigger comparable actions. -mipsel-boot leads to mipsel_path= . -partition_offset number is -boot_image any partition_offset=number. - Option -append_partition is supported. + Command -append_partition is supported. -untranslated_name_len number is -compliance untranslated_name_len=number. --old-empty is -compliance old_empty. The options of genisoimage Jigdo Template Extraction are - recognized and performed via `xorriso' option -jigdo. See the + recognized and performed via `xorriso' command -jigdo. See the "Alias:" names there for the meaning of the genisoimage options. Personalities "*xorrisofs*", "*genisoimage*", and "*genisofs*" are @@ -3442,8 +3445,8 @@ said programs trigger comparable actions. "genisofs", "mkisofs", or "genisoimage", then it performs -read_mkisofsrc and prepends -as "genisofs" to the program arguments. I.e. all arguments will be interpreted mkisofs style - until "--" is encountered. From then on, options are interpreted - as `xorriso' options. + until "--" is encountered. From then on, arguments are + interpreted as `xorriso' commands. --no_rc as first argument of such a program start prevents interpretation of startup files. See section FILES below. @@ -3476,7 +3479,7 @@ said programs trigger comparable actions. "cdrskin", "cdrecord", or "wodim", then it automatically prepends -as "cdrskin" to the program arguments. I.e. all arguments will be interpreted cdrecord style until "--" is encountered. From then - on, options are interpreted as `xorriso' options. + on, arguments are interpreted as `xorriso' commands. --no_rc as first argument of such a program start prevents interpretation of `xorriso' startup files. See section FILES below. @@ -3521,7 +3524,7 @@ File: xorriso.info, Node: Scripting, Next: Frontend, Prev: Emulation, Up: Op =================================================== -no_rc - Only if used as first program argument this option prevents + Only if used as first program argument this command prevents reading and interpretation of startup files. See section FILES below. @@ -3597,9 +3600,9 @@ File: xorriso.info, Node: Scripting, Next: Frontend, Prev: Emulation, Up: Op "with_program_arguments" translates all program arguments. Mode "encode_output" encodes output characters. It combines "encode_results" with "encode_infos". Inside single or double - quotation marks encoding applies to ASCII characters octal 001 to + quotation marks encoding applies to 8-bit characters octal 001 to 037 , 177 to 377 and to backslash(134). Outside quotation marks - some harmless control characters stay unencoded: bell(007), + some harmless ASCII control characters stay unencoded: bell(007), backspace(010), tab(011), linefeed(012), formfeed(014), carriage_return(015). Mode "off" is default and disables any translation. Mode "on" is @@ -3664,7 +3667,7 @@ File: xorriso.info, Node: Scripting, Next: Frontend, Prev: Emulation, Up: Op Mode "on" enables very verbous logging of SCSI commands and drive replies. Logging messages get printed to stderr, not to any of the `xorriso' output channels. - A special property of this option is that the first -scsi_log + A special property of this command is that the first -scsi_log setting among the start arguments is in effect already when the first operations of `xorriso' begin. Only "-scsi_log" with dash "-" is recognized that way. @@ -3792,7 +3795,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 parameter +from the hard disk. Commands -add and -map have different parameter rules but finally the same effect: they put files into the image.  @@ -3804,9 +3807,10 @@ File: xorriso.info, Node: ExDialog, Next: ExGrowing, Prev: ExCreate, Up: Exa Some settings are already given as start argument. The other activities are done as dialog input. The pager gets set to 20 lines of 80 characters. -The drive is acquired by option -dev rather than -outdev in order to see -the message about its current content. By option -blank this content is -made ready for being overwritten and the loaded ISO image is made empty. +The drive is acquired by command -dev rather than -outdev in order to +see the message about its current content. By command -blank this +content is made ready for being overwritten and the loaded ISO image is +made empty. In order to be able to eject the medium, the session needs to be committed explicitly. @@ -3902,7 +3906,7 @@ session with the same files gets added with converted file names. In order to avoid any weaknesses of the local character set, this command pretends that it uses already the final target set UTF-8. Therefore strange file names may appear in messages, which will be made -terminal-safe by option -backslash_codes. +terminal-safe by command -backslash_codes. $ xorriso -in_charset ISO-8859-1 -local_charset UTF-8 \ -out_charset UTF-8 -backslash_codes on -dev /dev/sr0 \ @@ -4090,29 +4094,29 @@ on the old one. This makes sense if the full backup leaves substantial remaining capacity on media and if the expected changes are much smaller than the full backup. To apply zisofs compression to those data files which get -newly copied from the local filesystem, insert these options +newly copied from the local filesystem, insert these commands immediately before -commit : -hardlinks perform_update \ -find / -type f -pending_data -exec set_filter --zisofs -- \ -Options -disk_dev_ino and -for_backup depend on stable device and inode -numbers on disk. Without them, an update run may use -md5 "on" to match -recorded MD5 sums against the current file content on hard disk. This -is usually much faster than the default which compares both contents -directly. +Commands -disk_dev_ino and -for_backup depend on stable device and +inode numbers on disk. Without them, an update run may use -md5 "on" to +match recorded MD5 sums against the current file content on hard disk. +This is usually much faster than the default which compares both +contents directly. With *mount* option *-o "sbsector="* on GNU/Linux resp. *-s* on FreeBSD 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=". Multi-session media and most overwriteable media written by `xorriso' -can tell the sbsectors of their sessions by `xorriso' option -toc. -Used after -commit the following option prints the matching mount +can tell the sbsectors of their sessions by `xorriso' command -toc. +Used after -commit the following command prints the matching mount command for the newly written session (here for mount point /mnt): -mount_cmd "indev" "auto" "auto" /mnt -Options -mount_cmd and -mount are also able to produce the mount +Commands -mount_cmd and -mount are also able to produce the mount commands for older sessions in the table-of-content. E.g. as superuser: # osirrox -mount /dev/sr0 "volid" '*2008_12_05*' /mnt @@ -4200,7 +4204,7 @@ their program name pre-select certain settings: *xorrisofs* starts `xorriso' with -as mkisofs emulation. *xorrecord* starts `xorriso' with -as cdrecord emulation. *osirrox* starts with -osirrox "on:o_excl_off" which allows to copy -files from ISO image to disk and to apply option -mount to one or more +files from ISO image to disk and to apply command -mount to one or more of the existing ISO sessions. 11.2 Startup Files @@ -4318,32 +4322,32 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * # starts a comment line: Scripting. (line 162) * -abort_on controls abort on error: Exception. (line 27) -* -abstract_file sets abstract file name: SetWrite. (line 164) -* -acl controls handling of ACLs: Loading. (line 142) +* -abstract_file sets abstract file name: SetWrite. (line 165) +* -acl controls handling of ACLs: Loading. (line 143) * -add inserts one or more paths: Insert. (line 42) * -add_plainly inserts one or more paths: Insert. (line 61) * -alter_date sets timestamps in ISO image: Manip. (line 147) * -alter_date_r sets timestamps in ISO image: Manip. (line 167) * -append_partition adds arbitrary file after image end: Bootable. (line 199) -* -application_id sets application id: SetWrite. (line 123) +* -application_id sets application id: SetWrite. (line 124) * -as emulates mkisofs or cdrecord: Emulation. (line 13) -* -assert_volid rejects undesired images: Loading. (line 83) -* -auto_charset learns character set from image: Loading. (line 97) +* -assert_volid rejects undesired images: Loading. (line 84) +* -auto_charset learns character set from image: Loading. (line 98) * -backslash_codes enables backslash conversion: Scripting. (line 67) -* -ban_stdio_write demands real drive: Loading. (line 246) -* -biblio_file sets biblio file name: SetWrite. (line 171) +* -ban_stdio_write demands real drive: Loading. (line 247) +* -biblio_file sets biblio file name: SetWrite. (line 172) * -blank erases media: Writing. (line 61) * -boot_image controls bootability: Bootable. (line 26) -* -calm_drive reduces drive activity: Loading. (line 235) +* -calm_drive reduces drive activity: Loading. (line 236) * -cd sets working directory in ISO: Navigate. (line 7) * -cdx sets working directory on disk: Navigate. (line 16) * -changes_pending overrides change status: Writing. (line 13) * -charset sets input/output character set: Charset. (line 43) -* -check_md5 verifies file checksum: Verify. (line 147) -* -check_md5_r verifies file tree checksums: Verify. (line 163) +* -check_md5 verifies file checksum: Verify. (line 148) +* -check_md5_r verifies file tree checksums: Verify. (line 164) * -check_media reads media block by block: Verify. (line 21) -* -check_media_defaults sets -check_media options: Verify. (line 40) +* -check_media_defaults sets -check_media options: Verify. (line 41) * -chgrp sets group in ISO image: Manip. (line 50) * -chgrp_r sets group in ISO image: Manip. (line 55) * -chmod sets permissions in ISO image: Manip. (line 58) @@ -4351,7 +4355,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -chown sets ownership in ISO image: Manip. (line 42) * -chown_r sets ownership in ISO image: Manip. (line 47) * -clone copies ISO directory tree: Insert. (line 171) -* -close controls media closing: SetWrite. (line 266) +* -close controls media closing: SetWrite. (line 267) * -close_damaged closes damaged track and session: Writing. (line 152) * -close_filter_list bans filter registration: Filter. (line 52) * -commit writes pending ISO image: Writing. (line 29) @@ -4360,7 +4364,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -compare_l reports ISO/disk differences: Navigate. (line 164) * -compare_r reports ISO/disk differences: Navigate. (line 159) * -compliance controls standard compliance: SetWrite. (line 14) -* -copyright_file sets copyright file name: SetWrite. (line 158) +* -copyright_file sets copyright file name: SetWrite. (line 159) * -cp_clone copies ISO directory tree: Insert. (line 183) * -cp_rx copies file trees to disk: Restore. (line 108) * -cpax copies files to disk: Restore. (line 104) @@ -4371,18 +4375,18 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -device_links gets list of drives: Inquiry. (line 18) * -devices gets list of drives: Inquiry. (line 7) * -dialog enables dialog mode: DialogCtl. (line 7) -* -disk_dev_ino fast incremental backup: Loading. (line 189) +* -disk_dev_ino fast incremental backup: Loading. (line 190) * -disk_pattern controls pattern expansion: Insert. (line 31) * -displacement compensate altered image start address: Loading. - (line 35) -* -drive_class controls drive accessability: Loading. (line 53) + (line 36) +* -drive_class controls drive accessability: Loading. (line 54) * -du show directory size in ISO image: Navigate. (line 89) -* -dummy controls write simulation: SetWrite. (line 255) +* -dummy controls write simulation: SetWrite. (line 256) * -dus show directory size in ISO image: Navigate. (line 93) * -dusx show directory size on disk: Navigate. (line 102) * -dux show directory size on disk: Navigate. (line 97) -* -dvd_obs set write block size: SetWrite. (line 242) -* -early_stdio_test classifies stdio drives: Loading. (line 251) +* -dvd_obs set write block size: SetWrite. (line 243) +* -early_stdio_test classifies stdio drives: Loading. (line 252) * -eject ejects drive tray: Writing. (line 52) * -end writes pending session and ends program: Scripting. (line 156) * -errfile_log logs problematic disk files: Scripting. (line 118) @@ -4397,20 +4401,20 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -find traverses and alters ISO tree: CmdFind. (line 7) * -findx traverses disk tree: Navigate. (line 106) * -follow softlinks and mount points: SetInsert. (line 76) -* -for_backup -acl,-xattr,-hardlinks,-md5: Loading. (line 184) +* -for_backup -acl,-xattr,-hardlinks,-md5: Loading. (line 185) * -format formats media: Writing. (line 88) -* -fs sets size of fifo: SetWrite. (line 259) +* -fs sets size of fifo: SetWrite. (line 260) * -getfacl shows ACL in ISO image: Navigate. (line 70) * -getfacl_r shows ACL in ISO image: Navigate. (line 77) * -getfattr shows xattr in ISO image: Navigate. (line 81) * -getfattr_r shows xattr in ISO image: Navigate. (line 85) -* -gid sets global ownership: SetWrite. (line 199) +* -gid sets global ownership: SetWrite. (line 200) * -grow_blindly overides next writeable address: AqDrive. (line 46) -* -hardlinks controls handling of hard links: Loading. (line 109) +* -hardlinks controls handling of hard links: Loading. (line 110) * -help prints help text: Scripting. (line 20) * -hide excludes file names from directory trees: Manip. (line 171) * -history brings text into readline history: Scripting. (line 44) -* -in_charset sets input character set: Loading. (line 91) +* -in_charset sets input character set: Loading. (line 92) * -indev acquires a drive for input: AqDrive. (line 24) * -iso_rr_pattern controls pattern expansion: Manip. (line 10) * -jigdo clears JTE or or adds parameter to JTE: Jigdo. (line 33) @@ -4437,7 +4441,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -map_l inserts paths from disk file: Insert. (line 94) * -map_single inserts path: Insert. (line 90) * -mark sets synchronizing message: Frontend. (line 25) -* -md5 controls handling of MD5 sums: Loading. (line 155) +* -md5 controls handling of MD5 sums: Loading. (line 156) * -mkdir creates ISO directory: Insert. (line 166) * -mount issues mount command for ISO session: Restore. (line 126) * -mount_cmd composes mount command line: Inquiry. (line 41) @@ -4450,17 +4454,17 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -not_paths sets absolute exclusion paths: SetInsert. (line 55) * -options_from_file reads commands from file: Scripting. (line 12) * -osirrox enables ISO-to-disk copying: Restore. (line 18) -* -out_charset sets output character set: SetWrite. (line 189) +* -out_charset sets output character set: SetWrite. (line 190) * -outdev acquires a drive for output: AqDrive. (line 31) * -overwrite enables overwriting in ISO: SetInsert. (line 127) * -pacifier controls pacifier text form: Emulation. (line 158) -* -padding sets amount or mode of image padding: SetWrite. (line 272) +* -padding sets amount or mode of image padding: SetWrite. (line 273) * -page set terminal geometry: DialogCtl. (line 19) * -paste_in copies file into disk file: Restore. (line 121) * -path_list inserts paths from disk file: Insert. (line 75) * -pathspecs sets meaning of = with -add: SetInsert. (line 118) * -pkt_output consolidates text output: Frontend. (line 7) -* -preparer_id sets preparer id: SetWrite. (line 177) +* -preparer_id sets preparer id: SetWrite. (line 178) * -print prints result text line: Scripting. (line 99) * -print_info prints message text line: Scripting. (line 102) * -print_mark prints synchronizing text line: Scripting. (line 105) @@ -4468,7 +4472,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -prog sets program name: Frontend. (line 30) * -prog_help prints help text: Frontend. (line 33) * -prompt prompts for enter key: Scripting. (line 110) -* -publisher sets publisher id: SetWrite. (line 117) +* -publisher sets publisher id: SetWrite. (line 118) * -pvd_info shows image id strings: Inquiry. (line 93) * -pwd tells working directory in ISO: Navigate. (line 20) * -pwdx tells working directory on disk: Navigate. (line 23) @@ -4484,7 +4488,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -rmdir deletes ISO directory: Manip. (line 32) * -rollback discards pending changes: Writing. (line 9) * -rollback_end ends program without writing: Scripting. (line 159) -* -rom_toc_scan searches for sessions: Loading. (line 210) +* -rom_toc_scan searches for sessions: Loading. (line 211) * -scdbackup_tag enables scdbackup checksum tag: Emulation. (line 168) * -scsi_log reports SCSI commands: Scripting. (line 147) * -session_log logs written sessions: Scripting. (line 138) @@ -4502,28 +4506,29 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -signal_handling controls handling of system signals: Exception. (line 69) * -sleep waits for a given time span: Scripting. (line 114) -* -speed set write speed: SetWrite. (line 215) +* -speed set write speed: SetWrite. (line 216) * -split_size enables large file splitting: SetInsert. (line 140) * -status shows current settings: Scripting. (line 47) * -status_history_max curbs -status history: Scripting. (line 56) -* -stdio_sync controls stdio buffer: SetWrite. (line 249) -* -stream_recording controls defect management: SetWrite. (line 230) -* -system_id sets system id: SetWrite. (line 132) +* -stdio_sync controls stdio buffer: SetWrite. (line 250) +* -stream_recording controls defect management: SetWrite. (line 231) +* -system_id sets system id: SetWrite. (line 133) * -tell_media_space reports free space: Inquiry. (line 89) * -temp_mem_limit curbs memory consumption: Scripting. (line 92) * -toc shows list of sessions: Inquiry. (line 28) -* -uid sets global ownership: SetWrite. (line 195) +* -uid sets global ownership: SetWrite. (line 196) * -update inserts path if different: Insert. (line 99) * -update_l inserts paths if different: Insert. (line 121) * -update_r inserts paths if different: Insert. (line 110) * -use_readline enables readline for dialog: DialogCtl. (line 28) * -version prints help text: Scripting. (line 23) -* -volid sets volume id: SetWrite. (line 93) -* -volset_id sets volume set id: SetWrite. (line 112) -* -volume_date sets volume timestamp: SetWrite. (line 139) -* -x enables automatic execution order of options: ArgSort. (line 16) -* -xattr controls handling of xattr (EA): Loading. (line 150) -* -zisofs controls zisofs production: SetWrite. (line 203) +* -volid sets volume id: SetWrite. (line 94) +* -volset_id sets volume set id: SetWrite. (line 113) +* -volume_date sets volume timestamp: SetWrite. (line 140) +* -x enables automatic execution order of arguments: ArgSort. + (line 16) +* -xattr controls handling of xattr (EA): Loading. (line 151) +* -zisofs controls zisofs production: SetWrite. (line 204)  File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top @@ -4535,7 +4540,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Menu: * ACL, _definiton: Extras. (line 38) -* ACL, control handling, -acl: Loading. (line 142) +* ACL, control handling, -acl: Loading. (line 143) * ACL, set in ISO image, -setfacl: Manip. (line 73) * ACL, set in ISO image, -setfacl_list: Manip. (line 101) * ACL, set in ISO image, -setfacl_r: Manip. (line 98) @@ -4543,10 +4548,10 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * ACL, show in ISO image, -getfacl_r: Navigate. (line 77) * Appendable media, _definition: Media. (line 38) * Appended Filesystem Image, -append_partition: Bootable. (line 199) -* Automatic execution order, of options, -x: ArgSort. (line 16) +* Automatic execution order, of arguments, -x: ArgSort. (line 16) * Backslash Interpretation, _definition: Processing. (line 52) -* Backup, enable fast incremental, -disk_dev_ino: Loading. (line 189) -* Backup, enable features, -for_backup: Loading. (line 184) +* Backup, enable fast incremental, -disk_dev_ino: Loading. (line 190) +* Backup, enable features, -for_backup: Loading. (line 185) * Backup, scdbackup checksum tag, -scdbackup: Emulation. (line 168) * Blank media, _definition: Media. (line 29) * Blind growing, _definition: Methods. (line 40) @@ -4554,10 +4559,10 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Bugs, reporting: Bugreport. (line 6) * cdrecord, Emulation: Emulation. (line 111) * Character Set, _definition: Charset. (line 6) -* Character Set, for input, -in_charset: Loading. (line 91) +* Character Set, for input, -in_charset: Loading. (line 92) * Character Set, for input/output, -charset: Charset. (line 43) -* Character Set, for output, -out_charset: SetWrite. (line 189) -* Character set, learn from image, -auto_charset: Loading. (line 97) +* Character Set, for output, -out_charset: SetWrite. (line 190) +* Character set, learn from image, -auto_charset: Loading. (line 98) * Character Set, of terminal, -local_charset: Charset. (line 47) * Closed media, _definition: Media. (line 43) * Comment, #: Scripting. (line 162) @@ -4580,9 +4585,9 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Directory, delete, -rmdir: Manip. (line 32) * disk_path, _definition: Insert. (line 6) * Drive, _definiton: Drives. (line 6) -* Drive, accessability, -drive_class: Loading. (line 53) -* Drive, classify stdio, -early_stdio_test: Loading. (line 251) -* Drive, demand real MMC, -ban_stdio_write: Loading. (line 246) +* Drive, accessability, -drive_class: Loading. (line 54) +* Drive, classify stdio, -early_stdio_test: Loading. (line 252) +* Drive, demand real MMC, -ban_stdio_write: Loading. (line 247) * Drive, eject tray, -eject: Writing. (line 52) * Drive, for input and output, -dev: AqDrive. (line 12) * Drive, for input, -indev: AqDrive. (line 24) @@ -4590,7 +4595,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Drive, get drive list, -device_links: Inquiry. (line 18) * Drive, get drive list, -devices: Inquiry. (line 7) * Drive, list supported media, -list_profiles: Writing. (line 166) -* Drive, reduce activity, -calm_drive: Loading. (line 235) +* Drive, reduce activity, -calm_drive: Loading. (line 236) * Drive, report SCSI commands, -scsi_log: Scripting. (line 147) * Drive, write and eject, -commit_eject: Writing. (line 56) * EA, _definiton: Extras. (line 54) @@ -4610,27 +4615,27 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Filter, show chain, -show_stream: Navigate. (line 169) * Filter, show chains of tree, -show_stream_r: Navigate. (line 183) * Filter, unregister, -unregister_filter: Filter. (line 48) -* Filter, zisofs parameters, -zisofs: SetWrite. (line 203) -* Group, global in ISO image, -gid: SetWrite. (line 199) +* Filter, zisofs parameters, -zisofs: SetWrite. (line 204) +* Group, global in ISO image, -gid: SetWrite. (line 200) * Group, in ISO image, -chgrp: Manip. (line 50) * Group, in ISO image, -chgrp_r: Manip. (line 55) * Growing, _definition: Methods. (line 19) -* Hard links, control handling, -hardlinks: Loading. (line 109) +* Hard links, control handling, -hardlinks: Loading. (line 110) * hidden, set in ISO image, -hide: Manip. (line 171) * Image, _definition: Model. (line 9) -* Image, demand volume id, -assert_volid: Loading. (line 83) +* Image, demand volume id, -assert_volid: Loading. (line 84) * Image, discard pending changes, -rollback: Writing. (line 9) * Image, override change status, -changes_pending: Writing. (line 13) -* Image, set abstract file name, -abstract_file: SetWrite. (line 164) -* Image, set application id, -application_id: SetWrite. (line 123) -* Image, set biblio file name, -biblio_file: SetWrite. (line 171) -* Image, set copyright file name, -copyright_file: SetWrite. (line 158) -* Image, set preparer id, -preparer_id: SetWrite. (line 177) -* Image, set publisher id, -publisher: SetWrite. (line 117) -* Image, set system id, -system_id: SetWrite. (line 132) -* Image, set volume id, -volid: SetWrite. (line 93) -* Image, set volume set id, -volset_id: SetWrite. (line 112) -* Image, set volume timestamp, -volume_date: SetWrite. (line 139) +* Image, set abstract file name, -abstract_file: SetWrite. (line 165) +* Image, set application id, -application_id: SetWrite. (line 124) +* Image, set biblio file name, -biblio_file: SetWrite. (line 172) +* Image, set copyright file name, -copyright_file: SetWrite. (line 159) +* Image, set preparer id, -preparer_id: SetWrite. (line 178) +* Image, set publisher id, -publisher: SetWrite. (line 118) +* Image, set system id, -system_id: SetWrite. (line 133) +* Image, set volume id, -volid: SetWrite. (line 94) +* Image, set volume set id, -volset_id: SetWrite. (line 113) +* Image, set volume timestamp, -volume_date: SetWrite. (line 140) * Image, show id strings, -pvd_info: Inquiry. (line 93) * Insert, enable overwriting, -overwrite: SetInsert. (line 127) * Insert, file exclusion absolute, -not_paths: SetInsert. (line 55) @@ -4660,7 +4665,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * List delimiter, _definiton: Processing. (line 9) * MBR, _definiton: Extras. (line 26) * MBR, set, -boot_image system_area=: Bootable. (line 121) -* MD5, control handling, -md5: Loading. (line 155) +* MD5, control handling, -md5: Loading. (line 156) * Media, erase, -blank: Writing. (line 61) * Media, format, -format: Writing. (line 88) * Media, list formats, -list_formats: Writing. (line 126) @@ -4688,7 +4693,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Navigate, tell ISO working directory, -pwd: Navigate. (line 20) * Next writeable address, -grow_blindly: AqDrive. (line 46) * Overwriteable media, _definition: Media. (line 14) -* Ownership, global in ISO image, -uid: SetWrite. (line 195) +* Ownership, global in ISO image, -uid: SetWrite. (line 196) * Ownership, in ISO image, -chown: Manip. (line 42) * Ownership, in ISO image, -chown_r: Manip. (line 47) * Partition offset, _definiton: Bootable. (line 146) @@ -4743,7 +4748,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Restore, enable ISO-to-disk, -osirrox: Restore. (line 18) * Rock Ridge, _definiton: Extras. (line 6) * Session, _definition: Model. (line 6) -* Session, altered start address, -displacement: Loading. (line 35) +* Session, altered start address, -displacement: Loading. (line 36) * Session, info string, -session_string: Inquiry. (line 67) * Session, issue mount command, -mount: Restore. (line 126) * Session, log when written, -session_log: Scripting. (line 138) @@ -4754,7 +4759,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * SUN Disk Label, production: Bootable. (line 187) * SUN SPARC boot images, activation: Bootable. (line 220) * System area, _definiton: Bootable. (line 121) -* Table-of-content, search sessions, -rom_toc_scan: Loading. (line 210) +* Table-of-content, search sessions, -rom_toc_scan: Loading. (line 211) * Table-of-content, show, -toc: Inquiry. (line 28) * Timestamps, set in ISO image, -alter_date: Manip. (line 147) * Timestamps, set in ISO image, -alter_date_r: Manip. (line 167) @@ -4764,27 +4769,27 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Verify, compare ISO and disk file, -compare: Navigate. (line 146) * Verify, compare ISO and disk tree, -compare_r: Navigate. (line 159) * Verify, compare ISO and disk, -compare_l: Navigate. (line 164) -* Verify, file checksum, -check_md5: Verify. (line 147) -* Verify, file tree checksums, -check_md5_r: Verify. (line 163) -* Verify, preset -check_media, -check_media_defaults: Verify. (line 40) -* Write, block size, -dvd_obs: SetWrite. (line 242) +* Verify, file checksum, -check_md5: Verify. (line 148) +* Verify, file tree checksums, -check_md5_r: Verify. (line 164) +* Verify, preset -check_media, -check_media_defaults: Verify. (line 41) +* Write, block size, -dvd_obs: SetWrite. (line 243) * Write, bootability, -boot_image: Bootable. (line 26) -* Write, buffer syncing, -stdio_sync: SetWrite. (line 249) -* Write, close media, -close: SetWrite. (line 266) +* Write, buffer syncing, -stdio_sync: SetWrite. (line 250) +* Write, close media, -close: SetWrite. (line 267) * Write, compliance to specs, -compliance: SetWrite. (line 14) -* Write, defect management, -stream_recording: SetWrite. (line 230) +* Write, defect management, -stream_recording: SetWrite. (line 231) * Write, enable Joliet, -joliet: SetWrite. (line 10) -* Write, fifo size, -fs: SetWrite. (line 259) +* Write, fifo size, -fs: SetWrite. (line 260) * Write, free space, -tell_media_space: Inquiry. (line 89) * Write, log problematic disk files, -errfile_log: Scripting. (line 118) * Write, log written sessions, -session_log: Scripting. (line 138) -* Write, padding image, -padding: SetWrite. (line 272) +* Write, padding image, -padding: SetWrite. (line 273) * Write, pending ISO image, -commit: Writing. (line 29) * Write, predict image size, -print_size: Inquiry. (line 80) -* Write, set speed, -speed: SetWrite. (line 215) -* Write, simulation, -dummy: SetWrite. (line 255) +* Write, set speed, -speed: SetWrite. (line 216) +* Write, simulation, -dummy: SetWrite. (line 256) * xattr, _definiton: Extras. (line 54) -* xattr, control handling, -xattr: Loading. (line 150) +* xattr, control handling, -xattr: Loading. (line 151) * xattr, set in ISO image, -setfattr: Manip. (line 111) * xattr, set in ISO image, -setfattr_list: Manip. (line 127) * xattr, set in ISO image, -setfattr_r: Manip. (line 124) @@ -4798,56 +4803,56 @@ Node: Top420 Node: Overview1375 Node: Model3264 Node: Media6151 -Node: Methods8817 -Node: Drives11386 -Node: Extras14699 -Node: Processing18417 -Node: Dialog22034 -Node: Options23710 -Node: ArgSort25380 -Node: AqDrive26869 -Node: Loading29912 -Node: Insert44184 -Node: SetInsert53894 -Node: Manip62465 -Node: CmdFind71198 -Node: Filter83305 -Node: Writing87860 -Node: SetWrite96820 -Node: Bootable111125 -Node: Jigdo124346 -Node: Charset128592 -Node: Exception131351 -Node: DialogCtl137464 -Node: Inquiry140059 -Node: Navigate144922 -Node: Verify153182 -Node: Restore161849 -Node: Emulation168755 -Node: Scripting178555 -Node: Frontend185707 -Node: Examples187007 -Node: ExDevices188184 -Node: ExCreate188843 -Node: ExDialog190127 -Node: ExGrowing191390 -Node: ExModifying192195 -Node: ExBootable192699 -Node: ExCharset193251 -Node: ExPseudo194071 -Node: ExCdrecord194969 -Node: ExMkisofs195286 -Node: ExGrowisofs196626 -Node: ExException197761 -Node: ExTime198215 -Node: ExIncBackup198674 -Node: ExRestore202660 -Node: ExRecovery203620 -Node: Files204190 -Node: Seealso205488 -Node: Bugreport206211 -Node: Legal206792 -Node: CommandIdx207722 -Node: ConceptIdx223037 +Node: Methods8822 +Node: Drives11397 +Node: Extras14712 +Node: Processing18433 +Node: Dialog22053 +Node: Options23730 +Node: ArgSort25404 +Node: AqDrive26894 +Node: Loading29938 +Node: Insert44222 +Node: SetInsert53937 +Node: Manip62513 +Node: CmdFind71249 +Node: Filter83358 +Node: Writing87913 +Node: SetWrite96877 +Node: Bootable111210 +Node: Jigdo124432 +Node: Charset128678 +Node: Exception131439 +Node: DialogCtl137558 +Node: Inquiry140155 +Node: Navigate145021 +Node: Verify153282 +Node: Restore161971 +Node: Emulation168880 +Node: Scripting178691 +Node: Frontend185851 +Node: Examples187151 +Node: ExDevices188328 +Node: ExCreate188987 +Node: ExDialog190272 +Node: ExGrowing191537 +Node: ExModifying192342 +Node: ExBootable192846 +Node: ExCharset193398 +Node: ExPseudo194219 +Node: ExCdrecord195117 +Node: ExMkisofs195434 +Node: ExGrowisofs196774 +Node: ExException197909 +Node: ExTime198363 +Node: ExIncBackup198822 +Node: ExRestore202813 +Node: ExRecovery203773 +Node: Files204343 +Node: Seealso205642 +Node: Bugreport206365 +Node: Legal206946 +Node: CommandIdx207876 +Node: ConceptIdx223255  End Tag Table diff --git a/xorriso/xorriso.texi b/xorriso/xorriso.texi index 7432aa2b..9e414a74 100644 --- a/xorriso/xorriso.texi +++ b/xorriso/xorriso.texi @@ -272,11 +272,11 @@ There are two families of media in the MMC standard: @cindex Multi-session media, _definition @strong{Multi-session media} are CD-R, CD-RW, DVD-R, DVD+R, DVD+R/DL, BD-R, and unformatted DVD-RW. These media provide a table of content which -describes their existing sessions. See option @strong{-toc}. +describes their existing sessions. See command @strong{-toc}. @* Similar to multi-session media are DVD-R DL and minimally blanked DVD-RW. They allow only a single session of which the size must be known in advance. -@command{xorriso} will write onto them only if option -close is set to "on". +@command{xorriso} will write onto them only if command -close is set to "on". @* @cindex Overwriteable media, _definition @strong{Overwriteable media} are DVD-RAM, DVD+RW, BD-RE, and formatted DVD-RW. @@ -313,7 +313,7 @@ media, or to apply mandatory formatting to new media if necessary. multi-session media in appendable state, or they are overwriteable media which contain an ISO image suitable for @command{xorriso}. @* -Appendable is the state after writing a session with option -close off. +Appendable is the state after writing a session with command -close off. @* @sp 1 @cindex Closed media, _definition @@ -321,7 +321,7 @@ Appendable is the state after writing a session with option -close off. for @command{xorriso}. @* Closed is the state of DVD-ROM media and of multi-session media which were -written with option -close on. If the drive is read-only hardware then it will +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. @* Overwriteable media assume this state in such read-only drives or if they @@ -329,7 +329,7 @@ contain unrecognizable data in the first 32 data blocks. @* Read-only drives may or may not show session histories of multi-session media. Often only the first and the last session are visible. Sometimes -not even that. Option -rom_toc_scan might or might not help in such cases. +not even that. Command -rom_toc_scan might or might not help in such cases. @c man .SS @node Methods, Drives, Media, top @chapter Creating, Growing, Modifying, Blind Growing: @@ -338,8 +338,8 @@ not even that. Option -rom_toc_scan might or might not help in such cases. @cindex Create, new ISO image, _definiton A new empty ISO image gets @strong{created} if there is no input drive with a valid ISO 9660 image when the first time -an output drive is defined. This is achieved by option -dev on blank media -or by option -outdev on media in any state. +an output drive is defined. This is achieved by command -dev on blank media +or by command -outdev on media in any state. @* The new empty image can be populated with directories and files. Before it can be written, the medium in the output drive must get into @@ -359,7 +359,7 @@ ISO 9660 + Rock Ridge directory tree. It is possible to hide files from previous sessions but they still exist on the medium and with many types of optical media it is quite easy to recover them by mounting older sessions. @* -Growing is achieved by option -dev. +Growing is achieved by command -dev. @c man .PP @sp 1 @cindex Modifying, _definition @@ -375,12 +375,12 @@ So for this method one needs either two optical drives or has to work with filesystem objects as source and/or target medium. @* Modifying takes place if input drive and output drive are not the same and -if option -grow_blindly is set to its default "off". -This is achieved by options -indev and -outdev. +if command -grow_blindly is set to its default "off". +This is achieved by commands -indev and -outdev. @c man .PP @sp 1 @cindex Blind growing, _definition -If option -grow_blindly is set to a non-negative number and if -indev and +If command -grow_blindly is set to a non-negative number and if -indev and -outdev are both set to different drives, then @strong{blind growing} is performed. It produces an add-on session which is ready for being written to the given block address. This is the usage model of @@ -483,13 +483,13 @@ device by using its path with the "stdio:" prefix. By default any address in the /dev tree without prefix "stdio:" will work only if it leads to a MMC drive. @* -One may use option +One may use command @strong{-ban_stdio_write} to surely prevent this risk and to allow only MMC drives. @* One may prepend "mmc:" to a path to surely disallow any automatic "stdio:". @c man .br -By option -drive_class one may ban certain paths or allow access without +By command -drive_class one may ban certain paths or allow access without prefix "stdio:" to other paths. @c man .SS @node Extras, Processing, Drives, top @@ -522,7 +522,7 @@ The content of the boot image files is not in the scope of El Torito. @* Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images. @command{xorriso} is able to create or maintain an El Torito object which -makes such an image bootable. For details see option -boot_image. +makes such an image bootable. For details see command -boot_image. @* @cindex MBR, _definiton It is possible to make ISO images bootable from USB stick or other @@ -547,7 +547,7 @@ EFI, MIPS Big Endian (SGI), MIPS Little Endian (DEC), SUN SPARC. are an advanced way of controlling access permissions to file objects. Neither ISO 9660 nor Rock Ridge specify a way to record ACLs. So libisofs has introduced a standard conformant extension named AAIP for that purpose. -It uses this extension if enabled by option +It uses this extension if enabled by command @strong{-acl}. @* AAIP enhanced images are supposed to be mountable normally, but one cannot @@ -576,7 +576,7 @@ pairs which have names out of the user namespace. I.e. those which begin with "user.", like "user.x" or "user.whatever". Name has to be a 0 terminated string. Value may be any array of bytes which does not exceed the size of 4095 bytes. -xattr processing happens only if it is enabled by option +xattr processing happens only if it is enabled by command @strong{-xattr}. @* As with ACL, currently only @command{xorriso} is able to retrieve xattr @@ -592,7 +592,7 @@ only on GNU/Linux and FreeBSD, where they are known as extattr. @c man .br Commands are either actions which happen immediately or settings which influence following actions. So their sequence does matter, unless they are -given as program arguments and option +given as program arguments and command @strong{-x} is among them. @* @@ -605,7 +605,7 @@ the argument list, or occur at the end of an input line. @c man .PP @sp 1 At program start the list delimiter is the string "@minus{}@minus{}". -This may be changed with the -list_delimiter option in order to allow +This may be changed with the -list_delimiter command in order to allow "@minus{}@minus{}" as parameter in a variable length list. However, it is advised to reset the delimiter to "@minus{}@minus{}" immediately afterwards. @@ -653,15 +653,15 @@ 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. @* @cindex Backslash Interpretation, _definition -Quoted input accepts any ASCII character except NUL (0) as the content of +Quoted input accepts any 8-bit character except NUL (0) as the content of the quotes. Nevertheless it can be cumbersome for the user to produce those characters directly. Therefore quoted input and program arguments allow optional @strong{Backslash Interpretation} -which can represent all ASCII characters except NUL (0) via backslash codes +which can represent all 8-bit characters except NUL (0) via backslash codes as in $'...' of bash. @* -This is not enabled by default. See option -backslash_codes. +This is not enabled by default. See command -backslash_codes. @c man .PP @sp 1 When the program starts then it first looks for argument -no_rc. If this is @@ -702,7 +702,7 @@ See info readline for more info about libreadline. @c man .PP @sp 1 -Option -page activates a built-in result text pager which may be convenient in +Command -page activates a built-in result text pager which may be convenient in dialog mode. After an action has output the given number of terminal lines, the pager prompts the user for a line of input. @* @@ -727,8 +727,8 @@ All actions try to abort as soon as possible. @c man .SH OPTIONS @c man .br All command words are shown with a leading dash although this dash is not -mandatory for the option to be recognized. Nevertheless within option -as -the dashes of the emulated options are mandatory. +mandatory for the command to be recognized. Nevertheless within command -as +the dashes of the emulated commands are mandatory. @* Normally any number of leading dashes is ignored with command words and inner dashes are interpreted as underscores. @@ -751,7 +751,7 @@ inner dashes are interpreted as underscores. * Inquiry:: Drive and media related inquiry actions * Navigate:: Navigation in ISO image and disk filesystem * Verify:: Evaluation of readability and recovery -* Restore:: osirrox ISO-to-disk restore options +* Restore:: osirrox ISO-to-disk restore commands * Emulation:: Command compatibility emulations (cdrtools) * Scripting:: Scripting, dialog and program control features * Frontend:: Support for frontend programs via stdin and stdout @@ -774,8 +774,8 @@ at the cost of loss of expressivity. @sp 1 @c man .TP @item -x -@kindex -x enables automatic execution order of options -@cindex Automatic execution order, of options, -x +@kindex -x enables automatic execution order of arguments +@cindex Automatic execution order, of arguments, -x 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 @@ -790,7 +790,8 @@ It affects only the commands given as program arguments. @item -list_arg_sorting @kindex -list_arg_sorting prints sorting order of -x @cindex Sorting order, for -x, -list_arg_sorting -List all xorriso commands in the order which applies if option -x is in effect. +List all xorriso commands in the order which applies if command -x is in +effect. @* 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 @@ -802,7 +803,7 @@ well make sense, though. @section Acquiring source and target drive @c man .B Acquiring source and target drive: @c man .PP -The effect of acquiring a drive may depend on several options in the +The effect of acquiring a drive may depend on several commands in the next paragraph "Influencing the behavior of image loading". If desired, their enabling commands have to be performed before the commands which acquire the drive. @@ -877,7 +878,7 @@ begins. The output drive is given up when writing is done. @node Loading, Insert, AqDrive, Options @section Influencing the behavior of image loading @c man .PP -The following options should normally be performed before loading an image +The following commands should normally be performed before loading an image by acquiring an input drive. In rare cases it is desirable to activate them only after image loading. @table @asis @@ -887,7 +888,7 @@ them only after image loading. @kindex -load addresses a particular session as input @cindex Session, select as input, -load Load a particular (possibly outdated) ISO session from -dev or -indev. -Usually all available sessions are shown with option -toc. +Usually all available sessions are shown with command -toc. @* entity depicts the kind of addressing. id depicts the particular address. The following entities are defined: @@ -979,7 +980,7 @@ 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. @* -This option does not hamper the creation of an empty image from blank +This command does not hamper the creation of an empty image from blank input media and does not discard an already loaded image. @c man .TP @item -in_charset character_set_name @@ -1051,14 +1052,14 @@ If enabled, then @command{xorriso} will obtain ACLs from disk file objects, store ACLs in the ISO image using the libisofs specific AAIP format, load AAIP data from ISO images, test ACL during file comparison, and restore ACLs to disk files when extracting them from ISO images. -See also options -getfacl, -setfacl. +See also commands -getfacl, -setfacl. @c man .TP @item -xattr "on"|"off" @kindex -xattr controls handling of xattr (EA) @cindex xattr, control handling, -xattr Enable or disable processing of xattr attributes in user namespace. If enabled, then @command{xorriso} will handle xattr similar to ACL. -See also options -getfattr, -setfattr and above paragraph about xattr. +See also commands -getfattr, -setfattr and above paragraph about xattr. @c man .TP @item -md5 "on"|"all"|"off"|"load_check_off" @kindex -md5 controls handling of MD5 sums @@ -1069,7 +1070,7 @@ only if the tags of superblock and directory tree match properly. The MD5 checksums of data files and whole session get loaded from the image if there are any. @* -With options -compare and -update the recorded MD5 of a file +With commands -compare and -update the recorded MD5 of a file will be used to avoid content reading from the image. Only the disk file content will be read and compared with that MD5. This can save much time if -disk_dev_ino "on" is not suitable. @@ -1092,7 +1093,7 @@ option -M is performed. @* The test can be re-enabled by mode "load_check_on". @* -Checksums can be exploited via options -check_md5, -check_md5_r, via find +Checksums can be exploited via commands -check_md5, -check_md5_r, via find actions get_md5, check_md5, and via -check_media. @c man .TP @item -for_backup @@ -1325,7 +1326,7 @@ composed from disk_path by replacing disk_prefix by iso_rr_prefix. Compare file object disk_path with file object iso_rr_path. If they do not match, then perform the necessary image manipulations to make iso_rr_path a matching copy of disk_path. By default this comparison will imply lengthy -content reading before a decision is made. Options -disk_dev_ino or -md5 may +content reading before a decision is made. Commands -disk_dev_ino or -md5 may accelerate comparison if they were already in effect when the loaded session was recorded. @* @@ -1341,7 +1342,7 @@ addresses get compared whether they have counterparts below the other address and whether both counterparts match. If there is a mismatch then the necessary update manipulation is done. @* -Note that the comparison result may depend on option -follow. Its setting +Note that the comparison result may depend on command -follow. Its setting should always be the same as with the first adding of disk_path as iso_rr_path. @* If iso_rr_path does not exist yet, then it gets added. If disk_path does not @@ -1383,12 +1384,12 @@ E.g: @* /file/part_3_of_3_at_4094m_with_2047m_of_5753194821 @* -While option -split_size is set larger than 0, and if all pieces of a file +While command -split_size is set larger than 0, and if all pieces of a file reside in the same ISO directory with no other files, and if the names look like above, then their ISO directory will be recognized and handled like a -regular file. This affects options -compare*, -update*, and overwrite +regular file. This affects commands -compare*, -update*, and overwrite situations. -See option -split_size for details. +See command -split_size for details. @c man .TP @item -cpr disk_path [***] iso_rr_path @kindex -cpr inserts like with cp -r @@ -1644,10 +1645,10 @@ FAILURE event. A well tested -split_size is 2047m. Sizes above -file_size_limit are not permissible. @* -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 +While command -split_size is set larger than 0 such a directory with split +file pieces will be recognized and handled like a regular file by commands -compare* , -update*, and in overwrite situations. There are -ossirox -options "concat_split_on" and "concat_split_off" which control the handling +parameters "concat_split_on" and "concat_split_off" which control the handling when files get restored to disk. @* In order to be recognizable, the names of the part files have to @@ -1710,7 +1711,7 @@ medium in modification mode. @kindex -rm_r deletes trees from ISO image @cindex Delete, from ISO image, -rm_r Delete the given files or directory trees from the ISO image. -See also the note with option -rm. +See also the note with command -rm. @c man .TP @item -rmdir iso_rr_path [***] @kindex -rmdir deletes ISO directory @@ -1838,7 +1839,7 @@ Only names from the user namespace are allowed. I.e. a name has to begin with "user.", like "user.x" or "user.whatever". @* Values and names undergo the normal input processing of @command{xorriso}. -See also option -backslash_codes. Other than with option -setfattr_list, +See also command -backslash_codes. Other than with command -setfattr_list, the byte value 0 cannot be expressed via -setfattr. @c man .TP @item -setfattr_r [-]name value iso_rr_path [***] @@ -1867,7 +1868,7 @@ Name must be from user namespace. I.e. user.xyz where xyz should consist of printable characters only. The separator "=" is not allowed in names. Value may contain any kind of bytes. It must be in quotes. Trailing whitespace after the end quote will be ignored. Non-printables bytes and quotes -must be represented as \XYZ by their octal ASCII code XYZ. +must be represented as \XYZ by their octal 8-bit code XYZ. Use code \000 for 0-bytes. @c man .TP @item -alter_date type timestring iso_rr_path [***] @@ -2165,7 +2166,7 @@ prints access permissions in ACL text form to the result channel. @* @item setfacl attaches ACLs after removing existing ones. The new -ACL is given in text form as defined with option -setfacl. +ACL is given in text form as defined with command -setfacl. @* E.g.: -exec setfacl u:lisa:rw,u::rw,g::r,o::@minus{},m::rw @minus{}@minus{} @* @@ -2192,7 +2193,7 @@ Mode "b" prints backslash encoding. Not suitable for shell parsing. @* E.g. -exec list_extattr e -- @* -Option -backslash_codes does not affect the output. +Command -backslash_codes does not affect the output. @* @item get_md5 prints the MD5 sum, if recorded, together with file path. @@ -2428,7 +2429,7 @@ Switch to growing mode. are uncommitted manipulations pending. @* So, to perform a final write operation with no new -dev -and no new loading of image, rather execute option -end. +and no new loading of image, rather execute command -end. If you want to go on without image loading, execute -commit_eject "none". To eject after write without image loading, use -commit_eject "all". @* @@ -2488,7 +2489,7 @@ but produces media which are only suitable for a single session. Some drives announce this state by not offering feature 21h, but some drives offer it anyway. If feature 21h is missing, then @command{xorriso} -will refuse to write on DVD-RW if not option -close is set to "on". +will refuse to write on DVD-RW if not command -close is set to "on". @* The progress reports issued by some drives while blanking are quite unrealistic. Do not conclude success or failure from the @@ -2512,7 +2513,7 @@ unformatted BD-R. Other media are left untouched. @* "fast" does the same as "full" but tries to be quicker. @* -"by_index_" selects a format out of the descriptor list issued by option +"by_index_" selects a format out of the descriptor list issued by command -list_formats. The index number from that list is to be appended to the mode word. E.g: "by_index_3". @* @@ -2587,7 +2588,7 @@ or BD-R media. It is indicated by warning messages when the drive gets acquired, and by a remark "but next track is damaged" with the line "Media status :" of command -toc. @* -The setting of option -close determines whether the medium stays appendable. +The setting of command -close determines whether the medium stays appendable. @* Mode "as_needed" gracefully refuses on media which are not reported as damaged. Mode "force" attempts the close operation even with media which @@ -2608,7 +2609,7 @@ The currently recognized type is marked by text "(current)". @section Settings for result writing @c man .PP Rock Ridge info will be generated by the program unconditionally. -ACLs will be written according to the setting of option -acl. +ACLs will be written according to the setting of command -acl. @table @asis @sp 1 @c man .TP @@ -2627,7 +2628,7 @@ cases it is worth to deviate a bit in order to circumvent bugs of the intended reader system or to get unofficial extra features. @* There are several adjustable rules which have a keyword each. If they -are mentioned with this option then their rule gets added to the relaxation +are mentioned with this command then their rule gets added to the relaxation list. This list can be erased by rules "strict" or "clear". It can be reset to its start setting by "default". All of the following relaxation rules can be revoked individually by appending "_off". Like "deep_paths_off". @@ -2662,11 +2663,12 @@ not 8.3. @* "lowercase" allows lowercase characters in ISO file names. @* -"full_ascii" allows all ASCII characters in ISO file names. +"full_ascii" allows all 8-bit characters except 0x0 and '/' +in ISO file names. @* "untranslated_names" might be dangerous for inadverted reader programs which rely on the restriction to at most 37 characters in ISO file names. -This option allows ISO file names up to 96 characters with no character +This rule allows ISO file names up to 96 characters with no character conversion. If a file name has more characters, then image production will fail deliberately. @* @@ -2799,7 +2801,7 @@ It is supposed to match this GRUB line: @* E.g. 2010040711405800 is 7 Apr 2010 11:40:58 (+0 centiseconds). @* -Timestrings for the other types may be given as with option -alter_date. +Timestrings for the other types may be given as with command -alter_date. They are prone to timezone computations. The timestrings "default" or "overridden" cause default settings: "c" and "m" will show the current time of image creation. "x" and "f" will be marked as insignificant. @@ -2869,7 +2871,7 @@ Group id to be used for all files when the new ISO tree gets written to media. @cindex Filter, zisofs parameters, -zisofs Set global parameters for zisofs compression. This data format is recognized and transparently uncompressed by some Linux kernels. It is to be applied -via option -set_filter with built-in filter "@minus{}@minus{}zisofs". +via command -set_filter with built-in filter "@minus{}@minus{}zisofs". Parameters are: @* "level="[0-9] zlib compression: 0=none, 1=fast,..., 9=slow @@ -2926,7 +2928,7 @@ written and writing of file content blocks begins. GNU/Linux specific: Set the number of bytes to be transmitted with each write operation to DVD 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 option +show latency problems. The default depends on media type, on command -stream_recording , and on compile time options. @c man .TP @item -stdio_sync "on"|"off"|number @@ -2958,7 +2960,7 @@ which means unit is kiB (= 1024) or MiB (= 1024 kiB). If "on" then mark the written medium as not appendable any more (if possible at all with the given type of target media). @* -This is the contrary of cdrecord, wodim, cdrskin option -multi, +This is the contrary of cdrecord, wodim, cdrskin command -multi, and is one aspect of growisofs option -dvd-compat. @c man .TP @item -padding number["k"|"m"]|"included"|"appended" @@ -3229,7 +3231,7 @@ Only a single boot file can be declared by mipsel_path=. @strong{sparc_label=}text causes the production of a SUN Disk Label with the given text as ASCII label. This boot block format allows to append images for partitions 2 to 8. Partition 1 will always be the ISO image. -See option -append_partition. +See command -append_partition. The first 512 bytes of any data provided by system_area= will be overwritten. @* @strong{mips_discard} and @strong{sparc_discard} revoke any boot file @@ -3408,7 +3410,7 @@ convert byte codes. There is an input conversion from input character set to the local character set which applies when an ISO image gets loaded. A conversion from local character set to the output character set is performed when an -image tree gets written. The sets can be defined independently by options +image tree gets written. The sets can be defined independently by commands -in_charset and -out_charset. Normally one will have both identical, if ever. @* If conversions are desired then @command{xorriso} needs to know the name of the @@ -3424,7 +3426,7 @@ filesystem names and emerging names in the image. The situation stays ambigous and the reader has to riddle what character set was used. @* -By option -auto_charset it is possible to attribute the output charset name +By command -auto_charset it is possible to attribute the output charset name to the image. This makes the situation unambigous. But if your terminal character set does not match the character set of the local file names, then this attribute can become plainly wrong and cause problems at read time. @@ -3499,10 +3501,10 @@ Set the severity threshold for events to abort the program. Useful: "NEVER", "ABORT", "FATAL", "FAILURE" , "MISHAP", "SORRY" @* It may become necessary to abort the program anyway, despite -the setting by this option. Expect not many "ABORT" events to +the setting by this command. Expect not many "ABORT" events to be ignorable. @* -A special property of this option is that it works preemptive if given as +A special property of this command is that it works preemptive if given as program start argument. I.e. the first -abort_on setting among the start arguments is in effect already when the first operations of @command{xorriso} begin. Only "-abort_on" with dash "-" is recognized that way. @@ -3545,7 +3547,7 @@ Event messages are sent to the info channel "I" which is usually stderr but may be influenced by command -pkt_output. Info messages which belong to no event get attributed severity "NOTE". @* -A special property of this option is that the first -report_about setting +A special property of this command is that the first -report_about setting among the start arguments is in effect already when the first operations of @command{xorriso} begin. Only "-report_about" with dash "-" is recognized that way. @@ -3579,7 +3581,7 @@ kill -9 then imposes the risk that the drive is left in unusable state and needs poweroff to be reset. So during burning, blanking, and formatting wait for at least their normal run time before killing externally. @* -A special property of this option is that the first -signal_handling setting +A special property of this command is that the first -signal_handling setting among the start arguments is in effect already when the first operations of @command{xorriso} begin. Only "-signal_handling" with dash "-" is recognized that way. @@ -3590,12 +3592,12 @@ recognized that way. Control the program behavior at problem event occasions. For now this applies to occasions "image_loading" which is given while an image tree is read from the input device, and to "file_extraction" which -is given with osirrox options like -extract. +is given with osirrox commands like -extract. @* With "image_loading" there are three behaviors available: @* "best_effort" goes on with reading after events with severity below FAILURE -if the threshold of option -abort_on allows this. +if the threshold of command -abort_on allows this. @* "failure" aborts image tree reading on first event of at least SORRY. It issues an own FAILURE event. @@ -3677,9 +3679,9 @@ directory only once and not for each file in its whole subtree. Setting "off" silently kills any kind of image file object resp. performs above irrevocable actions. @* -To really produce user prompts, option -dialog needs to be set to "on". +To really produce user prompts, command -dialog needs to be set to "on". Note that the prompt does not appear in situations where file removal -is forbidden by option -overwrite. -reassure only imposes an additional +is forbidden by command -overwrite. -reassure only imposes an additional curb for removing existing file objects. @* Be aware that file objects get deleted from the ISO image immediately @@ -3700,7 +3702,7 @@ Show list of available MMC drives with the addresses of their libburn standard device files. @* This is only possible when no ISO image changes are pending. -After this option was executed, there is no drive current +After this command was executed, there is no drive current and no image loaded. @* In order to be visible, a device has to offer rw-permissions @@ -3740,7 +3742,7 @@ with only one or two sessions on it. The last of these sessions is supposed to be the most recent real session then. @* Some read-only drives and media show no usable session history at all. -Option -rom_toc_scan might help. +Command -rom_toc_scan might help. @c man .TP @item -mount_cmd drive entity id path @kindex -mount_cmd composes mount command line @@ -3760,7 +3762,7 @@ as id. @* path will be used as mount point and must already exist as a directory on disk. @* -The command gets printed to the result channel. See option -mount +The command gets printed to the result channel. See command -mount for direct execution of this command. @c man .TP @item -mount_opts option[:option...] @@ -3799,9 +3801,9 @@ session number, resp. volume id of the depicted session. @cindex Write, predict image size, -print_size Print the foreseeable consumption of 2048 byte blocks by next -commit. This can last a while as a -commit gets -prepared and only in last moment is revoked by this option. +prepared and only in last moment is revoked by this command. The result depends on several settings and also on the kind of output device. -If no -jidgo options are given and not command -as "mkisofs" was used, +If no -jidgo options are set and not command -as "mkisofs" was used, then -padding (300 kB by default) is not counted as part of the image size. @c man .TP @item -tell_media_space @@ -3814,7 +3816,7 @@ subtracting already foreseeable consumption by next -commit. @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 -them may be changed by options like -volid or -publisher. For these +them may be changed by commands like -volid or -publisher. For these ids -pvd_info reports what would be written with the next -commit. @end table @c man .TP @@ -3923,7 +3925,7 @@ Output format resembles shell command ls -dln. Print the access permissions of the given files in the ISO image using the format of shell command getfacl. If a file has no ACL then it gets fabricated from the -chmod settings. A file may have a real ACL if it was introduced into -the ISO image while option -acl was set to "on". +the ISO image while command -acl was set to "on". @c man .TP @item -getfacl_r iso_rr_pattern [***] @kindex -getfacl_r shows ACL in ISO image @@ -4098,7 +4100,7 @@ according to their read speed, save them to a file, and keep track of successfuly saved blocks for further tries on the same medium. @* -By option -md5 checksums may get recorded with data files and whole +By command -md5 checksums may get recorded with data files and whole sessions. These checksums are reachable only via indev and a loaded image. They work independently of the media type and can detect transmission errors. @table @asis @@ -4112,9 +4114,9 @@ Try to read data blocks from the indev drive, optionally copy them to a disk file, and finally report about the encountered quality. Several options may be used to modify the default behavior. @* -The options given with this command override the default settings which -may have been changed by option -check_media_defaults. See there for a -description of options. +The parameters given with this command override the default settings which +may have been changed by command -check_media_defaults. See there for a +description of available options. @* The result list tells intervals of 2 KiB blocks with start address, number of blocks and quality. Qualities which begin with "+" are @@ -4267,10 +4269,10 @@ This gets rounded down to full blocks of 2048 bytes. 0 means automatic size. Compare the data content of the given files in the loaded image with their recorded MD5 checksums, if there are any. In case of any mismatch an event of the given severity is issued. It may then be handled by appropriate settings of -options -abort_on or -return_with which both can cause non-zero exit values +commands -abort_on or -return_with which both can cause non-zero exit values of the program run. Severity ALL suppresses that event. @* -This option reports match and mismatch of data files to the result channel. +This command reports match and mismatch of data files to the result channel. Non-data files cause NOTE events. There will also be UPDATE events from data reading. @* @@ -4285,9 +4287,9 @@ Like -check_md5 but checking all data files underneath the given paths. Only mismatching data files will be reported. @end table @c man .TP -@c man .B osirrox ISO-to-disk restore options: +@c man .B osirrox ISO-to-disk restore commands: @node Restore, Emulation, Verify, Options -@section osirrox ISO-to-disk restore options +@section osirrox ISO-to-disk restore commands @c man .PP Normally @command{xorriso} only writes to disk files which were given as stdio: pseudo-drives or as log files. @@ -4435,7 +4437,7 @@ ownership and group as in ISO image. @cindex Restore, copy file into disk file, -paste_in Read the content of a ISO data file and write it into a data file on disk beginning at the byte_offset. Write at most byte_count bytes. -This is the inverse of option -cut_out. +This is the inverse of command -cut_out. @c man .TP @item -mount drive entity id path @kindex -mount issues mount command for ISO session @@ -4495,7 +4497,7 @@ persists until things happen like -commit, -rollback, -dev, or end of -pacifier gets set to "mkisofs" if files are added to the image. @* -graft-points is equivalent to -pathspecs on. Note that pathspecs without "=" -are interpreted differently than with @command{xorriso} option -add. +are interpreted differently than with @command{xorriso} command -add. Directories get merged with the root directory of the ISO image, other filetypes get mapped into that root directory. @@ -4504,7 +4506,7 @@ If pathspecs are given and if no output file was chosen before or during the "mkisofs" option list, then standard output (-outdev "-") will get into effect. If -o points to a regular file, then it will be truncated to 0 bytes when finally writing begins. This truncation does not happen if the drive -is chosen by @command{xorriso} options before -as mkisofs or after its +is chosen by @command{xorriso} commands before -as mkisofs or after its list delimiter. Directories and symbolic links are no valid -o targets. @* Writing to stdout is possible only if -as "mkisofs" was among the start @@ -4533,7 +4535,7 @@ resp. to "on" by @minus{}@minus{}old-root-devno . 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 +They work like the @command{xorriso} commands with the same name and hardcoded parameter "on", e.g. -acl "on". Explicit parameters are expected by @minus{}@minus{}stdio_sync and @minus{}@minus{}scdbackup_tag. @@ -4570,7 +4572,7 @@ instead of -G to apply the effect of -boot_image isolinux partition_table=on. @minus{}partition_offset number is @minus{}boot_image any partition_offset=number. @* -Option @minus{}append_partition is supported. +Command @minus{}append_partition is supported. @* @minus{}untranslated_name_len number is @minus{}compliance untranslated_name_len=number. @@ -4578,7 +4580,7 @@ Option @minus{}append_partition is supported. @minus{}@minus{}old-empty is -compliance old_empty. @* The options of genisoimage Jigdo Template Extraction are recognized and -performed via @command{xorriso} option -jigdo. See the "Alias:" names there +performed via @command{xorriso} command -jigdo. See the "Alias:" names there for the meaning of the genisoimage options. @* @sp 1 @@ -4592,7 +4594,7 @@ If @command{xorriso} is started with one of the leafnames "xorrisofs", -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. +From then on, arguments are interpreted as @command{xorriso} commands. @* @minus{}@minus{}no_rc as first argument of such a program start prevents interpretation of startup files. See section FILES below. @@ -4641,7 +4643,7 @@ If @command{xorriso} is started with one of the leafnames "xorrecord", "cdrskin", "cdrecord", or "wodim", then it automatically prepends -as "cdrskin" 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. +From then on, arguments are interpreted as @command{xorriso} commands. @* @minus{}@minus{}no_rc as first argument of such a program start prevents interpretation of @command{xorriso} startup files. @@ -4705,7 +4707,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 program argument this option +Only if used as first program argument this command prevents reading and interpretation of startup files. See section FILES below. @c man .TP @item -options_from_file fileaddress @@ -4821,8 +4823,8 @@ With the start program arguments there is mode: @* Mode "encode_output" encodes output characters. It combines "encode_results" with "encode_infos". Inside single or double quotation marks encoding applies -to ASCII characters octal 001 to 037 , 177 to 377 and to backslash(134). -Outside quotation marks some harmless control characters stay unencoded: +to 8-bit characters octal 001 to 037 , 177 to 377 and to backslash(134). +Outside quotation marks some harmless ASCII control characters stay unencoded: bell(007), backspace(010), tab(011), linefeed(012), formfeed(014), carriage_return(015). @* @@ -4910,7 +4912,7 @@ Mode "on" enables very verbous logging of SCSI commands and drive replies. Logging messages get printed to stderr, not to any of the @command{xorriso} output channels. @* -A special property of this option is that the first -scsi_log setting +A special property of this command is that the first -scsi_log setting among the start arguments is in effect already when the first operations of @command{xorriso} begin. Only "-scsi_log" with dash "-" is recognized that way. @@ -5113,7 +5115,7 @@ $ xorriso -outdev /dev/sr2 \ @sp 1 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 +with addresses from the hard disk. Commands -add and -map have different 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 @@ -5123,8 +5125,8 @@ parameter rules but finally the same effect: they put files into the image. Some settings are already given as start argument. The other activities are done as dialog input. The pager gets set to 20 lines of 80 characters. @* -The drive is acquired by option -dev rather than -outdev in order to see -the message about its current content. By option -blank this content is +The drive is acquired by command -dev rather than -outdev in order to see +the message about its current content. By command -blank this content is made ready for being overwritten and the loaded ISO image is made empty. @* In order to be able to eject the medium, the session needs to be committed @@ -5273,7 +5275,7 @@ the same files gets added with converted file names. In order to avoid any weaknesses of the local character set, this command pretends that it uses already the final target set UTF-8. Therefore strange file names may appear in messages, which -will be made terminal-safe by option -backslash_codes. +will be made terminal-safe by command -backslash_codes. @* @sp 1 $ xorriso -in_charset ISO-8859-1 -local_charset UTF-8 \ @@ -5527,7 +5529,7 @@ the old one. This makes sense if the full backup leaves substantial remaining capacity on media and if the expected changes are much smaller than the full backup. To apply zisofs compression to those data files which get newly copied from -the local filesystem, insert these options immediately before -commit : +the local filesystem, insert these commands immediately before -commit : @* @sp 1 -hardlinks perform_update \ @@ -5535,7 +5537,7 @@ the local filesystem, insert these options immediately before -commit : -find / -type f -pending_data -exec set_filter @minus{}@minus{}zisofs @minus{}@minus{} \ @* @sp 1 -Options -disk_dev_ino and -for_backup depend on stable device and inode numbers +Commands -disk_dev_ino and -for_backup depend on stable device and inode numbers on disk. Without them, an update run may use -md5 "on" to match recorded MD5 sums against the current file content on hard disk. This is usually much faster than the default which compares both contents directly. @@ -5547,15 +5549,15 @@ versions. With CD media, GNU/Linux mount accepts session numbers directly by its option "session=". @* Multi-session media and most overwriteable media written by @command{xorriso} -can tell the sbsectors of their sessions by @command{xorriso} option -toc. -Used after -commit the following option prints the matching mount command for +can tell the sbsectors of their sessions by @command{xorriso} command -toc. +Used after -commit the following command prints the matching mount command for the newly written session (here for mount point /mnt): @* @sp 1 -mount_cmd "indev" "auto" "auto" /mnt @* @sp 1 -Options -mount_cmd and -mount are also able to produce the mount commands for +Commands -mount_cmd and -mount are also able to produce the mount commands for older sessions in the table-of-content. E.g. as superuser: @* @sp 1 @@ -5664,7 +5666,7 @@ program name pre-select certain settings: @strong{xorrecord} starts @command{xorriso} with -as cdrecord emulation. @* @strong{osirrox} starts with -osirrox "on:o_excl_off" which allows -to copy files from ISO image to disk and to apply option -mount to +to copy files from ISO image to disk and to apply command -mount to one or more of the existing ISO sessions. @c man .SS @c man .B Startup files: