libburnia/legacy
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Adjustments and documentation about -backslash_codes

Browse Source
This commit is contained in:
Thomas Schmitt
2008-10-17 12:33:49 +00:00
parent 2fce109cee
commit bfa22a38e8
4 changed files with 190 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
libisoburn/trunk/xorriso/xorriso.1
View File

@ -2,7 +2,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 "Oct 16, 2008"
.TH XORRISO 1 "Oct 17, 2008"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@ -385,14 +385,30 @@ lists which are marked in this man page by "[***]" rather than "[...]".
Some other commands perform pattern matching unconditionally.
.PP
Command and parameter words are either read from program arguments, where one
argument is one word, or from input lines where words are recognized similar
to the quotation rules of a shell parser.
argument is one word, or from quoted input lines where words are recognized
similar to the quotation rules of a shell parser.
.br
xorriso is not a shell, although it might appear so on first glimpse.
Be aware that the interaction of quotation marks and pattern symbols like "*"
differs from the usual shell parsers. In xorriso, a quotation mark does not
make a pattern symbol literal.
.PP
.B Quoted input
combines words from text pieces which are separated by whitespace.
The double quotation mark " and the single quotation mark ' can be used to
enclose whitespace and make it part of words (e.g. of file names). Each mark
type can enclose the marks of the other type. A trailing backslash \\ outside
quotations or an open quotation cause the next input line to be appended.
.br
Quoted input accepts any ASCII character except NUL (0) as content of quotes.
Nevertheless it can be cumbersome for the user to produce those characters
at all. Therefore quoted input and program arguments allow optional
.B Backslash Interpretation
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.
.PP
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
@ -666,11 +682,8 @@ 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 line reading rules of -dialog mode "on".
I.e. newline characters within quotes and trailing backslashes outside quotes
cause the next line to be appended to the pathspec resp. disk_pattern.
Eventual newline characters get part of the line, trailing backslashes get
discarded. Lines get split into words. 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
@ -680,7 +693,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 [***]
Performs -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
@ -708,7 +721,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 [***]
Performs -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
@ -1198,11 +1211,11 @@ 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 them as -not_paths argument if they contain
a / character. If not use the line 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 line reading rules of -dialog mode "on". Each word is
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[...]]
@ -1305,7 +1318,7 @@ Rock Ridge info will be generated by the program unconditionally.
If enabled by "on", generate Joliet info additional to Rock Ridge info.
.TP
\fB\-volid\fR text
Specifies the volume ID. xorriso accepts any text up to 32 characters,
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 character set [A-Z0-9_]. Like: "IMAGE_23"
@ -1406,7 +1419,7 @@ capability to influence the bootability of the existing sessions, unless one
can assume overwriteable media.
.TP
\fB\-boot_image\fR "any"|"isolinux" "discard"|"keep"|"patch"|bootspec
Defines the handling of an eventual El Torito object which has
Define the handling of an eventual El Torito object which has
been read from an existing ISO image or defines how to make a prepared
ISOLINUX file set bootable.
.br
@ -1989,7 +2002,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 [***]
Performs -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
@ -2050,7 +2063,7 @@ of commands which in said programs trigger comparable actions.
.TP
\fB\-as\fR personality option [options] --
.br
Performs its variable length option list as sparse emulation of the program
Perform its variable length option list as sparse emulation of the program
depicted by the personality word.
.br
@ -2162,7 +2175,7 @@ prevents reading and interpretation of eventual startup
files. See section FILES below.
.TP
\fB\-options_from_file\fR fileaddress
Reads lines from fileaddress and executes them as dialog lines.
Read quoted input from fileaddress and executes it like dialog lines.
.TP
\fB\-help\fR
.br
@ -2200,8 +2213,8 @@ For brevity the list delimiter is referred as "--" throughout this text.
.TP
\fB\-backslash_codes\fR "on"|"off"|mode[:mode]
Enable or disable the interpretation of symbolic representations of special
characters with quoted input or with program arguments. If enabled the
following translations apply:
characters with quoted input, or with program arguments, or with program
text output. If enabled the following translations apply:
.br
\\a=bell(007) \\b=backspace(008) \\e=Escape(033) \\f=formfeed(014)
.br
@ -2215,16 +2228,22 @@ Translations can occur with quoted input in 3 modes:
.br
"in_double_quotes" translates only inside " quotation.
.br
"outside_single_quotes" translates not inside ' quotation.
"in_quotes" translates inside " and ' quotation.
.br
"with_quoted_input" translates all input text.
"with_quoted_input" translates inside and outside quotes.
.br
With the start program arguments there is mode:
.br
"with_program_arguments" translates all program arguments.
.br
.br
Mode "encode_output" encodes output characters inside single or double
quotation marks. It combines "encode_results" with "encode_infos". Encoding
applies to ASCII characters 1 to 31 and 127 to 255.
.br
Mode "off" is default and disables any translation.
Mode "on" is the same as "with_quoted_input:with_program_arguments".
Mode "on" is
"with_quoted_input:with_program_arguments:encode_output".
.TP
\fB\-temp_mem_limit\fR number["k"|"m"]
Set the maximum size of temporary memory to be used for image dependent