From 67836d972150ab06658bb16b494d943cfbb0c69c Mon Sep 17 00:00:00 2001 From: Thomas Schmitt Date: Fri, 24 Feb 2012 20:20:22 +0000 Subject: [PATCH] Some adjustments in xorriso man page --- xorriso/xorriso.1 | 63 +++++++-------- xorriso/xorriso.info | 182 +++++++++++++++++++++---------------------- xorriso/xorriso.texi | 63 +++++++-------- 3 files changed, 155 insertions(+), 153 deletions(-) diff --git a/xorriso/xorriso.1 b/xorriso/xorriso.1 index 38f1df41..accdf1b5 100644 --- a/xorriso/xorriso.1 +++ b/xorriso/xorriso.1 @@ -390,7 +390,7 @@ Most bootable GNU/Linux CDs are equipped with ISOLINUX or GRUB boot images. makes such an image bootable. For details see option \-boot_image. .br It is possible to make ISO images bootable from USB stick or other -hard\-disk\-like media by \-boot_image argument system_area= . This installs +hard\-disk\-like media by \-boot_image parameter 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 @@ -460,7 +460,7 @@ 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. +"\-\-" as parameter in a list of variable length. It is advised to reset the delimiter to "\-\-" immediately afterwards. .br @@ -469,7 +469,7 @@ throughout this text. .br The list delimiter is silently tolerated if it appears after the parameters of a command with a fixed list length. It is handled as normal text if it -appears among the arguments of such a command. +appears among the parameters of such a command. .PP \fBPattern expansion\fR converts a list of pattern words into a list of existing file addresses. @@ -480,7 +480,7 @@ 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. -Commands which may use pattern expansion all have variable argument +Commands which may use pattern expansion all have variable parameter lists which are marked in this man page by "[***]" rather than "[...]". .br Some other commands perform pattern matching unconditionally. @@ -974,7 +974,7 @@ to replace it. The commands in this section alter the ISO image and not the local filesystem. .TP \fB\-disk_pattern\fR "on"|"ls"|"off" -Set the pattern expansion mode for the disk_path arguments of several +Set the pattern expansion mode for the disk_path parameters of several commands which support this feature. .br Setting "off" disables this feature for all commands which are marked in this @@ -1042,7 +1042,7 @@ is a directory then its whole sub tree is inserted into the ISO image. 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 parameters. 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 @@ -1070,7 +1070,7 @@ 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 parameters. 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 @@ -1153,7 +1153,7 @@ 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. +parameters. .TP .B Settings for file insertion: .TP @@ -1229,12 +1229,12 @@ 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, +Read lines from disk_path and use each of them either as \-not_paths parameter, 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. +handled as one parameter for \-not_paths resp. \-not_leaf. .TP \fB\-follow\fR occasion[:occasion[...]] Enable or disable resolution of symbolic links and mountpoints under @@ -1350,7 +1350,7 @@ 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 -argument and their contents may not overlap. +parameter and their contents may not overlap. .TP .B File manipulations: .PP @@ -1359,7 +1359,7 @@ they stem from the loaded image or were newly inserted. .PP .TP \fB\-iso_rr_pattern\fR "on"|"ls"|"off" -Set the pattern expansion mode for the iso_rr_path arguments of several +Set the pattern expansion mode for the iso_rr_path parameters of several commands which support this feature. .br Setting "off" disables pattern expansion for all commands which are marked @@ -1390,9 +1390,9 @@ Delete empty directories. .TP \fB\-mv\fR iso_rr_path [***] iso_rr_path Rename the given file objects in the ISO tree to the last -argument in the list. Use the same rules as with shell command mv. +parameter in the list. Use the same rules as with shell command mv. .br -If pattern expansion is enabled and if the last argument contains wildcard +If pattern expansion is enabled and if the last parameter contains wildcard characters then it must match exactly one existing file address, or else the command fails with a FAILURE event. .TP @@ -1577,7 +1577,7 @@ Rather use: \-boot_image "any" "cat_hidden=on" 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 +If not used as last command in the line then the parameter list needs to get terminated by "\-\-". .br Tests are optional. If they are omitted then action is applied to all file @@ -1722,7 +1722,7 @@ prints file information like shell command ls \-dl. .br \fBcompare\fR performs command \-compare with the found file address as -iso_rr_path and the corresponding file address below its argument +iso_rr_path and the corresponding file address below its parameter disk_path_start. For this the iso_rr_path of the \-find command gets replaced by the disk_path_start. .br @@ -2507,7 +2507,7 @@ Define the handling of a 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 +Each \-boot_image command has two parameters: 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 @@ -3049,7 +3049,8 @@ file content stems from the loaded ISO image and is not filtered. .B Dialog mode control: .TP \fB\-dialog\fR "on"|"off"|"single_line" -Enable or disable to enter dialog mode after all arguments are processed. +Enable or disable to enter dialog mode after all program 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 @@ -3329,7 +3330,7 @@ Similar to shell command du \-sk. 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 parameters 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. @@ -3395,7 +3396,7 @@ 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 parameters. 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 [***] @@ -3686,7 +3687,7 @@ 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 parameters. 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 @@ -3820,15 +3821,15 @@ Not original mkisofs options are \-\-quoted_path_list , \-\-hardlinks , \-\-acl , \-\-xattr , \-\-md5 , \-\-stdio_sync . They work like the \fBxorriso\fR options with the -same name and hardcoded argument "on", e.g. \-acl "on". -Explicit arguments are expected by \-\-stdio_sync +same name and hardcoded parameter "on", e.g. \-acl "on". +Explicit parameters 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. .br -\-\-sort\-weight gets as arguments a number and an iso_rr_path. +\-\-sort\-weight gets as parameters 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). @@ -3874,7 +3875,7 @@ and "\fBgenisofs\fR" are aliases for "mkisofs". If \fBxorriso\fR is started with one of the leafnames "xorrisofs", "genisofs", "mkisofs", or "genisoimage", then it performs \-read_mkisofsrc and prepends -\-as "genisofs" to the command line arguments. +\-as "genisofs" to the program arguments. I.e. all arguments will be interpreted mkisofs style until "\-\-" is encountered. From then on, options are interpreted as \fBxorriso\fR options. @@ -3921,7 +3922,7 @@ are aliases for "cdrecord". .br If \fBxorriso\fR is started with one of the leafnames "xorrecord", "cdrskin", "cdrecord", or "wodim", then it automatically prepends \-as "cdrskin" -to the command line arguments. I.e. all arguments will be interpreted cdrecord +to the program arguments. I.e. all arguments will be interpreted cdrecord style until "\-\-" is encountered. From then on, options are interpreted as \fBxorriso\fR options. .br @@ -3975,13 +3976,13 @@ Program scdbackup_verify will recognize and verify tag resp. record. .TP \fB\-no_rc\fR .br -Only if used as first command line argument this option +Only if used as first program argument this option prevents reading and interpretation of startup files. See section FILES below. .TP \fB\-options_from_file\fR fileaddress Read quoted input from fileaddress and execute it like dialog lines. Empty lines and lines which begin by # are ignored. Normally one line -should hold one \fBxorriso\fR command and all its arguments. +should hold one \fBxorriso\fR command and all its parameters. Nevertheless lines may be concatenated by a trailing backslash. .br See also section "Command processing", paragraph "Quoted input". @@ -4123,7 +4124,7 @@ 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. +some input files 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". @@ -4179,7 +4180,7 @@ a blank follows the payload text. .br Example: .br - I:1: enter option and arguments : + I:1: enter option and parameters : .TP \fB\-logfile\fR channel fileaddress Copy output of a channel to the given file. Channel may be one of: "." for all @@ -4294,7 +4295,7 @@ $ xorriso \-outdev /dev/sr2 \\ Note that '/pictures/*private*' is a pattern for iso_rr_paths while pictures/confidential/work* gets expanded by the shell with addresses from the hard disk. Options \-add and \-map have different -argument rules but finally the same effect: they put files into the image. +parameter rules but finally the same effect: they put files into the image. .SS .B A dialog session doing about the same .br diff --git a/xorriso/xorriso.info b/xorriso/xorriso.info index 5e46a718..70f04702 100644 --- a/xorriso/xorriso.info +++ b/xorriso/xorriso.info @@ -345,7 +345,7 @@ 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. It is possible to make ISO images bootable from USB stick or other -hard-disk-like media by -boot_image argument system_area= . This +hard-disk-like media by -boot_image parameter system_area= . This installs a Master Boot Record which may get adjusted according to the needs of GRUB resp. ISOLINUX. An *MBR* contains boot code and a partition table. It does not hamper CDROM booting. The new MBR of a @@ -400,13 +400,13 @@ by "[...]" or "[***]") then it has to be terminated by either the *list delimiter*, or the end of argument list, or an end of an input line. 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 +changed by option -list_delimiter in order to allow "--" as parameter +in a list of variable length. It is advised to reset the delimiter to "--" immediately afterwards. For brevity the list delimiter is referred as "--" throughout this text. The list delimiter is silently tolerated if it appears after the parameters of a command with a fixed list length. It is handled as -normal text if it appears among the arguments of such a command. +normal text if it appears among the parameters of such a command. *Pattern expansion* converts a list of pattern words into a list of existing file addresses. Unmatched pattern words appear themselves in @@ -416,7 +416,7 @@ Pattern matching supports the usual shell parser wildcards '*' '?' literally. It is a property of some particular commands and not a general feature. It gets controlled by commands -iso_rr_pattern and -disk_pattern. -Commands which may use pattern expansion all have variable argument +Commands which may use pattern expansion all have variable parameter lists which are marked in this man page by "[***]" rather than "[...]". Some other commands perform pattern matching unconditionally. @@ -909,7 +909,7 @@ attempting to replace it. filesystem. -disk_pattern "on"|"ls"|"off" - Set the pattern expansion mode for the disk_path arguments of + Set the pattern expansion mode for the disk_path parameters of several commands which support this feature. Setting "off" disables this feature for all commands which are marked in this man page by "disk_path [***]" or "disk_pattern @@ -972,7 +972,7 @@ filesystem. not inserted. -map_l disk_prefix iso_rr_prefix disk_path [***] - Perform -map with each of the disk_path arguments. iso_rr_path + Perform -map with each of the disk_path parameters. iso_rr_path will be composed from disk_path by replacing disk_prefix by iso_rr_prefix. @@ -999,7 +999,7 @@ filesystem. disk_path does not exist, then iso_rr_path gets deleted. -update_l disk_prefix iso_rr_prefix disk_path [***] - Perform -update_r with each of the disk_path arguments. + Perform -update_r with each of the disk_path parameters. iso_rr_path will be composed from disk_path by replacing disk_prefix by iso_rr_prefix. @@ -1069,7 +1069,7 @@ filesystem. 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. + depend on the number of iso_rr_path_original parameters.  File: xorriso.info, Node: SetInsert, Next: Manip, Prev: Insert, Up: Options @@ -1139,12 +1139,12 @@ File: xorriso.info, Node: SetInsert, Next: Manip, Prev: Insert, Up: Options -not_list 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_paths parameter, if they contain a / character, or as -not_leaf pattern. -quoted_not_list disk_path Like -not_list but with quoted input reading rules. Each word is - handled as one argument for -not_paths resp. -not_leaf. + handled as one parameter for -not_paths resp. -not_leaf. -follow occasion[:occasion[...]] Enable or disable resolution of symbolic links and mountpoints @@ -1237,7 +1237,7 @@ File: xorriso.info, Node: SetInsert, Next: Manip, Prev: Insert, Up: Options E.g: /file/part_1_of_3_at_0_with_2047m_of_5753194821 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 argument and their contents may not + must be valid as -cut_out parameter and their contents may not overlap.  @@ -1250,7 +1250,7 @@ The following commands manipulate files in the ISO image, regardless whether they stem from the loaded image or were newly inserted. -iso_rr_pattern "on"|"ls"|"off" - Set the pattern expansion mode for the iso_rr_path arguments of + Set the pattern expansion mode for the iso_rr_path parameters of several commands which support this feature. Setting "off" disables pattern expansion for all commands which are marked in this man page by "iso_rr_path [***]" or @@ -1275,9 +1275,9 @@ whether they stem from the loaded image or were newly inserted. Delete empty directories. -mv iso_rr_path [***] iso_rr_path - Rename the given file objects in the ISO tree to the last argument - in the list. Use the same rules as with shell command mv. - If pattern expansion is enabled and if the last argument contains + Rename the given file objects in the ISO tree to the last + parameter in the list. Use the same rules as with shell command mv. + If pattern expansion is enabled and if the last parameter contains wildcard characters then it must match exactly one existing file address, or else the command fails with a FAILURE event. @@ -1435,7 +1435,7 @@ File: xorriso.info, Node: CmdFind, Next: Filter, Prev: Manip, Up: Options 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. - If not used as last command in the line then the argument list + If not used as last command in the line then the parameter list needs to get terminated by "--". Tests are optional. If they are omitted then action is applied to all file objects. If tests are given then they form together an @@ -1556,7 +1556,7 @@ File: xorriso.info, Node: CmdFind, Next: Filter, Prev: Manip, Up: Options compare 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 + parameter disk_path_start. For this the iso_rr_path of the -find command gets replaced by the disk_path_start. E.g.: -find /thomas -exec compare /home/thomas -- update @@ -2233,9 +2233,9 @@ filesystem and announced by an MBR partition table entry. 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. - 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. + Each -boot_image command has two parameters: type and setting. + More than one -boot_image command may be used to define the + handling of one or more boot images. Sequence matters. Types *isolinux* and *grub* care for known peculiarities. Type *any* makes no assumptions about the origin of the boot images. @@ -2681,9 +2681,9 @@ File: xorriso.info, Node: DialogCtl, Next: Inquiry, Prev: Exception, Up: Opt ======================== -dialog "on"|"off"|"single_line" - Enable or disable to enter dialog mode after all arguments are - processed. In dialog mode input lines get prompted via readline - or from stdin. + Enable or disable to enter dialog mode after all program arguments + are processed. In dialog mode input lines get prompted via + readline or from stdin. 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 @@ -2935,7 +2935,7 @@ File: xorriso.info, Node: Navigate, Next: Verify, Prev: Inquiry, Up: Options -findx 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. - -findx accepts the same -type arguments as -find. Additionally it + -findx accepts the same -type parameters 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. @@ -2991,7 +2991,7 @@ File: xorriso.info, Node: Navigate, Next: Verify, Prev: Inquiry, Up: Options the other address and whether both counterparts match. -compare_l disk_prefix iso_rr_prefix disk_path [***] - Perform -compare_r with each of the disk_path arguments. + Perform -compare_r with each of the disk_path parameters. iso_rr_path will be composed from disk_path by replacing disk_prefix by iso_rr_prefix. @@ -3254,9 +3254,9 @@ The directory permissions on disk have to allow rwx. gets not restored. -extract_l iso_rr_prefix disk_prefix iso_rr_path [***] - 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. + Perform -extract with each of the iso_rr_path parameters. + disk_path will be composed from iso_rr_path by replacing + iso_rr_prefix by disk_prefix. -extract_cut iso_rr_path byte_offset byte_count disk_path Copy a byte interval from a data file out of an ISO image into a @@ -3377,13 +3377,13 @@ said programs trigger comparable actions. -md5 can be set to "off" by --old-root-no-md5 . Not original mkisofs options are --quoted_path_list , --hardlinks , --acl , --xattr , --md5 , --stdio_sync . They work like the - `xorriso' options with the same name and hardcoded argument "on", - e.g. -acl "on". Explicit arguments are expected by --stdio_sync + `xorriso' options with the same name and hardcoded parameter "on", + e.g. -acl "on". Explicit parameters are expected by --stdio_sync and --scdbackup_tag. The capability to preserve multi-session history on overwriteable media gets disabled by default. It can be enabled by using --emul-toc with the first session. See -compliance no_emul_toc. - --sort-weight gets as arguments a number and an iso_rr_path. The + --sort-weight gets as parameters 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). @@ -3415,7 +3415,7 @@ said programs trigger comparable actions. aliases for "mkisofs". 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 + -read_mkisofsrc and prepends -as "genisofs" to the program arguments. I.e. all arguments will be interpreted mkisofs style until "--" is encountered. From then on, options are interpreted as `xorriso' options. @@ -3449,9 +3449,9 @@ said programs trigger comparable actions. for "cdrecord". If `xorriso' is started with one of the leafnames "xorrecord", "cdrskin", "cdrecord", or "wodim", then it automatically prepends - -as "cdrskin" to the command line arguments. I.e. all arguments - will be interpreted cdrecord style until "--" is encountered. - From then on, options are interpreted as `xorriso' options. + -as "cdrskin" to the program arguments. I.e. all arguments will be + interpreted cdrecord style until "--" is encountered. From then + on, options are interpreted as `xorriso' options. --no_rc as first argument of such a program start prevents interpretation of `xorriso' startup files. See section FILES below. @@ -3496,7 +3496,7 @@ File: xorriso.info, Node: Scripting, Next: Frontend, Prev: Emulation, Up: Op =================================================== -no_rc - Only if used as first command line argument this option prevents + Only if used as first program argument this option prevents reading and interpretation of startup files. See section FILES below. @@ -3504,7 +3504,7 @@ File: xorriso.info, Node: Scripting, Next: Frontend, Prev: Emulation, Up: Op Read quoted input from fileaddress and execute it like dialog lines. Empty lines and lines which begin by # are ignored. Normally one line should hold one `xorriso' command and all its - arguments. Nevertheless lines may be concatenated by a trailing + parameters. Nevertheless lines may be concatenated by a trailing backslash. See also section "Command processing", paragraph "Quoted input". @@ -3620,8 +3620,8 @@ File: xorriso.info, Node: Scripting, Next: Frontend, Prev: Emulation, Up: Op append the log lines. 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. + complete because some input files might not have been processed at + all. The errfile paths are transported as messages of very low severity "ERRFILE". This transport becomes visible with -report_about "ALL". @@ -3672,7 +3672,7 @@ File: xorriso.info, Node: Frontend, Next: ExDevices, Prev: Scripting, Up: Op character at the end of the output line belongs to the payload. After another colon and a blank follows the payload text. Example: - I:1: enter option and arguments : + I:1: enter option and parameters : -logfile channel fileaddress Copy output of a channel to the given file. Channel may be one of: @@ -3767,8 +3767,8 @@ $ xorriso -outdev /dev/sr2 \ Note that '/pictures/*private*' is a pattern for iso_rr_paths while pictures/confidential/work* gets expanded by the shell with addresses -from the hard disk. Options -add and -map have different argument rules -but finally the same effect: they put files into the image. +from the hard disk. Options -add and -map have different parameter +rules but finally the same effect: they put files into the image.  File: xorriso.info, Node: ExDialog, Next: ExGrowing, Prev: ExCreate, Up: Examples @@ -4774,53 +4774,53 @@ Node: Media6151 Node: Methods8817 Node: Drives11386 Node: Extras14699 -Node: Processing18416 -Node: Dialog21960 -Node: Options23623 -Node: ArgSort25292 -Node: AqDrive26767 -Node: Loading29804 -Node: Insert44073 -Node: SetInsert53779 -Node: Manip62347 -Node: CmdFind71077 -Node: Filter83182 -Node: Writing87520 -Node: SetWrite95521 -Node: Bootable109826 -Node: Jigdo123046 -Node: Charset127292 -Node: Exception130051 -Node: DialogCtl136164 -Node: Inquiry138751 -Node: Navigate143614 -Node: Verify151872 -Node: Restore160539 -Node: Emulation167444 -Node: Scripting177249 -Node: Frontend184414 -Node: Examples185713 -Node: ExDevices186890 -Node: ExCreate187549 -Node: ExDialog188831 -Node: ExGrowing190094 -Node: ExModifying190899 -Node: ExBootable191402 -Node: ExCharset191954 -Node: ExPseudo192774 -Node: ExCdrecord193672 -Node: ExMkisofs193989 -Node: ExGrowisofs195329 -Node: ExException196464 -Node: ExTime196918 -Node: ExIncBackup197377 -Node: ExRestore201363 -Node: ExRecovery202323 -Node: Files202893 -Node: Seealso204191 -Node: Bugreport204914 -Node: Legal205495 -Node: CommandIdx206425 -Node: ConceptIdx221667 +Node: Processing18417 +Node: Dialog21964 +Node: Options23627 +Node: ArgSort25296 +Node: AqDrive26771 +Node: Loading29808 +Node: Insert44077 +Node: SetInsert53787 +Node: Manip62358 +Node: CmdFind71091 +Node: Filter83198 +Node: Writing87536 +Node: SetWrite95537 +Node: Bootable109842 +Node: Jigdo123063 +Node: Charset127309 +Node: Exception130068 +Node: DialogCtl136181 +Node: Inquiry138776 +Node: Navigate143639 +Node: Verify151899 +Node: Restore160566 +Node: Emulation167472 +Node: Scripting177271 +Node: Frontend184423 +Node: Examples185723 +Node: ExDevices186900 +Node: ExCreate187559 +Node: ExDialog188842 +Node: ExGrowing190105 +Node: ExModifying190910 +Node: ExBootable191413 +Node: ExCharset191965 +Node: ExPseudo192785 +Node: ExCdrecord193683 +Node: ExMkisofs194000 +Node: ExGrowisofs195340 +Node: ExException196475 +Node: ExTime196929 +Node: ExIncBackup197388 +Node: ExRestore201374 +Node: ExRecovery202334 +Node: Files202904 +Node: Seealso204202 +Node: Bugreport204925 +Node: Legal205506 +Node: CommandIdx206436 +Node: ConceptIdx221678  End Tag Table diff --git a/xorriso/xorriso.texi b/xorriso/xorriso.texi index b075da20..3cb8d27c 100644 --- a/xorriso/xorriso.texi +++ b/xorriso/xorriso.texi @@ -526,7 +526,7 @@ makes such an image bootable. For details see option -boot_image. @* @cindex MBR, _definiton 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 parameter system_area= . This installs a Master Boot Record which may get adjusted according to the needs of GRUB resp. ISOLINUX. An @strong{MBR} contains boot code and a partition table. It does not hamper @@ -606,7 +606,7 @@ or an end of an input line. @sp 1 At program start the list delimiter is the word "@minus{}@minus{}". This may be changed by option -list_delimiter in order to allow -"@minus{}@minus{}" as argument in a list of variable length. +"@minus{}@minus{}" as parameter in a list of variable length. It is advised to reset the delimiter to "@minus{}@minus{}" immediately afterwards. @* @@ -615,7 +615,7 @@ throughout this text. @* The list delimiter is silently tolerated if it appears after the parameters of a command with a fixed list length. It is handled as normal text if it -appears among the arguments of such a command. +appears among the parameters of such a command. @c man .PP @sp 1 @cindex Pattern expansion, _definition @@ -628,7 +628,7 @@ and respects '/' as separator which may only be matched literally. @* It is a property of some particular commands and not a general feature. It gets controlled by commands -iso_rr_pattern and -disk_pattern. -Commands which may use pattern expansion all have variable argument +Commands which may use pattern expansion all have variable parameter lists which are marked in this man page by "[***]" rather than "[...]". @* Some other commands perform pattern matching unconditionally. @@ -1231,7 +1231,7 @@ The commands in this section alter the ISO image and not the local filesystem. @item -disk_pattern "on"|"ls"|"off" @kindex -disk_pattern controls pattern expansion @cindex Pattern expansion, for disk paths, -disk_pattern -Set the pattern expansion mode for the disk_path arguments of several +Set the pattern expansion mode for the disk_path parameters of several commands which support this feature. @* Setting "off" disables this feature for all commands which are marked in this @@ -1313,7 +1313,7 @@ Like -map, but if disk_path is a directory then its sub tree is not inserted. @item -map_l disk_prefix iso_rr_prefix disk_path [***] @kindex -map_l inserts paths from disk file @cindex Insert, paths from disk file, -map_l -Perform -map with each of the disk_path arguments. iso_rr_path will be +Perform -map with each of the disk_path parameters. iso_rr_path will be composed from disk_path by replacing disk_prefix by iso_rr_prefix. @c man .TP @item -update disk_path iso_rr_path @@ -1347,7 +1347,7 @@ exist, then iso_rr_path gets deleted. @item -update_l disk_prefix iso_rr_prefix disk_path [***] @kindex -update_l inserts paths if different @cindex Insert, if different, -update_l -Perform -update_r with each of the disk_path arguments. iso_rr_path will be +Perform -update_r with each of the disk_path parameters. iso_rr_path will be composed from disk_path by replacing disk_prefix by iso_rr_prefix. @c man .TP @item -cut_out disk_path byte_offset byte_count iso_rr_path @@ -1440,7 +1440,7 @@ 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. +parameters. @end table @c man .TP @c man .B Settings for file insertion: @@ -1530,14 +1530,14 @@ made. @item -not_list disk_path @kindex -not_list sets exclusions from disk file @cindex Insert, file exclusion from file, -not_list -Read lines from disk_path and use each of them either as -not_paths argument, +Read lines from disk_path and use each of them either as -not_paths parameter, if they contain a / character, or as -not_leaf pattern. @c man .TP @item -quoted_not_list disk_path @kindex -quoted_not_list sets exclusions @cindex Insert, file exclusion, -quoted_not_list Like -not_list but with quoted input reading rules. Each word is -handled as one argument for -not_paths resp. -not_leaf. +handled as one parameter for -not_paths resp. -not_leaf. @c man .TP @item -follow occasion[:occasion[...]] @kindex -follow softlinks and mount points @@ -1663,7 +1663,7 @@ E.g: /file/part_1_of_3_at_0_with_2047m_of_5753194821 @* 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 -argument and their contents may not overlap. +parameter and their contents may not overlap. @end table @c man .TP @c man .B File manipulations: @@ -1679,7 +1679,7 @@ they stem from the loaded image or were newly inserted. @item -iso_rr_pattern "on"|"ls"|"off" @kindex -iso_rr_pattern controls pattern expansion @cindex Pattern expansion, for ISO paths, -iso_rr_pattern -Set the pattern expansion mode for the iso_rr_path arguments of several +Set the pattern expansion mode for the iso_rr_path parameters of several commands which support this feature. @* Setting "off" disables pattern expansion for all commands which are marked @@ -1719,9 +1719,9 @@ Delete empty directories. @kindex -mv renames file in ISO image @cindex Rename, in ISO image, -mv Rename the given file objects in the ISO tree to the last -argument in the list. Use the same rules as with shell command mv. +parameter in the list. Use the same rules as with shell command mv. @* -If pattern expansion is enabled and if the last argument contains wildcard +If pattern expansion is enabled and if the last parameter contains wildcard characters then it must match exactly one existing file address, or else the command fails with a FAILURE event. @c man .TP @@ -1942,7 +1942,7 @@ Rather use: -boot_image "any" "cat_hidden=on" 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. @* -If not used as last command in the line then the argument list +If not used as last command in the line then the parameter list needs to get terminated by "@minus{}@minus{}". @* Tests are optional. If they are omitted then action is applied to all file @@ -2107,7 +2107,7 @@ prints file information like shell command ls -dl. @* @item compare performs command -compare with the found file address as -iso_rr_path and the corresponding file address below its argument +iso_rr_path and the corresponding file address below its parameter disk_path_start. For this the iso_rr_path of the -find command gets replaced by the disk_path_start. @* @@ -2997,7 +2997,7 @@ Define the handling of a 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. @* -Each -boot_image command has two arguments: type and setting. More than one +Each -boot_image command has two parameters: type and setting. More than one -boot_image command may be used to define the handling of one or more boot images. Sequence matters. @* @@ -3594,7 +3594,8 @@ file content stems from the loaded ISO image and is not filtered. @item -dialog "on"|"off"|"single_line" @kindex -dialog enables dialog mode @cindex Dialog, enable dialog mode, -dialog -Enable or disable to enter dialog mode after all arguments are processed. +Enable or disable to enter dialog mode after all program arguments are +processed. In dialog mode input lines get prompted via readline or from stdin. @* If no -abort_on severity was set when dialog starts, then "NEVER" is set @@ -3948,7 +3949,7 @@ Similar to shell command du -sk. Like -find but operating on local filesystem and not on the ISO image. This is subject to the settings of -follow. @* --findx accepts the same -type arguments as -find. Additionally it recognizes +-findx accepts the same -type parameters 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. @@ -4023,7 +4024,7 @@ and whether both counterparts match. @item -compare_l disk_prefix iso_rr_prefix disk_path [***] @kindex -compare_l reports ISO/disk differences @cindex Verify, compare ISO and disk, -compare_l -Perform -compare_r with each of the disk_path arguments. iso_rr_path will be +Perform -compare_r with each of the disk_path parameters. iso_rr_path will be composed from disk_path by replacing disk_prefix by iso_rr_prefix. @c man .TP @item -show_stream iso_rr_path [***] @@ -4348,7 +4349,7 @@ restored. @item -extract_l iso_rr_prefix disk_prefix iso_rr_path [***] @kindex -extract_l copies files to disk @cindex Restore, copy files to disk, -extract_l -Perform -extract with each of the iso_rr_path arguments. disk_path will be +Perform -extract with each of the iso_rr_path parameters. disk_path will be composed from iso_rr_path by replacing iso_rr_prefix by disk_prefix. @c man .TP @item -extract_cut iso_rr_path byte_offset byte_count disk_path @@ -4506,15 +4507,15 @@ Not original mkisofs options are @minus{}@minus{}quoted_path_list , @minus{}@minus{}hardlinks , @minus{}@minus{}acl , @minus{}@minus{}xattr , @minus{}@minus{}md5 , @minus{}@minus{}stdio_sync . They work like the @command{xorriso} options with the -same name and hardcoded argument "on", e.g. -acl "on". -Explicit arguments are expected by @minus{}@minus{}stdio_sync +same name and hardcoded parameter "on", e.g. -acl "on". +Explicit parameters are expected by @minus{}@minus{}stdio_sync and @minus{}@minus{}scdbackup_tag. @* The capability to preserve multi-session history on overwriteable media gets disabled by default. It can be enabled by using @minus{}@minus{}emul-toc with the first session. See -compliance no_emul_toc. @* -@minus{}@minus{}sort-weight gets as arguments a number and an iso_rr_path. +@minus{}@minus{}sort-weight gets as parameters 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). @@ -4561,7 +4562,7 @@ and "@strong{genisofs}" are aliases for "mkisofs". If @command{xorriso} is started with one of the leafnames "xorrisofs", "genisofs", "mkisofs", or "genisoimage", then it performs -read_mkisofsrc and prepends --as "genisofs" to the command line arguments. +-as "genisofs" to the program arguments. I.e. all arguments will be interpreted mkisofs style until "@minus{}@minus{}" is encountered. From then on, options are interpreted as @command{xorriso} options. @@ -4611,7 +4612,7 @@ are aliases for "cdrecord". @* If @command{xorriso} is started with one of the leafnames "xorrecord", "cdrskin", "cdrecord", or "wodim", then it automatically prepends -as "cdrskin" -to the command line arguments. I.e. all arguments will be interpreted cdrecord +to the program arguments. I.e. all arguments will be interpreted cdrecord style until "@minus{}@minus{}" is encountered. From then on, options are interpreted as @command{xorriso} options. @* @@ -4677,7 +4678,7 @@ Program scdbackup_verify will recognize and verify tag resp. record. @kindex -no_rc disables startup files @cindex Process, disable startup files, -no_rc @* -Only if used as first command line argument this option +Only if used as first program argument this option prevents reading and interpretation of startup files. See section FILES below. @c man .TP @item -options_from_file fileaddress @@ -4685,7 +4686,7 @@ prevents reading and interpretation of startup files. See section FILES below. @cindex Process, read command file, -options_from_file Read quoted input from fileaddress and execute it like dialog lines. Empty lines and lines which begin by # are ignored. Normally one line -should hold one @command{xorriso} command and all its arguments. +should hold one @command{xorriso} command and all its parameters. Nevertheless lines may be concatenated by a trailing backslash. @* See also section "Command processing", paragraph "Quoted input". @@ -4857,7 +4858,7 @@ begin with "-" is used as path for a file to append the log lines. @* 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. +some input files might not have been processed at all. @* The errfile paths are transported as messages of very low severity "ERRFILE". This transport becomes visible with -report_about "ALL". @@ -4932,7 +4933,7 @@ a blank follows the payload text. @* Example: @* - I:1: enter option and arguments : + I:1: enter option and parameters : @c man .TP @item -logfile channel fileaddress @kindex -logfile logs output channels to file @@ -5086,7 +5087,7 @@ $ xorriso -outdev /dev/sr2 \ Note that '/pictures/*private*' is a pattern for iso_rr_paths while pictures/confidential/work* gets expanded by the shell with addresses from the hard disk. Options -add and -map have different -argument rules but finally the same effect: they put files into the image. +parameter rules but finally the same effect: they put files into the image. @c man .SS @c man .B A dialog session doing about the same @c man .br