Clarified relation of startup files, -options_from_file and quoted input.

This commit is contained in:
Thomas Schmitt 2011-04-03 08:28:07 +00:00
parent 570d5a0e22
commit b345056a2d
3 changed files with 85 additions and 67 deletions

View File

@ -9,7 +9,7 @@
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH XORRISO 1 "Mar 21, 2011"
.TH XORRISO 1 "Apr 03, 2011"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@ -2098,6 +2098,9 @@ fail deliberately.
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
than 64.
.br
"joliet_long_paths" allows Joliet paths longer than 240 characters.
.br
"always_gmt" stores timestamps in GMT representation with timezone 0.
@ -3793,7 +3796,12 @@ prevents reading and interpretation of eventual startup
files. See section FILES below.
.TP
\fB\-options_from_file\fR fileaddress
Read quoted input from fileaddress and executes it like dialog lines.
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 backslash.
.br
See also section "Command processing", paragraph "Quoted input".
.TP
\fB\-help\fR
.br
@ -4507,7 +4515,7 @@ 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.
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,

View File

@ -3362,8 +3362,12 @@ File: xorriso.info, Node: Scripting, Next: Frontend, Prev: Emulation, Up: Op
FILES below.
-options_from_file fileaddress
Read quoted input from fileaddress and executes it like dialog
lines.
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
backslash.
See also section "Command processing", paragraph "Quoted input".
-help
Print helptext.
@ -4015,7 +4019,8 @@ startup to read and execute lines from the following files:
$HOME/.xorrisorc
The files are read in the sequence given above, but none of them is
required to exist.
required to exist. The line format is described with command
-options_from_file.
If mkisofs emulation was enabled by program name "xorrisofs", "mkisofs",
"genisoimage", or "genisofs", then afterwards -read_mkisofsrc is
performed, which reads .mkisofsrc files. See there.
@ -4093,7 +4098,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
[index]
* Menu:
* # starts a comment line: Scripting. (line 128)
* # starts a comment line: Scripting. (line 132)
* -abort_on controls abort on error: Exception. (line 27)
* -abstract_file sets abstract file name: SetWrite. (line 160)
* -acl controls handling of ACLs: Loading. (line 142)
@ -4107,7 +4112,7 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -as emulates mkisofs or cdrecord: Emulation. (line 13)
* -assert_volid rejects undesired images: Loading. (line 84)
* -auto_charset learns character set from image: Loading. (line 99)
* -backslash_codes enables backslash conversion: Scripting. (line 45)
* -backslash_codes enables backslash conversion: Scripting. (line 49)
* -ban_stdio_write demands real drive: Loading. (line 246)
* -biblio_file sets biblio file name: SetWrite. (line 167)
* -blank erases media: Writing. (line 45)
@ -4158,8 +4163,8 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -dvd_obs set write block size: SetWrite. (line 238)
* -early_stdio_test classifies stdio drives: Loading. (line 251)
* -eject ejects drive tray: Writing. (line 36)
* -end writes pending session and ends program: Scripting. (line 122)
* -errfile_log logs problematic disk files: Scripting. (line 84)
* -end writes pending session and ends program: Scripting. (line 126)
* -errfile_log logs problematic disk files: Scripting. (line 88)
* -error_behavior controls error workarounds: Exception. (line 69)
* -external_filter registers data filter: Filter. (line 20)
* -external_filter unregisters data filter: Filter. (line 48)
@ -4181,15 +4186,15 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -gid sets global ownership: SetWrite. (line 195)
* -grow_blindly overides next writeable address: AqDrive. (line 44)
* -hardlinks controls handling of hard links: Loading. (line 110)
* -help prints help text: Scripting. (line 16)
* -help prints help text: Scripting. (line 20)
* -hide excludes file names from directory trees: Manip. (line 170)
* -history brings text into readline history: Scripting. (line 22)
* -history brings text into readline history: Scripting. (line 26)
* -in_charset sets input character set: Loading. (line 92)
* -indev aquires a drive for input: AqDrive. (line 22)
* -iso_rr_pattern controls pattern expansion: Manip. (line 10)
* -jigdo clears JTE or or adds parameter to JTE: Jigdo. (line 33)
* -joliet enables production of Joliet tree: SetWrite. (line 10)
* -list_delimiter replaces '--': Scripting. (line 38)
* -list_delimiter replaces '--': Scripting. (line 42)
* -list_formats lists available formats: Writing. (line 107)
* -list_profiles lists supported media: Writing. (line 119)
* -load addresses a particular session as input: Loading. (line 11)
@ -4231,11 +4236,11 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -pathspecs sets meaning of = with -add: SetInsert. (line 118)
* -pkt_output consolidates text output: Frontend. (line 7)
* -preparer_id sets preparer id: SetWrite. (line 173)
* -print prints text line: Scripting. (line 77)
* -print prints text line: Scripting. (line 81)
* -print_size predicts image size: Inquiry. (line 69)
* -prog sets program name: Frontend. (line 30)
* -prog_help prints help text: Frontend. (line 33)
* -prompt prompts for enter key: Scripting. (line 80)
* -prompt prompts for enter key: Scripting. (line 84)
* -publisher sets publisher id: SetWrite. (line 113)
* -pvd_info shows image id strings: Inquiry. (line 82)
* -pwd tells working directory in ISO: Navigate. (line 20)
@ -4251,11 +4256,11 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -rm_r deletes trees from ISO image: Manip. (line 28)
* -rmdir deletes ISO directory: Manip. (line 32)
* -rollback discards pending changes: Writing. (line 9)
* -rollback_end ends program without writing: Scripting. (line 125)
* -rollback_end ends program without writing: Scripting. (line 129)
* -rom_toc_scan searches for sessions: Loading. (line 210)
* -scdbackup_tag enables scdbackup checksum tag: Emulation. (line 168)
* -scsi_log reports SCSI commands: Scripting. (line 113)
* -session_log logs written sessions: Scripting. (line 104)
* -scsi_log reports SCSI commands: Scripting. (line 117)
* -session_log logs written sessions: Scripting. (line 108)
* -session_string composes session info line: Inquiry. (line 56)
* -set_filter applies filter to file: Filter. (line 59)
* -set_filter_r applies filter to file tree: Filter. (line 84)
@ -4269,20 +4274,20 @@ File: xorriso.info, Node: CommandIdx, Next: ConceptIdx, Prev: Legal, Up: Top
* -show_stream_r shows data source and filters: Navigate. (line 177)
* -speed set write speed: SetWrite. (line 211)
* -split_size enables large file splitting: SetInsert. (line 140)
* -status shows current settings: Scripting. (line 25)
* -status_history_max curbs -status history: Scripting. (line 34)
* -status shows current settings: Scripting. (line 29)
* -status_history_max curbs -status history: Scripting. (line 38)
* -stdio_sync controls stdio buffer: SetWrite. (line 245)
* -stream_recording controls defect management: SetWrite. (line 226)
* -system_id sets system id: SetWrite. (line 128)
* -tell_media_space reports free space: Inquiry. (line 78)
* -temp_mem_limit curbs memory consumption: Scripting. (line 70)
* -temp_mem_limit curbs memory consumption: Scripting. (line 74)
* -toc shows list of sessions: Inquiry. (line 18)
* -uid sets global ownership: SetWrite. (line 191)
* -update inserts path if different: Insert. (line 99)
* -update_l inserts paths if different: Insert. (line 121)
* -update_r inserts paths if different: Insert. (line 110)
* -use_readline enables readline for dialog: DialogCtl. (line 28)
* -version prints help text: Scripting. (line 19)
* -version prints help text: Scripting. (line 23)
* -volid sets volume id: SetWrite. (line 89)
* -volset_id sets volume set id: SetWrite. (line 108)
* -volume_date sets volume timestamp: SetWrite. (line 135)
@ -4322,14 +4327,14 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Character set, learn from image, -auto_charset: Loading. (line 99)
* Character Set, of terminal, -local_charset: Charset. (line 47)
* Closed media, _definition: Media. (line 43)
* Comment, #: Scripting. (line 128)
* Comment, #: Scripting. (line 132)
* Create, new ISO image, _definiton: Methods. (line 6)
* Cylinder alignment, _definiton: Bootable. (line 169)
* Cylinder size, _definiton: Bootable. (line 158)
* Delete, from ISO image, -rm: Manip. (line 21)
* Delete, from ISO image, -rm_r: Manip. (line 28)
* Delete, ISO directory, -rmdir: Manip. (line 32)
* Dialog, bring text into history, -history: Scripting. (line 22)
* Dialog, bring text into history, -history: Scripting. (line 26)
* Dialog, confirmation question, -reassure: DialogCtl. (line 32)
* Dialog, enable dialog mode, -dialog: DialogCtl. (line 7)
* Dialog, line editing, -use_readline: DialogCtl. (line 28)
@ -4350,7 +4355,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Drive, get drive list, -devices: Inquiry. (line 7)
* Drive, list supported media, -list_profiles: Writing. (line 119)
* Drive, reduce activity, -calm_drive: Loading. (line 235)
* Drive, report SCSI commands, -scsi_log: Scripting. (line 113)
* Drive, report SCSI commands, -scsi_log: Scripting. (line 117)
* Drive, write and eject, -commit_eject: Writing. (line 40)
* El Torito, _definiton: Extras. (line 19)
* Emulation, -as: Emulation. (line 13)
@ -4459,25 +4464,25 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Process, control exit value, -return_with: Exception. (line 39)
* Process, control verbosity, -report_about: Exception. (line 55)
* Process, disable startup files, -no_rc: Scripting. (line 7)
* Process, end program and write, -end: Scripting. (line 122)
* Process, end program, no writing, -rollback_end: Scripting. (line 125)
* Process, end program and write, -end: Scripting. (line 126)
* Process, end program, no writing, -rollback_end: Scripting. (line 129)
* Process, error workarounds, -error_behavior: Exception. (line 69)
* Process, log output channels to file, -logfile: Frontend. (line 20)
* Process, read command file, -options_from_file: Scripting. (line 12)
* Process, set synchronizing message, -mark: Frontend. (line 25)
* Program, backslash conversion, -backslash_codes: Scripting. (line 45)
* Program, curb memory, -temp_mem_limit: Scripting. (line 70)
* Program, end and write, -end: Scripting. (line 122)
* Program, end without writing, -rollback_end: Scripting. (line 125)
* Program, print help text, -help: Scripting. (line 16)
* Program, backslash conversion, -backslash_codes: Scripting. (line 49)
* Program, curb memory, -temp_mem_limit: Scripting. (line 74)
* Program, end and write, -end: Scripting. (line 126)
* Program, end without writing, -rollback_end: Scripting. (line 129)
* Program, print help text, -help: Scripting. (line 20)
* Program, print help text, -prog_help: Frontend. (line 33)
* Program, print text line, -print: Scripting. (line 77)
* Program, print version, -version: Scripting. (line 19)
* Program, prompt for enter key, -prompt: Scripting. (line 80)
* Program, replace --, -list_delimiter: Scripting. (line 38)
* Program, print text line, -print: Scripting. (line 81)
* Program, print version, -version: Scripting. (line 23)
* Program, prompt for enter key, -prompt: Scripting. (line 84)
* Program, replace --, -list_delimiter: Scripting. (line 42)
* Program, set name, -prog: Frontend. (line 30)
* Program, show current settings, -status: Scripting. (line 25)
* Program, status history, -status_history_max: Scripting. (line 34)
* Program, show current settings, -status: Scripting. (line 29)
* Program, status history, -status_history_max: Scripting. (line 38)
* Quoted input, _definiton: Processing. (line 43)
* Recovery, retrieve blocks, -check_media: Verify. (line 21)
* Rename, in ISO image, -mv: Manip. (line 35)
@ -4495,7 +4500,7 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Session, altered start address, -displacement: Loading. (line 35)
* Session, info string, -session_string: Inquiry. (line 56)
* Session, issue mount command, -mount: Restore. (line 122)
* Session, log when written, -session_log: Scripting. (line 104)
* Session, log when written, -session_log: Scripting. (line 108)
* Session, mount command line, -mount_cmd: Inquiry. (line 31)
* Session, mount parameters, -mount_opts: Inquiry. (line 47)
* Session, select as input, -load: Loading. (line 11)
@ -4524,8 +4529,8 @@ File: xorriso.info, Node: ConceptIdx, Prev: CommandIdx, Up: Top
* Write, enable Joliet, -joliet: SetWrite. (line 10)
* Write, fifo size, -fs: SetWrite. (line 255)
* Write, free space, -tell_media_space: Inquiry. (line 78)
* Write, log problematic disk files, -errfile_log: Scripting. (line 84)
* Write, log written sessions, -session_log: Scripting. (line 104)
* Write, log problematic disk files, -errfile_log: Scripting. (line 88)
* Write, log written sessions, -session_log: Scripting. (line 108)
* Write, padding image, -padding: SetWrite. (line 268)
* Write, pending ISO image, -commit: Writing. (line 13)
* Write, predict image size, -print_size: Inquiry. (line 69)
@ -4572,28 +4577,28 @@ Node: Verify144640
Node: Restore153229
Node: Emulation159885
Node: Scripting169721
Node: Frontend175283
Node: Examples176578
Node: ExDevices177747
Node: ExCreate178381
Node: ExDialog179655
Node: ExGrowing180917
Node: ExModifying181719
Node: ExBootable182220
Node: ExCharset182767
Node: ExPseudo183595
Node: ExCdrecord184489
Node: ExMkisofs184804
Node: ExGrowisofs186140
Node: ExException187264
Node: ExTime187718
Node: ExIncBackup188177
Node: ExRestore192098
Node: ExRecovery193067
Node: Files193633
Node: Seealso194861
Node: Legal195441
Node: CommandIdx196363
Node: ConceptIdx210743
Node: Frontend175557
Node: Examples176852
Node: ExDevices178021
Node: ExCreate178655
Node: ExDialog179929
Node: ExGrowing181191
Node: ExModifying181993
Node: ExBootable182494
Node: ExCharset183041
Node: ExPseudo183869
Node: ExCdrecord184763
Node: ExMkisofs185078
Node: ExGrowisofs186414
Node: ExException187538
Node: ExTime187992
Node: ExIncBackup188451
Node: ExRestore192372
Node: ExRecovery193341
Node: Files193907
Node: Seealso195197
Node: Legal195777
Node: CommandIdx196699
Node: ConceptIdx211079

End Tag Table

View File

@ -44,7 +44,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 "Mar 26, 2011"
@c man .TH XORRISO 1 "Apr 03, 2011"
@c man .\" Please adjust this date whenever revising the manpage.
@c man .\"
@c man .\" Some roff macros, for reference:
@ -4473,7 +4473,12 @@ files. See section FILES below.
@item -options_from_file fileaddress
@kindex -options_from_file reads commands from file
@cindex Process, read command file, -options_from_file
Read quoted input from fileaddress and executes it like dialog lines.
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 backslash.
@*
See also section "Command processing", paragraph "Quoted input".
@c man .TP
@item -help
@kindex -help prints help text
@ -5394,7 +5399,7 @@ to read and execute lines from the following files:
@*
@sp 1
The files are read in the sequence given above, but none of them is required
to exist.
to exist. The line format is described with command -options_from_file.
@*
If mkisofs emulation was enabled by program name "xorrisofs", "mkisofs",
"genisoimage", or "genisofs", then afterwards -read_mkisofsrc is performed,