From 53a4ead6a00787e0eedc3ed4c90c3a4dab94fe60 Mon Sep 17 00:00:00 2001 From: Thomas Schmitt Date: Fri, 13 May 2011 16:47:52 +0000 Subject: [PATCH] Added a rule to the conversion prescription for man pages --- xorriso/make_xorriso_1.c | 24 +- xorriso/xorriso.1 | 1658 +++++++++++++++++++------------------- xorriso/xorriso.texi | 4 +- 3 files changed, 854 insertions(+), 832 deletions(-) diff --git a/xorriso/make_xorriso_1.c b/xorriso/make_xorriso_1.c index 9560f38a..aba2c588 100644 --- a/xorriso/make_xorriso_1.c +++ b/xorriso/make_xorriso_1.c @@ -147,8 +147,8 @@ overflow:; */ int Mx1_convert(struct Mx1 *m, char line_in[256], char line_out[256], int flag) { - int l, num, keep= 0, ret, raw; - char word[256], buf[256], *remainder; + int l, num, keep= 0, ret, raw, i, backslash_count; + char word[256], buf[256], *remainder, *wpt; m->count_in++; l= strlen(line_in); @@ -273,6 +273,26 @@ int Mx1_convert(struct Mx1 *m, char line_in[256], char line_out[256], int flag) return(0); strcpy(line_out, line_in); } + + /* "-" which are not preceded by an uneven number of "\" will get + prepended one "\". + */ + l= strlen(line_out); + backslash_count= 0; + wpt= buf; + for(i= 0; i < l; i++) { + if(line_out[i] == '\\') + backslash_count++; + else if(line_out[i] == '-') { + if(backslash_count % 2 == 0) + *(wpt++)= '\\'; + backslash_count= 0; + } else + backslash_count= 0; + *(wpt++)= line_out[i]; + } + *wpt= 0; + strcpy(line_out, buf); m->count_out++; return(1); } diff --git a/xorriso/xorriso.1 b/xorriso/xorriso.1 index 4e8970ef..8da16c8a 100644 --- a/xorriso/xorriso.1 +++ b/xorriso/xorriso.1 @@ -9,7 +9,7 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH XORRISO 1 "Apr 22, 2011" +.TH XORRISO 1 "May 13, 2011" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -24,7 +24,7 @@ .\" for manpage-specific macros, see man(7) .nh .SH NAME -xorriso - creates, loads, manipulates and writes ISO 9660 filesystem images +xorriso \- creates, loads, manipulates and writes ISO 9660 filesystem images with Rock Ridge extensions. .SH SYNOPSIS .B xorriso @@ -35,7 +35,7 @@ with Rock Ridge extensions. \fBxorriso\fR 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 +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 @@ -43,7 +43,7 @@ Vice versa xorriso 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 formatter program nor an external burn program for CD, DVD or BD but rather -incorporates the libraries of libburnia-project.org . +incorporates the libraries of libburnia\-project.org . .SS .B Overview of features: .br @@ -59,12 +59,12 @@ Changes file properties in the ISO image. .br Updates ISO subtrees incrementally to match given disk subtrees. .br -Writes result either as completely new image or as add-on session +Writes result either as completely new image or as add\-on session to optical media or filesystem objects. .br Can activate ISOLINUX and GRUB boot images via El Torito and MBR. .br -Can perform multi-session tasks as emulation of mkisofs and cdrecord. +Can perform multi\-session tasks as emulation of mkisofs and cdrecord. .br Can record and restore hard links and ACL. .br @@ -76,7 +76,7 @@ Can check media for damages and copy readable blocks to disk. .br Can attach MD5 checksums to each data file and the whole session. .br -Scans for optical drives, blanks re-useable optical media. +Scans for optical drives, blanks re\-useable optical media. .br Reads its instructions from command line arguments, dialog, and files. .br @@ -105,20 +105,20 @@ this text before reading the next few hundred lines of background information. .SS \fBSession model:\fR .br -Unlike other filesystems, ISO 9660 is not intended for read-write operation but +Unlike other filesystems, ISO 9660 is not intended for read\-write operation but rather for being generated in a single sweep and being written to media as a \fBsession\fR. .br The data content of the session is called filesystem \fBimage\fR. .PP The written image in its session can then be mounted by the operating system -for being used read-only. GNU/Linux is able to mount ISO images from block +for being used read\-only. GNU/Linux is able to mount ISO images from block devices, which may represent optical media, other media or via a loop device even from regular disk files. FreeBSD mounts ISO images from devices that represent arbitrary media or from regular disk files. .PP This session usage model has been extended on CD media by the concept of -\fBmulti-session\fR , +\fBmulti\-session\fR , which allows to add information to the CD and gives the mount programs of the operating systems the addresses of the entry points of each session. The mount programs recognize block devices which represent @@ -132,7 +132,7 @@ together form a single filesystem image. Adding a session to an existing ISO image is in this text referred as \fBgrowing\fR. .br -The multi-session model of the MMC standard does not apply to all media +The multi\-session model of the MMC standard does not apply to all media 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. @@ -142,21 +142,21 @@ xorriso provides growing as well as an own method named 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 +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. .br The first session of a 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 +The session ends by command \-commit which triggers writing. A \-commit is done automatically when the program ends regularly. .PP -After -commit a new session begins with the freshly written one as input. +After \-commit a new session begins with the freshly written one as input. A new input drive can only be chosen as long as the loaded ISO image was -not altered. Pending alteration can be revoked by command -rollback. +not altered. Pending alteration can be revoked by command \-rollback. .PP Writing a session to the target is supposed to be very expensive in terms of -time and of consumed space on appendable or write-once media. Therefore all +time and of consumed space on appendable or write\-once media. Therefore all intended manipulations of a particular ISO image should be done in a single session. But in principle it is possible to store intermediate states and to continue with image manipulations. @@ -164,25 +164,25 @@ to store intermediate states and to continue with image manipulations. .B Media types and states: There are two families of media in the MMC standard: .br -\fBMulti-session media\fR are CD-R, CD-RW, DVD-R, DVD+R, DVD+R/DL, BD-R, and -unformatted DVD-RW. These media provide a table of content which +\fBMulti\-session media\fR are CD\-R, CD\-RW, DVD\-R, DVD+R, DVD+R/DL, BD\-R, and +unformatted DVD\-RW. These media provide a table of content which describes their existing sessions. See option \fB\-toc\fR. .br -Similar to multi-session media are DVD-R DL and minimally blanked DVD-RW. +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". +xorriso 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. +\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 be emulated. Else only a single overall session will be visible. .br -DVD-RW media can be formatted by -format "full". -They can be made unformatted by -blank "deformat". +DVD\-RW media can be formatted by \-format "full". +They can be made unformatted by \-blank "deformat". .br Regular files and block devices are handled as overwriteable media. -Pipes and other writeable file types are handled as blank multi-session media. +Pipes and other writeable file types are handled as blank multi\-session media. .PP These media can assume several states in which they offer different capabilities. @@ -191,38 +191,38 @@ capabilities. suitable for xorriso. .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". +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 +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 +multi\-session media in appendable state, or they are overwriteable media which contain an ISO image suitable for xorriso. .br -Appendable is the state after writing a session with option -close off. +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. .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 -probably show any media as closed CD-ROM resp. DVD-ROM. +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. .br -Overwriteable media assume this state in such read-only drives or if they +Overwriteable media assume this state in such read\-only drives or if they contain unrecognizable data in the first 32 data blocks. .br -Read-only drives may or may not show session histories of multi-session +Read\-only drives may or may not show session histories of multi\-session media. Often only the first and the last session are visible. Sometimes -not even that. Option -rom_toc_scan might or might not help in such cases. +not even that. Option \-rom_toc_scan might or might not help in such cases. .SS .B Creating, Growing, Modifying, Blind Growing: .br A new empty ISO image gets \fBcreated\fR if there is no input drive with a valid ISO 9660 image when the first time -an output drive is defined. This is achieved by option -dev on blank media -or by option -outdev on media in any state. +an output drive is defined. This is achieved by option \-dev on blank media +or by option \-outdev on media in any state. .br The new empty image can be populated with directories and files. Before it can be written, the media in the output drive must get into @@ -239,13 +239,13 @@ ISO 9660 + Rock Ridge directory tree. It is possible to hide files from previous sessions but they still exist on media and with many types of optical media it is quite easy to recover them by mounting older sessions. .br -Growing is achieved by option -dev. +Growing is achieved by option \-dev. .PP The write method of \fBmodifying\fR produces compact filesystem images with no outdated files or directory trees. Modifying can write its -images to target media which are completely unsuitable for multi-session -operations. E.g. DVD-RW which were treated with -blank deformat_quickest, -DVD-R DL, named pipes, character devices, sockets. +images to target media which are completely unsuitable for multi\-session +operations. E.g. DVD\-RW which were treated with \-blank deformat_quickest, +DVD\-R DL, named pipes, character devices, sockets. On the other hand modified sessions cannot be written to appendable media but to blank media only. .br @@ -253,21 +253,21 @@ So for this method one needs either two optical drives or has to work with filesystem objects as source and/or target media. .br Modifying takes place if input drive and output drive are not the same and -if option -grow_blindly is set to its default "off". -This is achieved by options -indev and -outdev. +if option \-grow_blindly is set to its default "off". +This is achieved by options \-indev and \-outdev. .PP -If option -grow_blindly is set to a non-negative number and if -indev and --outdev are both set to different drives, then \fBblind growing\fR is -performed. It produces an add-on session which is ready for being written +If option \-grow_blindly is set to a non\-negative number and if \-indev and +\-outdev are both set to different drives, then \fBblind growing\fR is +performed. It produces an add\-on session which is ready for being written to the given block address. This is the usage model of .br - mkisofs -M $indev -C $msc1,$msc2 -o $outdev + 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 -program is desired. -C $msc1,$msc2 is equivalent to: +program is desired. \-C $msc1,$msc2 is equivalent to: .br - -load sbsector $msc1 -grow_blindly $msc2 + \-load sbsector $msc1 \-grow_blindly $msc2 .SS .B Libburn drives: .br @@ -279,59 +279,59 @@ 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 xorriso. 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 the path of their block device or of their generic character device. E.g. .br - -dev /dev/sr0 + \-dev /dev/sr0 .br - -dev /dev/hdc + \-dev /dev/hdc .br - -dev /dev/sg2 + \-dev /dev/sg2 .br On FreeBSD the device files have names like .br - -dev /dev/cd0 + \-dev /dev/cd0 .br On OpenSolaris: .br - -dev /dev/rdsk/c4t0d0s2 + \-dev /dev/rdsk/c4t0d0s2 .br Get a list of accessible drives by command .br - -devices + \-devices .br It might be necessary to do this as \fBsuperuser\fR -in order to see all drives and to then allow rw-access for the intended users. +in order to see all drives and to then allow rw\-access for the intended users. Consider to bundle the authorized users in a group like old "floppy". .PP Filesystem objects of nearly any type can be addressed by prefix "stdio:" and their path in the filesystem. E.g.: .br - -dev stdio:/dev/sdc + \-dev stdio:/dev/sdc .br -The default setting of -drive_class allows to address files outside the +The default setting of \-drive_class allows to address files outside the /dev tree without that prefix. E.g.: .br - -dev /tmp/pseudo_drive + \-dev /tmp/pseudo_drive .br If path leads to a regular file or to a block device then the emulated drive is random access readable and can be used for the method of growing if it already contains a valid ISO 9660 image. Any other file type is not readable via "stdio:" and can only be used as target for the method of modifying or blind growing. -Non-existing paths in existing directories are handled as empty regular files. +Non\-existing paths in existing directories are handled as empty regular files. .PP A very special kind of pseudo drive are open file descriptors. They are depicted by "stdio:/dev/fd/" and descriptor number (see man 2 open). .br -Addresses "-" or "stdio:/dev/fd/1" depict standard output, which normally is +Addresses "\-" or "stdio:/dev/fd/1" depict standard output, which normally is the output channel for result texts. To prevent a fatal intermingling of ISO image and text messages, all result -texts get redirected to stderr if -*dev "-" or "stdio:/dev/fd/1" is among +texts get redirected to stderr if \-*dev "\-" or "stdio:/dev/fd/1" is among the start arguments of the program. .br Standard output is currently suitable for creating one session @@ -342,7 +342,7 @@ It is not allowed to use standard output as pseudo drive if it was not among the start arguments. Do not try to fool this ban via backdoor addresses to stdout. .br -If stdout is used as drive, then -use_readline is permanently disabled. +If stdout is used as drive, then \-use_readline is permanently disabled. Use of backdoors can cause severe memory and/or tty corruption. .PP Be aware that especially the superuser can write into any accessible file or @@ -356,7 +356,7 @@ to surely prevent this risk and to allow only MMC drives. .br One may prepend "mmc:" to a path to surely disallow any automatic "stdio:". .br -By option -drive_class one may ban certain paths or allow access without +By option \-drive_class one may ban certain paths or allow access without prefix "stdio:" to other paths. .SS .B Rock Ridge, POSIX, X/Open, El Torito, ACL, xattr: @@ -382,18 +382,18 @@ 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 -an image bootable. For details see option -boot_image. +an image bootable. For details see option \-boot_image. .br It is possible to make ISO images bootable from USB stick or other -hard-disk-like media by -boot_image argument system_area= . This installs +hard\-disk\-like media by \-boot_image argument system_area= . This installs a Master Boot Record which may get adjusted according to the needs of GRUB resp. ISOLINUX. An \fBMBR\fR contains boot code and a partition table. It does not hamper -CDROM booting. The new MBR of a follow-up session can get in effect +CDROM booting. The new MBR of a follow\-up session can get in effect only on overwriteable media. .br -Emulation -as mkisofs supports the example options out of the ISOLINUX wiki, -the options used in GRUB script grub-mkrescue, and the example in the +Emulation \-as mkisofs supports the example options out of the ISOLINUX wiki, +the options used in GRUB script grub\-mkrescue, and the example in the FreeBSD AvgLiveCD wiki. .br There is support for boot facilities other than PC BIOS: @@ -414,7 +414,7 @@ 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 +that entry exists. Nevertheless the non\-listed group members get handled according to entry "group::". xorriso brings "group::" into effect before eventually removing the ACL from a file. .PP @@ -442,13 +442,13 @@ is of variable length (indicated by "[...]" or "[***]") then it has to be terminated by either the \fBlist delimiter\fR, or the end of argument list, or an end of an input line. .PP -At program start the list delimiter is the word "--". -This may be changed by option -list_delimiter in order to allow -"--" as argument in a list of variable length. -It is advised to reset the delimiter to "--" immediately +At program start the list delimiter is the word "\-\-". +This may be changed by option \-list_delimiter in order to allow +"\-\-" as argument in a list of variable length. +It is advised to reset the delimiter to "\-\-" immediately afterwards. .br -For brevity the list delimiter is referred as "--" +For brevity the list delimiter is referred as "\-\-" throughout this text. .br The list delimiter is silently tolerated if it appears after the parameters of @@ -463,7 +463,7 @@ Pattern matching supports the usual shell parser wildcards '*' '?' '[xyz]' and respects '/' as separator which may only be matched literally. .br It is a property of some particular commands and not a general -feature. It gets controlled by commands -iso_rr_pattern and -disk_pattern. +feature. It gets controlled by commands \-iso_rr_pattern and \-disk_pattern. Commands which eventually use pattern expansion all have variable argument lists which are marked in this man page by "[***]" rather than "[...]". .br @@ -492,17 +492,17 @@ at all. Therefore quoted input and program arguments allow optional which can represent all ASCII characters except NUL (0) by backslash codes as in $'...' of bash. .br -It is not enabled by default. See option -backslash_codes. +It is not enabled by default. See option \-backslash_codes. .PP -When the program begins then it first looks for argument -no_rc. If this is +When the program begins then it first looks for argument \-no_rc. If this is not present then it looks for its startup files and eventually reads their content as command input lines. Then it interprets the program arguments as commands and parameters and finally it enters -dialog mode if command -dialog "on" was executed up to then. +dialog mode if command \-dialog "on" was executed up to then. .PP -The program ends either by command -end, or by the end of program arguments +The program ends either by command \-end, or by the end of program arguments if not dialog was enabled up to that moment, or by a problem -event which triggers the threshold of command -abort_on. +event which triggers the threshold of command \-abort_on. .SS .B Dialog, Readline, Result pager: .br @@ -512,7 +512,7 @@ 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. +of package readline\-dev at the time when xorriso 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. @@ -523,7 +523,7 @@ the history of previous input lines. See man readline for more info about libreadline. .PP -Option -page activates a built-in result text pager which may be convenient in +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 @@ -545,7 +545,7 @@ try to abort as soon as possible. .SH OPTIONS .br All command words are shown with a leading dash although this dash is not -mandatory for the option to be recognized. Nevertheless within option -as +mandatory for the option to be recognized. Nevertheless within option \-as the dashes of the emulated options are mandatory. .br Normally any number of leading dashes is ignored with command words and @@ -562,9 +562,9 @@ If there is no ISO image then create a blank one. Set the image expansion method to growing. .br This is only allowed as long as no changes are pending in the currently -loaded ISO image. Eventually one has to perform -commit or -rollback first. +loaded ISO image. Eventually one has to perform \-commit or \-rollback first. .br -Special address string "-" means standard output, to which several restrictions +Special address string "\-" means standard output, to which several restrictions apply. See above paragraph "Libburn drives". .br An empty address string "" gives up the current device @@ -572,38 +572,38 @@ without aquiring a new one. .TP \fB\-indev\fR address Set input drive and load an eventual ISO image. If the new input drive differs -from -outdev then switch from growing to modifying or to blind growing. -It depends on the setting of -grow_blindly which of both gets activated. -The same rules and restrictions apply as with -dev. +from \-outdev then switch from growing to modifying or to blind growing. +It depends on the setting of \-grow_blindly which of both gets activated. +The same rules and restrictions apply as with \-dev. .TP \fB\-outdev\fR address Set output drive and if it differs from the input drive then switch from -growing to modifying or to blind growing. Unlike -dev and -indev this action +growing to modifying or to blind growing. Unlike \-dev and \-indev this action does not load a new ISO image. So it can be performed even if there are pending changes. .br --outdev can be performed without previous -dev or -indev. In that case an +\-outdev can be performed without previous \-dev or \-indev. In that case an empty ISO image with no changes pending is created. It can either be populated -by help of -map, -add et.al. or it can be discarded silently if -dev or -indev +by help of \-map, \-add et.al. or it can be discarded silently if \-dev or \-indev are performed afterwards. .br -Special address string "-" means standard output, to which several restrictions +Special address string "\-" means standard output, to which several restrictions apply. See above paragraph "Libburn drives". .br An empty address string "" gives up the current output drive without aquiring a new one. No writing is possible without an output drive. .TP \fB\-grow_blindly\fR "off"|predicted_nwa -If predicted_nwa is a non-negative number then perform blind growing rather -than modifying if -indev and -outdev are set to different drives. -"off" or "-1" switch to modifying, which is the default. +If predicted_nwa is a non\-negative number then perform blind growing rather +than modifying if \-indev and \-outdev are set to different drives. +"off" or "\-1" switch to modifying, which is the default. .br -predicted_nwa is the block address where the add-on session of blind +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 -as obtained from examining -outdev and not necessarily to predicted_nwa. +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 begins. The output drive is given up when writing is done. @@ -615,13 +615,13 @@ by aquiring an input drive. In rare cases it is desirable to activate them only after image loading. .TP \fB\-load\fR entity id -Load a particular (possibly outdated) ISO session from -dev or -indev. -Usually all available sessions are shown with option -toc. +Load a particular (possibly outdated) ISO session from \-dev or \-indev. +Usually all available sessions are shown with option \-toc. .br entity depicts the kind of addressing. id depicts the particular address. The following entities are defined: .br -"auto" with any id addresses the last session in -toc. This is the default. +"auto" with any id addresses the last session in \-toc. This is the default. .br "session" with id being a number as of a line "ISO session", column "Idx". .br @@ -632,33 +632,33 @@ address. The following entities are defined: "volid" with a search pattern for a text as of a line "ISO ...", column "Volume Id". .br -Adressing a non-existing entity or one which does not represent an ISO -image will either abandon -indev or at least lead to a blank image. +Adressing a non\-existing entity or one which does not represent an ISO +image will either abandon \-indev or at least lead to a blank image. .br -If an input drive is set at the moment when -load is executed, then the +If an input drive is set at the moment when \-load is executed, then the addressed ISO image is loaded immediately. Else, the setting will be pending -until the next -dev or -indev. After the image has been loaded once, the -setting is valid for -rollback until next -dev or -indev, where it +until the next \-dev or \-indev. After the image has been loaded once, the +setting is valid for \-rollback until next \-dev or \-indev, where it will be reset to "auto". .TP \fB\-displacement\fR [-]lba Compensate an eventual displacement of the image versus the start address for which the image was prepared. This affects only loading of ISO images -and reading of their files. The multi-session method of growing is not allowed -as long as -displacement is non-zero. I.e. -indev and -outdev must be +and reading of their files. The multi\-session method of growing is not allowed +as long as \-displacement is non\-zero. I.e. \-indev and \-outdev must be different. Eventually the displacement is reset to 0 before the drive -gets re-aquired after writing. +gets re\-aquired after writing. .br Examples: .br If a track of a CD starts at block 123456 and gets copied to a disk file where it begins at block 0, then this copy can be loaded with --displacement -123456. +\-displacement \-123456. .br If an ISO image was written onto a partition with offset of 640000 blocks of -512 bytes, then it can be loaded from the base device by -displacement 160000. +512 bytes, then it can be loaded from the base device by \-displacement 160000. .br -In both cases, the ISO sessions should be self contained, i.e. not add-on +In both cases, the ISO sessions should be self contained, i.e. not add\-on sessions to an ISO image outside their track resp. partition. .TP \fB\-drive_class\fR "harmless"|"banned"|"caution"|"clear_list" disk_pattern @@ -684,22 +684,22 @@ A path matches a list if one of its parent paths or itself matches a list entry. An eventual address prefix "stdio:" or "mmc:" will be ignored when testing for matches. .br -By pseudo-class "clear_list" and pseudo-patterns "banned", "caution", +By pseudo\-class "clear_list" and pseudo\-patterns "banned", "caution", "harmless", or "all", the lists may be made empty. .br -E.g.: -drive_class clear_list banned +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 xorriso Startup Files. .br 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 filesystem. +have to deny its rw\-permissions in the filesystem. .TP \fB\-assert_volid\fR pattern severity Refuse to load ISO images with volume ids which do not match the given search pattern. When refusing an image, give up the input drive and issue -an event of the given severity (like FAILURE, see -abort_on). An empty search +an event of the given severity (like FAILURE, see \-abort_on). An empty search pattern accepts any image. .br This option does not hamper the creation of an empty image from blank @@ -707,10 +707,10 @@ input media and does not discard an already loaded image. .TP \fB\-in_charset\fR character_set_name Set the character set from which to convert file names when loading an -image. This has eventually to be done before specifying -dev , -indev or --rollback. See paragraph "Character sets" for more explanations. -When loading the written image after -commit the setting of -out_charset -will be copied to -in_charset. +image. This has eventually to be done before specifying \-dev , \-indev or +\-rollback. See paragraph "Character sets" for more explanations. +When loading the written image after \-commit the setting of \-out_charset +will be copied to \-in_charset. .TP \fB\-auto_charset\fR "on"|"off" Enable or disable recording and interpretation of the output character @@ -728,7 +728,7 @@ Enable or disable loading and recording of hardlink relations. .br In default mode "off", iso_rr files lose their inode numbers at image load time. Each iso_rr file object which has no inode number at image generation -time will get a new unique inode number if -compliance is set to new_rr. +time will get a new unique inode number if \-compliance is set to new_rr. .br Mode "on" preserves eventual inode numbers from the loaded image. When committing a session it searches for families of iso_rr files @@ -737,24 +737,24 @@ identical properties. The family members all get the same inode number. Whether these numbers are respected at mount time depends on the operating system. .br -Commands -update and -update_r track splits and fusions of hard links in +Commands \-update and \-update_r track splits and fusions of hard links in filesystems which have stable device and inode numbers. This can cause automatic last minute changes before the session gets written. Command --hardlinks "perform_update" may be used to do these changes earlier, +\-hardlinks "perform_update" may be used to do these changes earlier, e.g. if you need to apply filters to all updated files. .br Mode "without_update" avoids hardlink processing during update commands. -Use this if your filesystem situation does not allow -disk_dev_ino "on". +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 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". +by \-hardlinks "discard_extract". .br -A large number of hardlink families may exhaust -temp_mem_limit -if not -osirrox "sort_lba_on" and -hardlinks "cheap_sorted_extract" +A large number of hardlink families may exhaust \-temp_mem_limit +if not \-osirrox "sort_lba_on" and \-hardlinks "cheap_sorted_extract" are both in effect. This restricts hard linking to other files restored by -the same single extract command. -hardlinks "normal_extract" re-enables +the same single extract command. \-hardlinks "normal_extract" re\-enables wide and expensive hardlink accumulation. .br .TP @@ -764,12 +764,12 @@ 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 disk files when extracting them from ISO images. -See also options -getfacl, -setfacl. +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. -See also options -getfattr, -setfattr and above paragraph about xattr. +See also options \-getfattr, \-setfattr and above paragraph about xattr. .TP \fB\-md5\fR "on"|"all"|"off"|"load_check_off" Enable or disable processing of MD5 checksums for the overall session and for @@ -778,10 +778,10 @@ checksums tags of superblock and directory tree match properly. The MD5 checksums of data files and whole session get loaded from the image if there are any. .br -With options -compare and -update the eventually recorded MD5 of a file +With options \-compare and \-update the eventually recorded MD5 of a file will be used to avoid content reading from the image. Only the disk file content will be read and compared with that MD5. This can save much time -if -disk_dev_ino "on" is not suitable. +if \-disk_dev_ino "on" is not suitable. .br At image generation time they are computed for each file which gets its data written into the new session. The checksums of files which have their data @@ -796,18 +796,18 @@ 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 xorriso \-as mkisofs option \-M is performed. .br -The test can be re-enabled by mode "load_check_on". +The test can be re\-enabled by mode "load_check_on". .br -Checksums can be exploited via options -check_md5, -check_md5_r, via find -actions get_md5, check_md5, and via -check_media. +Checksums can be exploited via options \-check_md5, \-check_md5_r, via find +actions get_md5, check_md5, and via \-check_media. .TP \fB\-for_backup\fR Enable all extra features which help to produce or to restore backups with highest fidelity of file properties. -Currently this is a shortcut for: -hardlinks on -acl on -xattr on -md5 on. +Currently this is a shortcut for: \-hardlinks on \-acl on \-xattr on \-md5 on. .TP \fB\-disk_dev_ino\fR "on"|"ino_only"|"off" Enable or disable processing of recorded file identification numbers @@ -827,14 +827,14 @@ precondition that mount points in the compared tree always lead to the same filesystems. Use this if mode "on" always sees all files changed. .br The speed advantage appears only if the loaded session was produced with --disk_dev_ino "on" too. +\-disk_dev_ino "on" too. .br -Note that -disk_dev_ino "off" is totally in effect only if -hardlinks is "off", +Note that \-disk_dev_ino "off" is totally in effect only if \-hardlinks is "off", too. .TP \fB\-rom_toc_scan\fR "on"|"force"|"off"[:"emul_on"|"emul_off"] -Read-only drives do not tell the actual media type but show any media as -ROM (e.g. as DVD-ROM). The session history of MMC multi-session media might +Read\-only drives do not tell the actual media type but show any media as +ROM (e.g. as DVD\-ROM). The session history of MMC multi\-session media might be truncated to first and last session or even be completely false. (The eventual emulated history of overwriteable media is not affected by this.) .br @@ -843,18 +843,18 @@ especially the address of the last session, there is a scan for ISO 9660 filesystem headers which might help but also might yield worse results than the drive's table of content. At its end it can cause read attempts to invalid addresses and thus ugly drive behavior. -Setting "on" enables that scan for alleged read-only media. +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 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". .br On the other hand the emulation of session history on overwriteable media can hamper reading of partly damaged media. Setting "off:emul_off" disables -the elsewise trustworthy table-of-content scan for those media. +the elsewise trustworthy table\-of\-content scan for those media. .br -To be in effect, the -rom_toc_scan setting has to be made before the -*dev +To be in effect, the \-rom_toc_scan setting has to be made before the \-*dev command which aquires drive and media. .TP \fB\-calm_drive\fR "in"|"out"|"all"|"revoke"|"on"|"off" @@ -863,10 +863,10 @@ for substantial time after they have been used for reading. This reduces the startup time for the next drive operation but can be loud and waste energy if no i/o with the drive is expected to happen soon. .br -Modes "in", "out", "all" immediately calm down -indev, -outdev, resp. both. +Modes "in", "out", "all" immediately calm down \-indev, \-outdev, resp. both. Mode "revoke" immediately alerts both. -Mode "on" causes -calm_drive to be performed automatically after each -dev, --indev, and -outdev. Mode "off" disables this. +Mode "on" causes \-calm_drive to be performed automatically after each \-dev, +\-indev, and \-outdev. Mode "off" disables this. .TP \fB\-ban_stdio_write\fR Allow for writing only the usage of MMC optical drives. Disallow @@ -880,11 +880,11 @@ writing, which otherwise will happen only later and only if actual writing is desired. .br The test result is used for classifying the pseudo drives as overwriteable, -read-only, write-only, or uselessly empty. This may lead to earlier detection +read\-only, write\-only, or uselessly empty. This may lead to earlier detection of severe problems, and may avoid some less severe error events. .br Mode "appendable_wo" is like "on" with the additional property that -non-empty write-only files are regarded as appendable rather than blank. +non\-empty write\-only files are regarded as appendable rather than blank. .TP .B Inserting files into ISO image: .PP @@ -899,7 +899,7 @@ confuse with the lowlevel ISO 9660 names visible if Rock Ridge gets ignored.) .PP Note that in the ISO image you are as powerful as the superuser. Access permissions of the existing files in the image do not apply to your write -operations. They are intended to be in effect with the read-only mounted image. +operations. They are intended to be in effect with the read\-only mounted image. .PP If the iso_rr_path of a newly inserted file leads to an existing file object in the ISO image, then the following collision handling @@ -912,7 +912,7 @@ If other file types collide then the setting of command decides. .br Renaming of files has similar collision handling, but directories can only -be replaced, not merged. Note that -mv inserts the source objects into an +be replaced, not merged. Note that \-mv inserts the source objects into an eventual existing target directory rather than attempting to replace it. .PP The commands in this section alter the ISO image and not the local filesystem. @@ -935,32 +935,32 @@ Default is "ls". Insert the given files or directory trees from filesystem into the ISO image. .br -If -pathspecs is set to "on" then pattern expansion is always disabled and +If \-pathspecs is set to "on" then pattern expansion is always disabled and character '=' has a special meaning. It eventually separates the ISO image path from the disk path: .br iso_rr_path=disk_path .br The separator '=' can be escaped by '\\'. -If iso_rr_path does not begin with '/' then -cd is prepended. -If disk_path does not begin with '/' then -cdx is prepended. +If iso_rr_path does not begin with '/' then \-cd is prepended. +If disk_path does not begin with '/' then \-cdx is prepended. .br If no '=' is given then the word is used as both, iso_rr_path and disk path. -If in this case the word does not begin with '/' then -cdx is prepended to -the disk_path and -cd is prepended to the iso_rr_path. +If in this case the word does not begin with '/' then \-cdx is prepended to +the disk_path and \-cd is prepended to the iso_rr_path. .br -If -pathspecs is set to "off" then eventual -disk_pattern expansion applies. +If \-pathspecs is set to "off" then eventual \-disk_pattern expansion applies. The resulting words are used as both, iso_rr_path and disk path. Eventually --cdx gets prepended to disk_path and -cd to iso_rr_path. +\-cdx gets prepended to disk_path and \-cd to iso_rr_path. .TP \fB\-add_plainly\fR mode -If set to mode "unknown" then any command word that does not begin with "-" and -is not recognized as known command will be subject to a virtual -add command. +If set to mode "unknown" then any command word that does not begin with "\-" and +is not recognized as known command will be subject to a virtual \-add command. I.e. it will be used as pathspec or as disk_path and added to the image. -Eventually -disk_pattern expansion applies to disk_paths. +Eventually \-disk_pattern expansion applies to disk_paths. .br Mode "dashed" is similar to "unknown" but also adds unrecognized command -words even if they begin with "-". +words even if they begin with "\-". .br Mode "any" announces that all further words are to be added as pathspecs or disk_paths. This does not work in dialog mode. @@ -969,30 +969,30 @@ Mode "none" is the default. It prevents any words from being understood as files to add, if they are not parameters to appropriate commands. .TP \fB\-path_list\fR disk_path -Like -add but read the parameter words from file disk_path -or standard input if disk_path is "-". +Like \-add but read the parameter words from file disk_path +or standard input if disk_path is "\-". The list must contain exactly one pathspec resp. disk_path pattern per line. .TP \fB\-quoted_path_list\fR disk_path -Like -path_list but with quoted input reading rules. Lines get split into -parameter words for -add. Whitespace outside quotes is discarded. +Like \-path_list but with quoted input reading rules. Lines get split into +parameter words for \-add. Whitespace outside quotes is discarded. .TP \fB\-map\fR disk_path iso_rr_path Insert file object disk_path into the ISO image as iso_rr_path. If disk_path is a directory then its whole sub tree is inserted into the ISO image. .TP \fB\-map_single\fR disk_path iso_rr_path -Like -map, but if disk_path is a directory then its sub tree is not inserted. +Like \-map, but if disk_path is a directory then its sub tree is not inserted. .TP \fB\-map_l\fR disk_prefix iso_rr_prefix disk_path [***] -Perform -map with each of the disk_path arguments. iso_rr_path will be +Perform \-map with each of the disk_path arguments. iso_rr_path will be composed from disk_path by replacing disk_prefix by iso_rr_prefix. .TP \fB\-update\fR disk_path iso_rr_path Compare file object disk_path with file object iso_rr_path. If they do not match, then perform the necessary image manipulations to make iso_rr_path a matching copy of disk_path. By default this comparison will imply lengthy -content reading before a decision is made. Options -disk_dev_ino or -md5 may +content reading before a decision is made. Options \-disk_dev_ino or \-md5 may accelerate comparison if they were already in effect when the loaded session was recorded. .br @@ -1001,28 +1001,28 @@ whole subtree will be inserted. Else only directory attributes will be updated. .TP \fB\-update_r\fR disk_path iso_rr_path -Like -update but working recursively. I.e. all file objects below both +Like \-update but working recursively. I.e. all file objects below both addresses get compared whether they have counterparts below the other address and whether both counterparts match. If there is a mismatch then the necessary update manipulation is done. .br -Note that the comparison result may depend on option -follow. Its setting +Note that the comparison result may depend on option \-follow. Its setting should always be the same as with the first adding of disk_path as iso_rr_path. .br If iso_rr_path does not exist yet, then it gets added. If disk_path does not exist, then iso_rr_path gets deleted. .TP \fB\-update_l\fR disk_prefix iso_rr_prefix disk_path [***] -Perform -update_r with each of the disk_path arguments. iso_rr_path will be +Perform \-update_r with each of the disk_path arguments. iso_rr_path will be composed from disk_path by replacing disk_prefix by iso_rr_prefix. .TP \fB\-cut_out\fR disk_path byte_offset byte_count iso_rr_path Map a byte interval of a regular disk file into a regular file in the ISO image. This may be necessary if the disk file is larger than a single media, or if -it exceeds the traditional limit of 2 GiB - 1 for old operating systems, -or the limit of 4 GiB - 1 for newer ones. Only the newest Linux kernels -seem to read properly files >= 4 GiB - 1. +it exceeds the traditional limit of 2 GiB \- 1 for old operating systems, +or the limit of 4 GiB \- 1 for newer ones. Only the newest Linux kernels +seem to read properly files >= 4 GiB \- 1. .br A clumsy remedy for this limit is to backup file pieces and to concatenate them at restore time. A well tested chopping size is 2047m. @@ -1032,41 +1032,41 @@ To request a byte_offset higher than available yields no file in the ISO image but a SORRY event. E.g: .br - -cut_out /my/disk/file 0 2047m \\ + \-cut_out /my/disk/file 0 2047m \\ .br /file/part_1_of_3_at_0_with_2047m_of_5753194821 \\ .br - -cut_out /my/disk/file 2047m 2047m \\ + \-cut_out /my/disk/file 2047m 2047m \\ .br /file/part_2_of_3_at_2047m_with_2047m_of_5753194821 \\ .br - -cut_out /my/disk/file 4094m 2047m \\ + \-cut_out /my/disk/file 4094m 2047m \\ .br /file/part_3_of_3_at_4094m_with_2047m_of_5753194821 .br -While option -split_size is set larger than 0, and if all pieces of a file +While option \-split_size is set larger than 0, and if all pieces of a file reside in the same ISO directory with no other files, and if the names look like above, then their ISO directory will be recognized and handled like a -regular file. This affects options -compare*, -update*, and overwrite +regular file. This affects options \-compare*, \-update*, and overwrite situations. -See option -split_size for details. +See option \-split_size for details. .TP \fB\-cpr\fR disk_path [***] iso_rr_path Insert the given files or directory trees from filesystem into the ISO image. .br The rules for generating the ISO addresses are similar as with -shell command cp -r. Nevertheless, directories of the iso_rr_path +shell command cp \-r. Nevertheless, directories of the iso_rr_path are created if necessary. Especially a not yet existing iso_rr_path will be handled as directory if multiple disk_paths are present. The leafnames of the multiple disk_paths will be grafted under that directory as would be done with an existing directory. .br -If a single disk_path is present then a non-existing iso_rr_path will +If a single disk_path is present then a non\-existing iso_rr_path will get the same type as the disk_path. .br -If a disk_path does not begin with '/' then -cdx is prepended. -If the iso_rr_path does not begin with '/' then -cd is prepended. +If a disk_path does not begin with '/' then \-cdx is prepended. +If the iso_rr_path does not begin with '/' then \-cd is prepended. .TP \fB\-mkdir\fR iso_rr_path [...] Create empty directories if they do not exist yet. @@ -1087,14 +1087,14 @@ This command will refuse execution if the address iso_rr_path_copy already exists in the ISO tree. .TP \fB\-cp_clone\fR iso_rr_path_original [***] iso_rr_path_dest -Create copies of one or more ISO file objects as with command -clone. +Create copies of one or more ISO file objects as with command \-clone. Eventually merge directories with existing ones, but do not overwrite existing ISO file objects. .br The rules for generating the copy addresses are the same as with -command -cpr (see above) resp. shell command cp -r. Other than with -cpr, -relative iso_rr_path_original will get prepended the -cd path and not -the -cdx path. Consider to -mkdir iso_rr_path_dest before -cp_clone +command \-cpr (see above) resp. shell command cp \-r. Other than with \-cpr, +relative iso_rr_path_original will get prepended the \-cd path and not +the \-cdx path. Consider to \-mkdir iso_rr_path_dest before \-cp_clone so the copy address does not depend on the number of iso_rr_path_original arguments. .TP @@ -1103,26 +1103,26 @@ 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 xorriso. Default is a limit of 100 extents, 4g \-2k each: .br - -file_size_limit 400g -200k -- + \-file_size_limit 400g \-200k \-\- .br When mounting ISO 9660 filesystems, old operating systems can handle only files -up to 2g -1 --. Newer ones are good up to 4g -1 --. +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 operating system size limits. They apply to mounting only. Nevertheless, -the target filesystem of an -extract must be able to take the file size. +the target filesystem of an \-extract must be able to take the file size. .TP \fB\-not_mgt\fR code[:code[...]] Control the behavior of the exclusion lists. .br Exclusion processing happens before disk_paths get mapped to the ISO image and before disk files get compared with image files. -The absolute disk path of the source is matched against the -not_paths list. -The leafname of the disk path is matched against the patterns in the -not_leaf +The absolute disk path of the source is matched against the \-not_paths list. +The leafname of the disk path is matched against the patterns in the \-not_leaf list. If a match is detected then the disk path will not be regarded as an existing file and not be added to the ISO image. .br @@ -1130,14 +1130,14 @@ Several codes are defined. The _on/_off settings persist until they are revoked by their_off/_on counterparts. .br -"erase" empties the lists which were accumulated by -not_paths and -not_leaf. +"erase" empties the lists which were accumulated by \-not_paths and \-not_leaf. .br -"reset" is like "erase" but also re-installs default behavior. +"reset" is like "erase" but also re\-installs default behavior. .br "off" disables exclusion processing temporarily without invalidating the lists and settings. .br -"on" re-enables exclusion processing. +"on" re\-enables exclusion processing. .br "param_off" applies exclusion processing only to paths below disk_path parameter of commands. I.e. explicitly given disk_paths are exempted @@ -1147,23 +1147,23 @@ from exclusion processing. to files below such parameters. .br "subtree_off" with "param_on" excludes parameter paths only if they -match a -not_paths item exactly. +match a \-not_paths item exactly. .br "subtree_on" additionally excludes parameter paths which lead to a file -address below any -not_paths item. +address below any \-not_paths item. .br "ignore_off" treats excluded disk files as if they were missing. I.e. they -get reported with -compare and deleted from the image with -update. +get reported with \-compare and deleted from the image with \-update. .br -"ignore_on" keeps excluded files out of -compare or -update activities. +"ignore_on" keeps excluded files out of \-compare or \-update activities. .TP \fB\-not_paths\fR disk_path [***] Add the given paths to the list of excluded absolute disk paths. If a given -path is relative, then the current -cdx is prepended to form an absolute path. +path is relative, then the current \-cdx is prepended to form an absolute path. Eventual pattern matching happens at definition time and not when exclusion checks are made. .br -(Do not forget to end the list of disk_paths by "--") +(Do not forget to end the list of disk_paths by "\-\-") .TP \fB\-not_leaf\fR pattern Add a single shell parser style pattern to the list of exclusions for @@ -1171,17 +1171,17 @@ disk leafnames. These patterns are evaluated when the exclusion checks are made. .TP \fB\-not_list\fR disk_path -Read lines from disk_path and use each of them either as -not_paths argument, -if they contain a / character, or as -not_leaf pattern. +Read lines from disk_path and use each of them either as \-not_paths argument, +if they contain a / character, or as \-not_leaf pattern. .TP \fB\-quoted_not_list\fR disk_path -Like -not_list but with quoted input reading rules. Each word is -handled as one argument for -not_paths resp. -not_leaf. +Like \-not_list but with quoted input reading rules. Each word is +handled as one argument for \-not_paths resp. \-not_leaf. .TP \fB\-follow\fR occasion[:occasion[...]] Enable or disable resolution of symbolic links and mountpoints under -disk_paths. This applies to actions -add, -du*x, -ls*x, -findx, -and to -disk_pattern expansion. +disk_paths. This applies to actions \-add, \-du*x, \-ls*x, \-findx, +and to \-disk_pattern expansion. .br There are two kinds of follow decisison to be made: .br @@ -1196,11 +1196,11 @@ directory tree traversals. .br Less general than above occasions: .br -"pattern" is mount and link hopping, but only during -disk_pattern expansion. +"pattern" is mount and link hopping, but only during \-disk_pattern expansion. .br "param" is link hopping for parameter words (after eventual pattern expansion). -If enabled then -ls*x will show the link targets rather than the links -themselves. -du*x, -findx, and -add will process the link targets but not +If enabled then \-ls*x will show the link targets rather than the links +themselves. \-du*x, \-findx, and \-add will process the link targets but not follow links in an eventual directory tree below the targets (unless "link" is enabled). .br @@ -1223,9 +1223,9 @@ Not an occasion but an optional setting is: A link hop consists of a sequence of symbolic links and a final target of different type. Nevertheless those hops can loop. Example: .br - $ ln -s .. uploop + $ ln \-s .. uploop .br -Link hopping has a built-in loop detection which stops hopping at the first +Link hopping has a built\-in loop detection which stops hopping at the first repetition of a link target. Then the repeated link is handled as itself and not as its target. Regrettably one can construct link networks which @@ -1234,15 +1234,15 @@ 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 xorriso actions \-add and \-path_list. .br "on" enables pathspecs of the form \fBtarget=source\fR -like with program mkisofs -graft-points. -It also disables -disk_pattern expansion for command -add. +like with program mkisofs \-graft\-points. +It also disables \-disk_pattern expansion for command \-add. .br "off" disables pathspecs of the form target=source -and eventually enables -disk_pattern expansion. +and eventually enables \-disk_pattern expansion. .TP \fB\-overwrite\fR "on"|"nondir"|"off" Allow or disallow to overwrite existing files in the @@ -1250,8 +1250,8 @@ ISO image by files with the same name. .br With setting "off", name collisions cause FAILURE events. With setting "nondir", only directories are protected by such events, other -existing file types get treated with -rm before the new file gets added. -Setting "on" allows automatic -rm_r. I.e. a non-directory can replace an +existing file types get treated with \-rm before the new file gets added. +Setting "on" allows automatic \-rm_r. I.e. a non\-directory can replace an existing directory and all its subordinates. .br If restoring of files is enabled, then the overwrite rule applies to the @@ -1260,18 +1260,18 @@ target file objects on disk as well, but "on" is downgraded to "nondir". \fB\-split_size\fR number["k"|"m"] Set the threshold for automatic splitting of regular files. Such splitting maps a large disk file onto a ISO directory with several part files in it. -This is necessary if the size of the disk file exceeds -file_size_limit. +This is necessary if the size of the disk file exceeds \-file_size_limit. Older operating systems can handle files in mounted ISO 9660 filesystems only if they are smaller than 2 GiB resp. 4 GiB. .br -Default is 0 which will exclude files larger than -file_size_limit by a +Default is 0 which will exclude files larger than \-file_size_limit by a FAILURE event. -A well tested -split_size is 2047m. Sizes above -file_size_limit are not +A well tested \-split_size is 2047m. Sizes above \-file_size_limit are not permissible. .br -While option -split_size is set larger than 0 such a directory with split +While option \-split_size is set larger than 0 such a directory with split file pieces will be recognized and handled like a regular file by options --compare* , -update*, and in overwrite situations. There are -ossirox +\-compare* , \-update*, and in overwrite situations. There are \-ossirox options "concat_split_on" and "concat_split_off" which control the handling when files get restored to disk. .br @@ -1290,7 +1290,7 @@ All digits are interpreted as decimal, even if leading zeros are present. E.g: /file/part_1_of_3_at_0_with_2047m_of_5753194821 .br No other files are allowed in the directory. All parts have to be present and -their numbers have to be plausible. E.g. byte_count must be valid as -cut_out +their numbers have to be plausible. E.g. byte_count must be valid as \-cut_out argument and their contents may not overlap. .TP .B File manipulations: @@ -1316,7 +1316,7 @@ Default is "on". \fB\-rm\fR iso_rr_path [***] Delete the given files from the ISO image. .br -Note: This does not free any space on the -indev media, even if +Note: This does not free any space on the \-indev media, even if the deletion is committed to that same media. .br The image size will shrink if the image is written to a different @@ -1324,7 +1324,7 @@ media in modification mode. .TP \fB\-rm_r\fR iso_rr_path [***] Delete the given files or directory trees from the ISO image. -See also the note with option -rm. +See also the note with option \-rm. .TP \fB\-rmdir\fR iso_rr_path [***] Delete empty directories. @@ -1342,27 +1342,27 @@ Set ownership of file objects in the ISO image. uid may either be a decimal number or the name of a user known to the operating system. .TP \fB\-chown_r\fR uid iso_rr_path [***] -Like -chown but affecting all files below eventual directories. +Like \-chown but affecting all files below eventual directories. .TP \fB\-chgrp\fR gid iso_rr_path [***] Set group attribute of file objects in the ISO image. gid may either be a decimal number or the name of a group known to the operating system. .TP \fB\-chgrp_r\fR gid iso_rr_path [***] -Like -chgrp but affecting all files below eventual directories. +Like \-chgrp but affecting all files below eventual directories. .TP \fB\-chmod\fR mode iso_rr_path [***] Equivalent to shell command chmod in the ISO image. mode is either an octal number beginning with "0" or a comma separated -list of statements of the form [ugoa]*[+-=][rwxst]* . +list of statements of the form [ugoa]*[+\-=][rwxst]* . .br -Like: go-rwx,u+rwx . +Like: go\-rwx,u+rwx . .br \fBPersonalities\fR: u=user, g=group, o=others, a=all .br \fBOperators\fR: -+ adds given permissions, - revokes given permissions, ++ adds given permissions, \- revokes given permissions, = revokes all old permissions and then adds the given ones. .br \fBPermissions\fR: @@ -1371,30 +1371,30 @@ r=read, w=write, x=execute|inspect, s=setuid|setgid, t=sticky bit For octal numbers see man 2 stat. .TP \fB\-chmod_r\fR mode iso_rr_path [***] -Like -chmod but affecting all files below eventual directories. +Like \-chmod but affecting all files below eventual directories. .TP \fB\-setfacl\fR acl_text iso_rr_path [***] Attach the given ACL to the given iso_rr_paths after deleting their eventually existing ACLs. If acl_text is empty, or contains the text "clear" or the text -"--remove-all", +"\-\-remove\-all", then the existing ACLs will be removed and no new ones will be attached. Any other content of acl_text will be interpreted as a list of -ACL entries. It may be in the long multi-line format as put out by -getfacl +ACL entries. It may be in the long multi\-line format as put out by \-getfacl but may also be abbreviated as follows: .br ACL entries are separated by comma or newline. If an entry is empty text or begins with "#" then it will be ignored. A valid entry has to begin by a letter out of {ugom} for "user", "group", "other", "mask". It has to -contain two colons ":". A non-empty text between those ":" gives a user id -resp. group id. After the second ":" there may be letters out of {rwx- #}. +contain two colons ":". A non\-empty text between those ":" gives a user id +resp. group id. After the second ":" there may be letters out of {rwx\- #}. The first three give read, write resp. execute permission. -Letters "-", " " and TAB are ignored. "#" causes the rest of the entry to +Letters "\-", " " and TAB are ignored. "#" causes the rest of the entry to be ignored. Letter "X" or any other letters are not supported. Examples: .br g:toolies:rw,u:lisa:rw,u:1001:rw,u::wr,g::r,o::r,m::rw .br - group:toolies:rw-,user::rw-,group::r--,other::r--,mask::rw- + group:toolies:rw\-,user::rw\-,group::r\-\-,other::r\-\-,mask::rw\- .br A valid entry may be prefixed by "d", some following characters and ":". This indicates that the entry goes to the "default" ACL rather than to the @@ -1403,22 +1403,22 @@ This indicates that the entry goes to the "default" ACL rather than to the u::rwx,g::rx,o::,d:u::rwx,d:g::rx,d:o::,d:u:lisa:rwx,d:m::rwx .TP \fB\-setfacl_r\fR acl_text iso_rr_path [***] -Like -setfacl but affecting all files below eventual directories. +Like \-setfacl but affecting all files below eventual directories. .TP \fB\-setfacl_list\fR disk_path -Read the output of -getfacl_r or shell command getfacl -R and apply it to the +Read the output of \-getfacl_r or shell command getfacl \-R and apply it to the iso_rr_paths as given in lines beginning with "# file:". This will change ownership, group and ACL of the given files. -If disk_path is "-" then lines are read from standard input. Line "@" ends the +If disk_path is "\-" then lines are read from standard input. Line "@" ends the list, "@@@" aborts without changing the pending iso_rr_path. .br -Since -getfacl and getfacl -R strip leading "/" from file paths, the setting of --cd does always matter. +Since \-getfacl and getfacl \-R strip leading "/" from file paths, the setting of +\-cd does always matter. .TP \fB\-setfattr\fR [-]name value iso_rr_path [***] Attach the given xattr pair of name and value to the given iso_rr_paths. -If the given name is prefixed by "-", then the pair with that name gets -removed from the xattr list. If name is "--remove-all" +If the given name is prefixed by "\-", then the pair with that name gets +removed from the xattr list. If name is "\-\-remove\-all" then all user namespace xattr of the given iso_rr_paths get deleted. In case of deletion, value must be an empty text. @@ -1427,20 +1427,20 @@ 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. -See also option -backslash_codes. Other than with option -setfattr_list, -the byte value 0 cannot be expressed via -setfattr. +See also option \-backslash_codes. Other than with option \-setfattr_list, +the byte value 0 cannot be expressed via \-setfattr. .TP \fB\-setfattr_r\fR [-]name value iso_rr_path [***] -Like -setfattr but affecting all files below eventual directories. +Like \-setfattr but affecting all files below eventual directories. .TP \fB\-setfattr_list\fR disk_path -Read the output of -getfattr_r or shell command getfattr -Rd and apply it to +Read the output of \-getfattr_r or shell command getfattr \-Rd and apply it to the iso_rr_paths as given in lines beginning with "# file:". All previously existing user space xattr of the given iso_rr_paths will be deleted. -If disk_path is "-" then lines are read from standard input. +If disk_path is "\-" then lines are read from standard input. .br -Since -getfattr and getfattr -Rd strip leading "/" from file paths, the setting -of -cd does always matter. +Since \-getfattr and getfattr \-Rd strip leading "/" from file paths, the setting +of \-cd does always matter. .br Empty input lines and lines which begin by "#" will be ignored (except "# file:"). Line "@" ends the list, "@@@" aborts without changing @@ -1451,9 +1451,9 @@ the pending iso_rr_path. Other input lines must have the form Name must be from user namespace. I.e. user.xyz where xyz should consist of printable characters only. The separator "=" is not allowed in names. Value may contain any kind of bytes. It must be in quotes. Trailing -whitespace after the end quote will be ignored. Non-printables bytes and quotes +whitespace after the end quote will be ignored. Non\-printables bytes and quotes must be represented as \\XYZ by their octal ASCII code XYZ. -Use code \\000 for 0-bytes. +Use code \\000 for 0\-bytes. .TP \fB\-alter_date\fR type timestring iso_rr_path [***] Alter the date entries of a file in the ISO image. type is @@ -1472,7 +1472,7 @@ As produced by program date: .br Relative times counted from current clock time: .br - +|-Number["s"|"h"|"d"|"w"|"m"|"y"] + +|\-Number["s"|"h"|"d"|"w"|"m"|"y"] .br where "s" means seconds, "h" hours, "d" days, "w" weeks, "m"=30d, "y"=365.25d plus 1d added to multiplication result. @@ -1492,7 +1492,7 @@ scdbackup timestamps: where "A0" is year 2000, "B0" is 2010, etc. .TP \fB\-alter_date_r\fR type timestring iso_rr_path [***] -Like -alter_date but affecting all files below eventual directories. +Like \-alter_date but affecting all files below eventual directories. .TP \fB\-hide\fR hide_state iso_rr_path [***] Prevent the names of the given files from showing up in the directory trees @@ -1509,7 +1509,7 @@ Possible values of hide_state are: "iso_rr" for hiding from ISO 9660 tree, both directory trees. .br This command does not apply to the boot catalog. -Rather use: -boot_image "any" "cat_hidden=on" +Rather use: \-boot_image "any" "cat_hidden=on" .TP .B Tree traversal command -find: .PP @@ -1519,12 +1519,12 @@ A restricted substitute for shell command find in the ISO image. It performs an action on matching file objects at or below iso_rr_path. .br If not used as last command in the line then the argument list -needs to get terminated by "--". +needs to get terminated by "\-\-". .br Tests are optional. If they are omitted then action is applied to all file objects. If tests are given then they form together an expression. The action is applied only if the expression matches the file object. Default -expression operator between tests is -and, i.e. the expression matches only +expression operator between tests is \-and, i.e. the expression matches only if all its tests match. .br Available tests are: @@ -1537,7 +1537,7 @@ Matches if pattern matches the file path as it would be printed by action "echo". Character '/' is not special but can be matched by wildcards. .br \fB\-disk_name\fR pattern : -Like -name but testing the leaf name of the file source on disk. +Like \-name but testing the leaf name of the file source on disk. Can be true only for data files which stem not from the loaded image. .br \fB\-type\fR type_letter : @@ -1545,28 +1545,28 @@ Matches files of the given type: "block", "char", "dir", "pipe", "file", "link", "socket", "eltorito", "Xotic" which eventually matches what is not matched by the other types. .br -Only the first letter is interpreted. E.g.: -find / -type d +Only the first letter is interpreted. E.g.: \-find / \-type d .br \fB\-damaged\fR : Matches files which use data blocks marked as damaged by a previous -run of -check_media. The damage info vanishes when a new ISO image gets +run of \-check_media. The damage info vanishes when a new ISO image gets loaded. .br Note that a MD5 session mismatch marks all files of the session as damaged. -If finer distinction is desired, perform -md5 off before -check_media. +If finer distinction is desired, perform \-md5 off before \-check_media. .br \fB\-pending_data\fR : Matches files which get their content from outside the loaded ISO image. .br \fB\-lba_range\fR start_lba block_count : Matches files which use data blocks within the range of start_lba -and start_lba+block_count-1. +and start_lba+block_count\-1. .br \fB\-has_acl\fR : -Matches files which have a non-trivial ACL. +Matches files which have a non\-trivial ACL. .br \fB\-has_xattr\fR : -Matches files which have xattr name-value pairs from user namespace. +Matches files which have xattr name\-value pairs from user namespace. .br \fB\-has_aaip\fR : Matches files which have ACL or any xattr. @@ -1578,26 +1578,26 @@ Matches files which have any xattr other than ACL. Matches data files which have MD5 checksums. .br \fB\-has_filter\fR : -Matches files which are filtered by -set_filter. +Matches files which are filtered by \-set_filter. .br \fB\-hidden\fR hide_state : Matches files which are hidden in "iso_rr" tree, in "joliet" tree, in both trees ("on"), or not hidden in any tree ("off"). -Those which are hidden in some tree match -not -hidden "off". +Those which are hidden in some tree match \-not \-hidden "off". .br \fB\-prune\fR : -If this test is reached and the tested file is a directory then -find will not +If this test is reached and the tested file is a directory then \-find will not dive into that directory. This test itself does always match. .br \fB\-decision\fR "yes"|"no" : If this test is reached then the evaluation ends immediately and action -is performed if the decision is "yes" or "true". See operator -if. +is performed if the decision is "yes" or "true". See operator \-if. .br \fB\-true\fR and \fB\-false\fR : Always match resp. match not. Evaluation goes on. .br \fB\-sort_lba\fR : -Always match. This causes -find to perform its action in a sequence sorted by +Always match. This causes \-find to perform its action in a sequence sorted by the ISO image block addresses of the files. It may improve throughput with actions which read data from optical drives. Action will always get the absolute path as parameter. @@ -1608,8 +1608,8 @@ Available operators are: Matches if the next test or sub expression does not match. Several tests do this specifically: .br --undamaged, -lba_range with negative start_lba, -has_no_acl, -has_no_xattr, --has_no_aaip, -has_no_filter . +\-undamaged, \-lba_range with negative start_lba, \-has_no_acl, \-has_no_xattr, +\-has_no_aaip, \-has_no_filter . .br \fB\-and\fR : Matches if both neighboring tests or expressions match. @@ -1620,19 +1620,19 @@ Matches if at least one of both neighboring tests or expressions matches. \fB\-sub\fR ... \fB\-subend\fR or \fB(\fR ... \fB)\fR : Enclose a sub expression which gets evaluated first before it is processed by neighboring operators. -Normal precedence is: -not, -or , -and. +Normal precedence is: \-not, \-or , \-and. .br \fB\-if\fR ... \fB\-then\fR\ ... \fB\-elseif\fR ... \fB\-then\fR ... \fB\-else\fR ... \fB\-endif\fR : -Enclose one or more sub expressions. If the -if expression matches, then -the -then expression is evaluated as the result of the whole expression -up to -endif. Else the next -elseif expression is evaluated and eventually -its -then expression. Finally in case of no match, the -else expression +Enclose one or more sub expressions. If the \-if expression matches, then +the \-then expression is evaluated as the result of the whole expression +up to \-endif. Else the next \-elseif expression is evaluated and eventually +its \-then expression. Finally in case of no match, the \-else expression is evaluated. -There may be more than one -elseif. Neither -else nor -elseif are mandatory. -If -else is missing and would be hit, then the result is a non-match. +There may be more than one \-elseif. Neither \-else nor \-elseif are mandatory. +If \-else is missing and would be hit, then the result is a non\-match. .br --if-expressions are the main use case for above test -decision. +\-if\-expressions are the main use case for above test \-decision. Default action is \fBecho\fR, i.e. to print the address of the found file. Other actions are certain @@ -1641,35 +1641,35 @@ may have specific parameters. See also their particular descriptions. .br \fBchown\fR and \fBchown_r\fR change the ownership and get the user id -as parameter. E.g.: -exec chown thomas -- +as parameter. E.g.: \-exec chown thomas \-\- .br \fBchgrp\fR and \fBchgrp_r\fR change the group attribute and get the group id -as parameter. E.g.: -exec chgrp_r staff -- +as parameter. E.g.: \-exec chgrp_r staff \-\- .br \fBchmod\fR and \fBchmod_r\fR change access permissions and get a mode string -as parameter. E.g.: -exec chmod a-w,a+r -- +as parameter. E.g.: \-exec chmod a\-w,a+r \-\- .br \fBalter_date\fR and \fBalter_date_r\fR change the timestamps. They get a type character and a timestring as parameters. .br -E.g.: -exec alter_date "m" "Dec 30 19:34:12 2007" -- +E.g.: \-exec alter_date "m" "Dec 30 19:34:12 2007" \-\- .br \fBlsdl\fR -prints file information like shell command ls -dl. +prints file information like shell command ls \-dl. .br \fBcompare\fR -performs command -compare with the found file address as +performs command \-compare with the found file address as iso_rr_path and the corresponding file address below its argument -disk_path_start. For this the iso_rr_path of the -find command gets +disk_path_start. For this the iso_rr_path of the \-find command gets replaced by the disk_path_start. .br -E.g.: -find /thomas -exec compare /home/thomas -- +E.g.: \-find /thomas \-exec compare /home/thomas \-\- .br \fBupdate\fR -performs command -update with the found file address as +performs command \-update with the found file address as iso_rr_path. The corresponding file address is determined like with above action "compare". .br @@ -1677,7 +1677,7 @@ action "compare". is like update but does not delete the found file if it is missing on disk. It may be run several times and records with all visited files whether their counterpart on disk has already been seen by one of the update_merge runs. -Finally, a -find run with action "rm_merge" may remove all files that +Finally, a \-find run with action "rm_merge" may remove all files that saw no counterpart on disk. .br Up to the next "rm_merge" or "clear_merge" all newly inserted files will @@ -1717,16 +1717,16 @@ prints access permissions in ACL text form to the result channel. .br \fBsetfacl\fR attaches ACLs after removing eventually exiting ones. The new -ACL is given in text form as defined with option -setfacl. +ACL is given in text form as defined with option \-setfacl. .br -E.g.: -exec setfacl u:lisa:rw,u::rw,g::r,o::-,m::rw -- +E.g.: \-exec setfacl u:lisa:rw,u::rw,g::r,o::\-,m::rw \-\- .br \fBgetfattr\fR -prints eventual xattr name-value pairs from user namespace +prints eventual xattr name\-value pairs from user namespace to the result channel. .br \fBget_any_xattr\fR -prints eventual xattr name-value pairs from any namespace +prints eventual xattr name\-value pairs from any namespace except ACL to the result channel. This is mostly for debugging of namespace "isofs". .br @@ -1737,42 +1737,42 @@ prints eventual recorded MD5 sum together with file path. compares eventual recorded MD5 sum with the file content and reports if mismatch. .br -E.g.: -find / -not -pending_data -exec check_md5 FAILURE -- +E.g.: \-find / \-not \-pending_data \-exec check_md5 FAILURE \-\- .br \fBmake_md5\fR equips a data file with an MD5 sum of its content. Useful to upgrade the files in the loaded image to full MD5 coverage by the next -commit with -md5 "on". +commit with \-md5 "on". .br -E.g.: -find / -type f -not -has_md5 -exec make_md5 -- +E.g.: \-find / \-type f \-not \-has_md5 \-exec make_md5 \-\- .br \fBsetfattr\fR sets or deletes xattr name value pairs. .br -E.g.: -find / -has_xattr -exec setfattr --remove-all '' -- +E.g.: \-find / \-has_xattr \-exec setfattr \-\-remove\-all '' \-\- .br \fBset_filter\fR applies or removes filters. .br -E.g.: -exec set_filter --zisofs -- +E.g.: \-exec set_filter \-\-zisofs \-\- .br \fBmkisofs_r\fR -applies the rules of mkisofs -r to the file object: +applies the rules of mkisofs \-r to the file object: .br -user id and group id become 0, all r-permissions get granted, all w denied. -If there is any x-permission, then all three x get granted. -s- and t-bits get removed. +user id and group id become 0, all r\-permissions get granted, all w denied. +If there is any x\-permission, then all three x get granted. +s\- and t\-bits get removed. .br \fBsort_weight\fR attributes a LBA weight number to regular files. .br -The number may range from -2147483648 to 2147483647. The higher it is, the +The number may range from \-2147483648 to 2147483647. The higher it is, the lower will be the block address of the file data in the emerging ISO image. Currently the boot catalog has a hardcoded weight of 1 billion. Normally it should occupy the block with the lowest possible address. Data files get added or loaded with initial weight 0. .br -E.g.: -exec sort_weight 3 -- +E.g.: \-exec sort_weight 3 \-\- .br \fBshow_stream\fR shows the content stream chain of a data file. @@ -1782,21 +1782,21 @@ brings the file into one of the hide states "on", "iso_rr", "joliet", "off". .br E.g.: .br - -find / -disk_name *_secret -exec hide on + \-find / \-disk_name *_secret \-exec hide on .br \fBestimate_size\fR prints a lower and an upper estimation of the number of blocks which the found files together will occupy in the emerging ISO image. This does not account for the superblock, -for the directories in the -find path, or for image padding. +for the directories in the \-find path, or for image padding. .br \fBfind\fR -performs another run of -find on the matching file address. -It accepts the same params as -find, except iso_rr_path. +performs another run of \-find on the matching file address. +It accepts the same params as \-find, except iso_rr_path. .br E.g.: .br - -find / -name '???' -type d -exec find -name '[abc]*' -exec chmod a-w,a+r -- + \-find / \-name '???' \-type d \-exec find \-name '[abc]*' \-exec chmod a\-w,a+r \-\- .TP .B Filters for data file content: .PP @@ -1804,13 +1804,13 @@ E.g.: content source outside the image. They may also be used vice versa between data content in the image and target files on disk. .br -Built-in filters are "--zisofs" and -"--zisofs-decode". The former is to be -applied via -set_filter, the latter is automatically applied if zisofs +Built\-in filters are "\-\-zisofs" and +"\-\-zisofs\-decode". The former is to be +applied via \-set_filter, the latter is automatically applied if zisofs compressed content is detected with a file when loading the ISO image. .br -Another built-in filter pair is "--gzip" -and "--gunzip" with suffix ".gz". +Another built\-in filter pair is "\-\-gzip" +and "\-\-gunzip" with suffix ".gz". They behave about like external gzip and gunzip but avoid forking a process for each single file. So they are much faster if there are many small files. .PP @@ -1834,39 +1834,39 @@ appended to the file name or removed from it. "remove_suffix" will remove an eventual file name suffix rather than appending it. .br - "if_nonempty" will leave 0-sized files unfiltered. + "if_nonempty" will leave 0\-sized files unfiltered. .br "if_reduction" will try filtering and revoke it if the content size does not shrink. .br "if_block_reduction" will revoke if the number of 2 kB blocks does not shrink. .br - "used=..." is ignored. Command -status shows it with the number of + "used=..." is ignored. Command \-status shows it with the number of files which currently have the filter applied. .br Examples: .br - -external_filter bzip2 suffix=.bz2:if_block_reduction \\ + \-external_filter bzip2 suffix=.bz2:if_block_reduction \\ .br - /usr/bin/bzip2 -- + /usr/bin/bzip2 \-\- .br - -external_filter bunzip2 suffix=.bz2:remove_suffix \\ + \-external_filter bunzip2 suffix=.bz2:remove_suffix \\ .br - /usr/bin/bunzip2 -- + /usr/bin/bunzip2 \-\- .TP \fB\-unregister_filter\fR name -Remove an -external_filter registration. This is only possible if the filter +Remove an \-external_filter registration. This is only possible if the filter is not applied to any file in the ISO image. .TP \fB\-close_filter_list\fR -Irrevocably ban commands -external_filter and -unregister_filter, -but not -set_filter. Use this to prevent external filtering in general or +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. .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 +Apply an \-external_filter or a built\-in filter to the given data files in the ISO image. If the filter suffix is not empty , then it will be applied to the file name. Renaming only happens if the filter really gets attached and is not revoked by @@ -1879,51 +1879,51 @@ Name oversize or collision caused by suffix change will prevent filtering. .br With most filter types this command will immediately run the filter once for each file in order to determine the output size. -Content reading operations like -extract , -compare and image generation will +Content reading operations like \-extract , \-compare and image generation will perform further filter runs and deliver filtered content. .br At image generation time the filter output must still be the same as the output from the first run. Filtering for image generation does not happen with files from the loaded ISO image if the write method of growing is in -effect (i.e -indev and -outdev are identical). +effect (i.e \-indev and \-outdev are identical). .br -The reserved filter name "--remove-all-filters" revokes +The reserved filter name "\-\-remove\-all\-filters" revokes filtering. This will revoke eventual suffix renamings as well. -Use "--remove-all-filters+" to +Use "\-\-remove\-all\-filters+" to prevent any suffix renaming. .TP \fB\-set_filter_r\fR name iso_rr_path [***] -Like -set_filter but affecting all data files below eventual directories. +Like \-set_filter but affecting all data files below eventual directories. .TP .B Writing the result, drive control: .PP (see also paragraph about settings below) .TP \fB\-rollback\fR -Discard the manipulated ISO image and reload it from -indev. -(Use -rollback_end if immediate program end is desired.) +Discard the manipulated ISO image and reload it from \-indev. +(Use \-rollback_end if immediate program end is desired.) .TP \fB\-commit\fR Perform the write operation. Afterwards eventually make the --outdev the new -dev and load the image from there. +\-outdev the new \-dev and load the image from there. Switch to growing mode. -(A subsequent -outdev will activate modification mode or blind growing.) --commit is performed automatically at end of program if there +(A subsequent \-outdev will activate modification mode or blind growing.) +\-commit is performed automatically at end of program if there are uncommitted manipulations pending. .br -So, to perform a final write operation with no new -dev -and no new loading of image, rather execute option -end. -If you want to go on without image loading, execute -commit_eject "none". -To eject after write without image loading, use -commit_eject "all". +So, to perform a final write operation with no new \-dev +and no new loading of image, rather execute option \-end. +If you want to go on without image loading, execute \-commit_eject "none". +To eject after write without image loading, use \-commit_eject "all". .br -To suppress a final write, execute -rollback_end. +To suppress a final write, execute \-rollback_end. .br 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. +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. @@ -1933,37 +1933,37 @@ burn programs but you may well try some of those listed below under SEE ALSO. .TP \fB\-eject\fR "in"|"out"|"all" -Eject the media in -indev, resp. -outdev, resp. both drives. +Eject the media in \-indev, resp. \-outdev, resp. both drives. Note: It is not possible yet to effectively eject disk files. .TP \fB\-commit_eject\fR "in"|"out"|"all"|"none" -Combined -commit and -eject. When writing has finished do not make --outdev the new -dev, and load no ISO image. Rather eject --indev and/or -outdev. Eventually give up any non-ejected drive. +Combined \-commit and \-eject. When writing has finished do not make +\-outdev the new \-dev, and load no ISO image. Rather eject +\-indev and/or \-outdev. Eventually give up any non\-ejected drive. .TP \fB\-blank\fR mode -Make media ready for writing from scratch (if not -dummy is activated). +Make media ready for writing from scratch (if not \-dummy is activated). .br -This affects only the -outdev not the -indev. +This affects only the \-outdev not the \-indev. If both drives are the same and if the ISO image was altered then this command leads to a FAILURE event. Defined modes are: as_needed, fast, all, deformat, deformat_quickest .br -"as_needed" cares for used CD-RW, DVD-RW and for used overwriteable media -by applying -blank "fast". It applies -format "full" to yet unformatted -DVD-RAM and BD-RE. Other media in blank state are gracefully ignored. +"as_needed" cares for used CD\-RW, DVD\-RW and for used overwriteable media +by applying \-blank "fast". It applies \-format "full" to yet unformatted +DVD\-RAM and BD\-RE. Other media in blank state are gracefully ignored. Media which cannot be made ready for writing from scratch cause a FAILURE event. .br -"fast" makes CD-RW and unformatted DVD-RW re-usable, or invalidates +"fast" makes CD\-RW and unformatted DVD\-RW re\-usable, or invalidates overwriteable ISO images. "all" might work more thoroughly and need more time. .br -"deformat" converts overwriteable DVD-RW into unformatted ones. +"deformat" converts overwriteable DVD\-RW into unformatted ones. .br -"deformat_quickest" is a faster way to deformat or blank DVD-RW +"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". .br The progress reports issued by some drives while blanking are quite unrealistic. Do not conclude success or failure from the @@ -1971,22 +1971,22 @@ reported percentages. Blanking was successful if no SORRY event or worse occured. .TP \fB\-format\fR mode -Convert unformatted DVD-RW into overwriteable ones, "de-ice" DVD+RW, format -newly purchased BD-RE or BD-R, re-format DVD-RAM or BD-RE. +Convert unformatted DVD\-RW into overwriteable ones, "de\-ice" DVD+RW, format +newly purchased BD\-RE or BD\-R, re\-format DVD\-RAM or BD\-RE. .br Defined modes are: .br as_needed, full, fast, by_index_, fast_by_index_ .br -"as_needed" formats yet unformatted DVD-RW, DVD-RAM, BD-RE, or blank -unformatted BD-R. Other media are left untouched. +"as_needed" formats yet unformatted DVD\-RW, DVD\-RAM, BD\-RE, or blank +unformatted BD\-R. Other media are left untouched. .br -"full" (re-)formats DVD-RW, DVD+RW, DVD-RAM, BD-RE, or blank unformatted BD-R. +"full" (re\-)formats DVD\-RW, DVD+RW, DVD\-RAM, BD\-RE, or blank unformatted BD\-R. .br "fast" does the same as "full" but tries to be quicker. .br "by_index_" selects a format out of the descriptor list issued by option --list_formats. The index number from that list is to be appended to the +\-list_formats. The index number from that list is to be appended to the mode word. E.g: "by_index_3". .br "fast_by_index_" does the same as "by_index_" but tries to be quicker. @@ -1997,18 +1997,18 @@ E.g: "by_size_4100m". This applies to media with Defect Management. .br "fast_by_size_" does the same as "by_size_" but tries to be quicker. .br -The formatting action has no effect on media if -dummy is activated. +The formatting action has no effect on media if \-dummy is activated. .br Formatting is normally needed only once during the lifetime of a media, -if ever. But it is a reason for re-formatting if: +if ever. But it is a reason for re\-formatting if: .br - DVD-RW was deformatted by -blank, + DVD\-RW was deformatted by \-blank, .br - DVD+RW has read failures (re-format before next write), + DVD+RW has read failures (re\-format before next write), .br - DVD-RAM or BD-RE shall change their amount of defect reserve. + DVD\-RAM or BD\-RE shall change their amount of defect reserve. .br -BD-R may be written unformatted or may be formatted before first use. +BD\-R may be written unformatted or may be formatted before first use. Formatting activates Defect Management which tries to catch and repair bad spots on media during the write process at the expense of half speed even with flawless media. @@ -2025,20 +2025,20 @@ a MMC format code, the announced size in blocks (like "2236704s") and the same size in MiB. .br MMC format codes are manifold. Most important are: -"00h" general formatting, "01h" increases reserve space for DVD-RAM, -"26h" for DVD+RW, "30h" for BD-RE with reserve space, -"31h" for BD-RE without reserve space, "32h" for BD-R. +"00h" general formatting, "01h" increases reserve space for DVD\-RAM, +"26h" for DVD+RW, "30h" for BD\-RE with reserve space, +"31h" for BD\-RE without reserve space, "32h" for BD\-R. .br -Smaller format size with DVD-RAM, BD-RE, or BD-R means more reserve space. +Smaller format size with DVD\-RAM, BD\-RE, or BD\-R means more reserve space. .TP \fB\-list_profiles\fR "in"|"out"|"all" -Put out a list of media types supported by -indev, resp. -outdev, resp. both. +Put out a list of media types supported by \-indev, resp. \-outdev, resp. both. The currently recognized type is marked by text "(current)". .TP .B Settings for result writing: .PP Rock Ridge info will be generated by the program unconditionally. -ACLs will be written according to the setting of option -acl. +ACLs will be written according to the setting of option \-acl. .TP \fB\-joliet\fR "on"|"off" If enabled by "on", generate Joliet tree additional to ISO 9660 + Rock Ridge @@ -2059,14 +2059,14 @@ can be revoked individually by appending "_off". Like "deep_paths_off". Rule keywords are: .br "iso_9660_level="number chooses level 1 with ISO names of the form 8.3 -and -file_size_limit <= 4g - 1, or level 2 with ISO names up to -length 32 and the same -file_size_limit, or level 3 with ISO names up to -length 32 and -file_size_limit >= 400g -200k. If necessary -file_size_limit +and \-file_size_limit <= 4g \- 1, or level 2 with ISO names up to +length 32 and the same \-file_size_limit, or level 3 with ISO names up to +length 32 and \-file_size_limit >= 400g \-200k. If necessary \-file_size_limit gets adjusted. .br "allow_dir_id_ext" allows ISO names of directories to have a name extension as with other file types. It does not force dots and it omits the version -number, though. This is a bad tradition of mkisofs which violates ECMA-119. +number, though. This is a bad tradition of mkisofs which violates ECMA\-119. Especially ISO level 1 only allows 8 characters in a directory name and not 8.3. .br @@ -2095,7 +2095,7 @@ conversion. If a file name has more characters, then image production will fail deliberately. .br "untranslated_name_len="number enables untranslated_names with a smaller limit -for the length of file names. 0 disables this feature, -1 chooses maximum +for the length of file names. 0 disables this feature, \-1 chooses maximum length limit, numbers larger than 0 give the desired length limit. .br "joliet_long_names" allows Joliet leaf names up to 103 characters rather @@ -2116,7 +2116,7 @@ Default is "old_rr" which uses Rock Ridge version 1.10. This implies also "aaip_susp_1_10" which may be changed by subsequent "aaip_susp_1_10_off". .br "aaip_susp_1_10" allows AAIP to be written as unofficial extension of RRIP -rather than as official extension under SUSP-1.12. +rather than as official extension under SUSP\-1.12. .br "no_emul_toc" saves 64 kB with the first session on overwriteable media but makes the image incapable of displaying its session history. @@ -2142,45 +2142,45 @@ which get visible if the reader ignores Rock Ridge. Specify the volume ID. xorriso 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" +ECMA 119 demands ASCII characters out of [A\-Z0\-9_]. Like: "IMAGE_23" .br -Joliet allows 16 UCS-2 characters. Like: "Windows name" +Joliet allows 16 UCS\-2 characters. Like: "Windows name" .br Be aware that the volume id might get used automatically as name of the mount point when the media is inserted into a playful computer system. .br If an ISO image gets loaded while the volume ID is set to default "ISOIMAGE" or to "", then the volume ID of the loaded image will become the effective -volume id for the next write run. But as soon as command -volid is performed +volume id for the next write run. But as soon as command \-volid is performed afterwards, this pending id is overridden by the new setting. .br -Consider this when setting -volid "ISOIMAGE" before executing -dev, -indev, -or -rollback. -If you insist in -volid "ISOIMAGE", set it again after those commands. +Consider this when setting \-volid "ISOIMAGE" before executing \-dev, \-indev, +or \-rollback. +If you insist in \-volid "ISOIMAGE", set it again after those commands. .TP \fB\-volset_id\fR text -Set the volume set id string to be written with the next -commit. +Set the volume set id string to be written with the next \-commit. Permissible are up to 128 characters. This setting gets overridden by image loading. .TP \fB\-publisher\fR text -Set the publisher id string to be written with the next -commit. This may +Set the publisher id string to be written with the next \-commit. This may identify the person or organisation who specified what shall be recorded. Permissible are up to 128 characters. This setting gets overridden by image loading. .TP \fB\-application_id\fR text -Set the application id string to be written with the next -commit. This may +Set the application id string to be written with the next \-commit. This may 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 -which is normally written as -preparer_id. It is a wrong tradition to write -the program id as -application_id. +which is normally written as \-preparer_id. It is a wrong tradition to write +the program id as \-application_id. .TP \fB\-system_id\fR text -Set the system id string to be written with the next -commit. This may +Set the system id string to be written with the next \-commit. This may identify the system which can recognize and act upon the content of the System Area in image blocks 0 to 15. Permissible are up to 32 characters. This setting gets overridden by @@ -2203,39 +2203,39 @@ It must consist of 16 decimal digits which form YYYYMMDDhhmmsscc, with YYYY between 1970 and 2999. Time zone is GMT. It is supposed to match this GRUB line: .br - search --fs-uuid --set YYYY-MM-DD-hh-mm-ss-cc + search \-\-fs\-uuid \-\-set YYYY\-MM\-DD\-hh\-mm\-ss\-cc .br E.g. 2010040711405800 is 7 Apr 2010 11:40:58 (+0 centiseconds). .br -Timestrings for the other types may be given as with option -alter_date. +Timestrings for the other types may be given as with option \-alter_date. They are prone to timezone computations. The timestrings "default" or "overridden" cause default settings: "c" and "m" will show the current time of image creation. "x" and "f" will be marked as insignificant. "uuid" will be deactivated. .TP \fB\-copyright_file\fR text -Set the copyright file name to be written with the next -commit. This should +Set the copyright file name to be written with the next \-commit. This should be the ISO 9660 path of a file in the image which contains a copyright statement. Permissible are up to 37 characters. This setting gets overridden by image loading. .TP \fB\-abstract_file\fR text -Set the abstract file name to be written with the next -commit. This should +Set the abstract file name to be written with the next \-commit. This should be the ISO 9660 path of a file in the image which contains an abstract statement about the image content. Permissible are up to 37 characters. This setting gets overridden by image loading. .TP \fB\-biblio_file\fR text -Set the biblio file name to be written with the next -commit. This should +Set the biblio file name to be written with the next \-commit. This should be the ISO 9660 path of a file in the image which contains bibliographic records. Permissible are up to 37 characters. This setting gets overridden by image loading. .TP \fB\-preparer_id\fR -Set the preparer id string to be written with the next -commit. This may +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. @@ -2249,8 +2249,8 @@ Unlike other id strings, this setting is not influenced by image loading. \fB\-out_charset\fR character_set_name Set the character set to which file names get converted when writing an image. See paragraph "Character sets" for more explanations. -When loading the written image after -commit the setting of -out_charset -will be copied to -in_charset. +When loading the written image after \-commit the setting of \-out_charset +will be copied to \-in_charset. .TP \fB\-uid\fR uid User id to be used for all files when the new ISO tree gets written to media. @@ -2261,10 +2261,10 @@ Group id to be used for all files when the new ISO tree gets written to media. \fB\-zisofs\fR option[:options] Set global parameters for zisofs compression. This data format is recognized and transparently uncompressed by some Linux kernels. It is to be applied -via option -set_filter with built-in filter "--zisofs". +via option \-set_filter with built\-in filter "\-\-zisofs". Parameters are: .br - "level="[0-9] zlib compression: 0=none, 1=fast,..., 9=slow + "level="[0\-9] zlib compression: 0=none, 1=fast,..., 9=slow .br "block_size="32k|64k|128k size of compression blocks .br @@ -2278,7 +2278,7 @@ mkzftree. Set the burn speed. Default is 0 = maximum speed. Speed can be given in media dependent numbers or as a desired throughput per second in MMC compliant kB (= 1000) -or MB (= 1000 kB). Media x-speed factor can be set explicity +or MB (= 1000 kB). Media x\-speed factor can be set explicity by "c" for CD, "d" for DVD, "b" for BD, "x" is optional. .br Example speeds: @@ -2288,17 +2288,17 @@ Example speeds: 5540k = 5540kB/s = 4d = 4xDVD .br If there is no hint about the speed unit attached, then the -media in the -outdev will decide. Default unit is CD = 176.4k. +media in the \-outdev will decide. Default unit is CD = 176.4k. .br MMC drives usually activate their own idea of speed and take the speed value given by the burn program only as upper limit for their own decision. .TP \fB\-stream_recording\fR "on"|"off"|"full"|"data"|number -Setting "on" tries to circumvent the management of defects on DVD-RAM, BD-RE, -or BD-R. Defect management keeps partly damaged media usable. But it reduces +Setting "on" tries to circumvent the management of defects on DVD\-RAM, BD\-RE, +or BD\-R. Defect management keeps partly damaged media usable. But it reduces write speed to half nominal speed even if the media is in perfect shape. -For the case of flawless media, one may use -stream_recording "on" to get +For the case of flawless media, one may use \-stream_recording "on" to get full speed. .br "full" tries full speed with all write operations, whereas "on" does this @@ -2313,7 +2313,7 @@ GNU/Linux specific: Set the number of bytes to be transmitted with each write operation to DVD or BD media. A number of 64 KB may improve throughput with bus systems which show latency problems. The default depends on media type, on option --stream_recording , and on compile time options. +\-stream_recording , and on compile time options. .TP \fB\-stdio_sync\fR "on"|"off"|number Set the number of bytes after which to force output to stdio: pseudo drives. @@ -2336,8 +2336,8 @@ which means unit is kiB (= 1024) or MiB (= 1024 kiB). If "on" then mark the written media as not appendable any more (if possible at all with the given type of target media). .br -This is the contrary of cdrecord, wodim, cdrskin option -multi, -and is one aspect of growisofs option -dvd-compat. +This is the contrary of cdrecord, wodim, cdrskin option \-multi, +and is one aspect of growisofs option \-dvd\-compat. .TP \fB\-padding\fR number["k"|"m"]|"included"|"appended" Append the given number of extra bytes to the image stream. @@ -2346,14 +2346,14 @@ 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. .br -For images which will never get to a CD it is safe to use -padding 0 . +For images which will never get to a CD it is safe to use \-padding 0 . .br Normally padding is not written as part of the ISO image but appended -after the image end. This is -padding mode "appended". +after the image end. This is \-padding mode "appended". .br -Emulation command -as "mkisofs" and command -jigdo cause padding to be +Emulation command \-as "mkisofs" and command \-jigdo cause padding to be written as part of the image. -The same effect is achieved by -padding mode "included". +The same effect is achieved by \-padding mode "included". .TP .B Bootable ISO images: .PP @@ -2362,19 +2362,19 @@ record from the first session on media and not from the last one, which gets mounted by default. This makes no problems with overwriteable media, because they appear to inadverted readers as one single session. .br -But with multi-session media CD-R[W], DVD-R[W], DVD+R, it implies that the +But with multi\-session media CD\-R[W], DVD\-R[W], DVD+R, it implies that the whole bootable system has to reside already in the first session and that the last session still has to bear all files which the booted system expects after eventually mounting the ISO image. .br If a boot image from ISOLINUX or GRUB is known to be present on media then it is advised to patch it -when a follow-up session gets written. But one should not rely on the +when a follow\-up session gets written. But one should not rely on the capability to influence the bootability of the existing sessions, unless one can assume overwriteable media. .br There are booting mechanisms which do not use an El Torito record but rather -start at the first bytes of the image: PC-BIOS MBR for hard-disk-like devices, +start at the first bytes of the image: PC\-BIOS MBR for hard\-disk\-like devices, MIPS Volume Header for old SGI computers, DEC Boot Block for old DECstation, SUN Disk Label for SPARC machines. .br @@ -2390,8 +2390,8 @@ Define the handling of an eventual set of El Torito boot images which has been read from an existing ISO image or define how to make a prepared boot image file set bootable. Such file sets get produced by ISOLINUX or GRUB. .br -Each -boot_image command has two arguments: type and setting. More than one --boot_image command may be used to define the handling of one or more boot +Each \-boot_image command has two arguments: type and setting. More than one +\-boot_image command may be used to define the handling of one or more boot images. Sequence matters. .br Types \fBisolinux\fR and \fBgrub\fR care for known peculiarities. @@ -2415,11 +2415,11 @@ then they stay unpatched. This check is not infallible. So if you do know that the images need no patching, use "any" "keep". "grub" "patch" will not patch EFI images (platform_id=0xef). .br -Most safe is the default: -boot_image "any" "discard". +Most safe is the default: \-boot_image "any" "discard". .br -Advised for GRUB : -boot_image "grub" "patch" +Advised for GRUB : \-boot_image "grub" "patch" .br -For ISOLINUX : -boot_image "isolinux" "patch" +For ISOLINUX : \-boot_image "isolinux" "patch" .br \fBshow_status\fR will print what is known about the loaded boot images and their designated fate. @@ -2435,26 +2435,26 @@ sessions an existing boot image can get replaced by a new one, but depending on the media type this may have few effect at boot time. See above. .br The boot image and its supporting files have to be added to the ISO image by -normal means (image loading, -map, -add, ...). In case of ISOLINUX the files +normal means (image loading, \-map, \-add, ...). In case of ISOLINUX the files should reside either in ISO image directory /isolinux or in /boot/isolinux . In that case it suffices to use as bootspec the text "dir=/isolinux" or "dir=/boot/isolinux". E.g.: .br - -boot_image isolinux dir=/boot/isolinux + \-boot_image isolinux dir=/boot/isolinux .br which bundles these individual settings: .br - -boot_image isolinux bin_path=/boot/isolinux/isolinux.bin + \-boot_image isolinux bin_path=/boot/isolinux/isolinux.bin .br - -boot_image isolinux cat_path=/boot/isolinux/boot.cat + \-boot_image isolinux cat_path=/boot/isolinux/boot.cat .br - -boot_image isolinux load_size=2048 + \-boot_image isolinux load_size=2048 .br - -boot_image any boot_info_table=on + \-boot_image any boot_info_table=on .br An El Torito boot catalog file gets inserted into the ISO image with address -\fBcat_path=\fR at -commit time. -It is subject to normal -overwrite and -reassure processing if there is already +\fBcat_path=\fR at \-commit time. +It is subject to normal \-overwrite and \-reassure processing if there is already a file with the same name. The catalog lists the boot images and is read by the boot facility to choose one of the boot images. But it is not necessary that it appears in the @@ -2479,21 +2479,21 @@ Default 2048 should be overridden only if a better value is known. is given by "any" "bin_path=". "boot_info_table=off" disables patching. .br \fBplatform_id=\fR defines by two hex digits the Platform ID of the -boot image. "00" is 80x86 PC-BIOS, "01" is PowerPC, "02" is Mac, "ef" is EFI. +boot image. "00" is 80x86 PC\-BIOS, "01" is PowerPC, "02" is Mac, "ef" is EFI. .br \fBid_string=\fRtext|56_hexdigits defines the ID string of the boot catalog section where the boot image will be listed. If the value consists of 56 -characters [0-9A-Fa-f] then it is converted into 28 bytes, else the first +characters [0\-9A\-Fa\-f] then it is converted into 28 bytes, else the first 28 characters become the ID string. The ID string of the first boot image becomes the overall catalog ID. It is limited to 24 characters. Other id_strings become section IDs. .br \fBsel_crit=\fRhexdigits defines the Selection Criteria of the boot image. -Up to 20 bytes get read from the given characters [0-9A-Fa-f]. +Up to 20 bytes get read from the given characters [0\-9A\-Fa\-f]. They get attributed to the boot image entry in the catalog. .br \fBnext\fR ends the definition of a boot image and starts a new one. -Any following -bootimage bootspecs will affect the new image. +Any following \-bootimage bootspecs will affect the new image. The first "next" discards eventually loaded boot images and their catalog. .br @@ -2512,7 +2512,7 @@ which can be used to boot from USB stick or hard disk. Other than a El Torito boot image, the file disk_path needs not to be added to the ISO image. .br --boot_image isolinux system_area= implies "partition_table=on". +\-boot_image isolinux system_area= implies "partition_table=on". .br \fBpartition_table=on\fR causes a simple partition table to be written into bytes 446 to 511 of the System Area. @@ -2526,20 +2526,20 @@ With types "any" and "grub" it shows a single partiton which starts at byte 512 and ends where the ISO image ends. This works with or without system_area= or boot image. .br -In follow-up sessions the existing System Area is preserved by default. +In follow\-up sessions the existing System Area is preserved by default. If types "isolinux" or "grub" are set to "patch", then "partition_table=on" is activated without new boot image. In this case the existing System Area gets checked whether it bears addresses and sizes as if it had been processed by "partition_table=on". If so, then those parameters get updated when the new System Area is written. .br -Special "system_area=/dev/zero" causes 32k of NUL-bytes. +Special "system_area=/dev/zero" causes 32k of NUL\-bytes. Use this to discard an MBR which eventually was loaded with the ISO image. .br \fBpartition_offset=\fR2kb_block_adr causes a partition table with a single partition that begins at the given block address. This is counted in 2048 byte -blocks, not in 512 byte blocks. If the block address is non-zero then it must -be at least 16. A non-zero partition offset causes two superblocks to be +blocks, not in 512 byte blocks. If the block address is non\-zero then it must +be at least 16. A non\-zero partition offset causes two superblocks to be generated and two sets of directory trees. The image is then mountable from its absolute start as well as from the partition start. .br @@ -2588,7 +2588,7 @@ Only a single boot file can be declared by mipsel_path=. \fBsparc_label=\fRtext causes the production of a SUN Disk Label with the given text as ASCII label. This boot block format allows to append images for partitions 2 to 8. Partition 1 will always be the ISO image. -See option -append_partition. +See option \-append_partition. The first 512 bytes of any data eventually provided by system_area= will be overwritten. .br @@ -2605,7 +2605,7 @@ described by a partition table entry in a boot block at the start of the emerging ISO image. The partition entry will bear the size of the submitted file rounded up to the next multiple of 2048 bytes. .br -Beware of subsequent multi-session runs. The appended partition will get +Beware of subsequent multi\-session runs. The appended partition will get overwritten. .br Partitions may be appended with boot block type MBR and with SUN Disk Label. @@ -2624,7 +2624,7 @@ yield usable results. For a list of codes search the Internet for The disk_path must provide the necessary data bytes at commit time. An empty disk_path disables this feature for the given partition number. .br -With SUN Disk Label (selected by -boot_image any sparc_label=): +With SUN Disk Label (selected by \-boot_image any sparc_label=): .br partition_number may be 2 to 8. Number 1 will always be the ISO image. Partition start addresses are aligned to 320 KiB. The type_code does not @@ -2642,13 +2642,13 @@ 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 -single-session ISO image. +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 -on a blank -outdev, and a .md5 file which lists those data files which may be +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: .br @@ -2663,14 +2663,14 @@ 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 -write to non-blank targets, it will disable multi-session emulation, and +write to non\-blank targets, it will disable multi\-session emulation, and eventual padding will be counted as part of the ISO image. .br .TP \fB\-jigdo\fR parameter_name value Clear Jigdo Template Extraction parameter list or add a parameter to that list. The alias names are the corresponding genisoimage options. They are accepted -as parameter names as well. Especially they are recognized by the -as mkisofs +as parameter names as well. Especially they are recognized by the \-as mkisofs emulation command. .br Parameter \fBclear\fR with any value empties the whole list. @@ -2679,33 +2679,33 @@ No .jigdo and .template file will be produced. \fBtemplate_path\fR sets the disk_path for the .template file with the holed and compressed ISO image copy. .br -Alias: -jigdo-template +Alias: \-jigdo\-template .br \fBjigdo_path\fR sets the disk_path for the .jigdo file with the checksums and download addresses for filling the holes in .template. .br -Alias: -jigdo-jigdo +Alias: \-jigdo\-jigdo .br \fBmd5_path\fR sets the disk_path where to find the .md5 input file. .br -Alias: -md5-list +Alias: \-md5\-list .br \fBmin_size\fR sets the minimum size for a data file to be listed in the .jigdo file and being a hole in the .template file. .br -Alias: -jigdo-min-file-size +Alias: \-jigdo\-min\-file\-size .br \fBexclude\fR adds a regular expression pattern which will get compared with the absolute disk_path of any data file. A match causes the file to stay in .template in any case. .br -Alias: -jigdo-exclude +Alias: \-jigdo\-exclude .br \fBdemand_md5\fR adds a regular expression pattern which will get compared with the absolute disk_path of any data file that was not found in the .md5 list. A match causes a MISHAP event. .br -Alias: -jigdo-force-md5 +Alias: \-jigdo\-force\-md5 .br \fBmapping\fR adds a string pair of the form To=From to the parameter list. If a data file gets listed in the .jigdo file, then it is referred by the @@ -2714,31 +2714,31 @@ whether it begins with the From string. If so, then this string will be replaced by the To string and a ':' character, before it goes into the .jigdo file. The From string should end by a '/' character. .br -Alias: -jigdo-map +Alias: \-jigdo\-map .br \fBcompression\fR chooses one of "bzip2" or "gzip" for the compression of the template file. The jigdo file is put out uncompressed. .br -Alias: -jigdo-template-compress +Alias: \-jigdo\-template\-compress .br \fBchecksum_iso\fR chooses one or more of "md5", "sha1", "sha256", "sha512" for the auxiliary "# Image Hex" checksums in the jigdo file. The value may e.g. look like "md5,sha1,sha512". Value "all" chooses all available algorithms. Note that MD5 stays always enabled. .br -Alias: -checksum_algorithm_iso +Alias: \-checksum_algorithm_iso .br \fBchecksum_template\fR is like checksum_iso but for "# Template Hex". .br -Alias: -checksum_algorithm_template +Alias: \-checksum_algorithm_template .TP .B Character sets: .PP -File names are strings of non-zero bytes with 8 bit each. Unfortunately +File names are strings of non\-zero bytes with 8 bit each. Unfortunately the same byte string may appear as different peculiar national characters on differently nationalized terminals. The meanings of byte codes are defined in \fBcharacter sets\fR which have -names. Shell command iconv -l lists them. +names. Shell command iconv \-l lists them. .br 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 @@ -2750,7 +2750,7 @@ There is an input conversion from input character set to the local character set which applies when an ISO image gets loaded. A conversion from local character set to the output character set is performed when an image tree gets written. The sets can be defined independently by options --in_charset and -out_charset. Normally one will have both identical, if ever. +\-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 @@ -2763,7 +2763,7 @@ 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. .br -By option -auto_charset it is possible to attribute the output charset name +By option \-auto_charset it is possible to attribute the output charset name to the image. This makes the situation unambigous. But if your terminal character set does not match the character set of the local file names, then this attribute can become plainly wrong and cause problems at read time. @@ -2772,8 +2772,8 @@ displays all intended filenames. Check especially the exotic national characters. .br To enforce recording of a particular character set name without any conversion -at image generation time, set -charset and -local_charset to the desired name, -and enable -backslash_codes to avoid evil character display on your terminal. +at image generation time, set \-charset and \-local_charset to the desired name, +and enable \-backslash_codes to avoid evil character display on your terminal. .TP \fB\-charset\fR character_set_name Set the character set from which to convert file names when loading an @@ -2781,7 +2781,7 @@ image and to which to convert when writing an image. .TP \fB\-local_charset\fR character_set_name Override the system assumption of the local character set name. -If this appears necessary, one should consider to set -backslash_codes to +If this appears necessary, one should consider to set \-backslash_codes to "on" in order to avoid dangerous binary codes being sent to the terminal. .TP .B Exception processing: @@ -2828,15 +2828,15 @@ the setting by this option. Expect not many "ABORT" events to 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 +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 recognized that way. +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 a failure indicating exit value from the program, nevertheless. -Useful is a value lower than the -abort_on threshold, down to "WARNING". +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 @@ -2848,7 +2848,7 @@ it decides to abort the program run: .br 3=creation of xorriso main object failed .br -4=failure to start libburnia-project.org libraries +4=failure to start libburnia\-project.org libraries .br 5=program abort during argument processing .br @@ -2859,16 +2859,16 @@ Set the threshold for events to be reported. .br Useful: "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG", "ALL" .br -Regardless what is set by -report_about, messages get always reported if they -reach the severity threshold of -abort_on . +Regardless what is set by \-report_about, messages get always reported if they +reach the severity threshold of \-abort_on . .br Event messages are sent to the info channel "I" which is usually stderr -but may be influenced by command -pkt_output. +but may be influenced by command \-pkt_output. Info messages which belong to no event get attributed severity "NOTE". .br -A special property of this option is that the first -report_about setting +A special property of this 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 xorriso 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 @@ -2879,7 +2879,7 @@ 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. .br -Mode "off" as first -signal_handling among the start arguments prevents all +Mode "off" as first \-signal_handling among the start arguments prevents all own signal precautions of xorriso. Eventually inherited signal handler settings stay as they are. .br @@ -2891,25 +2891,25 @@ 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. -kill -9 then imposes the risk that the drive is left in unusable state and +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. .br -A special property of this option is that the first -signal_handling setting +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 xorriso 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. For now this applies to occasions "image_loading" which is given while an image tree is read from the input device, and to "file_extraction" which -is given with osirrox options like -extract. +is given with osirrox options like \-extract. .br With "image_loading" there are three behaviors available: .br "best_effort" goes on with reading after events with severity below FAILURE -if the threshold of option -abort_on allows this. +if the threshold of option \-abort_on allows this. .br "failure" aborts image tree reading on first event of at least SORRY. It issues an own FAILURE event. @@ -2923,7 +2923,7 @@ With occasion "file_extraction" there are three behaviors: .br "delete" removes files which encountered errors during content extraction. .br -"best_effort" starts a revovery attempt by means of -extract_cut if the +"best_effort" starts a revovery attempt by means of \-extract_cut if the file content stems from the loaded ISO image and is not filtered. .TP .B Dialog mode control: @@ -2932,7 +2932,7 @@ file content stems from the loaded ISO image and is not filtered. Enable or disable to enter dialog mode after all arguments are processed. In dialog mode input lines get prompted via readline or from stdin. .br -If no -abort_on severity was set when dialog starts, then "NEVER" is set +If no \-abort_on severity was set when dialog starts, then "NEVER" is set to avoid abort in most cases of wrong input or other problems. Before dialog begins, the default is "FAILURE" which e.g. aborts on unknown commands. .br @@ -2978,15 +2978,15 @@ directory only once and not for each file in its whole subtree. Setting "off" silently kills any kind of image file object resp. performs above irrevocable actions. .br -To really produce user prompts, option -dialog needs to be set to "on". +To really produce user prompts, option \-dialog needs to be set to "on". Note that the prompt does not appear in situations where file removal -is forbidden by option -overwrite. -reassure only imposes an additional +is forbidden by option \-overwrite. \-reassure only imposes an additional curb for removing existing file objects. .br Be aware that file objects get deleted from the ISO image immediately after confirmation. They are gone even if the running command gets aborted -and its desired effect gets revoked. In case of severe mess-up, consider to -use -rollback to revoke the whole session. +and its desired effect gets revoked. In case of severe mess\-up, consider to +use \-rollback to revoke the whole session. .TP .B Drive and media related inquiry actions: .TP @@ -2998,7 +2998,7 @@ This is only possible when no ISO image changes are pending. After this option was executed, there is no drive current and no image loaded. Eventually one has to aquire a drive again. .br -In order to be visible, a device has to offer rw-permissions +In order to be visible, a device has to offer rw\-permissions with its libburn standard device file. Thus it might be only the \fBsuperuser\fR who is able to see all drives. @@ -3015,12 +3015,12 @@ only a single session gets shown. But if the first session on the overwriteable media was written by xorriso 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 +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 sessions is supposed to be the most recent real session then. .br -Some read-only drives and media show no usable session history at all. -Eventually option -rom_toc_scan might help. +Some read\-only drives and media show no usable session history at all. +Eventually option \-rom_toc_scan might help. .TP \fB\-mount_cmd\fR drive entity id path Emit an appropriate command line for mounting the ISO session @@ -3029,7 +3029,7 @@ The result will be different on GNU/Linux and on FreeBSD. .br drive can be "indev" or "outdev" to indicate already acquired drives, or it can be the path of a not yet acquired drive. -Prefix "stdio:" for non-MMC drives is not mandatory. +Prefix "stdio:" for non\-MMC drives is not mandatory. .br entity must be either "sbsector" with the superblock sector address as id, or "track" with a track number as id, or "session" with a session number, @@ -3038,13 +3038,13 @@ as id. .br path will be used as mount point and must already exist as a directory on disk. .br -The command gets printed to the result channel. See option -mount +The command gets printed to the result channel. See option \-mount for direct execution of this command. .TP \fB\-mount_opts\fR option[:option...] -Set options which influence -mount and -mount_cmd. Currently there is only +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 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 @@ -3054,7 +3054,7 @@ before ejecting. Print to the result channel a text which gets composed according to format and the parameters of the addressed session. .br -Formats "linux:"path or "freebsd:"path produce the output of -mount_cmd +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. @@ -3070,20 +3070,20 @@ session number, resp. volume id of the depicted session. .TP \fB\-print_size\fR Print the foreseeable consumption of 2048 byte blocks -by next -commit. This can last a while as a -commit gets +by next \-commit. This can last a while as a \-commit gets prepared and only in last moment is revoked by this option. The result depends on several settings and also on the kind of output device. -If no -jidgo options are given and not command -as "mkisofs" was used, -then -padding (300 kB by default) is not counted as part of the image size. +If no \-jidgo options are given and not command \-as "mkisofs" was used, +then \-padding (300 kB by default) is not counted as part of the image size. .TP \fB\-tell_media_space\fR Print available space on output media and the free space after -subtracting already foreseeable consumption by next -commit. +subtracting already foreseeable consumption by next \-commit. .TP \fB\-pvd_info\fR Print various id strings which can be found in loaded ISO images. Some of -them may be changed by options like -volid or -publisher. For these -ids -pvd_info reports what would be written with the next -commit. +them may be changed by options like \-volid or \-publisher. For these +ids \-pvd_info reports what would be written with the next \-commit. .TP .B Navigation in ISO image and disk filesystem: .TP @@ -3094,7 +3094,7 @@ This is prepended to iso_rr_paths which do not begin with '/'. It is possible to set the working directory to a path which does not exist yet in the ISO image. The necessary parent directories will be created when the first file object is inserted into that virtual directory. -Use -mkdir if you want to enforce the existence of the directory already at +Use \-mkdir if you want to enforce the existence of the directory already at first insertion. .TP \fB\-cdx\fR disk_path @@ -3111,58 +3111,58 @@ Tell the current working directory in the local filesystem. .TP \fB\-ls\fR iso_rr_pattern [***] List files in the ISO image which match shell patterns -(i.e. with wildcards '*' '?' '[a-z]'). +(i.e. with wildcards '*' '?' '[a\-z]'). If a pattern does not begin with '/' then it is compared with addresses -relative to -cd. +relative to \-cd. .br Directories are listed by their content rather than as single file item. .br -Pattern expansion may be disabled by command -iso_rr_pattern. +Pattern expansion may be disabled by command \-iso_rr_pattern. .TP \fB\-lsd\fR iso_rr_pattern [***] -Like -ls but listing directories as themselves and not by their content. -This resembles shell command ls -d. +Like \-ls but listing directories as themselves and not by their content. +This resembles shell command ls \-d. .TP \fB\-lsl\fR iso_rr_pattern [***] -Like -ls but also list some of the file attributes. -The output format resembles shell command ls -ln. +Like \-ls but also list some of the file attributes. +The output format resembles shell command ls \-ln. .br -If the file has non-trivial ACL, then a '+' is appended to the permission info. +If the file has non\-trivial ACL, then a '+' is appended to the permission info. If the file is hidden, then 'I' for "iso_rr", 'J' for "joliet", resp. 'H' for "on" gets appended. Together with ACL it is 'i', 'j', resp. 'h'. .TP \fB\-lsdl\fR iso_rr_pattern [***] -Like -lsd but also list some of the file attributes. -The output format resembles shell command ls -dln. +Like \-lsd but also list some of the file attributes. +The output format resembles shell command ls \-dln. .TP \fB\-lsx\fR disk_pattern [***] List files in the local filesystem which match shell patterns. Patterns which -do not begin with '/' are used relative to -cdx. +do not begin with '/' are used relative to \-cdx. .br Directories are listed by their content rather than as single file item. .br -Pattern expansion may be disabled by command -disk_pattern. +Pattern expansion may be disabled by command \-disk_pattern. .TP \fB\-lsdx\fR disk_pattern [***] -Like -lsx but listing directories as themselves and not by their content. -This resembles shell command ls -d. +Like \-lsx but listing directories as themselves and not by their content. +This resembles shell command ls \-d. .TP \fB\-lslx\fR disk_pattern [***] -Like -lsx but also listing some of the file attributes. -Output format resembles shell command ls -ln. +Like \-lsx but also listing some of the file attributes. +Output format resembles shell command ls \-ln. .TP \fB\-lsdlx\fR disk_pattern [***] -Like -lsdx but also listing some of the file attributes. -Output format resembles shell command ls -dln. +Like \-lsdx but also listing some of the file attributes. +Output format resembles shell command ls \-dln. .TP \fB\-getfacl\fR iso_rr_pattern [***] Print the access permissions of the given files in the ISO image using the format of shell command getfacl. If a file has no ACL then it gets fabricated -from the -chmod settings. A file may have a real ACL if it was introduced into -the ISO image while option -acl was set to "on". +from the \-chmod settings. A file may have a real ACL if it was introduced into +the ISO image while option \-acl was set to "on". .TP \fB\-getfacl_r\fR iso_rr_pattern [***] -Like -gefacl but listing recursively the whole file trees underneath eventual +Like \-gefacl but listing recursively the whole file trees underneath eventual directories. .TP \fB\-getfattr\fR iso_rr_pattern [***] @@ -3170,71 +3170,71 @@ Print the xattr of the given files in the ISO image. If a file has no such xattr then noting is printed for it. .TP \fB\-getfattr_r\fR iso_rr_pattern [***] -Like -gefattr but listing recursively the whole file trees underneath eventual +Like \-gefattr but listing recursively the whole file trees underneath eventual directories. .TP \fB\-du\fR iso_rr_pattern [***] Recursively list size of directories and files in the ISO image which match one of the patterns. -similar to shell command du -k. +similar to shell command du \-k. .TP \fB\-dus\fR iso_rr_pattern [***] List size of directories and files in the ISO image which match one of the patterns. -Similar to shell command du -sk. +Similar to shell command du \-sk. .TP \fB\-dux\fR disk_pattern [***] Recursively list size of directories and files in the local filesystem -which match one of the patterns. Similar to shell command du -k. +which match one of the patterns. Similar to shell command du \-k. .TP \fB\-dusx\fR disk_pattern [***] List size of directories and files in the local filesystem which match one of the patterns. -Similar to shell command du -sk. +Similar to shell command du \-sk. .TP \fB\-findx\fR disk_path [-name pattern] [-type t] [-exec action [params]] -- -Like -find but operating on local filesystem and not on the ISO image. -This is subject to the settings of -follow. +Like \-find but operating on local filesystem and not on the ISO image. +This is subject to the settings of \-follow. .br --findx accepts the same -type arguments as -find. Additionally it recognizes +\-findx accepts the same \-type arguments as \-find. Additionally it recognizes type "mountpoint" (or "m") which matches subdirectories which reside on a different device than their parent. It never matches the disk_path -given as start address for -findx. +given as start address for \-findx. .br --findx accepts the -exec actions as does -find. But except the following few +\-findx accepts the \-exec actions as does \-find. But except the following few actions it will always perform action "echo". .br \fBin_iso\fR reports the path if its counterpart exists in the ISO image. -For this the disk_path of the -findx command gets replaced +For this the disk_path of the \-findx command gets replaced by the iso_rr_path given as parameter. .br -E.g.: -findx /home/thomas -exec in_iso /thomas_on_cd -- +E.g.: \-findx /home/thomas \-exec in_iso /thomas_on_cd \-\- .br \fBnot_in_iso\fR reports the path if its counterpart does not exist in the ISO image. The report format is the same as with command --compare. +\-compare. .br \fBadd_missing\fR iso_rr_path_start adds the counterpart if it does not yet -exist in the ISO image and marks it for "rm_merge" as non-removable. +exist in the ISO image and marks it for "rm_merge" as non\-removable. .br -E.g.: -findx /home/thomas -exec add_missing /thomas_on_cd -- +E.g.: \-findx /home/thomas \-exec add_missing /thomas_on_cd \-\- .br \fBis_full_in_iso\fR reports if the counterpart in the ISO image -contains files. To be used with -type "m" to report mount points. +contains files. To be used with \-type "m" to report mount points. .br \fBempty_iso_dir\fR deletes all files from the counterpart -in the ISO image. To be used with -type "m" to truncate mount points. +in the ISO image. To be used with \-type "m" to truncate mount points. .br \fBestimate_size\fR prints a lower and an upper estimation of the number of blocks which the found files together will occupy in the emerging ISO image. This does not account for the superblock, -for the directories in the -findx path, or for image padding. +for the directories in the \-findx path, or for image padding. .TP \fB\-compare\fR disk_path iso_rr_path Compare attributes and eventual data file content of a fileobject in the @@ -3250,18 +3250,18 @@ Both to the result channel. In case of no differences no result lines are emitted. .TP \fB\-compare_r\fR disk_path iso_rr_path -Like -compare but working recursively. I.e. all file objects below both +Like \-compare but working recursively. I.e. all file objects below both addresses get compared whether they have counterparts below the other address and whether both counterparts match. .TP \fB\-compare_l\fR disk_prefix iso_rr_prefix disk_path [***] -Perform -compare_r with each of the disk_path arguments. iso_rr_path will be +Perform \-compare_r with each of the disk_path arguments. iso_rr_path will be composed from disk_path by replacing disk_prefix by iso_rr_prefix. .TP \fB\-show_stream\fR iso_rr_path [***] Display the content stream chain of data files in the ISO image. The chain consists of the iso_rr_name and one or more streams, separated by " < " marks. -A stream consists of one or more texts eventually in ''-quotation marks, +A stream consists of one or more texts eventually in ''\-quotation marks, eventually separated by ":" characters. The first text describes the stream type, the following ones describe its individual properties. Frequently used types are: @@ -3270,7 +3270,7 @@ Frequently used types are: .br image:'iso_rr_path' for ISO image file objects. .br - cout:'disk_path offset count' for -cut_out files. + cout:'disk_path offset count' for \-cut_out files. .br extf:'filter_name' for external filters. .br @@ -3279,7 +3279,7 @@ Example: '/abc/xyz.gz' < extf:'gzip' < disk:'/home/me/x' .TP \fB\-show_stream_r\fR iso_rr_path [***] -Like -show_stream but working recursively. +Like \-show_stream but working recursively. .TP .B Evaluation of readability and recovery: .PP @@ -3293,7 +3293,7 @@ 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. .br -By option -md5 checksums may get recorded with data files and whole +By option \-md5 checksums may get recorded with data files and whole sessions. These checksums are reachable only via indev and a loaded image. They work independently of the media type and can detect transmission errors. .TP @@ -3303,33 +3303,33 @@ disk file, and finally report about the encountered quality. Several options may be used to modify the default behavior. .br The options given with this command override the default settings which -may have been changed by option -check_media_defaults. See there for a +may have been changed by option \-check_media_defaults. See there for a description of options. .br The result list tells intervals of 2 KiB blocks with start address, number of blocks and quality. Qualities which begin with "+" are -supposed to be valid readable data. Qualities with "-" are unreadable or +supposed to be valid readable data. Qualities with "\-" are unreadable or corrupted data. "0" indicates qualities which are not covered by the check run or are regularly allowed to be unreadable (e.g. gaps between tracks). .br Alternatively it is possible to report damaged files rather than blocks. .br -If -md5 is "on" then the default mode what=tracks looks out for libisofs +If \-md5 is "on" then the default mode what=tracks looks out for libisofs checksum tags for the ISO session data and eventually checks them against the checksums computed from the data stream. .TP \fB\-check_media_defaults\fR [option [option ...]] -- -Preset options for runs of -check_media, -extract_cut and best_effort -file extraction. Eventual options given with -check_media will override the -preset options. -extract_cut will override some options automatically. +Preset options for runs of \-check_media, \-extract_cut and best_effort +file extraction. Eventual options given with \-check_media will override the +preset options. \-extract_cut will override some options automatically. .br An option consists of a keyword, a "=" character, and a value. Options may override each other. So their sequence matters. .br The default setting at program start is: .br -use=indev what=tracks min_lba=-1 max_lba=-1 retry=default +use=indev what=tracks min_lba=\-1 max_lba=\-1 retry=default .br time_limit=28800 item_limit=100000 data_to='' event=ALL .br @@ -3341,13 +3341,13 @@ bad_limit=valid slow_limit=1.0 chunk_size=0s .br Option "reset=now" restores these startup defaults. .br -Non-default options are: +Non\-default options are: .br \fBreport="files"\fR lists the files which use damaged blocks (not with use=outdev). -The format is like with find -exec report_damage. +The format is like with find \-exec report_damage. Note that a MD5 session mismatch marks all files of the session as damaged. -If finer distinction is desired, perform -md5 off before -check_media. +If finer distinction is desired, perform \-md5 off before \-check_media. .br \fBreport="blocks_files"\fR first lists damaged blocks and then affected files. @@ -3386,11 +3386,11 @@ gives the number of seconds after which the scan shall be aborted. This is useful for unattended scanning of media which may else overwork the drive in its effort to squeeze out some readable blocks. Abort may be delayed by the drive gnawing on the last single read operation. -Value -1 means unlimited time. +Value \-1 means unlimited time. .br \fBitem_limit=number\fR gives the number of report list items after which to abort. -Value -1 means unlimited item number. +Value \-1 means unlimited item number. .br \fBdata_to=disk_path\fR copies the valid blocks to the given file. @@ -3427,7 +3427,7 @@ 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 start address of the session to be copied. In this case it is not necessary to -have an -indev and a loaded image. ":force" may be appended after the number. +have an \-indev and a loaded image. ":force" may be appended after the number. .br \fBbad_limit=threshold\fR sets the highest quality which shall be considered as damage. @@ -3446,11 +3446,11 @@ This gets rounded down to full blocks of 2048 bytes. 0 means automatic size. Compare the data content of the given files in the loaded image with their recorded MD5 checksums, if there are any. In case of any mismatch an event of the given severity is issued. It may then be handled by appropriate settings of -options -abort_on or -return_with which both can cause non-zero exit values +options \-abort_on or \-return_with which both can cause non\-zero exit values of the program run. Severity ALL suppresses that event. .br This option reports match and mismatch of data files to the result channel. -Non-data files cause NOTE events. There will also be UPDATE events from +Non\-data files cause NOTE events. There will also be UPDATE events from data reading. .br If no iso_rr_path is given then the whole loaded session is compared with its @@ -3458,20 +3458,20 @@ MD5 sum. Be aware that this covers only one session and not the whole image if there are older sessions. .TP \fB\-check_md5_r\fR severity iso_rr_path [***] -Like -check_md5 but checking all data files underneath the given paths. +Like \-check_md5 but checking all data files underneath the given paths. Only mismatching data files will be reported. .TP .B osirrox ISO-to-disk restore options: .PP Normally xorriso only writes to disk files which were given as stdio: -pseudo-drives or as log files. +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. .br -Disk file exclusions by -not_mgt, -not_leaf, -not_paths apply. -If disk file objects already exist then the settings of -overwrite and --reassure apply. But -overwrite "on" only triggers the behavior -of -overwrite "nondir". I.e. directories cannot be deleted. +Disk file exclusions by \-not_mgt, \-not_leaf, \-not_paths apply. +If disk file objects already exist then the settings of \-overwrite and +\-reassure apply. But \-overwrite "on" only triggers the behavior +of \-overwrite "nondir". I.e. directories cannot be deleted. .br Access permissions of files in the ISO image do not restrict restoring. The directory permissions on disk have to allow rwx. @@ -3479,8 +3479,8 @@ The directory permissions on disk have to allow rwx. \fB\-osirrox\fR "on"|"device_files"|"off"|"banned"|[:option:...] Setting "off" disables disk filesystem manipulations. This is the default unless the program was started with leafname "osirrox". Elsewise -the capability to restore files can be enabled explicitly by -osirrox "on". -It can be irrevocably disabled by -osirrox "banned". +the capability to restore files can be enabled explicitly by \-osirrox "on". +It can be irrevocably disabled by \-osirrox "banned". .br To enable restoring of special files by "device_files" is potentially dangerous. @@ -3495,7 +3495,7 @@ restored. .br Option "concat_split_on" is default. It enables restoring of split file directories as data files if the directory contains a complete collection -of -cut_out part files. With option "concat_split_off" such directories are +of \-cut_out part files. With option "concat_split_off" such directories are handled like any other ISO image directory. .br Option "auto_chmod_off" is default. If "auto_chmod_on" is set then access @@ -3505,8 +3505,8 @@ granting rwx permission to the owner. .br 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 and it needs --osirrox option auto_chmod_on in order to extract directories which offer no +\-temp_mem_limit. It does not preserve directory mtime and it needs +\-osirrox option auto_chmod_on in order to extract directories which offer no write permission. Default is "sort_lba_off". .br Option "o_excl_on" is the default unless the program was started with leafname @@ -3515,12 +3515,12 @@ use by other libburn programs. Option "o_excl_off" allows on GNU/Linux to access such drives. Drives which get acquired while "o_excl_off" will refuse to get blanked, formatted, written, or ejected. But be aware that even harmless inquiries can spoil -ongoing burns of CD-R[W] and DVD-R[W]. +ongoing burns of CD\-R[W] and DVD\-R[W]. .TP \fB\-extract\fR iso_rr_path disk_path Copy the file objects at and underneath iso_rr_path to their corresponding addresses at and underneath disk_path. -This is the inverse of -map or -update_r. +This is the inverse of \-map or \-update_r. .br If iso_rr_path is a directory and disk_path is an existing directory then both trees will be merged. Directory attributes get extracted only if the disk @@ -3532,63 +3532,63 @@ As many attributes as possible are copied together with restored file objects. .TP \fB\-extract_single\fR iso_rr_path disk_path -Like -extract, but if iso_rr_path is a directory then its sub tree gets not +Like \-extract, but if iso_rr_path is a directory then its sub tree gets not restored. .TP \fB\-extract_l\fR iso_rr_prefix disk_prefix iso_rr_path [***] -Perform -extract with each of the iso_rr_path arguments. disk_path will be +Perform \-extract with each of the iso_rr_path arguments. disk_path will be composed from iso_rr_path by replacing iso_rr_prefix by disk_prefix. .TP \fB\-extract_cut\fR iso_rr_path byte_offset byte_count disk_path Copy a byte interval from a data file out of an ISO image into a newly created disk file. The main purpose for this is to allow handling of large files if they -are not supported by mount -t iso9660 and if the reading system is unable +are not supported by mount \-t iso9660 and if the reading system is unable to buffer them as a whole. .br If the data bytes of iso_rr_path are stored in the loaded ISO image, and no filter is applied, -and byte_offset is a multiple of 2048, then a special run of -check_media +and byte_offset is a multiple of 2048, then a special run of \-check_media is performed. It may be quicker and more rugged than the general reading method. .TP \fB\-cpx\fR iso_rr_path [***] disk_path Copy single leaf file objects from the ISO image to the address given by disk_path. If more then one iso_rr_path is given then -disk_path must be a directory or non-existent. In the latter case it gets +disk_path must be a directory or non\-existent. In the latter case it gets created and the extracted files get installed in it with the same leafnames. .br Missing directory components in disk_path will get created, if possible. .br -Directories are allowed as iso_rr_path only with -osirrox "concat_split_on" -and only if they actually represent a complete collection of -cut_out split +Directories are allowed as iso_rr_path only with \-osirrox "concat_split_on" +and only if they actually represent a complete collection of \-cut_out split file parts. .TP \fB\-cpax\fR iso_rr_path [***] disk_path -Like -cpx but restoring mtime, atime as in ISO image and trying to set +Like \-cpx but restoring mtime, atime as in ISO image and trying to set ownership and group as in ISO image. .TP \fB\-cp_rx\fR iso_rr_path [***] disk_path -Like -cpx but also extracting whole directory trees from the ISO image. +Like \-cpx but also extracting whole directory trees from the ISO image. .br -The resulting disk paths are determined as with shell command cp -r : +The resulting disk paths are determined as with shell command cp \-r : If disk_path is an existing directory then the trees will be inserted or merged underneath this directory and will keep their leaf names. The ISO directory "/" has no leaf name and thus gets mapped directly to disk_path. .TP \fB\-cp_rax\fR iso_rr_path [***] disk_path -Like -cp_rx but restoring mtime, atime as in ISO image and trying to set +Like \-cp_rx but restoring mtime, atime as in ISO image and trying to set ownership and group as in ISO image. .TP \fB\-paste_in\fR iso_rr_path disk_path byte_offset byte_count Read the content of a ISO data file and write it into a data file on disk beginning at the byte_offset. Write at most byte_count bytes. -This is the inverse of option -cut_out. +This is the inverse of option \-cut_out. .TP \fB\-mount\fR drive entity id path -Produce the same line as -mount_cmd and then execute it as external program run -after giving up the depicted drive. See also -mount_opts. -This demands -osirrox to be enabled and normally will succeed only for the +Produce the same line as \-mount_cmd and then execute it as external program run +after giving up the depicted drive. See also \-mount_opts. +This demands \-osirrox to be enabled and normally will succeed only for the superuser. For safety reasons the mount program is only executed if it is reachable as /bin/mount or /sbin/mount. .TP @@ -3608,13 +3608,13 @@ depicted by the personality word. Personality "\fBmkisofs\fR" accepts the options listed with: .br - -as mkisofs -help -- + \-as mkisofs \-help \-\- .br -Among them: -R (always on), -r, -J, -o, -M, -C, -dir-mode, -file-mode, --path-list, -m, -exclude-list, --f, -print-size, -pad, -no-pad, -V, -v, -version, -graft-points, -z, --no-emul-boot, -b, -c, -boot-info-table, -boot-load-size, -input-charset, -G, --output-charset, -U, -hide, -hide-joliet, -hide-list, -hide-joliet-list, +Among them: \-R (always on), \-r, \-J, \-o, \-M, \-C, \-dir\-mode, \-file\-mode, +\-path\-list, \-m, \-exclude\-list, +\-f, \-print\-size, \-pad, \-no\-pad, \-V, \-v, \-version, \-graft\-points, \-z, +\-no\-emul\-boot, \-b, \-c, \-boot\-info\-table, \-boot\-load\-size, \-input\-charset, \-G, +\-output\-charset, \-U, \-hide, \-hide\-joliet, \-hide\-list, \-hide\-joliet\-list, file paths and pathspecs. A lot of options are not supported and lead to failure of the mkisofs emulation. Some are ignored, but better do not rely on this tolerance. @@ -3623,96 +3623,96 @@ 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. .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. --pacifier gets set to "mkisofs" if files are added to the image. +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 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 +\-graft\-points is equivalent to \-pathspecs on. Note that pathspecs without "=" +are interpreted differently than with xorriso option \-add. Directories get merged with the root directory of the ISO image, other filetypes get mapped into that root directory. .br 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 +"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. -Directories and symbolic links are no valid -o targets. +is chosen by xorriso 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 +Writing to stdout is possible only if \-as "mkisofs" was among the start arguments or if other start arguments pointed the output drive to standard output. .br --print-size inhibits automatic image production at program end. This ban is +\-print\-size inhibits automatic image production at program end. This ban is lifted only if the pending image changes get discarded. .br -Eventual padding is counted as part of the ISO image if not option --emul-toc +Eventual padding is counted as part of the ISO image if not option \-\-emul\-toc is given. .br -If no -iso-level is given, then level 1 is chosen when the first file or +If no \-iso\-level is given, then level 1 is chosen when the first file or 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. +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 -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", +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 "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 . +\-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 . .br -Not original mkisofs options are --quoted_path_list , ---hardlinks , --acl , ---xattr , --md5 , --stdio_sync . +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", e.g. -acl "on". -Explicit arguments are expected by --stdio_sync -and --scdbackup_tag. +same name and hardcoded argument "on", e.g. \-acl "on". +Explicit arguments are expected by \-\-stdio_sync +and \-\-scdbackup_tag. .br -The capability to preserve multi-session history on overwriteable media -gets disabled by default. It can be enabled by using --emul-toc -with the first session. See -compliance no_emul_toc. +The capability to preserve multi\-session history on overwriteable media +gets disabled by default. It can be enabled by using \-\-emul\-toc +with the first session. See \-compliance no_emul_toc. .br ---sort-weight gets as arguments a number and an iso_rr_path. +\-\-sort\-weight gets as arguments a number and an iso_rr_path. The number becomes the LBA sorting weight of regular file iso_rr_path or of all regular files underneath directory iso_rr_path. -(See -find -exec sort_weight). +(See \-find \-exec sort_weight). .br -Adopted from grub-mkisofs are --protective-msdos-label -(see -boot_image grub partition_table=on) and ---modification-date=YYYYMMDDhhmmsscc -(see -volume_date uuid). For EFI bootable GRUB boot images use ---efi-boot. -It performs -boot_image grub efi_path= surrounded by two --boot_image "any" "next". -Alternative option -e from Fedora genisoimage sets bin_path and +Adopted from grub\-mkisofs are \-\-protective\-msdos\-label +(see \-boot_image grub partition_table=on) and +\-\-modification\-date=YYYYMMDDhhmmsscc +(see \-volume_date uuid). For EFI bootable GRUB boot images use +\-\-efi\-boot. +It performs \-boot_image grub efi_path= surrounded by two +\-boot_image "any" "next". +Alternative option \-e from Fedora genisoimage sets bin_path and platform_id for EFI, but performs no "next". .br -For MBR bootable ISOLINUX images there is -isohybrid-mbr FILE, where +For MBR bootable ISOLINUX images there is \-isohybrid\-mbr FILE, where FILE is one of the Syslinux files mbr/isohdp[fp]x*.bin . Use this -instead of -G to apply the effect of -boot_image isolinux partition_table=on. +instead of \-G to apply the effect of \-boot_image isolinux partition_table=on. .br ---boot-catalog-hide is -boot_image any cat_hidden=on. +\-\-boot\-catalog\-hide is \-boot_image any cat_hidden=on. .br --mips-boot is the same as -boot_image any mips_path= . +\-mips\-boot is the same as \-boot_image any mips_path= . .br --mipsel-boot leads to mipsel_path= . +\-mipsel\-boot leads to mipsel_path= . .br --partition_offset number is --boot_image any partition_offset=number. +\-partition_offset number is +\-boot_image any partition_offset=number. .br -Option -append_partition is supported. +Option \-append_partition is supported. .br --untranslated_name_len number is --compliance untranslated_name_len=number. +\-untranslated_name_len number is +\-compliance untranslated_name_len=number. .br ---old-empty is -compliance old_empty. +\-\-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 xorriso option \-jigdo. See the "Alias:" names there for the meaning of the genisoimage options. .br @@ -3720,31 +3720,31 @@ Personalities "\fBxorrisofs\fR", "\fBgenisoimage\fR", and "\fBgenisofs\fR" are aliases for "mkisofs". .br 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 "--" +"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. .br ---no_rc as first argument of such a program start +\-\-no_rc as first argument of such a program start prevents interpretation of startup files. See section FILES below. .br Personality "\fBcdrecord\fR" accepts the options listed with: .br - -as cdrecord -help -- + \-as cdrecord \-help \-\- .br -Among them: -v, dev=, speed=, blank=, fs=, -eject, -atip, padsize=, tsize=, --isosize, -multi, -msinfo, --grow_overwriteable_iso, +Among them: \-v, dev=, speed=, blank=, fs=, \-eject, \-atip, padsize=, tsize=, +\-isosize, \-multi, \-msinfo, \-\-grow_overwriteable_iso, write_start_address=, -track source file path or "-" for standard input as track source. +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 xorriso. .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 -closing is applicable and not option -multi is present. +closing is applicable and not option \-multi is present. .br An eventually acquired input drive is given up. This is only allowed if no image changes are pending. @@ -3752,14 +3752,14 @@ 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. .br -If a track source is given, then an automatic -commit happens at the end of +If a track source is given, then an automatic \-commit happens at the end of the "cdrecord" option list. .br ---grow_overwriteable_iso -enables emulation of multi-session on overwriteable -media. To enable emulation of a TOC, the first session needs -C 0,32 with --as mkisofs (but no -M) and --grow_overwriteable_iso -write_start_address=32s with -as cdrecord. +\-\-grow_overwriteable_iso +enables emulation of multi\-session on overwriteable +media. To enable emulation of a TOC, the first session needs \-C 0,32 with +\-as mkisofs (but no \-M) and \-\-grow_overwriteable_iso +write_start_address=32s with \-as cdrecord. .br A much more elaborate libburn based cdrecord emulator is the program cdrskin. .br @@ -3767,12 +3767,12 @@ Personalites "\fBxorrecord\fR", "\fBwodim\fR", and "\fBcdrskin\fR" are aliases for "cdrecord". .br If xorriso is started with one of the leafnames "xorrecord", "cdrskin", -"cdrecord", or "wodim", then it automatically prepends -as "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. +style until "\-\-" is encountered and an eventual commit happens. From then on, options are interpreted as xorriso options. .br ---no_rc as first argument of such a program start +\-\-no_rc as first argument of such a program start prevents interpretation of xorriso startup files. See section FILES below. .TP \fB\-read_mkisofsrc\fR @@ -3781,11 +3781,11 @@ Try one by one to open for reading: .br On success interpret the file content as of man mkisofs CONFIGURATION, and end this command. Do not try further files. -The last address is used only if start argument 0 has a non-trivial dirname. +The last address is used only if start argument 0 has a non\-trivial dirname. .br The reader currently interprets the following NAME=VALUE pairs: -APPI (-application_id) , PUBL (-publisher) , SYSI (-system_id) , -VOLI (-volid) , VOLS (-volset_id) +APPI (\-application_id) , PUBL (\-publisher) , SYSI (\-system_id) , +VOLI (\-volid) , VOLS (\-volset_id) .br Any other lines will be silently ignored. .TP @@ -3807,7 +3807,7 @@ nn% done, estimate finish Tue Jul 15 20:13:28 2008 .TP \fB\-scdbackup_tag\fR list_path record_name Set the parameter "name" for a scdbackup checksum record. -It will be appended in an scdbackup checksum tag to the -md5 session tag if +It will be appended in an scdbackup checksum tag to the \-md5 session tag if the image starts at LBA 0. This is the case if it gets written as first session onto a sequential media, or piped into a program, named pipe or character device. @@ -3853,20 +3853,20 @@ Modes: .br long_history like long plus history lines .br -Filters begin with '-' and are compared literally against the -output lines of -status:long_history. A line is put out only +Filters begin with '\-' and are compared literally against the +output lines of \-status:long_history. A line is put out only if its start matches the filter text. No wildcards. .TP \fB\-status_history_max\fR number -Set maximum number of history lines to be reported with -status "long_history". +Set maximum number of history lines to be reported with \-status "long_history". .TP \fB\-list_delimiter\fR word -Set the list delimiter to be used instead of "--". +Set the list delimiter to be used instead of "\-\-". It has to be a single word, must not be empty, not longer than 80 characters, and must not contain quotation marks. .br -For brevity the list delimiter is referred as "--" +For brevity the list delimiter is referred as "\-\-" throughout this text. .TP \fB\-backslash_codes\fR "on"|"off"|mode[:mode] @@ -3878,9 +3878,9 @@ text output. If enabled the following translations apply: .br \\n=linefeed(012) \\r=carriage_return(015) \\t=tab(011) .br - \\v=vtab(013) \\\\=backslash(134) \\[0-7][0-7][0-7]=octal_code + \\v=vtab(013) \\\\=backslash(134) \\[0\-7][0\-7][0\-7]=octal_code .br - \\x[0-9a-f][0-9a-f]=hex_code \\cC=control-C + \\x[0\-9a\-f][0\-9a\-f]=hex_code \\cC=control\-C .br Translations can occur with quoted input in 3 modes: .br @@ -3937,24 +3937,24 @@ Mode can either be "plain" or "marked". The latter causes marker lines which give the time of log start, burn session start, burn session end, log end or program end. In mode "plain", only the file paths are logged. .br -If path is "-" or "-R" then the log is directed to the result channel. -Path "-I" directs it to the info message channel. Any text that does not -begin with "-" is used as path for a file to append the log lines. +If path is "\-" or "\-R" then the log is directed to the result channel. +Path "\-I" directs it to the info message channel. Any text that does not +begin with "\-" is used as path for a file to append the log lines. .br Problematic files can be recorded multiple times during one program run. If the program run aborts then the list might not be complete because some input file arguments might not have been processed at all. .br The errfile paths are transported as messages of very low severity "ERRFILE". -This transport becomes visible with -report_about "ALL". +This transport becomes visible with \-report_about "ALL". .TP \fB\-session_log\fR path If path is not empty it gives the address of a plain text file where a log record gets appended after each session. This log can be used to -determine the start_lba of a session for mount options -o sbsector= -resp. -s from date or volume id. +determine the start_lba of a session for mount options \-o sbsector= +resp. \-s from date or volume id. .br -Record format is: timestamp start_lba size volume-id +Record format is: timestamp start_lba size volume\-id .br The first three items are single words, the rest of the line is the volume id. .TP @@ -3963,9 +3963,9 @@ 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. .br -A special property of this option is that the first -scsi_log setting +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 xorriso begin. Only "\-scsi_log" with dash "\-" is recognized that way. .TP \fB\-end\fR .br @@ -3976,7 +3976,7 @@ Discard pending changes. End program immediately. .TP \fB#\fR any text Only in dialog or file execution mode, and only as first -non-whitespace in line: +non\-whitespace in line: Do not execute the line but eventually store it in history. .TP .B Support for frontend programs via stdin and stdout: @@ -3989,7 +3989,7 @@ line by a channel indicator: .br 'I:' for notes and error messages, .br - 'M:' for -mark texts. + 'M:' for \-mark texts. .br Next is a decimal number of which only bit 0 has a meaning for now. 0 means no newline at end of payload, 1 means that the newline character at @@ -4002,7 +4002,7 @@ Example: .TP \fB\-logfile\fR channel fileaddress 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. +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 @@ -4013,7 +4013,7 @@ was entered to the pager prompt. Use text as name of this program in subsequent messages .TP \fB\-prog_help\fR text -Use text as name of this program and perform -help. +Use text as name of this program and perform \-help. .br .SH EXAMPLES .SS @@ -4051,34 +4051,34 @@ Restore directory trees from a particular ISO session to disk 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 +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 -"base,sys_devices" and to give r-permission to user or group. +"base,sys_devices" and to give r\-permission to user or group. .br -$ xorriso -devices +$ xorriso \-devices .br -0 -dev '/dev/sr0' rwrw-- : '_NEC ' 'DVD_RW ND-4570A' +0 \-dev '/dev/sr0' rwrw\-\- : '_NEC ' 'DVD_RW ND\-4570A' .br -1 -dev '/dev/sr1' rwrw-- : 'HL-DT-ST' 'DVDRAM GSA-4082B' +1 \-dev '/dev/sr1' rwrw\-\- : 'HL\-DT\-ST' 'DVDRAM GSA\-4082B' .br -2 -dev '/dev/sr2' rwrw-- : 'PHILIPS ' 'SPD3300L' +2 \-dev '/dev/sr2' rwrw\-\- : 'PHILIPS ' 'SPD3300L' .SS .B Blank media and compose a new ISO image as batch run Aquire drive /dev/sr2, make media ready for writing a new image, fill the image with the files from hard disk directories /home/me/sounds and /home/me/pictures. .br -Because no -dialog "on" is given, the program will then end by writing the +Because no \-dialog "on" is given, the program will then end by writing the session to media. .br -$ xorriso -outdev /dev/sr2 \\ +$ xorriso \-outdev /dev/sr2 \\ .br - -blank as_needed \\ + \-blank as_needed \\ .br - -map /home/me/sounds /sounds \\ + \-map /home/me/sounds /sounds \\ .br - -map /home/me/pictures /pictures + \-map /home/me/pictures /pictures .br .br @@ -4088,15 +4088,15 @@ Reintroduce some wanted stuff. .br $ cd /home/me .br -$ xorriso -outdev /dev/sr2 \\ +$ xorriso \-outdev /dev/sr2 \\ .br - -blank as_needed \\ + \-blank as_needed \\ .br - -map /home/me/sounds /sounds \\ + \-map /home/me/sounds /sounds \\ .br - -map /home/me/pictures /pictures \\ + \-map /home/me/pictures /pictures \\ .br - -rm_r \\ + \-rm_r \\ .br /sounds/indecent \\ .br @@ -4104,15 +4104,15 @@ $ xorriso -outdev /dev/sr2 \\ .br /pictures/confidential \\ .br - -- \\ + \-\- \\ .br - -cd / \\ + \-cd / \\ .br - -add pictures/confidential/work* -- + \-add pictures/confidential/work* \-\- .br Note that '/pictures/*private*' is a pattern for iso_rr_paths while pictures/confidential/work* gets expanded by the shell -with addresses from the hard disk. Options -add and -map have different +with addresses from the hard disk. Options \-add and \-map have different argument rules but finally the same effect: they put files into the image. .SS .B A dialog session doing about the same @@ -4120,8 +4120,8 @@ argument rules but finally the same effect: they put files into the image. Some settings are already given as start argument. The other activities are done as dialog input. The pager gets set to 20 lines of 80 characters. .br -The drive is acquired by option -dev rather than -outdev in order to see -the message about its current content. By option -blank this content is +The drive is acquired by option \-dev rather than \-outdev in order to see +the message about its current content. By option \-blank this content is made ready for being overwritten and the loaded ISO image is made empty. .br In order to be able to eject the media, the session needs to be committed @@ -4178,92 +4178,92 @@ Change access permissions of directory /pictures/restricted. Add new directory trees /sounds and /movies. Burn to the same media, check whether the tree can be loaded, and eject. .br -$ xorriso -dev /dev/sr2 \\ +$ xorriso \-dev /dev/sr2 \\ .br - -rm_r /sounds -- \\ + \-rm_r /sounds \-\- \\ .br - -mv \\ + \-mv \\ .br /pictures/confidential \\ .br /pictures/restricted \\ .br - -- \\ + \-\- \\ .br - -chmod go-rwx /pictures/restricted -- \\ + \-chmod go\-rwx /pictures/restricted \-\- \\ .br - -map /home/me/prepared_for_dvd/sounds_dummy /sounds \\ + \-map /home/me/prepared_for_dvd/sounds_dummy /sounds \\ .br - -map /home/me/prepared_for_dvd/movies /movies \\ + \-map /home/me/prepared_for_dvd/movies /movies \\ .br - -commit -eject all + \-commit \-eject all .SS .B Copy modified ISO image from one media to another Load image from input drive. Do the same manipulations as in the previous example. Aquire output drive and blank it. Burn the modified image as first and only session to the output drive. .br -$ xorriso -indev /dev/sr2 \\ +$ xorriso \-indev /dev/sr2 \\ .br - -rm_r /sounds -- \\ + \-rm_r /sounds \-\- \\ .br ... .br - -outdev /dev/sr0 -blank as_needed \\ + \-outdev /dev/sr0 \-blank as_needed \\ .br - -commit -eject all + \-commit \-eject all .SS .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: .br -$ xorriso -outdev /dev/sr0 -blank as_needed \\ +$ xorriso \-outdev /dev/sr0 \-blank as_needed \\ .br - -map /home/me/ISOLINUX_prepared_tree / \\ + \-map /home/me/ISOLINUX_prepared_tree / \\ .br - -boot_image isolinux dir=/boot/isolinux + \-boot_image isolinux dir=/boot/isolinux .SS .B Change existing file name tree from ISO-8859-1 to UTF-8 This example assumes that the existing ISO image was written with character -set ISO-8859-1 but that the readers expected UTF-8. Now a new session with +set ISO\-8859\-1 but that the readers expected UTF\-8. Now a new session with the same files gets added with converted file names. In order to avoid any weaknesses of the local character set, this command -pretends that it uses already the final target set UTF-8. +pretends that it uses already the final target set UTF\-8. Therefore strange file names may appear in eventual messages which -will be made terminal-safe by option -backslash_codes. +will be made terminal\-safe by option \-backslash_codes. .br -$ xorriso -in_charset ISO-8859-1 -local_charset UTF-8 \\ +$ xorriso \-in_charset ISO\-8859\-1 \-local_charset UTF\-8 \\ .br - -out_charset UTF-8 -backslash_codes on -dev /dev/sr0 \\ + \-out_charset UTF\-8 \-backslash_codes on \-dev /dev/sr0 \\ .br - -alter_date m +0 / -- -commit -eject all + \-alter_date m +0 / \-\- \-commit \-eject all .SS .B Operate on storage facilities other than optical drives -Full read-write operation is possible with regular files and block devices: +Full read\-write operation is possible with regular files and block devices: .br -$ xorriso -dev /tmp/regular_file ... +$ xorriso \-dev /tmp/regular_file ... .br Paths underneath /dev normally need prefix "stdio:" .br -$ xorriso -dev stdio:/dev/sdb ... +$ 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. They allow to use /dev/sdb without prefix and protect disk /dev/sda from xorriso: .br - -drive_class banned /dev/sda* + \-drive_class banned /dev/sda* .br - -drive_class harmless /dev/sdb + \-drive_class harmless /dev/sdb .br -Other writeable file types are supported write-only: +Other writeable file types are supported write\-only: .br -$ xorriso -outdev /tmp/named_pipe ... +$ xorriso \-outdev /tmp/named_pipe ... .br -Among the write-only drives is standard output: +Among the write\-only drives is standard output: .br -$ xorriso -outdev - \\ +$ xorriso \-outdev \- \\ .br ... .br @@ -4272,7 +4272,7 @@ $ xorriso -outdev - \\ .B Burn an existing ISO image file to media Actually this works with any kind of data, not only ISO images: .br -$ xorriso -as cdrecord -v dev=/dev/sr0 blank=as_needed image.iso +$ xorriso \-as cdrecord \-v dev=/dev/sr0 blank=as_needed image.iso .SS .B Perform multi-session runs as of cdrtools traditions Between both processes there can be performed arbitrary transportation @@ -4280,19 +4280,19 @@ or filtering. .br The first session is written like this: .br -$ xorriso -as mkisofs prepared_for_iso/tree1 | \\ +$ xorriso \-as mkisofs prepared_for_iso/tree1 | \\ .br - xorriso -as cdrecord -v dev=/dev/sr0 blank=fast -multi -eject - + xorriso \-as cdrecord \-v dev=/dev/sr0 blank=fast \-multi \-eject \- .br -Follow-up sessions are written like this: +Follow\-up sessions are written like this: .br $ dd if=/dev/sr0 count=1 >/dev/null 2>&1 .br -$ m=$(xorriso -as cdrecord dev=/dev/sr0 -msinfo) +$ m=$(xorriso \-as cdrecord dev=/dev/sr0 \-msinfo) .br -$ xorriso -as mkisofs -M /dev/sr0 -C $m prepared_for_iso/tree2 | \\ +$ xorriso \-as mkisofs \-M /dev/sr0 \-C $m prepared_for_iso/tree2 | \\ .br - xorriso -as cdrecord -v dev=/dev/sr0 -waiti -multi -eject - + xorriso \-as cdrecord \-v dev=/dev/sr0 \-waiti \-multi \-eject \- .br Always eject the drive tray between sessions. The old sessions get read via /dev/sr0. Its device driver might not be aware @@ -4300,39 +4300,39 @@ 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 xorriso \-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. -Add cdrskin option --grow_overwriteable_iso -to all -as cdrecord runs -in order to enable multi-session emulation on overwriteable media. +This example works for multi\-session media only. +Add cdrskin option \-\-grow_overwriteable_iso +to all \-as cdrecord runs +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. +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. .br $ export MKISOFS="xorrisofs" .br -$ growisofs -Z /dev/dvd /some/files +$ growisofs \-Z /dev/dvd /some/files .br -$ growisofs -M /dev/dvd /more/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: .br -$ ln -s $(which xorriso) "$HOME/xorrisofs" +$ ln \-s $(which xorriso) "$HOME/xorrisofs" .br $ export MKISOFS="$HOME/xorrisofs" .br -One may quit mkisofs emulation by argument "--" and make +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 "-". +start with "\-o" but \-outdev must be set to "\-". So use "outdev" instead: .br -$ growisofs -Z /dev/dvd -- outdev - -update_r /my/files /files +$ growisofs \-Z /dev/dvd \-\- outdev \- \-update_r /my/files /files .br -$ growisofs -M /dev/dvd -- outdev - -update_r /my/files /files +$ growisofs \-M /dev/dvd \-\- outdev \- \-update_r /my/files /files .br growisofs has excellent burn capabilities with DVD and BD. It does not emulate session history on overwriteable media, though. @@ -4343,11 +4343,11 @@ do not abort prematurely but forcibly go on until the end of commands. .br $ xorriso ... \\ .br - -report_about UPDATE \\ + \-report_about UPDATE \\ .br - -return_with FAILURE 32 \\ + \-return_with FAILURE 32 \\ .br - -abort_on NEVER \\ + \-abort_on NEVER \\ .br ... .SS @@ -4396,23 +4396,23 @@ When done with writing the new session gets checked by its recorded MD5. .br $ xorriso \\ .br - -abort_on FATAL \\ + \-abort_on FATAL \\ .br - -for_backup -disk_dev_ino on \\ + \-for_backup \-disk_dev_ino on \\ .br - -assert_volid 'PROJECTS_MAIL_*' FATAL \\ + \-assert_volid 'PROJECTS_MAIL_*' FATAL \\ .br - -dev /dev/sr0 \\ + \-dev /dev/sr0 \\ .br - -volid PROJECTS_MAIL_"$(date '+%Y_%m_%d_%H%M%S')" \\ + \-volid PROJECTS_MAIL_"$(date '+%Y_%m_%d_%H%M%S')" \\ .br - -not_leaf '*.o' -not_leaf '*.swp' \\ + \-not_leaf '*.o' \-not_leaf '*.swp' \\ .br - -update_r /home/thomas/projects /projects \\ + \-update_r /home/thomas/projects /projects \\ .br - -update_r /home/thomas/personal_mail /personal_mail \\ + \-update_r /home/thomas/personal_mail /personal_mail \\ .br - -commit -toc -check_md5 FAILURE -- -eject all + \-commit \-toc \-check_md5 FAILURE \-\- \-eject all .br To be used several times on the same media, whenever an update of the two disk trees to the media is desired. Begin with blank media and start @@ -4422,14 +4422,14 @@ the old one. This makes sense if the full backup leaves substantial remaining capacity on media and if the expected changes are much smaller than the full backup. To apply zisofs compression to those data files which get newly copied from -the local filesystem, insert these options immediately before -commit : +the local filesystem, insert these options immediately before \-commit : .br - -hardlinks perform_update \\ + \-hardlinks perform_update \\ .br - -find / -type f -pending_data -exec set_filter --zisofs -- \\ + \-find / \-type f \-pending_data \-exec set_filter \-\-zisofs \-\- \\ .br -Options -disk_dev_ino and -for_backup depend on stable device and inode numbers -on disk. Without them, an update run may use -md5 "on" to match recorded MD5 +Options \-disk_dev_ino and \-for_backup depend on stable device and inode numbers +on disk. Without them, an update run may use \-md5 "on" to match recorded MD5 sums against the current file content on hard disk. This is usually much faster than the default which compares both contents directly. .br @@ -4439,40 +4439,40 @@ 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. -Used after -commit the following option prints the matching mount command for +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): .br - -mount_cmd "indev" "auto" "auto" /mnt + \-mount_cmd "indev" "auto" "auto" /mnt .br -Options -mount_cmd and -mount are also able to produce the mount commands for -older sessions in the table-of-content. E.g. as superuser: +Options \-mount_cmd and \-mount are also able to produce the mount commands for +older sessions in the table\-of\-content. E.g. as superuser: .br - # osirrox -mount /dev/sr0 "volid" '*2008_12_05*' /mnt + # osirrox \-mount /dev/sr0 "volid" '*2008_12_05*' /mnt .br .sp 1 -Above example produces a result similar to -root / -old-root / with mkisofs. -For getting the session trees accumulated in the new sessions, let all -update +Above example produces a result similar to \-root / \-old\-root / with mkisofs. +For getting the session trees accumulated in the new sessions, let all \-update commands use a common parent directory and clone it after updating is done: .br - -update_r /home/thomas/projects /current/projects \\ + \-update_r /home/thomas/projects /current/projects \\ .br - -update_r /home/thomas/personal_mail /current/personal_mail \\ + \-update_r /home/thomas/personal_mail /current/personal_mail \\ .br - -clone /current /"$(date '+%Y_%m_%d_%H%M%S')" \\ + \-clone /current /"$(date '+%Y_%m_%d_%H%M%S')" \\ .br The cloned tree will have a name like /2011_02_12_155700. .br .sp 1 -Sessions on multi-session media are separated by several MB of unused blocks. +Sessions on multi\-session media are separated by several MB of unused blocks. So with small sessions the payload capacity can become substantially lower than the overall media capacity. If the remaining space on media does not suffice for the next gap, the drive is supposed to close the media automatically. .br .sp 1 -\fBBetter do not use your youngest backup for -update_r\fR. +\fBBetter do not use your youngest backup for \-update_r\fR. Have at least two media which you use alternatingly. So only older backups get endangered by the new write operation, while the newest backup is stored safely on a different media. @@ -4484,63 +4484,63 @@ This is an alternative to mounting the media and using normal file operations. .br First check which backup sessions are on the media: .br -$ xorriso -outdev /dev/sr0 -toc +$ xorriso \-outdev /dev/sr0 \-toc .br Then load the desired session and copy the file trees to disk. Enable restoring of ACL, xattr and hard links. -Avoid to eventually create /home/thomas/restored without rwx-permission. +Avoid to eventually create /home/thomas/restored without rwx\-permission. .br -$ xorriso -for_backup \\ +$ xorriso \-for_backup \\ .br - -load volid 'PROJECTS_MAIL_2008_06_19*' \\ + \-load volid 'PROJECTS_MAIL_2008_06_19*' \\ .br - -indev /dev/sr0 \\ + \-indev /dev/sr0 \\ .br - -osirrox on:auto_chmod_on \\ + \-osirrox on:auto_chmod_on \\ .br - -chmod u+rwx / -- \\ + \-chmod u+rwx / \-\- \\ .br - -extract /open_source_projects \\ + \-extract /open_source_projects \\ .br /home/thomas/restored/open_source_projects \\ .br - -extract /personal_mail /home/thomas/restored/personal_mail \\ + \-extract /personal_mail /home/thomas/restored/personal_mail \\ .br - -rollback_end + \-rollback_end .br -The final command -rollback_end prevents an error message about the altered +The final command \-rollback_end prevents an error message about the altered image being discarded. .SS .B Try to retrieve blocks from a damaged media .br -$ xorriso -abort_on NEVER -indev /dev/sr0 \\ +$ xorriso \-abort_on NEVER \-indev /dev/sr0 \\ .br - -check_media time_limit=1800 report=blocks_files \\ + \-check_media time_limit=1800 report=blocks_files \\ .br - data_to="$HOME"/dvd_copy sector_map="$HOME"/dvd_copy.map -- + data_to="$HOME"/dvd_copy sector_map="$HOME"/dvd_copy.map \-\- .br -This can be repeated several times, eventually with -eject or with other --indev drives. See the human readable part of "$HOME"/dvd_copy.map for -addresses which can be used on "$HOME"/dvd_copy with mount option -o sbsector= -resp. -s. +This can be repeated several times, eventually with \-eject or with other +\-indev drives. See the human readable part of "$HOME"/dvd_copy.map for +addresses which can be used on "$HOME"/dvd_copy with mount option \-o sbsector= +resp. \-s. .SH FILES .SS .B Program alias names: .br Normal installation of xorriso creates three links or copies which by their -program name pre-select certain settings: +program name pre\-select certain settings: .br -\fBxorrisofs\fR starts xorriso with -as mkisofs emulation. +\fBxorrisofs\fR starts xorriso with \-as mkisofs emulation. .br -\fBxorrecord\fR starts xorriso with -as cdrecord emulation. +\fBxorrecord\fR starts xorriso 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 +\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 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 xorriso attempts on startup to read and execute lines from the following files: .br /etc/default/xorriso @@ -4552,15 +4552,15 @@ to read and execute lines from the following files: $HOME/.xorrisorc .br The files are read in the sequence given above, but none of them is required -to exist. The line format is described with command -options_from_file. +to exist. The line format is described with command \-options_from_file. .br If mkisofs emulation was enabled by program name "xorrisofs", "mkisofs", -"genisoimage", or "genisofs", then afterwards -read_mkisofsrc is performed, +"genisoimage", or "genisofs", then afterwards \-read_mkisofsrc is performed, which reads .mkisofsrc files. See there. .SS .B Runtime control files: .br -The default setting of -check_media abort_file= is: +The default setting of \-check_media abort_file= is: .br /var/opt/xorriso/do_abort_check_media .br @@ -4596,9 +4596,9 @@ MD5 checksums .SH AUTHOR Thomas Schmitt .br -for libburnia-project.org +for libburnia\-project.org .SH COPYRIGHT -Copyright (c) 2007 - 2011 Thomas Schmitt +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 diff --git a/xorriso/xorriso.texi b/xorriso/xorriso.texi index 2630f574..e99269f5 100644 --- a/xorriso/xorriso.texi +++ b/xorriso/xorriso.texi @@ -31,6 +31,8 @@ @c @@ , @{, @} will get stripped of their first @. @c Other lines which begin by "@" will be discarded. @c In lines not stemming from "@c man", "\" becomes "\\" +@c "-" which are not preceded by an uneven number of "\" will get +@c prepended one "\". @c @c @c man .\" Hey, EMACS: -*- nroff -*- @@ -44,7 +46,7 @@ @c man .\" First parameter, NAME, should be all caps @c man .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection @c man .\" other parameters are allowed: see man(7), man(1) -@c man .TH XORRISO 1 "Apr 22, 2011" +@c man .TH XORRISO 1 "May 13, 2011" @c man .\" Please adjust this date whenever revising the manpage. @c man .\" @c man .\" Some roff macros, for reference: