From 8a6f217c42898cef16aba5b141ad1622f9eb93e3 Mon Sep 17 00:00:00 2001 From: Thomas Schmitt Date: Sat, 14 May 2011 10:50:08 +0000 Subject: [PATCH] Patch by Mats Erik Anderson: wrap @command{} around the word xorriso --- xorriso/make_xorriso_1.c | 19 ++ xorriso/xorriso.1 | 234 ++++++++++---------- xorriso/xorriso.info | 455 ++++++++++++++++++++------------------- xorriso/xorriso.texi | 245 ++++++++++----------- 4 files changed, 489 insertions(+), 464 deletions(-) diff --git a/xorriso/make_xorriso_1.c b/xorriso/make_xorriso_1.c index aba2c588..fe76b492 100644 --- a/xorriso/make_xorriso_1.c +++ b/xorriso/make_xorriso_1.c @@ -111,6 +111,23 @@ int Mx1_substitute(struct Mx1 *m, char line_in[256], char line_out[256], strcpy(wpt, "\\fR"); wpt+= 3; rpt+= ept - rpt; + } else if(strncmp(rpt, "@command{}", 9) == 0) { + /* @command{... } gets mapped to \fB...\fR . */ + ept= strchr(rpt, '}'); + if(ept == NULL) { + Mx1_report_error(m, "No closing bracket found for '@command{'", 0); + return(-1); + } + l= ept - rpt - 9; + if((wpt - line_out) + l + 6 + (rpt[9] == '-') > 255) + goto overflow; + strcpy(wpt, "\\fB"); + wpt+= 3; + strncpy(wpt, rpt + 9, l); + wpt+= l; + strcpy(wpt, "\\fR"); + wpt+= 3; + rpt+= ept - rpt; } else if(strncmp(rpt, "@minus{}", 8) == 0) { /* @minus{} will become "-". */ if((wpt - line_out) + 1 > 255) @@ -252,11 +269,13 @@ int Mx1_convert(struct Mx1 *m, char line_in[256], char line_out[256], int flag) /* @strong{-...} gets mapped to \fB\-...\fR . */ /* @strong{... } gets mapped to \fB...\fR . */ + /* @command{... } gets mapped to \fB...\fR . */ /* @minus{} will become "-". */ /* @@ , @{, @} will get stripped of their first @. */ /* "\" becomes "\\" */ if(line_in[0] != '@' || strncmp(line_in, "@strong{", 8) == 0 || + strncmp(line_in, "@command{", 9) == 0 || strncmp(line_in, "@minus{}", 8) == 0 || strncmp(line_in, "@@", 2) == 0 || strncmp(line_in, "@{", 2) == 0 || diff --git a/xorriso/xorriso.1 b/xorriso/xorriso.1 index 8da16c8a..cbac7f4d 100644 --- a/xorriso/xorriso.1 +++ b/xorriso/xorriso.1 @@ -39,9 +39,9 @@ session\-wise manipulation of such filesystems. It can load the management information of existing ISO images and it writes the session results to optical media or to filesystem objects. .br -Vice versa xorriso is able to copy file objects out of ISO 9660 filesystems. +Vice versa \fBxorriso\fR is able to copy file objects out of ISO 9660 filesystems. .PP -A special property of xorriso is that it needs neither an external ISO 9660 +A special property of \fBxorriso\fR is that it needs neither an external ISO 9660 formatter program nor an external burn program for CD, DVD or BD but rather incorporates the libraries of libburnia\-project.org . .SS @@ -137,16 +137,16 @@ types. But program growisofs by Andy Polyakov showed how to extend this functionality to overwriteable media or disk files which carry valid ISO 9660 filesystems. .PP -xorriso provides growing as well as an own method named +\fBxorriso\fR provides growing as well as an own method named \fBmodifying\fR which produces a completely new ISO image from the old one and the modifications. See paragraph Creating, Growing, Modifying, Blind Growing below. .PP -xorriso adopts the concept of multi\-session by loading an eventual image +\fBxorriso\fR adopts the concept of multi\-session by loading an eventual image directory tree, allowing to manipulate it by several actions, and to write the new image to the target media. .br -The first session of a xorriso run begins by the definition of the input +The first session of a \fBxorriso\fR run begins by the definition of the input drive with the eventual ISO image or by the definition of an output drive. The session ends by command \-commit which triggers writing. A \-commit is done automatically when the program ends regularly. @@ -170,12 +170,12 @@ describes their existing sessions. See option \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. -xorriso will write onto them only if option \-close is set to "on". +\fBxorriso\fR will write onto them only if option \-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 session history. If they contain one or more ISO 9660 sessions and if the -first session was written by xorriso, then a table of content can +first session was written by \fBxorriso\fR, then a table of content can be emulated. Else only a single overall session will be visible. .br DVD\-RW media can be formatted by \-format "full". @@ -188,23 +188,23 @@ These media can assume several states in which they offer different capabilities. .br \fBBlank\fR media can be written from scratch. They contain no ISO image -suitable for xorriso. +suitable for \fBxorriso\fR. .br Blank is the state of newly purchased optical media. With used CD\-RW and DVD\-RW it can be achieved by action \-blank "as_needed". Overwriteable media are considered blank if they are new or if they have -been marked as blank by xorriso. +been marked as blank by \fBxorriso\fR. Action \-blank "as_needed" can be used to do this marking on overwriteable media, or to apply eventual mandatory formatting to new media. .br \fBAppendable\fR 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. +which contain an ISO image suitable for \fBxorriso\fR. .br Appendable is the state after writing a session with option \-close off. .br \fBClosed\fR media cannot be written. They may contain an ISO image suitable -for xorriso. +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 @@ -264,7 +264,7 @@ to the given block address. This is the usage model of mkisofs \-M $indev \-C $msc1,$msc2 \-o $outdev .br which gives much room for wrong parameter combinations and should thus only be -employed if a strict distinction between ISO formatter xorriso and the burn +employed if a strict distinction between ISO formatter \fBxorriso\fR and the burn program is desired. \-C $msc1,$msc2 is equivalent to: .br \-load sbsector $msc1 \-grow_blindly $msc2 @@ -279,7 +279,7 @@ Output drive, i.e. target for writing, can be any libburn drive. Some drive types do not support the method of growing but only the methods of modifying and blind growing. They all are suitable for newly created images. .br -All drive file objects have to offer rw\-permission to the user of xorriso. +All drive file objects have to offer rw\-permission to the user of \fBxorriso\fR. Even those which will not be useable for reading an ISO image. .PP MMC compliant (i.e. optical) drives on GNU/Linux usually get addressed by @@ -366,11 +366,11 @@ is the name of a set of additional information which enhance an ISO 9660 filesystem so that it can represent a POSIX compliant filesystem with ownership, access permissions, symbolic links, and other attributes. .br -This is what xorriso uses for a decent representation of the disk files -within the ISO image. Rock Ridge information is produced with any xorriso +This is what \fBxorriso\fR uses for a decent representation of the disk files +within the ISO image. Rock Ridge information is produced with any \fBxorriso\fR image. .PP -xorriso is not named "porriso" because POSIX only guarantees 14 characters +\fBxorriso\fR is not named "porriso" because POSIX only guarantees 14 characters of filename length. It is the X/Open System Interface standard XSI which demands a file name length of up to 255 characters and paths of up to 1024 characters. Rock Ridge fulfills this demand. @@ -381,7 +381,7 @@ images, which are binary program files stored in the ISO image. 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. -xorriso is able to create or maintain an El Torito object which makes such +\fBxorriso\fR is able to create or maintain an El Torito object which makes such an image bootable. For details see option \-boot_image. .br It is possible to make ISO images bootable from USB stick or other @@ -409,25 +409,25 @@ It uses this extension if enabled by option .br AAIP enhanced images are supposed to be mountable normally, but one cannot expect that the mounted filesystem will show and respect the eventual ACLs. -For now, only xorriso is able to retrieve those ACLs. It can bring them into +For now, only \fBxorriso\fR is able to retrieve those ACLs. It can bring them into effect when files get restored to an ACL enabled file system or it can print them in a format suitable for tool setfacl. .br Files with ACL show as group permissions the setting of entry "mask::" if that entry exists. Nevertheless the non\-listed group members get handled -according to entry "group::". xorriso brings "group::" into effect before +according to entry "group::". \fBxorriso\fR brings "group::" into effect before eventually removing the ACL from a file. .PP \fBxattr\fR (aka EA) are pairs of name and value which can be attached to file objects. AAIP is -able to represent them and xorriso allows to record and restore pairs which +able to represent them and \fBxorriso\fR allows to record and restore 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 \fB\-xattr\fR. .br -As with ACL, currently only xorriso is able to retrieve xattr from AAIP +As with ACL, currently only \fBxorriso\fR is able to retrieve xattr from AAIP enhanced images, to restore them to xattr capable file systems, or to print them. .SS @@ -473,9 +473,9 @@ Command and parameter words are either read from program arguments, where one argument is one word, or from quoted input lines where words are recognized similar to the quotation rules of a shell parser. .br -xorriso is not a shell, although it might appear so on first glimpse. +\fBxorriso\fR is not a shell, although it might appear so on first glimpse. Be aware that the interaction of quotation marks and pattern symbols like "*" -differs from the usual shell parsers. In xorriso, a quotation mark does not +differs from the usual shell parsers. In \fBxorriso\fR, a quotation mark does not make a pattern symbol literal. .PP \fBQuoted input\fR @@ -511,8 +511,8 @@ them as commands with their parameters. It provides assisting services to make dialog more comfortable. .PP Readline is an enhancement for the input line. You may know it already from -the bash shell. Whether it is available in xorriso depends on the availability -of package readline\-dev at the time when xorriso was built from its sourcecode. +the bash shell. Whether it is available in \fBxorriso\fR depends on the availability +of package readline\-dev at the time when \fBxorriso\fR was built from its sourcecode. .br It allows to move the cursor over the text in the line by help of the Leftward and the Rightward arrow key. @@ -527,7 +527,7 @@ Option \-page activates a built\-in result text pager which may be convenient in dialog. After an action has put out the given number of terminal lines, the pager prompts the user for a line of input. .br -An empty line lets xorriso resume work until the next page is put out. +An empty line lets \fBxorriso\fR resume work until the next page is put out. .br The single character "@" disables paging for the current action. .br @@ -602,7 +602,7 @@ predicted_nwa is the block address where the add\-on session of blind growing will finally end up. It is the responsibility of the user to ensure this final position and the presence of the older sessions. Else the overall ISO image will not be mountable or will produce read errors when -accessing file content. xorriso will write the session to the address +accessing file content. \fBxorriso\fR will write the session to the address as obtained from examining \-outdev and not necessarily to predicted_nwa. .br During a run of blind growing, the input drive is given up before output @@ -670,7 +670,7 @@ accepted. If it is not a MMC device then the prefix "stdio:" will be prepended automatically. This list is empty by default. .br Else if the path matches the "banned" list then the drive will not be -accepted by xorriso but rather lead to a FAILURE event. This list is empty by +accepted by \fBxorriso\fR but rather lead to a FAILURE event. This list is empty by default. .br Else if the path matches the "caution" list and if it is not a MMC device, @@ -689,7 +689,7 @@ By pseudo\-class "clear_list" and pseudo\-patterns "banned", "caution", .br E.g.: \-drive_class clear_list banned .br -One will normally define the \-drive_class lists in one of the xorriso +One will normally define the \-drive_class lists in one of the \fBxorriso\fR Startup Files. .br Note: This is not a security feature but rather a bumper for the superuser to @@ -719,7 +719,7 @@ an eventual recorded character set name gets used as input character set when reading an image. .br Note that the default output charset is the local character set of the -terminal where xorriso runs. Before attributing this local character set +terminal where \fBxorriso\fR runs. Before attributing this local character set to the produced ISO image, check whether the terminal properly displays all intended filenames, especially exotic national characters. .TP @@ -746,7 +746,7 @@ e.g. if you need to apply filters to all updated files. Mode "without_update" avoids hardlink processing during update commands. Use this if your filesystem situation does not allow \-disk_dev_ino "on". .br -xorriso commands which extract files from an ISO image try to hardlink files +\fBxorriso\fR commands which extract files from an ISO image try to hardlink files with identical inode number. The normal scope of this operation is from image load to image load. One may give up the accumulated hard link addresses by \-hardlinks "discard_extract". @@ -760,7 +760,7 @@ wide and expensive hardlink accumulation. .TP \fB\-acl\fR "on"|"off" Enable or disable processing of ACLs. -If enabled, then xorriso will obtain ACLs from disk file objects, +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. @@ -768,7 +768,7 @@ See also options \-getfacl, \-setfacl. .TP \fB\-xattr\fR "on"|"off" Enable or disable processing of xattr attributes in user namespace. -If enabled, then xorriso will handle xattr similar to ACL. +If enabled, then \fBxorriso\fR will handle xattr similar to ACL. See also options \-getfattr, \-setfattr and above paragraph about xattr. .TP \fB\-md5\fR "on"|"all"|"off"|"load_check_off" @@ -796,7 +796,7 @@ Mode "load_check_off" together with "on" or "all" will load recorded MD5 sums but not test the recorded checksum tags of superblock and directory tree. This is necessary if growisofs was used as burn program, because it does not overwrite the superblock checksum tag of the first session. -Therefore load_check_off is in effect when xorriso \-as mkisofs option \-M +Therefore load_check_off is in effect when \fBxorriso\fR \-as mkisofs option \-M is performed. .br The test can be re\-enabled by mode "load_check_on". @@ -846,7 +846,7 @@ to invalid addresses and thus ugly drive behavior. Setting "on" enables that scan for alleged read\-only media. .br Some operating systems are not able to mount the most recent session of -multi\-session DVD or BD. If on such a system xorriso has no own MMC +multi\-session DVD or BD. If on such a system \fBxorriso\fR has no own MMC capabilities then it may still find that session from a scanned table of content. Setting "force" handles any media like a ROM media with setting "on". .br @@ -1103,7 +1103,7 @@ arguments. \fB\-file_size_limit\fR value [value [...]] -- Set the maximum permissible size for a single data file. The values get summed up for the actual limit. If the only value is "off" then the file -size is not limited by xorriso. Default is a limit of 100 extents, 4g \-2k each: +size is not limited by \fBxorriso\fR. Default is a limit of 100 extents, 4g \-2k each: .br \-file_size_limit 400g \-200k \-\- .br @@ -1112,7 +1112,7 @@ up to 2g \-1 \-\-. Newer ones are good up to 4g \-1 \-\-. You need quite a new Linux kernel to read correctly the final bytes of a file >= 4g if its size is not aligned to 2048 byte blocks. .br -xorriso's own data read capabilities are not affected by eventual +\fBxorriso\fR's own data read capabilities are not affected by eventual operating system size limits. They apply to mounting only. Nevertheless, the target filesystem of an \-extract must be able to take the file size. .TP @@ -1234,7 +1234,7 @@ The number given with "limit=" can curb this workload at the risk of truncating an intentional sequence of link hops. .TP \fB\-pathspecs\fR "on"|"off" -Control parameter interpretation with xorriso actions \-add and \-path_list. +Control parameter interpretation with \fBxorriso\fR actions \-add and \-path_list. .br "on" enables pathspecs of the form \fBtarget=source\fR @@ -1426,7 +1426,7 @@ be an empty text. 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 xorriso. +Values and names undergo the normal input processing of \fBxorriso\fR. See also option \-backslash_codes. Other than with option \-setfattr_list, the byte value 0 cannot be expressed via \-setfattr. .TP @@ -1481,7 +1481,7 @@ Absolute seconds counted from Jan 1 1970: .br =Number .br -xorriso's own timestamps: +\fBxorriso\fR's own timestamps: .br YYYY.MM.DD[.hh[mm[ss]]] .br @@ -1636,7 +1636,7 @@ If \-else is missing and would be hit, then the result is a non\-match. Default action is \fBecho\fR, i.e. to print the address of the found file. Other actions are certain -xorriso commands which get performed on the found files. These commands +\fBxorriso\fR commands which get performed on the found files. These commands may have specific parameters. See also their particular descriptions. .br \fBchown\fR and \fBchown_r\fR @@ -1862,8 +1862,8 @@ is not applied to any file in the ISO image. Irrevocably ban commands \-external_filter and \-unregister_filter, but not \-set_filter. Use this to prevent external filtering in general or when all intended filters are registered. -External filters may also be banned totally at compile time of xorriso. -By default they are banned if xorriso runs under setuid permission. +External filters may also be banned totally at compile time of \fBxorriso\fR. +By default they are banned if \fBxorriso\fR runs under setuid permission. .TP \fB\-set_filter\fR name iso_rr_path [***] Apply an \-external_filter or a built\-in filter to the given data files in the @@ -1923,7 +1923,7 @@ Writing can last quite a while. It is not unnormal with several types of media that there is no progress visible for the first few minutes or that the drive gnaws on the media for a few minutes after all data have been transmitted. -xorriso and the drives are in a client\-server relationship. +\fBxorriso\fR and the drives are in a client\-server relationship. The drives have much freedom about what to do with the media. Some combinations of drives and media simply do not work, despite the promises by their vendors. @@ -1963,7 +1963,7 @@ overwriteable ISO images. "all" might work more thoroughly and need more time. .br "deformat_quickest" is a faster way to deformat or blank DVD\-RW but produces media which are only suitable for a single session. -xorriso will write onto them only if option \-close is set to "on". +\fBxorriso\fR will write onto them only if option \-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 @@ -2139,7 +2139,7 @@ Note: The term "ISO file" means the plain ISO 9660 names and attributes which get visible if the reader ignores Rock Ridge. .TP \fB\-volid\fR text -Specify the volume ID. xorriso accepts any text up to 32 characters, +Specify the volume ID. \fBxorriso\fR accepts any text up to 32 characters, but according to rarely obeyed specs stricter rules apply: .br ECMA 119 demands ASCII characters out of [A\-Z0\-9_]. Like: "IMAGE_23" @@ -2175,7 +2175,7 @@ identify the specification of how the data are recorded. Permissible are up to 128 characters. This setting gets overridden by image loading. .br -The special text "@xorriso@" gets converted to the id string of xorriso +The special text "@xorriso@" gets converted to the id string of \fBxorriso\fR which is normally written as \-preparer_id. It is a wrong tradition to write the program id as \-application_id. .TP @@ -2237,11 +2237,11 @@ image loading. \fB\-preparer_id\fR Set the preparer id string to be written with the next \-commit. This may identify the person or other entity which controls the preparation of the data -which shall be recorded. Normally this should be the id of xorriso and not -of the person or program which operates xorriso. Please avoid to change it. +which shall be recorded. Normally this should be the id of \fBxorriso\fR and not +of the person or program which operates \fBxorriso\fR. Please avoid to change it. Permissible are up to 128 characters. .br -The special text "@xorriso@" gets converted to the id string of xorriso +The special text "@xorriso@" gets converted to the id string of \fBxorriso\fR which is default at program startup. .br Unlike other id strings, this setting is not influenced by image loading. @@ -2344,7 +2344,7 @@ Append the given number of extra bytes to the image stream. This is a traditional remedy for a traditional bug in block device read drivers. Needed only for CD recordings in TAO mode. Since one can hardly predict on what media an image might end up, -xorriso adds the traditional 300k of padding by default to all images. +\fBxorriso\fR adds the traditional 300k of padding by default to all images. .br For images which will never get to a CD it is safe to use \-padding 0 . .br @@ -2613,7 +2613,7 @@ Partitions may be appended with boot block type MBR and with SUN Disk Label. With MBR: .br partition_number may be 1 to 4. Number 1 will put the whole ISO image into -the unclaimed space before partition 1. So together with most xorriso MBR +the unclaimed space before partition 1. So together with most \fBxorriso\fR MBR features, number 2 would be the most natural choice. .br The type_code may be "FAT12", "FAT16", "Linux", @@ -2641,13 +2641,13 @@ DVD images; see http://atterer.net/jigdo/ for more details. Debian CDs and DVD ISO images are published on the web in jigdo format to allow end users to download them more efficiently." .br -xorriso can produce a .jigdo and a .template file together with a +\fBxorriso\fR can produce a .jigdo and a .template file together with a single\-session ISO image. The .jigdo file contains checksums and symbolic file addresses. The .template file contains the compressed ISO image with reference tags instead of the content bytes of the listed files. .br -Input for this process are the normal arguments for a xorriso session +Input for this process are the normal arguments for a \fBxorriso\fR session on a blank \-outdev, and a .md5 file which lists those data files which may be listed in the .jigdo file and externally referenced in the .template file. Each designated file is represented in the .md5 file by a single text line: @@ -2662,7 +2662,7 @@ After eventual To=From mapping, the file address gets written into the .jigdo file. Jigdo restore tools will convert these addresses into really reachable data source addresses from which they can read. .br -If the list of jigdo parameters is not empty, then xorriso will refuse to +If the list of jigdo parameters is not empty, then \fBxorriso\fR will refuse to write to non\-blank targets, it will disable multi\-session emulation, and eventual padding will be counted as part of the ISO image. .br @@ -2743,7 +2743,7 @@ names. Shell command iconv \-l lists them. Character sets should not matter as long as only english alphanumeric characters are used for file names or as long as all writers and readers of the media use the same character set. -Outside these constraints it may be necessary to let xorriso convert byte +Outside these constraints it may be necessary to let \fBxorriso\fR convert byte codes. .br There is an input conversion from input character set to the local character @@ -2752,14 +2752,14 @@ 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 identical, if ever. .br -If conversions are desired then xorriso needs to know the name of the -local character set. xorriso can inquire the same info as shell command +If conversions are desired then \fBxorriso\fR needs to know the name of the +local character set. \fBxorriso\fR can inquire the same info as shell command "locale" with argument "charmap". This may be influenced by environment variables LC_ALL, LC_CTYPE, or LANG and should match the expectations of the terminal. .br The default output charset is the local character set of the terminal where -xorriso runs. So by default no conversion happens between local filesystem +\fBxorriso\fR 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. .br @@ -2786,8 +2786,8 @@ If this appears necessary, one should consider to set \-backslash_codes to .TP .B Exception processing: .PP -Since the tasks of xorriso are manifold and prone to external influence, there -may arise the need for xorriso to report and handle problem events. +Since the tasks of \fBxorriso\fR are manifold and prone to external influence, there +may arise the need for \fBxorriso\fR to report and handle problem events. .br Those events get classified when they are detected by one of the software modules and forwarded to reporting and evaluation modules which decide about @@ -2829,24 +2829,24 @@ be ignorable. .br A special property of this option 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 +start arguments is in effect already when the first operations of \fBxorriso\fR begin. Only "\-abort_on" with dash "\-" is recognized that way. .TP \fB\-return_with\fR severity exit_value Set the threshold and exit_value to be returned at program end if no abort -has happened. This is to allow xorriso to go on after problems but to get +has happened. This is to allow \fBxorriso\fR to go on after problems but to get a failure indicating exit value from the program, nevertheless. Useful is a value lower than the \-abort_on threshold, down to "WARNING". .br exit_value may be either 0 (indicating success to the starter of the program) -or a number between 32 and 63. Some other exit_values are used by xorriso if +or a number between 32 and 63. Some other exit_values are used by \fBxorriso\fR if it decides to abort the program run: .br 1=abort due to external signal .br 2=no program arguments given .br -3=creation of xorriso main object failed +3=creation of \fBxorriso\fR main object failed .br 4=failure to start libburnia\-project.org libraries .br @@ -2868,7 +2868,7 @@ 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 among the start arguments is in effect already when the first operations -of xorriso begin. Only "\-report_about" with dash "\-" is recognized that way. +of \fBxorriso\fR begin. Only "\-report_about" with dash "\-" is recognized that way. .TP \fB\-signal_handling\fR mode Control the installation of a signal handler which shall react on external @@ -2877,10 +2877,10 @@ caused by severe program errors. .br Mode "on" is the default. It uses the signal handler of libburn which produces ugly messages but puts much effort in releasing eventually used optical drives -before xorriso ends. +before \fBxorriso\fR ends. .br Mode "off" as first \-signal_handling among the start arguments prevents all -own signal precautions of xorriso. Eventually inherited signal handler settings +own signal precautions of \fBxorriso\fR. Eventually inherited signal handler settings stay as they are. .br It works like "sig_dfl" if given after other signal handling was already @@ -2891,14 +2891,14 @@ normally a sudden abort of the program. To prevent stuck drives, the libburn handler is used during burning, blanking, and formatting on MMC drives. .br Mode "sig_ign" tries to ignore as many signal types as possible. This imposes -the risk that xorriso refuses to end until externally kill \-9 if performed. +the risk that \fBxorriso\fR refuses to end until externally kill \-9 if performed. 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 among the start arguments is in effect already when the first operations -of xorriso begin. Only "\-signal_handling" with dash "\-" is recognized that way. +of \fBxorriso\fR begin. Only "\-signal_handling" with dash "\-" is recognized that way. .TP \fB\-error_behavior\fR occasion behavior Control the program behavior at problem event occasions. @@ -3012,7 +3012,7 @@ not the ISO image directory tree. .br In case of overwriteable media holding a valid ISO image, it may happen that only a single session gets shown. But if the first session on the -overwriteable media was written by xorriso then a complete +overwriteable media was written by \fBxorriso\fR then a complete session history can be emulated. .br A drive which is incapable of writing may show any media as CD\-ROM or DVD\-ROM @@ -3044,7 +3044,7 @@ for direct execution of this command. \fB\-mount_opts\fR option[:option...] Set options which influence \-mount and \-mount_cmd. Currently there is only option "exclusive" which is default and its counterpart "shared". The latter -causes xorriso not to give up the affected drive with command \-mount. +causes \fBxorriso\fR not to give up the affected drive with command \-mount. On GNU/Linux it adds mount option "loop" which may allow to mount several sessions of the same block device at the same time. One should not write to a mounted optical media, of course. Take care to umount all sessions @@ -3057,7 +3057,7 @@ format and the parameters of the addressed session. Formats "linux:"path or "freebsd:"path produce the output of \-mount_cmd for the given operating systems. .br -In other texts xorriso will substitute the following parameter names. +In other texts \fBxorriso\fR will substitute the following parameter names. An optional prefix "string:" will be removed. .br "%device%" will be substituted by the mountable device path of the drive @@ -3289,7 +3289,7 @@ and based on extra data on the media. If a drive returns data then one can quite trust that they are valid. But at some degree of read problems the correction will fail and the drive is supposed to indicate error. .br -xorriso can scan the media for readable data blocks, classify them according +\fBxorriso\fR can scan the media 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 media. .br @@ -3379,7 +3379,7 @@ gives the path of the file which may abort a scan run. Abort happens if the file exists and its mtime is not older than the start time of the run. Use shell command "touch" to trigger this. Other than an aborted program run, this will report the tested and untested -blocks and go on with running xorriso. +blocks and go on with running \fBxorriso\fR. .br \fBtime_limit=seconds\fR gives the number of seconds after which the scan shall be @@ -3422,7 +3422,7 @@ when it gets mounted or loaded as stdio: drive. But it usually makes the original session 1 inaccessible. .br \fBpatch_lba0="force"\fR -performs patch_lba0="on" even if xorriso believes +performs patch_lba0="on" even if \fBxorriso\fR believes that the copied data are not valid. .br patch_lba0= may also bear a number. If it is 32 or higher it is taken as @@ -3463,7 +3463,7 @@ Only mismatching data files will be reported. .TP .B osirrox ISO-to-disk restore options: .PP -Normally xorriso only writes to disk files which were given as stdio: +Normally \fBxorriso\fR only writes to disk files which were given as stdio: pseudo\-drives or as log files. But its alter ego osirrox is able to extract file objects from ISO images and to create, overwrite, or delete file objects on disk. @@ -3500,7 +3500,7 @@ handled like any other ISO image directory. .br Option "auto_chmod_off" is default. If "auto_chmod_on" is set then access restrictions for disk directories get circumvented if those directories -are owned by the effective user who runs xorriso. This happens by temporarily +are owned by the effective user who runs \fBxorriso\fR. This happens by temporarily granting rwx permission to the owner. .br Option "sort_lba_on" may improve read performance with optical drives. It @@ -3596,7 +3596,7 @@ reachable as /bin/mount or /sbin/mount. .PP Writing of ISO 9660 on CD is traditionally done by program mkisofs as ISO 9660 image producer and cdrecord as burn program. -xorriso does not strive for their comprehensive emulation. +\fBxorriso\fR does not strive for their comprehensive emulation. Nevertheless it is ready to perform some of its core tasks under control of commands which in said programs trigger comparable actions. .TP @@ -3621,16 +3621,16 @@ emulation. Some are ignored, but better do not rely on this tolerance. .br The supported options are documented in detail in xorrisofs.info and in man xorrisofs. The description here is focused on the effect -of mkisofs emulation in the context of a xorriso run. +of mkisofs emulation in the context of a \fBxorriso\fR run. .br Other than with the "cdrecord" personality there is no automatic \-commit at the end of a "mkisofs" option list. Verbosity settings \-v (= "UPDATE") and \-quiet (= "SORRY") persist. The output file, eventually chosen with \-o, -persists until things happen like \-commit, \-rollback, \-dev, or end of xorriso. +persists until things happen like \-commit, \-rollback, \-dev, or end of \fBxorriso\fR. \-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 xorriso option \-add. Directories get +are interpreted differently than with \fBxorriso\fR option \-add. Directories get merged with the root directory of the ISO image, other filetypes get mapped into that root directory. .br @@ -3638,7 +3638,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 xorriso options before \-as mkisofs or after its list delimiter. +is chosen by \fBxorriso\fR options 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 @@ -3656,7 +3656,7 @@ directory is added to the image. At the same occasion directory names get allowed to violate the standard by \-compliance option allow_dir_id_ext. This may be avoided by option \-disallow_dir_id_ext. .br -Option \-root is supported. Option \-old\-root is implemented by xorriso +Option \-root is supported. Option \-old\-root is implemented by \fBxorriso\fR commands \-mkdir, \-cp_clone, \-find update_merge, and \-find rm_merge. \-root and \-old\-root set command \-disk_dev_ino to "ino_only" and \-md5 to "on", by default. @@ -3667,7 +3667,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 xorriso options with the +They work like the \fBxorriso\fR options with the same name and hardcoded argument "on", e.g. \-acl "on". Explicit arguments are expected by \-\-stdio_sync and \-\-scdbackup_tag. @@ -3712,19 +3712,19 @@ Option \-append_partition is supported. \-\-old\-empty is \-compliance old_empty. .br The options of genisoimage Jigdo Template Extraction are recognized and -performed via xorriso option \-jigdo. See the "Alias:" names there for the +performed via \fBxorriso\fR option \-jigdo. See the "Alias:" names there for the meaning of the genisoimage options. .br Personalities "\fBxorrisofs\fR", "\fBgenisoimage\fR", and "\fBgenisofs\fR" are aliases for "mkisofs". .br -If xorriso is started with one of the leafnames "xorrisofs", "genisofs", +If \fBxorriso\fR is started with one of the leafnames "xorrisofs", "genisofs", "mkisofs", or "genisoimage", then it performs \-read_mkisofsrc and prepends \-as "genisofs" to the command line arguments. I.e. all arguments will be interpreted mkisofs style until "\-\-" is encountered. -From then on, options are interpreted as xorriso options. +From then on, options are interpreted as \fBxorriso\fR options. .br \-\-no_rc as first argument of such a program start prevents interpretation of startup files. See section FILES below. @@ -3740,7 +3740,7 @@ write_start_address=, track source file path or "\-" for standard input as track source. .br It ignores most other options of cdrecord and cdrskin but refuses on -\-audio, \-scanbus, and on blanking modes unknown to xorriso. +\-audio, \-scanbus, and on blanking modes unknown to \fBxorriso\fR. .br The scope is only a single data track per session to be written to blank, overwriteable, or appendable media. The media gets closed if @@ -3749,7 +3749,7 @@ closing is applicable and not option \-multi is present. An eventually acquired input drive is given up. This is only allowed if no image changes are pending. .br -dev= must be given as xorriso device address. Addresses like 0,0,0 or ATA:1,1,0 +dev= must be given as \fBxorriso\fR device address. Addresses like 0,0,0 or ATA:1,1,0 are not supported. .br If a track source is given, then an automatic \-commit happens at the end of @@ -3766,14 +3766,14 @@ A much more elaborate libburn based cdrecord emulator is the program cdrskin. Personalites "\fBxorrecord\fR", "\fBwodim\fR", and "\fBcdrskin\fR" are aliases for "cdrecord". .br -If xorriso is started with one of the leafnames "xorrecord", "cdrskin", +If \fBxorriso\fR is started with one of the leafnames "xorrecord", "cdrskin", "cdrecord", or "wodim", then it automatically prepends \-as "cdrskin" to the command line arguments. I.e. all arguments will be interpreted cdrecord style until "\-\-" is encountered and an eventual commit happens. -From then on, options are interpreted as xorriso options. +From then on, options are interpreted as \fBxorriso\fR options. .br \-\-no_rc as first argument of such a program start -prevents interpretation of xorriso startup files. See section FILES below. +prevents interpretation of \fBxorriso\fR startup files. See section FILES below. .TP \fB\-read_mkisofsrc\fR Try one by one to open for reading: @@ -3828,7 +3828,7 @@ files. See section FILES below. \fB\-options_from_file\fR fileaddress Read quoted input from fileaddress and execute it like dialog lines. Empty lines and lines which begin by # are ignored. Normally one line -should hold one xorriso command and all its arguments. Nevertheless lines +should hold one \fBxorriso\fR command and all its arguments. Nevertheless lines may be concatenated by a trailing backslash. .br See also section "Command processing", paragraph "Quoted input". @@ -3844,7 +3844,7 @@ Print program name and version, component versions, license. Copy textline into libreadline history. .TP \fB\-status\fR mode|filter -Print the current settings of xorriso. +Print the current settings of \fBxorriso\fR. Modes: .br short... print only important or altered settings @@ -3960,12 +3960,12 @@ The first three items are single words, the rest of the line is the volume id. .TP \fB\-scsi_log\fR "on"|"off" 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 +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 among the start arguments is in effect already when the first operations -of xorriso begin. Only "\-scsi_log" with dash "\-" is recognized that way. +of \fBxorriso\fR begin. Only "\-scsi_log" with dash "\-" is recognized that way. .TP \fB\-end\fR .br @@ -4005,8 +4005,8 @@ Copy output of a channel to the given file. Channel may be one of: "." for all channels, "I" for info messages, "R" for result lines, "M" for \-mark texts. .TP \fB\-mark\fR text -If text is not empty it will get put out on "M" channel each time xorriso -is ready for the next dialog line or before xorriso performs a command that +If text is not empty it will get put out on "M" channel each time \fBxorriso\fR +is ready for the next dialog line or before \fBxorriso\fR performs a command that was entered to the pager prompt. .TP \fB\-prog\fR text @@ -4052,8 +4052,8 @@ Try to retrieve blocks from a damaged media .SS .B As superuser learn about available drives On Linux or FreeBSD consider to give rw\-permissions to those users or groups -which shall be able to use the drives with xorriso. -On Solaris use pfexec. Consider to restrict privileges of xorriso to +which shall be able to use the drives with \fBxorriso\fR. +On Solaris use pfexec. Consider to restrict privileges of \fBxorriso\fR to "base,sys_devices" and to give r\-permission to user or group. .br $ xorriso \-devices @@ -4216,7 +4216,7 @@ $ xorriso \-indev /dev/sr2 \\ .B Bring a prepared ISOLINUX tree onto media and make it bootable The user has already created a suitable file tree on disk and copied the ISOLINUX files into subdirectory ./boot/isolinux of that tree. -Now xorriso can burn an El Torito bootable media: +Now \fBxorriso\fR can burn an El Torito bootable media: .br $ xorriso \-outdev /dev/sr0 \-blank as_needed \\ .br @@ -4249,9 +4249,9 @@ Paths underneath /dev normally need prefix "stdio:" $ xorriso \-dev stdio:/dev/sdb ... .br If /dev/sdb is to be used frequently and /dev/sda is the system disk, -then consider to place the following lines in a xorriso Startup File. +then consider to place the following lines in a \fBxorriso\fR Startup File. They allow to use /dev/sdb without prefix and protect disk /dev/sda -from xorriso: +from \fBxorriso\fR: .br \-drive_class banned /dev/sda* .br @@ -4300,7 +4300,7 @@ of the changed content before it loads the media again. In this case the previous session would not be loaded and the new session would contain only the newly added files. .br -For the same reason do not let xorriso \-as cdrecord load the media, +For the same reason do not let \fBxorriso\fR \-as cdrecord load the media, but rather do this manually or by a program that reads from /dev/sr0. .br This example works for multi\-session media only. @@ -4310,7 +4310,7 @@ in order to enable multi\-session emulation on overwriteable media. .SS .B Let xorriso work underneath growisofs growisofs expects an ISO formatter program which understands options \-C and -\-M. If xorriso gets started by name "xorrisofs" then it is suitable for that. +\-M. If \fBxorriso\fR gets started by name "xorrisofs" then it is suitable for that. .br $ export MKISOFS="xorrisofs" .br @@ -4319,14 +4319,14 @@ $ growisofs \-Z /dev/dvd /some/files $ growisofs \-M /dev/dvd /more/files .br If no "xorrisofs" is available on your system, then you will have to create -a link pointing to the xorriso binary and tell growisofs to use it. E.g. by: +a link pointing to the \fBxorriso\fR binary and tell growisofs to use it. E.g. by: .br $ ln \-s $(which xorriso) "$HOME/xorrisofs" .br $ export MKISOFS="$HOME/xorrisofs" .br One may quit mkisofs emulation by argument "\-\-" and make -use of all xorriso commands. growisofs dislikes options which +use of all \fBxorriso\fR commands. growisofs dislikes options which start with "\-o" but \-outdev must be set to "\-". So use "outdev" instead: .br @@ -4439,8 +4439,8 @@ 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=". .br -Multi\-session media and most overwriteable media written by xorriso can tell -the sbsectors of their sessions by xorriso option \-toc. +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 the newly written session (here for mount point /mnt): .br @@ -4527,12 +4527,12 @@ resp. \-s. .SS .B Program alias names: .br -Normal installation of xorriso creates three links or copies which by their +Normal installation of \fBxorriso\fR creates three links or copies which by their program name pre\-select certain settings: .br -\fBxorrisofs\fR starts xorriso with \-as mkisofs emulation. +\fBxorrisofs\fR starts \fBxorriso\fR with \-as mkisofs emulation. .br -\fBxorrecord\fR starts xorriso with \-as cdrecord emulation. +\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 @@ -4540,7 +4540,7 @@ one or more of the existing ISO sessions. .SS .B Startup files: .br -If not \-no_rc is given as the first argument then xorriso attempts on startup +If not \-no_rc is given as the first argument then \fBxorriso\fR attempts on startup to read and execute lines from the following files: .br /etc/default/xorriso @@ -4601,11 +4601,11 @@ for libburnia\-project.org Copyright (c) 2007 \- 2011 Thomas Schmitt .br Permission is granted to distribute this text freely. It shall only be -modified in sync with the technical properties of xorriso. If you make use -of the license to derive modified versions of xorriso then you are entitled +modified in sync with the technical properties of \fBxorriso\fR. If you make use +of the license to derive modified versions of \fBxorriso\fR then you are entitled to modify this text under that same license. .SH CREDITS -xorriso is in part based on work by Vreixo Formoso who provides libisofs +\fBxorriso\fR is in part based on work by Vreixo Formoso who provides libisofs together with Mario Danic who also leads the libburnia team. Thanks to Andy Polyakov who invented emulated growing, to Derek Foreman and Ben Jansens who once founded libburn. diff --git a/xorriso/xorriso.info b/xorriso/xorriso.info index 43e79c5f..95cb63fc 100644 --- a/xorriso/xorriso.info +++ b/xorriso/xorriso.info @@ -45,15 +45,15 @@ File: xorriso.info, Node: Overview, Next: Model, Prev: Top, Up: Top 1 Overview ********** -*xorriso* is a program which copies file objects from POSIX compliant +`xorriso' is a program which copies file objects from POSIX compliant filesystems into Rock Ridge enhanced ISO 9660 filesystems and allows session-wise manipulation of such filesystems. It can load the management information of existing ISO images and it writes the session results to optical media or to filesystem objects. -Vice versa xorriso is able to copy file objects out of ISO 9660 +Vice versa `xorriso' is able to copy file objects out of ISO 9660 filesystems. - A special property of xorriso is that it needs neither an external + A special property of `xorriso' is that it needs neither an external ISO 9660 formatter program nor an external burn program for CD, DVD or BD but rather incorporates the libraries of libburnia-project.org . @@ -115,15 +115,15 @@ types. But program growisofs by Andy Polyakov showed how to extend this functionality to overwriteable media or disk files which carry valid ISO 9660 filesystems. - xorriso provides growing as well as an own method named *modifying* -which produces a completely new ISO image from the old one and the -modifications. See paragraph Creating, Growing, Modifying, Blind -Growing below. + `xorriso' provides growing as well as an own method named +*modifying* which produces a completely new ISO image from the old one +and the modifications. See paragraph Creating, Growing, Modifying, +Blind Growing below. - xorriso adopts the concept of multi-session by loading an eventual + `xorriso' adopts the concept of multi-session by loading an eventual image directory tree, allowing to manipulate it by several actions, and to write the new image to the target media. The first session of a -xorriso run begins by the definition of the input drive with the +`xorriso' run begins by the definition of the input drive with the eventual ISO image or by the definition of an output drive. The session ends by command -commit which triggers writing. A -commit is done automatically when the program ends regularly. @@ -151,12 +151,12 @@ unformatted DVD-RW. These media provide a table of content which describes their existing sessions. See option *-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 +known in advance. `xorriso' will write onto them only if option -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 -and if the first session was written by xorriso, then a table of +and if the first session was written by `xorriso', then a table of content can be emulated. Else only a single overall session will be visible. DVD-RW media can be formatted by -format "full". They can be made @@ -169,21 +169,21 @@ media. capabilities. *Blank* media can be written from scratch. They contain no ISO image -suitable for xorriso. +suitable for `xorriso'. Blank is the state of newly purchased optical media. With used CD-RW and DVD-RW it can be achieved by action -blank "as_needed". Overwriteable media are considered blank if they are new or if they have -been marked as blank by xorriso. Action -blank "as_needed" can be used -to do this marking on overwriteable media, or to apply eventual +been marked as blank by `xorriso'. Action -blank "as_needed" can be +used to do this marking on overwriteable media, or to apply eventual mandatory formatting to new media. *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. +which contain an ISO image suitable for `xorriso'. Appendable is the state after writing a session with option -close off. *Closed* media cannot be written. They may contain an ISO image suitable -for xorriso. +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 then it will probably show any media as closed CD-ROM resp. DVD-ROM. @@ -240,8 +240,9 @@ 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 mkisofs -M $indev -C $msc1,$msc2 -o $outdev which gives much room for wrong parameter combinations and should thus -only be employed if a strict distinction between ISO formatter xorriso -and the burn program is desired. -C $msc1,$msc2 is equivalent to: +only be employed if a strict distinction between ISO formatter +`xorriso' and the burn program is desired. -C $msc1,$msc2 is equivalent +to: -load sbsector $msc1 -grow_blindly $msc2  @@ -259,7 +260,8 @@ Some drive types do not support the method of growing but only the methods of modifying and blind growing. They all are suitable for newly created images. All drive file objects have to offer rw-permission to the user of -xorriso. Even those which will not be useable for reading an ISO image. +`xorriso'. Even those which will not be useable for reading an ISO +image. MMC compliant (i.e. optical) drives on GNU/Linux usually get addressed by the path of their block device or of their generic @@ -326,11 +328,11 @@ File: xorriso.info, Node: Extras, Next: Processing, Prev: Drives, Up: Top enhance an ISO 9660 filesystem so that it can represent a POSIX compliant filesystem with ownership, access permissions, symbolic links, and other attributes. -This is what xorriso uses for a decent representation of the disk files -within the ISO image. Rock Ridge information is produced with any -xorriso image. +This is what `xorriso' uses for a decent representation of the disk +files within the ISO image. Rock Ridge information is produced with any +`xorriso' image. - xorriso is not named "porriso" because POSIX only guarantees 14 + `xorriso' is not named "porriso" because POSIX only guarantees 14 characters of filename length. It is the X/Open System Interface standard XSI which demands a file name length of up to 255 characters and paths of up to 1024 characters. Rock Ridge fulfills this demand. @@ -340,7 +342,7 @@ one or more boot images, which are binary program files stored in the 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 +images. `xorriso' is able to create or maintain an El Torito object which makes such an image bootable. For details see option -boot_image. It is possible to make ISO images bootable from USB stick or other hard-disk-like media by -boot_image argument system_area= . This @@ -360,24 +362,24 @@ So libisofs has introduced a standard conformant extension named AAIP for that purpose. It uses this extension if enabled by option *-acl*. AAIP enhanced images are supposed to be mountable normally, but one cannot expect that the mounted filesystem will show and respect the -eventual ACLs. For now, only xorriso is able to retrieve those ACLs. +eventual ACLs. For now, only `xorriso' is able to retrieve those ACLs. It can bring them into effect when files get restored to an ACL enabled file system or it can print them in a format suitable for tool setfacl. Files with ACL show as group permissions the setting of entry "mask::" if that entry exists. Nevertheless the non-listed group members get -handled according to entry "group::". xorriso brings "group::" into +handled according to entry "group::". `xorriso' brings "group::" into effect before eventually removing the ACL from a file. *xattr* (aka EA) are pairs of name and value which can be attached -to file objects. AAIP is able to represent them and xorriso allows to +to file objects. AAIP is able to represent them and `xorriso' allows to record and restore 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*. -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. +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.  File: xorriso.info, Node: Processing, Next: Dialog, Prev: Extras, Up: Top @@ -417,10 +419,10 @@ Some other commands perform pattern matching unconditionally. Command and parameter words are either read from program arguments, where one argument is one word, or from quoted input lines where words are recognized similar to the quotation rules of a shell parser. -xorriso is not a shell, although it might appear so on first glimpse. +`xorriso' is not a shell, although it might appear so on first glimpse. Be aware that the interaction of quotation marks and pattern symbols -like "*" differs from the usual shell parsers. In xorriso, a quotation -mark does not make a pattern symbol literal. +like "*" differs from the usual shell parsers. In `xorriso', a +quotation mark does not make a pattern symbol literal. *Quoted input* converts whitespace separated text pieces into words. The double quotation mark " and the single quotation mark ' can be used @@ -456,9 +458,9 @@ performs them as commands with their parameters. It provides assisting services to make dialog more comfortable. Readline is an enhancement for the input line. You may know it -already from the bash shell. Whether it is available in xorriso depends -on the availability of package readline-dev at the time when xorriso -was built from its sourcecode. +already from the bash shell. Whether it is available in `xorriso' +depends on the availability of package readline-dev at the time when +`xorriso' was built from its sourcecode. It allows to move the cursor over the text in the line by help of the Leftward and the Rightward arrow key. Text may be inserted at the cursor position. The Delete key removes the character under the cursor. @@ -469,7 +471,7 @@ See info readline for more info about libreadline. Option -page activates a built-in result text pager which may be convenient in dialog. After an action has put out the given number of terminal lines, the pager prompts the user for a line of input. -An empty line lets xorriso resume work until the next page is put out. +An empty line lets `xorriso' resume work until the next page is put out. The single character "@" disables paging for the current action. "@@@", "x", "q", "X", or "Q" urge the current action to abort and suppress further result output. @@ -568,7 +570,7 @@ influence the behavior of image loading. See next option group. blind growing will finally end up. It is the responsibility of the user to ensure this final position and the presence of the older sessions. Else the overall ISO image will not be mountable or will - produce read errors when accessing file content. xorriso will + produce read errors when accessing file content. `xorriso' will write the session to the address as obtained from examining -outdev and not necessarily to predicted_nwa. During a run of blind growing, the input drive is given up before @@ -636,7 +638,7 @@ activate them only after image loading. "stdio:" will be prepended automatically. This list is empty by default. Else if the path matches the "banned" list then the drive will not - be accepted by xorriso but rather lead to a FAILURE event. This + be accepted by `xorriso' but rather lead to a FAILURE event. This list is empty by default. Else if the path matches the "caution" list and if it is not a MMC device, then its address must have the prefix "stdio:" or it will @@ -651,7 +653,7 @@ activate them only after image loading. "caution", "harmless", or "all", the lists may be made empty. E.g.: -drive_class clear_list banned One will normally define the -drive_class lists in one of the - xorriso Startup Files. + `xorriso' Startup Files. Note: This is not a security feature but rather a bumper for the superuser to prevent inadverted mishaps. For reliably blocking access to a device file you have to deny its rw-permissions in the @@ -678,7 +680,7 @@ activate them only after image loading. directory. If enabled then an eventual recorded character set name gets used as input character set when reading an image. Note that the default output charset is the local character set of - the terminal where xorriso runs. Before attributing this local + the terminal where `xorriso' runs. Before attributing this local character set to the produced ISO image, check whether the terminal properly displays all intended filenames, especially exotic national characters. @@ -704,7 +706,7 @@ activate them only after image loading. Mode "without_update" avoids hardlink processing during update commands. Use this if your filesystem situation does not allow -disk_dev_ino "on". - xorriso commands which extract files from an ISO image try to + `xorriso' commands which extract files from an ISO image try to hardlink files with identical inode number. The normal scope of this operation is from image load to image load. One may give up the accumulated hard link addresses by -hardlinks @@ -716,7 +718,7 @@ activate them only after image loading. "normal_extract" re-enables wide and expensive hardlink accumulation. -acl "on"|"off" - Enable or disable processing of ACLs. If enabled, then xorriso + Enable or disable processing of ACLs. If enabled, then `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 @@ -725,7 +727,7 @@ activate them only after image loading. -xattr "on"|"off" Enable or disable processing of xattr attributes in user namespace. - If enabled, then xorriso will handle xattr similar to ACL. See + If enabled, then `xorriso' will handle xattr similar to ACL. See also options -getfattr, -setfattr and above paragraph about xattr. -md5 "on"|"all"|"off"|"load_check_off" @@ -752,7 +754,7 @@ activate them only after image loading. superblock and directory tree. This is necessary if growisofs was used as burn program, because it does not overwrite the superblock checksum tag of the first session. Therefore load_check_off is in - effect when xorriso -as mkisofs option -M is performed. + 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, via find actions get_md5, check_md5, and via -check_media. @@ -797,7 +799,7 @@ activate them only after image loading. drive behavior. Setting "on" enables that scan for alleged read-only media. Some operating systems are not able to mount the most recent - session of multi-session DVD or BD. If on such a system xorriso + session of multi-session DVD or BD. If on such a system `xorriso' has no own MMC capabilities then it may still find that session from a scanned table of content. Setting "force" handles any media like a ROM media with setting "on". @@ -1038,7 +1040,7 @@ File: xorriso.info, Node: SetInsert, Next: Manip, Prev: Insert, Up: Options -file_size_limit value [value [...]] -- Set the maximum permissible size for a single data file. The values get summed up for the actual limit. If the only value is - "off" then the file size is not limited by xorriso. Default is a + "off" then the file size is not limited by `xorriso'. Default is a limit of 100 extents, 4g -2k each: -file_size_limit 400g -200k -- When mounting ISO 9660 filesystems, old operating systems can @@ -1046,7 +1048,7 @@ File: xorriso.info, Node: SetInsert, Next: Manip, Prev: Insert, Up: Options --. You need quite a new Linux kernel to read correctly the final bytes of a file >= 4g if its size is not aligned to 2048 byte blocks. - xorriso's own data read capabilities are not affected by eventual + `xorriso''s own data read capabilities are not affected by eventual operating system size limits. They apply to mounting only. Nevertheless, the target filesystem of an -extract must be able to take the file size. @@ -1147,7 +1149,7 @@ File: xorriso.info, Node: SetInsert, Next: Manip, Prev: Insert, Up: Options link hops. -pathspecs "on"|"off" - Control parameter interpretation with xorriso actions -add and + Control parameter interpretation with `xorriso' actions -add and -path_list. "on" enables pathspecs of the form *target=source* like with program mkisofs -graft-points. It also disables -disk_pattern @@ -1316,7 +1318,7 @@ whether they stem from the loaded image or were newly inserted. empty text. 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. + Values and names undergo the normal input processing of `xorriso'. See also option -backslash_codes. Other than with option -setfattr_list, the byte value 0 cannot be expressed via -setfattr. @@ -1357,7 +1359,7 @@ whether they stem from the loaded image or were newly inserted. "y"=365.25d plus 1d added to multiplication result. Absolute seconds counted from Jan 1 1970: =Number - xorriso's own timestamps: + `xorriso''s own timestamps: YYYY.MM.DD[.hh[mm[ss]]] scdbackup timestamps: YYMMDD[.hhmm[ss]] @@ -1491,7 +1493,7 @@ File: xorriso.info, Node: CmdFind, Next: Filter, Prev: Manip, Up: Options Default action is *echo*, i.e. to print the address of the found - file. Other actions are certain xorriso commands which get + file. Other actions are certain `xorriso' commands which get performed on the found files. These commands may have specific parameters. See also their particular descriptions. @@ -1672,8 +1674,9 @@ there are many small files. Irrevocably ban commands -external_filter and -unregister_filter, but not -set_filter. Use this to prevent external filtering in general or when all intended filters are registered. External - filters may also be banned totally at compile time of xorriso. By - default they are banned if xorriso runs under setuid permission. + filters may also be banned totally at compile time of `xorriso'. + By default they are banned if `xorriso' runs under setuid + permission. -set_filter name iso_rr_path [***] Apply an -external_filter or a built-in filter to the given data @@ -1730,8 +1733,8 @@ File: xorriso.info, Node: Writing, Next: SetWrite, Prev: Filter, Up: Options Writing can last quite a while. It is not unnormal with several types of media that there is no progress visible for the first few minutes or that the drive gnaws on the media for a few minutes - after all data have been transmitted. xorriso and the drives are - in a client-server relationship. The drives have much freedom + after all data have been transmitted. `xorriso' and the drives + are in a client-server relationship. The drives have much freedom about what to do with the media. Some combinations of drives and media simply do not work, despite the promises by their vendors. If writing fails then try other media or another drive. The reason @@ -1766,7 +1769,8 @@ File: xorriso.info, Node: Writing, Next: SetWrite, Prev: Filter, Up: Options "deformat" converts overwriteable DVD-RW into unformatted ones. "deformat_quickest" is a faster way to deformat or blank DVD-RW but produces media which are only suitable for a single session. - xorriso will write onto them only if option -close is set to "on". + `xorriso' will write onto them only if option -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 reported percentages. Blanking was successful if no SORRY event or @@ -1916,7 +1920,7 @@ will be written according to the setting of option -acl. attributes which get visible if the reader ignores Rock Ridge. -volid text - Specify the volume ID. xorriso accepts any text up to 32 + Specify the volume ID. `xorriso' accepts any text up to 32 characters, but according to rarely obeyed specs stricter rules apply: ECMA 119 demands ASCII characters out of [A-Z0-9_]. Like: @@ -1951,7 +1955,7 @@ will be written according to the setting of option -acl. Permissible are up to 128 characters. This setting gets overridden by image loading. The special text "@xorriso@" gets converted to the id string of - xorriso which is normally written as -preparer_id. It is a wrong + `xorriso' which is normally written as -preparer_id. It is a wrong tradition to write the program id as -application_id. -system_id text @@ -2003,11 +2007,11 @@ will be written according to the setting of option -acl. Set the preparer id string to be written with the next -commit. This may identify the person or other entity which controls the preparation of the data which shall be recorded. Normally this - should be the id of xorriso and not of the person or program which - operates xorriso. Please avoid to change it. Permissible are up - to 128 characters. + should be the id of `xorriso' and not of the person or program + which operates `xorriso'. Please avoid to change it. Permissible + are up to 128 characters. The special text "@xorriso@" gets converted to the id string of - xorriso which is default at program startup. + `xorriso' which is default at program startup. Unlike other id strings, this setting is not influenced by image loading. @@ -2098,7 +2102,7 @@ will be written according to the setting of option -acl. Append the given number of extra bytes to the image stream. This is a traditional remedy for a traditional bug in block device read drivers. Needed only for CD recordings in TAO mode. Since one can - hardly predict on what media an image might end up, xorriso adds + hardly predict on what media an image might end up, `xorriso' adds the traditional 300k of padding by default to all images. For images which will never get to a CD it is safe to use -padding 0 . @@ -2322,8 +2326,8 @@ filesystem and announced by an MBR partition table entry. With MBR: partition_number may be 1 to 4. Number 1 will put the whole ISO image into the unclaimed space before partition 1. So together - with most xorriso MBR features, number 2 would be the most natural - choice. + with most `xorriso' MBR features, number 2 would be the most + natural choice. The type_code may be "FAT12", "FAT16", "Linux", or a hexadecimal number between 0x00 and 0xff. Not all those numbers will yield usable results. For a list of codes search the Internet for @@ -2348,12 +2352,12 @@ From man genisoimage: "Jigdo is a tool to help in the distribution of large files like CD and DVD images; see http://atterer.net/jigdo/ for more details. Debian CDs and DVD ISO images are published on the web in jigdo format to allow end users to download them more efficiently." -xorriso can produce a .jigdo and a .template file together with a +`xorriso' can produce a .jigdo and a .template file together with a single-session ISO image. The .jigdo file contains checksums and symbolic file addresses. The .template file contains the compressed ISO image with reference tags instead of the content bytes of the listed files. -Input for this process are the normal arguments for a xorriso session +Input for this process are the normal arguments for a `xorriso' session on a blank -outdev, and a .md5 file which lists those data files which may be listed in the .jigdo file and externally referenced in the .template file. Each designated file is represented in the .md5 file @@ -2366,9 +2370,10 @@ file address is decisive for To=From mapping, not for file recognition. After eventual To=From mapping, the file address gets written into the .jigdo file. Jigdo restore tools will convert these addresses into really reachable data source addresses from which they can read. -If the list of jigdo parameters is not empty, then xorriso will refuse -to write to non-blank targets, it will disable multi-session emulation, -and eventual padding will be counted as part of the ISO image. +If the list of jigdo parameters is not empty, then `xorriso' will +refuse to write to non-blank targets, it will disable multi-session +emulation, and eventual padding will be counted as part of the ISO +image. -jigdo parameter_name value Clear Jigdo Template Extraction parameter list or add a parameter @@ -2431,20 +2436,20 @@ iconv -l lists them. Character sets should not matter as long as only english alphanumeric characters are used for file names or as long as all writers and readers of the media use the same character set. Outside these constraints it -may be necessary to let xorriso convert byte codes. +may be necessary to let `xorriso' 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 -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 command -"locale" with argument "charmap". This may be influenced by environment -variables LC_ALL, LC_CTYPE, or LANG and should match the expectations of -the terminal. +If conversions are desired then `xorriso' needs to know the name of the +local character set. `xorriso' can inquire the same info as shell +command "locale" with argument "charmap". This may be influenced by +environment variables LC_ALL, LC_CTYPE, or LANG and should match the +expectations of the terminal. The default output charset is the local character set of the terminal -where xorriso runs. So by default no conversion happens between local +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 @@ -2475,8 +2480,8 @@ File: xorriso.info, Node: Exception, Next: DialogCtl, Prev: Charset, Up: Opt 9.13 Exception processing ========================= -Since the tasks of xorriso are manifold and prone to external -influence, there may arise the need for xorriso to report and handle +Since the tasks of `xorriso' are manifold and prone to external +influence, there may arise the need for `xorriso' to report and handle problem events. Those events get classified when they are detected by one of the software modules and forwarded to reporting and evaluation modules @@ -2504,21 +2509,21 @@ failed unexpectedly. A special property of this option 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 + operations of `xorriso' begin. Only "-abort_on" with dash "-" is recognized that way. -return_with severity exit_value Set the threshold and exit_value to be returned at program end if - no abort has happened. This is to allow xorriso to go on after + no abort has happened. This is to allow `xorriso' to go on after problems but to get a failure indicating exit value from the program, nevertheless. Useful is a value lower than the -abort_on threshold, down to "WARNING". exit_value may be either 0 (indicating success to the starter of the program) or a number between 32 and 63. Some other exit_values - are used by xorriso if it decides to abort the program run: + are used by `xorriso' if it decides to abort the program run: 1=abort due to external signal 2=no program arguments given - 3=creation of xorriso main object failed + 3=creation of `xorriso' main object failed 4=failure to start libburnia-project.org libraries 5=program abort during argument processing 6=program abort during dialog processing @@ -2534,8 +2539,8 @@ failed unexpectedly. messages which belong to no event get attributed severity "NOTE". A special property of this option 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. + first operations of `xorriso' begin. Only "-report_about" with + dash "-" is recognized that way. -signal_handling mode Control the installation of a signal handler which shall react on @@ -2543,9 +2548,9 @@ failed unexpectedly. on signals caused by severe program errors. Mode "on" is the default. It uses the signal handler of libburn which produces ugly messages but puts much effort in releasing - eventually used optical drives before xorriso ends. + eventually used optical drives before `xorriso' ends. Mode "off" as first -signal_handling among the start arguments - prevents all own signal precautions of xorriso. Eventually + prevents all own signal precautions of `xorriso'. Eventually inherited signal handler settings stay as they are. It works like "sig_dfl" if given after other signal handling was already established at program start. @@ -2554,14 +2559,14 @@ failed unexpectedly. prevent stuck drives, the libburn handler is used during burning, blanking, and formatting on MMC drives. Mode "sig_ign" tries to ignore as many signal types as possible. - This imposes the risk that xorriso refuses to end until externally - kill -9 if performed. 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. + This imposes the risk that `xorriso' refuses to end until + externally kill -9 if performed. 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 among the start arguments is in effect - already when the first operations of xorriso begin. Only + already when the first operations of `xorriso' begin. Only "-signal_handling" with dash "-" is recognized that way. -error_behavior occasion behavior @@ -2661,7 +2666,7 @@ File: xorriso.info, Node: Inquiry, Next: Navigate, Prev: DialogCtl, Up: Opti history, not the ISO image directory tree. In case of overwriteable media holding a valid ISO image, it may happen that only a single session gets shown. But if the first - session on the overwriteable media was written by xorriso then a + session on the overwriteable media was written by `xorriso' then a complete session history can be emulated. A drive which is incapable of writing may show any media as CD-ROM or DVD-ROM with only one or two sessions on it. The last of these @@ -2688,7 +2693,7 @@ File: xorriso.info, Node: Inquiry, Next: Navigate, Prev: DialogCtl, Up: Opti -mount_opts option[:option...] Set options which influence -mount and -mount_cmd. Currently there is only option "exclusive" which is default and its counterpart - "shared". The latter causes xorriso not to give up the affected + "shared". The latter causes `xorriso' not to give up the affected drive with command -mount. On GNU/Linux it adds mount option "loop" which may allow to mount several sessions of the same block device at the same time. One should not write to a mounted optical @@ -2699,7 +2704,7 @@ File: xorriso.info, Node: Inquiry, Next: Navigate, Prev: DialogCtl, Up: Opti format and the parameters of the addressed session. Formats "linux:"path or "freebsd:"path produce the output of -mount_cmd for the given operating systems. - In other texts xorriso will substitute the following parameter + In other texts `xorriso' will substitute the following parameter names. An optional prefix "string:" will be removed. "%device%" will be substituted by the mountable device path of the drive address. @@ -2917,7 +2922,7 @@ by the drives and based on extra data on the media. If a drive returns data then one can quite trust that they are valid. But at some degree of read problems the correction will fail and the drive is supposed to indicate error. -xorriso can scan the media for readable data blocks, classify them +`xorriso' can scan the media 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 media. By option -md5 checksums may get recorded with data files and whole @@ -2992,7 +2997,7 @@ transmission errors. the start time of the run. Use shell command "touch" to trigger this. Other than an aborted program run, this will report the tested and untested blocks and go on with running - xorriso. + `xorriso'. time_limit=seconds gives the number of seconds after which the scan shall be aborted. This is useful for unattended scanning of media @@ -3032,7 +3037,7 @@ transmission errors. loaded as stdio: drive. But it usually makes the original session 1 inaccessible. patch_lba0="force" - performs patch_lba0="on" even if xorriso believes that the + performs patch_lba0="on" even if `xorriso' believes that the copied data are not valid. patch_lba0= may also bear a number. If it is 32 or higher it is taken as start address of the session to be copied. In @@ -3076,7 +3081,7 @@ File: xorriso.info, Node: Restore, Next: Emulation, Prev: Verify, Up: Option 9.18 osirrox ISO-to-disk restore options ======================================== -Normally xorriso only writes to disk files which were given as stdio: +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 extract file objects from ISO images and to create, overwrite, or delete file objects on disk. @@ -3109,8 +3114,8 @@ The directory permissions on disk have to allow rwx. image directory. Option "auto_chmod_off" is default. If "auto_chmod_on" is set then access restrictions for disk directories get circumvented if those - directories are owned by the effective user who runs xorriso. This - happens by temporarily granting rwx permission to the owner. + directories are owned by the effective user who runs `xorriso'. + This happens by temporarily granting rwx permission to the owner. Option "sort_lba_on" may improve read performance with optical drives. It allows to restore large numbers of hard links without exhausting -temp_mem_limit. It does not preserve directory mtime @@ -3206,10 +3211,10 @@ File: xorriso.info, Node: Emulation, Next: Scripting, Prev: Restore, Up: Opt ================================================ Writing of ISO 9660 on CD is traditionally done by program mkisofs as -ISO 9660 image producer and cdrecord as burn program. xorriso does not -strive for their comprehensive emulation. Nevertheless it is ready to -perform some of its core tasks under control of commands which in said -programs trigger comparable actions. +ISO 9660 image producer and cdrecord as burn program. `xorriso' does +not strive for their comprehensive emulation. Nevertheless it is ready +to perform some of its core tasks under control of commands which in +said programs trigger comparable actions. -as personality option [options] -- Perform the variable length option list as sparse emulation of the @@ -3227,22 +3232,22 @@ programs trigger comparable actions. are ignored, but better do not rely on this tolerance. The supported options are documented in detail in xorrisofs.info and in man xorrisofs. The description here is focused on the effect - of mkisofs emulation in the context of a xorriso run. + of mkisofs emulation in the context of a `xorriso' run. Other than with the "cdrecord" personality there is no automatic -commit at the end of a "mkisofs" option list. Verbosity settings -v (= "UPDATE") and -quiet (= "SORRY") persist. The output file, eventually chosen with -o, persists until things happen like - -commit, -rollback, -dev, or end of xorriso. -pacifier gets set + -commit, -rollback, -dev, or end 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 + 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. 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 + truncation does not happen if the drive is chosen by `xorriso' options 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 @@ -3258,14 +3263,14 @@ programs trigger comparable actions. option allow_dir_id_ext. This may be avoided by option -disallow_dir_id_ext. Option -root is supported. Option -old-root is implemented by - xorriso commands -mkdir, -cp_clone, -find update_merge, and -find - rm_merge. -root and -old-root set command -disk_dev_ino to + `xorriso' commands -mkdir, -cp_clone, -find update_merge, and + -find rm_merge. -root and -old-root set command -disk_dev_ino to "ino_only" and -md5 to "on", by default. -disk_dev_ino can be set to "off" by --old-root-no-ino resp. to "on" by --old-root-devno . -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 argument "on", + `xorriso' options with the same name and hardcoded argument "on", e.g. -acl "on". Explicit arguments are expected by --stdio_sync and --scdbackup_tag. The capability to preserve multi-session history on overwriteable @@ -3296,17 +3301,17 @@ programs trigger comparable actions. 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' option -jigdo. See the "Alias:" names there for the meaning of the genisoimage options. Personalities "*xorrisofs*", "*genisoimage*", and "*genisofs*" are aliases for "mkisofs". - If xorriso is started with one of the leafnames "xorrisofs", + If `xorriso' is started with one of the leafnames "xorrisofs", "genisofs", "mkisofs", or "genisoimage", then it performs -read_mkisofsrc and prepends -as "genisofs" to the command line arguments. I.e. all arguments will be interpreted mkisofs style until "--" is encountered. From then on, options are interpreted - as xorriso options. + as `xorriso' options. --no_rc as first argument of such a program start prevents interpretation of startup files. See section FILES below. @@ -3317,14 +3322,14 @@ programs trigger comparable actions. --grow_overwriteable_iso, write_start_address=, track source file path or "-" for standard input as track source. It ignores most other options of cdrecord and cdrskin but refuses - on -audio, -scanbus, and on blanking modes unknown to xorriso. + on -audio, -scanbus, and on blanking modes unknown to `xorriso'. The scope is only a single data track per session to be written to blank, overwriteable, or appendable media. The media gets closed if closing is applicable and not option -multi is present. An eventually acquired input drive is given up. This is only allowed if no image changes are pending. - dev= must be given as xorriso device address. Addresses like 0,0,0 - or ATA:1,1,0 are not supported. + dev= must be given as `xorriso' device address. Addresses like + 0,0,0 or ATA:1,1,0 are not supported. If a track source is given, then an automatic -commit happens at the end of the "cdrecord" option list. --grow_overwriteable_iso enables emulation of multi-session on @@ -3335,14 +3340,14 @@ programs trigger comparable actions. program cdrskin. Personalites "*xorrecord*", "*wodim*", and "*cdrskin*" are aliases for "cdrecord". - If xorriso is started with one of the leafnames "xorrecord", + If `xorriso' is started with one of the leafnames "xorrecord", "cdrskin", "cdrecord", or "wodim", then it automatically prepends -as "cdrskin" to the command line arguments. I.e. all arguments will be interpreted cdrecord style until "--" is encountered and an eventual commit happens. From then on, options are interpreted - as xorriso options. + as `xorriso' options. --no_rc as first argument of such a program start prevents - interpretation of xorriso startup files. See section FILES below. + interpretation of `xorriso' startup files. See section FILES below. -read_mkisofsrc Try one by one to open for reading: ./.mkisofsrc , $MKISOFSRC , @@ -3391,7 +3396,7 @@ File: xorriso.info, Node: Scripting, Next: Frontend, Prev: Emulation, Up: Op -options_from_file fileaddress Read quoted input from fileaddress and execute it like dialog lines. Empty lines and lines which begin by # are ignored. - Normally one line should hold one xorriso command and all its + Normally one line should hold one `xorriso' command and all its arguments. Nevertheless lines may be concatenated by a trailing backslash. See also section "Command processing", paragraph "Quoted input". @@ -3406,7 +3411,7 @@ File: xorriso.info, Node: Scripting, Next: Frontend, Prev: Emulation, Up: Op Copy textline into libreadline history. -status mode|filter - Print the current settings of xorriso. Modes: + Print the current settings of `xorriso'. Modes: short... print only important or altered settings long ... print all settings including defaults long_history like long plus history lines @@ -3504,11 +3509,11 @@ File: xorriso.info, Node: Scripting, Next: Frontend, Prev: Emulation, Up: Op -scsi_log "on"|"off" 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. + the `xorriso' output channels. A special property of this option 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. + first operations of `xorriso' begin. Only "-scsi_log" with dash + "-" is recognized that way. -end End program after writing eventually pending changes. @@ -3547,7 +3552,7 @@ File: xorriso.info, Node: Frontend, Next: ExDevices, Prev: Scripting, Up: Op -mark text If text is not empty it will get put out on "M" channel each time - xorriso is ready for the next dialog line or before xorriso + `xorriso' is ready for the next dialog line or before `xorriso' performs a command that was entered to the pager prompt. -prog text @@ -3574,7 +3579,7 @@ File: xorriso.info, Node: Examples, Next: Files, Prev: Options, Up: Top * ExPseudo:: Operate on storage facilities other than optical drives * ExCdrecord:: Burn an existing ISO image file to media * ExMkisofs:: Perform multi-session runs as of cdrtools traditions -* ExGrowisofs:: Let xorriso work underneath growisofs +* ExGrowisofs:: Let `xorriso' work underneath growisofs * ExException:: Adjust thresholds for verbosity, exit value and program abort * ExTime:: Examples of input timestrings * ExIncBackup:: Incremental backup of a few directory trees @@ -3588,8 +3593,8 @@ File: xorriso.info, Node: ExDevices, Next: ExCreate, Prev: Frontend, Up: Exa ============================================== On Linux or FreeBSD consider to give rw-permissions to those users or -groups which shall be able to use the drives with xorriso. On Solaris -use pfexec. Consider to restrict privileges of xorriso to +groups which shall be able to use the drives with `xorriso'. On +Solaris use pfexec. Consider to restrict privileges of `xorriso' to "base,sys_devices" and to give r-permission to user or group. $ xorriso -devices @@ -3724,7 +3729,7 @@ File: xorriso.info, Node: ExBootable, Next: ExCharset, Prev: ExModifying, Up The user has already created a suitable file tree on disk and copied the ISOLINUX files into subdirectory ./boot/isolinux of that tree. Now -xorriso can burn an El Torito bootable media: +`xorriso' can burn an El Torito bootable media: $ xorriso -outdev /dev/sr0 -blank as_needed \ -map /home/me/ISOLINUX_prepared_tree / \ @@ -3764,9 +3769,9 @@ Paths underneath /dev normally need prefix "stdio:" $ xorriso -dev stdio:/dev/sdb ... If /dev/sdb is to be used frequently and /dev/sda is the system disk, -then consider to place the following lines in a xorriso Startup File. +then consider to place the following lines in a `xorriso' Startup File. They allow to use /dev/sdb without prefix and protect disk /dev/sda -from xorriso: +from `xorriso': -drive_class banned /dev/sda* -drive_class harmless /dev/sdb @@ -3816,8 +3821,8 @@ via /dev/sr0. Its device driver might not be aware of the changed content before it loads the media again. In this case the previous session would not be loaded and the new session would contain only the newly added files. -For the same reason do not let xorriso -as cdrecord load the media, but -rather do this manually or by a program that reads from /dev/sr0. +For the same reason do not let `xorriso' -as cdrecord load the media, +but rather do this manually or by a program that reads from /dev/sr0. This example works for multi-session media only. Add cdrskin option --grow_overwriteable_iso to all -as cdrecord runs in order to enable @@ -3826,27 +3831,27 @@ multi-session emulation on overwriteable media.  File: xorriso.info, Node: ExGrowisofs, Next: ExException, Prev: ExMkisofs, Up: Examples -10.11 Let xorriso work underneath growisofs -=========================================== +10.11 Let `xorriso' work underneath growisofs +============================================= growisofs expects an ISO formatter program which understands options -C -and -M. If xorriso gets started by name "xorrisofs" then it is suitable -for that. +and -M. If `xorriso' gets started by name "xorrisofs" then it is +suitable for that. $ export MKISOFS="xorrisofs" $ growisofs -Z /dev/dvd /some/files $ growisofs -M /dev/dvd /more/files If no "xorrisofs" is available on your system, then you will have to -create a link pointing to the xorriso binary and tell growisofs to use -it. E.g. by: +create a link pointing to the `xorriso' binary and tell growisofs to +use it. E.g. by: $ ln -s $(which xorriso) "$HOME/xorrisofs" $ export MKISOFS="$HOME/xorrisofs" One may quit mkisofs emulation by argument "--" and make use of all -xorriso commands. growisofs dislikes options which start with "-o" but --outdev must be set to "-". So use "outdev" instead: +`xorriso' commands. growisofs dislikes options which start with "-o" +but -outdev must be set to "-". So use "outdev" instead: $ growisofs -Z /dev/dvd -- outdev - -update_r /my/files /files $ growisofs -M /dev/dvd -- outdev - -update_r /my/files /files @@ -3945,10 +3950,10 @@ 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 command for -the newly written session (here for mount point /mnt): +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 +command for the newly written session (here for mount point /mnt): -mount_cmd "indev" "auto" "auto" /mnt @@ -4033,11 +4038,11 @@ File: xorriso.info, Node: Files, Next: Seealso, Prev: Examples, Up: Top 11.1 Program Alias Names ======================== -Normal installation of xorriso creates three links or copies which by +Normal installation of `xorriso' creates three links or copies which by their program name pre-select certain settings: -*xorrisofs* starts xorriso with -as mkisofs emulation. -*xorrecord* starts xorriso with -as cdrecord emulation. +*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 of the existing ISO sessions. @@ -4045,7 +4050,7 @@ of the existing ISO sessions. 11.2 Startup Files ================== -If not -no_rc is given as the first argument then xorriso attempts on +If not -no_rc is given as the first argument then `xorriso' attempts on startup to read and execute lines from the following files: /etc/default/xorriso @@ -4072,10 +4077,10 @@ File: xorriso.info, Node: Seealso, Next: Legal, Prev: Files, Up: Top 12 See also *********** -For the mkisofs emulation of xorriso +For the mkisofs emulation of `xorriso' xorrisofs(1) -For mounting xorriso generated ISO 9660 images (-t iso9660) +For mounting `xorriso' generated ISO 9660 images (-t iso9660) mount(8) Libreadline, a comfortable input line facility @@ -4110,17 +4115,17 @@ for libburnia-project.org Copyright (c) 2007 - 2011 Thomas Schmitt Permission is granted to distribute this text freely. It shall only be -modified in sync with the technical properties of xorriso. If you make -use of the license to derive modified versions of xorriso then you are -entitled to modify this text under that same license. +modified in sync with the technical properties of `xorriso'. If you +make use of the license to derive modified versions of `xorriso' then +you are entitled to modify this text under that same license. 13.3 Credits ============ -xorriso is in part based on work by Vreixo Formoso who provides libisofs -together with Mario Danic who also leads the libburnia team. Thanks to -Andy Polyakov who invented emulated growing, to Derek Foreman and Ben -Jansens who once founded libburn. +`xorriso' is in part based on work by Vreixo Formoso who provides +libisofs together with Mario Danic who also leads the libburnia team. +Thanks to Andy Polyakov who invented emulated growing, to Derek Foreman +and Ben Jansens who once founded libburn. Compliments towards Joerg Schilling whose cdrtools served me for ten years. @@ -4212,7 +4217,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -findx traverses disk tree: Navigate. (line 105) * -follow softlinks and mount points: SetInsert. (line 76) * -for_backup -acl,-xattr,-hardlinks,-md5: Loading. (line 184) -* -format formats media: Writing. (line 69) +* -format formats media: Writing. (line 70) * -fs sets size of fifo: SetWrite. (line 255) * -getfacl shows ACL in ISO image: Navigate. (line 69) * -getfacl_r shows ACL in ISO image: Navigate. (line 76) @@ -4227,11 +4232,11 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -in_charset sets input character set: Loading. (line 92) * -indev aquires a drive for input: AqDrive. (line 22) * -iso_rr_pattern controls pattern expansion: Manip. (line 10) -* -jigdo clears JTE or or adds parameter to JTE: Jigdo. (line 33) +* -jigdo clears JTE or or adds parameter to JTE: Jigdo. (line 34) * -joliet enables production of Joliet tree: SetWrite. (line 10) * -list_delimiter replaces '--': Scripting. (line 42) -* -list_formats lists available formats: Writing. (line 107) -* -list_profiles lists supported media: Writing. (line 119) +* -list_formats lists available formats: Writing. (line 108) +* -list_profiles lists supported media: Writing. (line 120) * -load addresses a particular session as input: Loading. (line 11) * -local_charset sets terminal character set: Charset. (line 47) * -logfile logs output channels to file: Frontend. (line 20) @@ -4299,8 +4304,8 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top * -scsi_log reports SCSI commands: Scripting. (line 125) * -session_log logs written sessions: Scripting. (line 116) * -session_string composes session info line: Inquiry. (line 56) -* -set_filter applies filter to file: Filter. (line 59) -* -set_filter_r applies filter to file tree: Filter. (line 84) +* -set_filter applies filter to file: Filter. (line 60) +* -set_filter_r applies filter to file tree: Filter. (line 85) * -setfacl sets ACL in ISO image: Manip. (line 73) * -setfacl_list sets ACL in ISO image: Manip. (line 100) * -setfacl_r sets ACL in ISO image: Manip. (line 97) @@ -4393,7 +4398,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Drive, for input, -indev: AqDrive. (line 22) * Drive, for output, -outdev: AqDrive. (line 29) * Drive, get drive list, -devices: Inquiry. (line 7) -* Drive, list supported media, -list_profiles: Writing. (line 119) +* Drive, list supported media, -list_profiles: Writing. (line 120) * Drive, reduce activity, -calm_drive: Loading. (line 235) * Drive, report SCSI commands, -scsi_log: Scripting. (line 125) * Drive, write and eject, -commit_eject: Writing. (line 40) @@ -4405,8 +4410,8 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Emulation, pacifier form, -pacifier: Emulation. (line 158) * Examples: Examples. (line 6) * Filter, _definition: Filter. (line 6) -* Filter, apply to file tree, -set_filter_r: Filter. (line 84) -* Filter, apply to file, -set_filter: Filter. (line 59) +* Filter, apply to file tree, -set_filter_r: Filter. (line 85) +* Filter, apply to file, -set_filter: Filter. (line 60) * Filter, ban registration, -close_filter_list: Filter. (line 52) * Filter, register, -external_filter: Filter. (line 20) * Filter, show chain, -show_stream: Navigate. (line 162) @@ -4456,15 +4461,15 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top * Insert, pathspecs, -add: Insert. (line 42) * Insert, piece of data file, -cut_out: Insert. (line 126) * iso_rr_path, _definition: Insert. (line 7) -* Jigdo Template Extraction, -jigdo: Jigdo. (line 33) +* Jigdo Template Extraction, -jigdo: Jigdo. (line 34) * Jigdo Template Extraction, _definition: Jigdo. (line 6) * List delimiter, _definiton: Processing. (line 8) * MBR, _definiton: Extras. (line 26) * MBR, set, -boot_image system_area=: Bootable. (line 123) * MD5, control handling, -md5: Loading. (line 155) * Media, erase, -blank: Writing. (line 45) -* Media, format, -format: Writing. (line 69) -* Media, list formats, -list_formats: Writing. (line 107) +* Media, format, -format: Writing. (line 70) +* Media, list formats, -list_formats: Writing. (line 108) * MIPS boot file, activation: Bootable. (line 178) * mkisofs, Emulation: Emulation. (line 16) * Modifying, _definition: Methods. (line 27) @@ -4592,56 +4597,56 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top Tag Table: Node: Top420 Node: Overview1324 -Node: Model3209 -Node: Media6089 -Node: Methods8739 -Node: Drives11295 -Node: Extras14601 -Node: Processing18074 -Node: Dialog21570 -Node: Options23227 -Node: AqDrive24835 -Node: Loading27741 -Node: Insert42060 -Node: SetInsert51679 -Node: Manip60246 -Node: CmdFind68927 -Node: Filter80227 -Node: Writing84576 -Node: SetWrite90865 -Node: Bootable104898 -Node: Jigdo118216 -Node: Charset122474 -Node: Exception125225 -Node: DialogCtl131343 -Node: Inquiry133930 -Node: Navigate138307 -Node: Verify146247 -Node: Restore154836 -Node: Emulation161492 -Node: Scripting171328 -Node: Frontend177468 -Node: Examples178763 -Node: ExDevices179932 -Node: ExCreate180566 -Node: ExDialog181840 -Node: ExGrowing183102 -Node: ExModifying183904 -Node: ExBootable184405 -Node: ExCharset184952 -Node: ExPseudo185780 -Node: ExCdrecord186674 -Node: ExMkisofs186989 -Node: ExGrowisofs188325 -Node: ExException189449 -Node: ExTime189903 -Node: ExIncBackup190362 -Node: ExRestore194283 -Node: ExRecovery195252 -Node: Files195818 -Node: Seealso197108 -Node: Legal197688 -Node: CommandIdx198610 -Node: ConceptIdx213278 +Node: Model3213 +Node: Media6099 +Node: Methods8761 +Node: Drives11319 +Node: Extras14627 +Node: Processing18116 +Node: Dialog21616 +Node: Options23279 +Node: AqDrive24887 +Node: Loading27795 +Node: Insert42130 +Node: SetInsert51749 +Node: Manip60322 +Node: CmdFind69007 +Node: Filter80309 +Node: Writing84666 +Node: SetWrite90964 +Node: Bootable105009 +Node: Jigdo118329 +Node: Charset122593 +Node: Exception125352 +Node: DialogCtl131492 +Node: Inquiry134079 +Node: Navigate138462 +Node: Verify146402 +Node: Restore154997 +Node: Emulation161657 +Node: Scripting171523 +Node: Frontend177671 +Node: Examples178970 +Node: ExDevices180141 +Node: ExCreate180779 +Node: ExDialog182053 +Node: ExGrowing183315 +Node: ExModifying184117 +Node: ExBootable184618 +Node: ExCharset185167 +Node: ExPseudo185995 +Node: ExCdrecord186893 +Node: ExMkisofs187208 +Node: ExGrowisofs188546 +Node: ExException189680 +Node: ExTime190134 +Node: ExIncBackup190593 +Node: ExRestore194517 +Node: ExRecovery195486 +Node: Files196052 +Node: Seealso197350 +Node: Legal197934 +Node: CommandIdx198861 +Node: ConceptIdx213529  End Tag Table diff --git a/xorriso/xorriso.texi b/xorriso/xorriso.texi index e99269f5..f7906237 100644 --- a/xorriso/xorriso.texi +++ b/xorriso/xorriso.texi @@ -27,6 +27,7 @@ @c "@item word words" becomes "\fBword\fR words". @c @strong{-...} gets mapped to \fB\-...\fR . @c @strong{...} gets mapped to \fB...\fR . +@c @command{...} gets mapped to \fB...\fR . @c @minus{} will become "-". @c @@ , @{, @} will get stripped of their first @. @c Other lines which begin by "@" will be discarded. @@ -114,17 +115,17 @@ with Rock Ridge extensions. @c man .br @c man .SH DESCRIPTION @c man .PP -@strong{xorriso} +@command{xorriso} is a program which copies file objects from POSIX compliant filesystems into Rock Ridge enhanced ISO 9660 filesystems and allows session-wise manipulation of such filesystems. It can load the management information of existing ISO images and it writes the session results to optical media or to filesystem objects. @* -Vice versa xorriso is able to copy file objects out of ISO 9660 filesystems. +Vice versa @command{xorriso} is able to copy file objects out of ISO 9660 filesystems. @c man .PP @sp 1 -A special property of xorriso is that it needs neither an external ISO 9660 +A special property of @command{xorriso} is that it needs neither an external ISO 9660 formatter program nor an external burn program for CD, DVD or BD but rather incorporates the libraries of libburnia-project.org . @c man .SS @@ -229,17 +230,17 @@ functionality to overwriteable media or disk files which carry valid ISO 9660 filesystems. @c man .PP @sp 1 -xorriso provides growing as well as an own method named +@command{xorriso} provides growing as well as an own method named @strong{modifying} which produces a completely new ISO image from the old one and the modifications. See paragraph Creating, Growing, Modifying, Blind Growing below. @c man .PP @sp 1 -xorriso adopts the concept of multi-session by loading an eventual image +@command{xorriso} adopts the concept of multi-session by loading an eventual image directory tree, allowing to manipulate it by several actions, and to write the new image to the target media. @c man .br -The first session of a xorriso run begins by the definition of the input +The first session of a @command{xorriso} run begins by the definition of the input drive with the eventual ISO image or by the definition of an output drive. The session ends by command -commit which triggers writing. A -commit is done automatically when the program ends regularly. @@ -268,13 +269,13 @@ describes their existing sessions. See option @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. -xorriso will write onto them only if option -close is set to "on". +@command{xorriso} will write onto them only if option -close is set to "on". @* @cindex Overwriteable media, _definition @strong{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 and if the -first session was written by xorriso, then a table of content can +first session was written by @command{xorriso}, then a table of content can be emulated. Else only a single overall session will be visible. @* DVD-RW media can be formatted by -format "full". @@ -290,12 +291,12 @@ capabilities. @sp 1 @cindex Blank media, _definition @strong{Blank} media can be written from scratch. They contain no ISO image -suitable for xorriso. +suitable for @command{xorriso}. @* Blank is the state of newly purchased optical media. With used CD-RW and DVD-RW it can be achieved by action -blank "as_needed". Overwriteable media are considered blank if they are new or if they have -been marked as blank by xorriso. +been marked as blank by @command{xorriso}. Action -blank "as_needed" can be used to do this marking on overwriteable media, or to apply eventual mandatory formatting to new media. @* @@ -303,14 +304,14 @@ media, or to apply eventual mandatory formatting to new media. @cindex Appendable media, _definition @strong{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. +which contain an ISO image suitable for @command{xorriso}. @* Appendable is the state after writing a session with option -close off. @* @sp 1 @cindex Closed media, _definition @strong{Closed} media cannot be written. They may contain an ISO image suitable -for xorriso. +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 @@ -380,7 +381,7 @@ to the given block address. This is the usage model of mkisofs -M $indev -C $msc1,$msc2 -o $outdev @* which gives much room for wrong parameter combinations and should thus only be -employed if a strict distinction between ISO formatter xorriso and the burn +employed if a strict distinction between ISO formatter @command{xorriso} and the burn program is desired. -C $msc1,$msc2 is equivalent to: @* -load sbsector $msc1 -grow_blindly $msc2 @@ -399,7 +400,7 @@ Output drive, i.e. target for writing, can be any libburn drive. Some drive types do not support the method of growing but only the methods of modifying and blind growing. They all are suitable for newly created images. @* -All drive file objects have to offer rw-permission to the user of xorriso. +All drive file objects have to offer rw-permission to the user of @command{xorriso}. Even those which will not be useable for reading an ISO image. @c man .PP @sp 1 @@ -493,12 +494,12 @@ is the name of a set of additional information which enhance an ISO 9660 filesystem so that it can represent a POSIX compliant filesystem with ownership, access permissions, symbolic links, and other attributes. @* -This is what xorriso uses for a decent representation of the disk files -within the ISO image. Rock Ridge information is produced with any xorriso +This is what @command{xorriso} uses for a decent representation of the disk files +within the ISO image. Rock Ridge information is produced with any @command{xorriso} image. @c man .PP @sp 1 -xorriso is not named "porriso" because POSIX only guarantees 14 characters +@command{xorriso} is not named "porriso" because POSIX only guarantees 14 characters of filename length. It is the X/Open System Interface standard XSI which demands a file name length of up to 255 characters and paths of up to 1024 characters. Rock Ridge fulfills this demand. @@ -511,7 +512,7 @@ images, which are binary program files stored in the 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 +@command{xorriso} is able to create or maintain an El Torito object which makes such an image bootable. For details see option -boot_image. @* @cindex MBR, _definiton @@ -542,27 +543,27 @@ It uses this extension if enabled by option @* AAIP enhanced images are supposed to be mountable normally, but one cannot expect that the mounted filesystem will show and respect the eventual ACLs. -For now, only xorriso is able to retrieve those ACLs. It can bring them into +For now, only @command{xorriso} is able to retrieve those ACLs. It can bring them into effect when files get restored to an ACL enabled file system or it can print them in a format suitable for tool setfacl. @* Files with ACL show as group permissions the setting of entry "mask::" if that entry exists. Nevertheless the non-listed group members get handled -according to entry "group::". xorriso brings "group::" into effect before +according to entry "group::". @command{xorriso} brings "group::" into effect before eventually removing the ACL from a file. @c man .PP @sp 1 @cindex xattr, _definiton @strong{xattr} (aka EA) are pairs of name and value which can be attached to file objects. AAIP is -able to represent them and xorriso allows to record and restore pairs which +able to represent them and @command{xorriso} allows to record and restore 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 @strong{-xattr}. @* -As with ACL, currently only xorriso is able to retrieve xattr from AAIP +As with ACL, currently only @command{xorriso} is able to retrieve xattr from AAIP enhanced images, to restore them to xattr capable file systems, or to print them. @c man .SS @@ -615,9 +616,9 @@ Command and parameter words are either read from program arguments, where one argument is one word, or from quoted input lines where words are recognized similar to the quotation rules of a shell parser. @* -xorriso is not a shell, although it might appear so on first glimpse. +@command{xorriso} is not a shell, although it might appear so on first glimpse. Be aware that the interaction of quotation marks and pattern symbols like "*" -differs from the usual shell parsers. In xorriso, a quotation mark does not +differs from the usual shell parsers. In @command{xorriso}, a quotation mark does not make a pattern symbol literal. @c man .PP @sp 1 @@ -661,8 +662,8 @@ to make dialog more comfortable. @c man .PP @sp 1 Readline is an enhancement for the input line. You may know it already from -the bash shell. Whether it is available in xorriso depends on the availability -of package readline-dev at the time when xorriso was built from its sourcecode. +the bash shell. Whether it is available in @command{xorriso} depends on the availability +of package readline-dev at the time when @command{xorriso} was built from its sourcecode. @* It allows to move the cursor over the text in the line by help of the Leftward and the Rightward arrow key. @@ -680,7 +681,7 @@ Option -page activates a built-in result text pager which may be convenient in dialog. After an action has put out the given number of terminal lines, the pager prompts the user for a line of input. @* -An empty line lets xorriso resume work until the next page is put out. +An empty line lets @command{xorriso} resume work until the next page is put out. @* The single character "@@" disables paging for the current action. @* @@ -793,7 +794,7 @@ predicted_nwa is the block address where the add-on session of blind growing will finally end up. It is the responsibility of the user to ensure this final position and the presence of the older sessions. Else the overall ISO image will not be mountable or will produce read errors when -accessing file content. xorriso will write the session to the address +accessing file content. @command{xorriso} will write the session to the address as obtained from examining -outdev and not necessarily to predicted_nwa. @* During a run of blind growing, the input drive is given up before output @@ -872,7 +873,7 @@ accepted. If it is not a MMC device then the prefix "stdio:" will be prepended automatically. This list is empty by default. @* Else if the path matches the "banned" list then the drive will not be -accepted by xorriso but rather lead to a FAILURE event. This list is empty by +accepted by @command{xorriso} but rather lead to a FAILURE event. This list is empty by default. @* Else if the path matches the "caution" list and if it is not a MMC device, @@ -891,7 +892,7 @@ By pseudo-class "clear_list" and pseudo-patterns "banned", "caution", @* E.g.: -drive_class clear_list banned @* -One will normally define the -drive_class lists in one of the xorriso +One will normally define the -drive_class lists in one of the @command{xorriso} Startup Files. @* Note: This is not a security feature but rather a bumper for the superuser to @@ -927,7 +928,7 @@ an eventual recorded character set name gets used as input character set when reading an image. @* Note that the default output charset is the local character set of the -terminal where xorriso runs. Before attributing this local character set +terminal where @command{xorriso} runs. Before attributing this local character set to the produced ISO image, check whether the terminal properly displays all intended filenames, especially exotic national characters. @c man .TP @@ -956,7 +957,7 @@ e.g. if you need to apply filters to all updated files. Mode "without_update" avoids hardlink processing during update commands. Use this if your filesystem situation does not allow -disk_dev_ino "on". @* -xorriso commands which extract files from an ISO image try to hardlink files +@command{xorriso} commands which extract files from an ISO image try to hardlink files with identical inode number. The normal scope of this operation is from image load to image load. One may give up the accumulated hard link addresses by -hardlinks "discard_extract". @@ -972,7 +973,7 @@ wide and expensive hardlink accumulation. @kindex -acl controls handling of ACLs @cindex ACL, control handling, -acl Enable or disable processing of ACLs. -If enabled, then xorriso will obtain ACLs from disk file objects, +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. @@ -982,7 +983,7 @@ See also options -getfacl, -setfacl. @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 xorriso will handle xattr similar to ACL. +If enabled, then @command{xorriso} will handle xattr similar to ACL. See also options -getfattr, -setfattr and above paragraph about xattr. @c man .TP @item -md5 "on"|"all"|"off"|"load_check_off" @@ -1012,7 +1013,7 @@ Mode "load_check_off" together with "on" or "all" will load recorded MD5 sums but not test the recorded checksum tags of superblock and directory tree. This is necessary if growisofs was used as burn program, because it does not overwrite the superblock checksum tag of the first session. -Therefore load_check_off is in effect when xorriso -as mkisofs option -M +Therefore load_check_off is in effect when @command{xorriso} -as mkisofs option -M is performed. @* The test can be re-enabled by mode "load_check_on". @@ -1068,7 +1069,7 @@ to invalid addresses and thus ugly drive behavior. Setting "on" enables that scan for alleged read-only media. @* Some operating systems are not able to mount the most recent session of -multi-session DVD or BD. If on such a system xorriso has no own MMC +multi-session DVD or BD. If on such a system @command{xorriso} has no own MMC capabilities then it may still find that session from a scanned table of content. Setting "force" handles any media like a ROM media with setting "on". @* @@ -1379,7 +1380,7 @@ arguments. @cindex Insert, limit data file size, -file_size_limit Set the maximum permissible size for a single data file. The values get summed up for the actual limit. If the only value is "off" then the file -size is not limited by xorriso. Default is a limit of 100 extents, 4g -2k each: +size is not limited by @command{xorriso}. Default is a limit of 100 extents, 4g -2k each: @* -file_size_limit 400g -200k @minus{}@minus{} @* @@ -1388,7 +1389,7 @@ up to 2g -1 @minus{}@minus{}. Newer ones are good up to 4g -1 @minus{}@minus{}. You need quite a new Linux kernel to read correctly the final bytes of a file >= 4g if its size is not aligned to 2048 byte blocks. @* -xorriso's own data read capabilities are not affected by eventual +@command{xorriso}'s own data read capabilities are not affected by eventual operating system size limits. They apply to mounting only. Nevertheless, the target filesystem of an -extract must be able to take the file size. @c man .TP @@ -1525,7 +1526,7 @@ an intentional sequence of link hops. @item -pathspecs "on"|"off" @kindex -pathspecs sets meaning of = with -add @cindex Insert, meaning of = with -add, -pathspecs -Control parameter interpretation with xorriso actions -add and -path_list. +Control parameter interpretation with @command{xorriso} actions -add and -path_list. @* @cindex Pathspec, _definition "on" enables pathspecs of the form @@ -1758,7 +1759,7 @@ be an empty text. 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. +Values and names undergo the normal input processing of @command{xorriso}. See also option -backslash_codes. Other than with option -setfattr_list, the byte value 0 cannot be expressed via -setfattr. @c man .TP @@ -1819,7 +1820,7 @@ Absolute seconds counted from Jan 1 1970: @* =Number @* -xorriso's own timestamps: +@command{xorriso}'s own timestamps: @* YYYY.MM.DD[.hh[mm[ss]]] @* @@ -1994,7 +1995,7 @@ If -else is missing and would be hit, then the result is a non-match. Default action is @strong{echo}, i.e. to print the address of the found file. Other actions are certain -xorriso commands which get performed on the found files. These commands +@command{xorriso} commands which get performed on the found files. These commands may have specific parameters. See also their particular descriptions. @c man .br @table @asis @@ -2244,8 +2245,8 @@ is not applied to any file in the ISO image. Irrevocably ban commands -external_filter and -unregister_filter, but not -set_filter. Use this to prevent external filtering in general or when all intended filters are registered. -External filters may also be banned totally at compile time of xorriso. -By default they are banned if xorriso runs under setuid permission. +External filters may also be banned totally at compile time of @command{xorriso}. +By default they are banned if @command{xorriso} runs under setuid permission. @c man .TP @item -set_filter name iso_rr_path [***] @kindex -set_filter applies filter to file @@ -2318,7 +2319,7 @@ Writing can last quite a while. It is not unnormal with several types of media that there is no progress visible for the first few minutes or that the drive gnaws on the media for a few minutes after all data have been transmitted. -xorriso and the drives are in a client-server relationship. +@command{xorriso} and the drives are in a client-server relationship. The drives have much freedom about what to do with the media. Some combinations of drives and media simply do not work, despite the promises by their vendors. @@ -2364,7 +2365,7 @@ overwriteable ISO images. "all" might work more thoroughly and need more time. @* "deformat_quickest" is a faster way to deformat or blank DVD-RW but produces media which are only suitable for a single session. -xorriso will write onto them only if option -close is set to "on". +@command{xorriso} will write onto them only if option -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 @@ -2557,7 +2558,7 @@ which get visible if the reader ignores Rock Ridge. @item -volid text @kindex -volid sets volume id @cindex Image, set volume id, -volid -Specify the volume ID. xorriso accepts any text up to 32 characters, +Specify the volume ID. @command{xorriso} accepts any text up to 32 characters, but according to rarely obeyed specs stricter rules apply: @* ECMA 119 demands ASCII characters out of [A-Z0-9_]. Like: "IMAGE_23" @@ -2599,7 +2600,7 @@ identify the specification of how the data are recorded. Permissible are up to 128 characters. This setting gets overridden by image loading. @* -The special text "@@xorriso@@" gets converted to the id string of xorriso +The special text "@@xorriso@@" gets converted to the id string of @command{xorriso} which is normally written as -preparer_id. It is a wrong tradition to write the program id as -application_id. @c man .TP @@ -2673,11 +2674,11 @@ image loading. @cindex Image, set preparer id, -preparer_id Set the preparer id string to be written with the next -commit. This may identify the person or other entity which controls the preparation of the data -which shall be recorded. Normally this should be the id of xorriso and not -of the person or program which operates xorriso. Please avoid to change it. +which shall be recorded. Normally this should be the id of @command{xorriso} and not +of the person or program which operates @command{xorriso}. Please avoid to change it. Permissible are up to 128 characters. @* -The special text "@@xorriso@@" gets converted to the id string of xorriso +The special text "@@xorriso@@" gets converted to the id string of @command{xorriso} which is default at program startup. @* Unlike other id strings, this setting is not influenced by image loading. @@ -2804,7 +2805,7 @@ Append the given number of extra bytes to the image stream. This is a traditional remedy for a traditional bug in block device read drivers. Needed only for CD recordings in TAO mode. Since one can hardly predict on what media an image might end up, -xorriso adds the traditional 300k of padding by default to all images. +@command{xorriso} adds the traditional 300k of padding by default to all images. @* For images which will never get to a CD it is safe to use -padding 0 . @* @@ -3097,7 +3098,7 @@ Partitions may be appended with boot block type MBR and with SUN Disk Label. With MBR: @* partition_number may be 1 to 4. Number 1 will put the whole ISO image into -the unclaimed space before partition 1. So together with most xorriso MBR +the unclaimed space before partition 1. So together with most @command{xorriso} MBR features, number 2 would be the most natural choice. @* The type_code may be "FAT12", "FAT16", "Linux", @@ -3130,13 +3131,13 @@ DVD images; see http://atterer.net/jigdo/ for more details. Debian CDs and DVD ISO images are published on the web in jigdo format to allow end users to download them more efficiently." @* -xorriso can produce a .jigdo and a .template file together with a +@command{xorriso} can produce a .jigdo and a .template file together with a single-session ISO image. The .jigdo file contains checksums and symbolic file addresses. The .template file contains the compressed ISO image with reference tags instead of the content bytes of the listed files. @* -Input for this process are the normal arguments for a xorriso session +Input for this process are the normal arguments for a @command{xorriso} session on a blank -outdev, and a .md5 file which lists those data files which may be listed in the .jigdo file and externally referenced in the .template file. Each designated file is represented in the .md5 file by a single text line: @@ -3151,7 +3152,7 @@ After eventual To=From mapping, the file address gets written into the .jigdo file. Jigdo restore tools will convert these addresses into really reachable data source addresses from which they can read. @* -If the list of jigdo parameters is not empty, then xorriso will refuse to +If the list of jigdo parameters is not empty, then @command{xorriso} will refuse to write to non-blank targets, it will disable multi-session emulation, and eventual padding will be counted as part of the ISO image. @* @@ -3240,7 +3241,7 @@ names. Shell command iconv -l lists them. Character sets should not matter as long as only english alphanumeric characters are used for file names or as long as all writers and readers of the media use the same character set. -Outside these constraints it may be necessary to let xorriso convert byte +Outside these constraints it may be necessary to let @command{xorriso} convert byte codes. @* There is an input conversion from input character set to the local character @@ -3249,14 +3250,14 @@ 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 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 command +If conversions are desired then @command{xorriso} needs to know the name of the +local character set. @command{xorriso} can inquire the same info as shell command "locale" with argument "charmap". This may be influenced by environment variables LC_ALL, LC_CTYPE, or LANG and should match the expectations of the terminal. @* The default output charset is the local character set of the terminal where -xorriso runs. So by default no conversion happens between local filesystem +@command{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. @* @@ -3292,8 +3293,8 @@ If this appears necessary, one should consider to set -backslash_codes to @node Exception, DialogCtl, Charset, Options @section Exception processing @c man .PP -Since the tasks of xorriso are manifold and prone to external influence, there -may arise the need for xorriso to report and handle problem events. +Since the tasks of @command{xorriso} are manifold and prone to external influence, there +may arise the need for @command{xorriso} to report and handle problem events. @* Those events get classified when they are detected by one of the software modules and forwarded to reporting and evaluation modules which decide about @@ -3339,26 +3340,26 @@ be ignorable. @* A special property of this option 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 +start arguments is in effect already when the first operations of @command{xorriso} begin. Only "-abort_on" with dash "-" is recognized that way. @c man .TP @item -return_with severity exit_value @kindex -return_with controls exit value @cindex Process, control exit value, -return_with Set the threshold and exit_value to be returned at program end if no abort -has happened. This is to allow xorriso to go on after problems but to get +has happened. This is to allow @command{xorriso} to go on after problems but to get a failure indicating exit value from the program, nevertheless. Useful is a value lower than the -abort_on threshold, down to "WARNING". @* exit_value may be either 0 (indicating success to the starter of the program) -or a number between 32 and 63. Some other exit_values are used by xorriso if +or a number between 32 and 63. Some other exit_values are used by @command{xorriso} if it decides to abort the program run: @* 1=abort due to external signal @* 2=no program arguments given @* -3=creation of xorriso main object failed +3=creation of @command{xorriso} main object failed @* 4=failure to start libburnia-project.org libraries @* @@ -3382,7 +3383,7 @@ Info messages which belong to no event get attributed severity "NOTE". @* A special property of this option 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. +of @command{xorriso} begin. Only "-report_about" with dash "-" is recognized that way. @c man .TP @item -signal_handling mode @kindex -signal_handling controls handling of system signals @@ -3393,10 +3394,10 @@ caused by severe program errors. @* Mode "on" is the default. It uses the signal handler of libburn which produces ugly messages but puts much effort in releasing eventually used optical drives -before xorriso ends. +before @command{xorriso} ends. @* Mode "off" as first -signal_handling among the start arguments prevents all -own signal precautions of xorriso. Eventually inherited signal handler settings +own signal precautions of @command{xorriso}. Eventually inherited signal handler settings stay as they are. @* It works like "sig_dfl" if given after other signal handling was already @@ -3407,14 +3408,14 @@ normally a sudden abort of the program. To prevent stuck drives, the libburn handler is used during burning, blanking, and formatting on MMC drives. @* Mode "sig_ign" tries to ignore as many signal types as possible. This imposes -the risk that xorriso refuses to end until externally kill -9 if performed. +the risk that @command{xorriso} refuses to end until externally kill -9 if performed. 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 among the start arguments is in effect already when the first operations -of xorriso begin. Only "-signal_handling" with dash "-" is recognized that way. +of @command{xorriso} begin. Only "-signal_handling" with dash "-" is recognized that way. @c man .TP @item -error_behavior occasion behavior @kindex -error_behavior controls error workarounds @@ -3550,7 +3551,7 @@ not the ISO image directory tree. @* In case of overwriteable media holding a valid ISO image, it may happen that only a single session gets shown. But if the first session on the -overwriteable media was written by xorriso then a complete +overwriteable media was written by @command{xorriso} then a complete session history can be emulated. @* A drive which is incapable of writing may show any media as CD-ROM or DVD-ROM @@ -3586,7 +3587,7 @@ for direct execution of this command. @cindex Session, mount parameters, -mount_opts Set options which influence -mount and -mount_cmd. Currently there is only option "exclusive" which is default and its counterpart "shared". The latter -causes xorriso not to give up the affected drive with command -mount. +causes @command{xorriso} not to give up the affected drive with command -mount. On GNU/Linux it adds mount option "loop" which may allow to mount several sessions of the same block device at the same time. One should not write to a mounted optical media, of course. Take care to umount all sessions @@ -3601,7 +3602,7 @@ format and the parameters of the addressed session. Formats "linux:"path or "freebsd:"path produce the output of -mount_cmd for the given operating systems. @* -In other texts xorriso will substitute the following parameter names. +In other texts @command{xorriso} will substitute the following parameter names. An optional prefix "string:" will be removed. @* "%device%" will be substituted by the mountable device path of the drive @@ -3901,7 +3902,7 @@ and based on extra data on the media. If a drive returns data then one can quite trust that they are valid. But at some degree of read problems the correction will fail and the drive is supposed to indicate error. @* -xorriso can scan the media for readable data blocks, classify them according +@command{xorriso} can scan the media 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 media. @* @@ -4000,7 +4001,7 @@ gives the path of the file which may abort a scan run. Abort happens if the file exists and its mtime is not older than the start time of the run. Use shell command "touch" to trigger this. Other than an aborted program run, this will report the tested and untested -blocks and go on with running xorriso. +blocks and go on with running @command{xorriso}. @* @item time_limit=seconds gives the number of seconds after which the scan shall be @@ -4043,7 +4044,7 @@ when it gets mounted or loaded as stdio: drive. But it usually makes the original session 1 inaccessible. @* @item patch_lba0="force" -performs patch_lba0="on" even if xorriso believes +performs patch_lba0="on" even if @command{xorriso} believes that the copied data are not valid. @* patch_lba0= may also bear a number. If it is 32 or higher it is taken as @@ -4092,7 +4093,7 @@ Only mismatching data files will be reported. @node Restore, Emulation, Verify, Options @section osirrox ISO-to-disk restore options @c man .PP -Normally xorriso only writes to disk files which were given as stdio: +Normally @command{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 extract file objects from ISO images and to create, overwrite, or delete file objects on disk. @@ -4133,7 +4134,7 @@ handled like any other ISO image directory. @* Option "auto_chmod_off" is default. If "auto_chmod_on" is set then access restrictions for disk directories get circumvented if those directories -are owned by the effective user who runs xorriso. This happens by temporarily +are owned by the effective user who runs @command{xorriso}. This happens by temporarily granting rwx permission to the owner. @* Option "sort_lba_on" may improve read performance with optical drives. It @@ -4252,7 +4253,7 @@ reachable as /bin/mount or /sbin/mount. @c man .PP Writing of ISO 9660 on CD is traditionally done by program mkisofs as ISO 9660 image producer and cdrecord as burn program. -xorriso does not strive for their comprehensive emulation. +@command{xorriso} does not strive for their comprehensive emulation. Nevertheless it is ready to perform some of its core tasks under control of commands which in said programs trigger comparable actions. @table @asis @@ -4284,16 +4285,16 @@ emulation. Some are ignored, but better do not rely on this tolerance. @* The supported options are documented in detail in xorrisofs.info and in man xorrisofs. The description here is focused on the effect -of mkisofs emulation in the context of a xorriso run. +of mkisofs emulation in the context of a @command{xorriso} run. @* Other than with the "cdrecord" personality there is no automatic -commit at the end of a "mkisofs" option list. Verbosity settings -v (= "UPDATE") and -quiet (= "SORRY") persist. The output file, eventually chosen with -o, -persists until things happen like -commit, -rollback, -dev, or end of xorriso. +persists until things happen like -commit, -rollback, -dev, or end of @command{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 +are interpreted differently than with @command{xorriso} option -add. Directories get merged with the root directory of the ISO image, other filetypes get mapped into that root directory. @* @@ -4301,7 +4302,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 xorriso options before -as mkisofs or after its list delimiter. +is chosen by @command{xorriso} options 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 @@ -4319,7 +4320,7 @@ directory is added to the image. At the same occasion directory names get allowed to violate the standard by -compliance option allow_dir_id_ext. This may be avoided by option -disallow_dir_id_ext. @* -Option -root is supported. Option -old-root is implemented by xorriso +Option -root is supported. Option -old-root is implemented by @command{xorriso} commands -mkdir, -cp_clone, -find update_merge, and -find rm_merge. -root and -old-root set command -disk_dev_ino to "ino_only" and -md5 to "on", by default. @@ -4330,7 +4331,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 xorriso options with the +They work like the @command{xorriso} options with the same name and hardcoded argument "on", e.g. -acl "on". Explicit arguments are expected by @minus{}@minus{}stdio_sync and @minus{}@minus{}scdbackup_tag. @@ -4375,7 +4376,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 xorriso option -jigdo. See the "Alias:" names there for the +performed via @command{xorriso} option -jigdo. See the "Alias:" names there for the meaning of the genisoimage options. @* @sp 1 @@ -4383,12 +4384,12 @@ meaning of the genisoimage options. Personalities "@strong{xorrisofs}", "@strong{genisoimage}", and "@strong{genisofs}" are aliases for "mkisofs". @* -If xorriso is started with one of the leafnames "xorrisofs", "genisofs", +If @command{xorriso} is started with one of the leafnames "xorrisofs", "genisofs", "mkisofs", or "genisoimage", then it performs -read_mkisofsrc and prepends -as "genisofs" to the command line arguments. I.e. all arguments will be interpreted mkisofs style until "@minus{}@minus{}" is encountered. -From then on, options are interpreted as xorriso options. +From then on, options are interpreted as @command{xorriso} options. @* @minus{}@minus{}no_rc as first argument of such a program start prevents interpretation of startup files. See section FILES below. @@ -4407,7 +4408,7 @@ write_start_address=, track source file path or "-" for standard input as track source. @* It ignores most other options of cdrecord and cdrskin but refuses on --audio, -scanbus, and on blanking modes unknown to xorriso. +-audio, -scanbus, and on blanking modes unknown to @command{xorriso}. @* The scope is only a single data track per session to be written to blank, overwriteable, or appendable media. The media gets closed if @@ -4416,7 +4417,7 @@ closing is applicable and not option -multi is present. An eventually acquired input drive is given up. This is only allowed if no image changes are pending. @* -dev= must be given as xorriso device address. Addresses like 0,0,0 or ATA:1,1,0 +dev= must be given as @command{xorriso} device address. Addresses like 0,0,0 or ATA:1,1,0 are not supported. @* If a track source is given, then an automatic -commit happens at the end of @@ -4433,14 +4434,14 @@ A much more elaborate libburn based cdrecord emulator is the program cdrskin. Personalites "@strong{xorrecord}", "@strong{wodim}", and "@strong{cdrskin}" are aliases for "cdrecord". @* -If xorriso is started with one of the leafnames "xorrecord", "cdrskin", +If @command{xorriso} is started with one of the leafnames "xorrecord", "cdrskin", "cdrecord", or "wodim", then it automatically prepends -as "cdrskin" to the command line arguments. I.e. all arguments will be interpreted cdrecord style until "@minus{}@minus{}" is encountered and an eventual commit happens. -From then on, options are interpreted as xorriso options. +From then on, options are interpreted as @command{xorriso} options. @* @minus{}@minus{}no_rc as first argument of such a program start -prevents interpretation of xorriso startup files. See section FILES below. +prevents interpretation of @command{xorriso} startup files. See section FILES below. @c man .TP @item -read_mkisofsrc @kindex -read_mkisofsrc searches and reads .mkisofsrc file @@ -4509,7 +4510,7 @@ files. See section FILES below. @cindex Process, read command file, -options_from_file Read quoted input from fileaddress and execute it like dialog lines. Empty lines and lines which begin by # are ignored. Normally one line -should hold one xorriso command and all its arguments. Nevertheless lines +should hold one @command{xorriso} command and all its arguments. Nevertheless lines may be concatenated by a trailing backslash. @* See also section "Command processing", paragraph "Quoted input". @@ -4533,7 +4534,7 @@ Copy textline into libreadline history. @item -status mode|filter @kindex -status shows current settings @cindex Program, show current settings, -status -Print the current settings of xorriso. +Print the current settings of @command{xorriso}. Modes: @* short... print only important or altered settings @@ -4672,12 +4673,12 @@ The first three items are single words, the rest of the line is the volume id. @kindex -scsi_log reports SCSI commands @cindex Drive, report SCSI commands, -scsi_log 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 +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 among the start arguments is in effect already when the first operations -of xorriso begin. Only "-scsi_log" with dash "-" is recognized that way. +of @command{xorriso} begin. Only "-scsi_log" with dash "-" is recognized that way. @c man .TP @item -end @kindex -end writes pending session and ends program @@ -4735,8 +4736,8 @@ channels, "I" for info messages, "R" for result lines, "M" for -mark texts. @item -mark text @kindex -mark sets synchronizing message @cindex Process, set synchronizing message, -mark -If text is not empty it will get put out on "M" channel each time xorriso -is ready for the next dialog line or before xorriso performs a command that +If text is not empty it will get put out on "M" channel each time @command{xorriso} +is ready for the next dialog line or before @command{xorriso} performs a command that was entered to the pager prompt. @c man .TP @item -prog text @@ -4798,7 +4799,7 @@ Use text as name of this program and perform -help. * ExPseudo:: Operate on storage facilities other than optical drives * ExCdrecord:: Burn an existing ISO image file to media * ExMkisofs:: Perform multi-session runs as of cdrtools traditions -* ExGrowisofs:: Let xorriso work underneath growisofs +* ExGrowisofs:: Let @command{xorriso} work underneath growisofs * ExException:: Adjust thresholds for verbosity, exit value and program abort * ExTime:: Examples of input timestrings * ExIncBackup:: Incremental backup of a few directory trees @@ -4810,8 +4811,8 @@ Use text as name of this program and perform -help. @node ExDevices, ExCreate, Frontend, Examples @section As superuser learn about available drives On Linux or FreeBSD consider to give rw-permissions to those users or groups -which shall be able to use the drives with xorriso. -On Solaris use pfexec. Consider to restrict privileges of xorriso to +which shall be able to use the drives with @command{xorriso}. +On Solaris use pfexec. Consider to restrict privileges of @command{xorriso} to "base,sys_devices" and to give r-permission to user or group. @* @sp 1 @@ -5019,7 +5020,7 @@ $ xorriso -indev /dev/sr2 \ @section Bring a prepared ISOLINUX tree onto media and make it bootable The user has already created a suitable file tree on disk and copied the ISOLINUX files into subdirectory ./boot/isolinux of that tree. -Now xorriso can burn an El Torito bootable media: +Now @command{xorriso} can burn an El Torito bootable media: @* @sp 1 $ xorriso -outdev /dev/sr0 -blank as_needed \ @@ -5062,9 +5063,9 @@ $ xorriso -dev stdio:/dev/sdb ... @* @sp 1 If /dev/sdb is to be used frequently and /dev/sda is the system disk, -then consider to place the following lines in a xorriso Startup File. +then consider to place the following lines in a @command{xorriso} Startup File. They allow to use /dev/sdb without prefix and protect disk /dev/sda -from xorriso: +from @command{xorriso}: @* @sp 1 -drive_class banned /dev/sda* @@ -5127,7 +5128,7 @@ of the changed content before it loads the media again. In this case the previous session would not be loaded and the new session would contain only the newly added files. @* -For the same reason do not let xorriso -as cdrecord load the media, +For the same reason do not let @command{xorriso} -as cdrecord load the media, but rather do this manually or by a program that reads from /dev/sr0. @* @sp 1 @@ -5138,9 +5139,9 @@ in order to enable multi-session emulation on overwriteable media. @c man .SS @c man .B Let xorriso work underneath growisofs @node ExGrowisofs, ExException, ExMkisofs, Examples -@section Let xorriso work underneath growisofs +@section Let @command{xorriso} work underneath growisofs growisofs expects an ISO formatter program which understands options -C and --M. If xorriso gets started by name "xorrisofs" then it is suitable for that. +-M. If @command{xorriso} gets started by name "xorrisofs" then it is suitable for that. @* @sp 1 $ export MKISOFS="xorrisofs" @@ -5151,7 +5152,7 @@ $ growisofs -M /dev/dvd /more/files @* @sp 1 If no "xorrisofs" is available on your system, then you will have to create -a link pointing to the xorriso binary and tell growisofs to use it. E.g. by: +a link pointing to the @command{xorriso} binary and tell growisofs to use it. E.g. by: @* @sp 1 $ ln -s $(which xorriso) "$HOME/xorrisofs" @@ -5160,7 +5161,7 @@ $ export MKISOFS="$HOME/xorrisofs" @* @sp 1 One may quit mkisofs emulation by argument "@minus{}@minus{}" and make -use of all xorriso commands. growisofs dislikes options which +use of all @command{xorriso} commands. growisofs dislikes options which start with "-o" but -outdev must be set to "-". So use "outdev" instead: @* @@ -5308,8 +5309,8 @@ 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. +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 the newly written session (here for mount point /mnt): @* @@ -5415,13 +5416,13 @@ resp. -s. @c man .B Program alias names: @* @section Program Alias Names -Normal installation of xorriso creates three links or copies which by their +Normal installation of @command{xorriso} creates three links or copies which by their program name pre-select certain settings: @* @sp 1 -@strong{xorrisofs} starts xorriso with -as mkisofs emulation. +@strong{xorrisofs} starts @command{xorriso} with -as mkisofs emulation. @* -@strong{xorrecord} starts xorriso with -as cdrecord emulation. +@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 @@ -5430,7 +5431,7 @@ one or more of the existing ISO sessions. @c man .B Startup files: @section Startup Files @* -If not -no_rc is given as the first argument then xorriso attempts on startup +If not -no_rc is given as the first argument then @command{xorriso} attempts on startup to read and execute lines from the following files: @* @sp 1 @@ -5491,9 +5492,9 @@ The default setting of -check_media abort_file= is: @node Seealso, Legal, Files, Top @chapter See also @table @asis -@item For the mkisofs emulation of xorriso +@item For the mkisofs emulation of @command{xorriso} xorrisofs(1) -@item For mounting xorriso generated ISO 9660 images (-t iso9660) +@item For mounting @command{xorriso} generated ISO 9660 images (-t iso9660) mount(8) @item Libreadline, a comfortable input line facility readline(3) @@ -5526,12 +5527,12 @@ for libburnia-project.org Copyright (c) 2007 - 2011 Thomas Schmitt @* Permission is granted to distribute this text freely. It shall only be -modified in sync with the technical properties of xorriso. If you make use -of the license to derive modified versions of xorriso then you are entitled +modified in sync with the technical properties of @command{xorriso}. If you make use +of the license to derive modified versions of @command{xorriso} then you are entitled to modify this text under that same license. @c man .SH CREDITS @section Credits -xorriso is in part based on work by Vreixo Formoso who provides libisofs +@command{xorriso} is in part based on work by Vreixo Formoso who provides libisofs together with Mario Danic who also leads the libburnia team. Thanks to Andy Polyakov who invented emulated growing, to Derek Foreman and Ben Jansens who once founded libburn.