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

Clarified man page

Browse Source
This commit is contained in:
Thomas Schmitt 2007-11-11 11:22:39 +00:00
parent a59c10dfec
commit e5f9c2a28e
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
test/xorriso.1
View File

@ -32,8 +32,8 @@ information of existing ISO images and it writes the session results to
optical media or to filesystem objects. optical media or to filesystem objects.
.PP .PP
A special property of xorriso is that it needs neither an external ISO 9660 A special property of xorriso is that it needs neither an external ISO 9660
formatter program nor an external burn program but rather incorporates formatter program nor an external burn program for CD or DVD but rather
the libraries of libburnia-project.org . incorporates the libraries of libburnia-project.org .
.SS .SS
.B Overview of features: .B Overview of features:
.br .br
@ -208,7 +208,7 @@ with a fixed list length.
is a property of some particular commands and not a general is a property of some particular commands and not a general
feature. It gets controlled by command -iso_rr_pattern. Commands which feature. It gets controlled by command -iso_rr_pattern. Commands which
eventually use pattern expansion all have variable argument lists which eventually use pattern expansion all have variable argument lists which
are marked in this man page by [***] rather than [...]. are marked in this man page by "[***]" rather than "[...]".
.br .br
Some other commands perform pattern matching unconditionally. Some other commands perform pattern matching unconditionally.
.PP .PP
@ -297,11 +297,11 @@ commands which support this feature.
converts a list of pattern words into a list of existing file addresses. converts a list of pattern words into a list of existing file addresses.
Eventual unmatched pattern words appear themselves in that result list, though. Eventual unmatched pattern words appear themselves in that result list, though.
.br .br
Pattern matching supports the usual shell parser wildcards '*' '?' '[a-z]' Pattern matching supports the usual shell parser wildcards '*' '?' '[xyz]'
and respects '/' as separator which may only be matched literally. and respects '/' as separator which may only be matched literally.
.br .br
Setting "off" disables this feature for all commands which are marked in this Setting "off" disables this feature for all commands which are marked in this
man page by "iso_rr_path [***]" or "pattern [***]. man page by "iso_rr_path [***]" or "pattern [***]".
Setting "on" enables it for all those commands. Setting "on" enables it for all those commands.
Setting "ls" enables it only for those which are marked by "pattern [***]". Setting "ls" enables it only for those which are marked by "pattern [***]".
.br .br
@ -594,7 +594,7 @@ readline or from stdin.
\fB\-page\fR len width \fB\-page\fR len width
Describe terminal to the text pager. Describe terminal to the text pager.
.TP .TP
? \fB\-use_readline\fR "on"|"off" \fB\-use_readline\fR "on"|"off"
If "on" then use readline for dialog. Else use plain stdin. If "on" then use readline for dialog. Else use plain stdin.
.TP .TP
\fB\-reassure\fR "on"|"tree"|"off" \fB\-reassure\fR "on"|"tree"|"off"
@ -603,9 +603,16 @@ before deleting or overwriting any file in the ISO image.
With setting "tree" the reassuring prompt will appear for an eventual With setting "tree" the reassuring prompt will appear for an eventual
directory only once and not for each file in its whole subtree. directory only once and not for each file in its whole subtree.
Setting "off" silently kills any kind of image file object. Setting "off" silently kills any kind of image file object.
To really produce user prompts, option -dialog needs to be set to "on".
.br .br
Note that the prompt appears only in situations where file removal Note that the prompt appears only in situations where file removal
is not forbidden by option -overwrite. is not 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.
.TP .TP
.B Drive and media related inquiry actions: .B Drive and media related inquiry actions:
.TP .TP
@ -711,7 +718,7 @@ Filters begin with '-' and are compared literally against the
output lines of -status:long_history. A line is put out only output lines of -status:long_history. A line is put out only
if its start matches the filter text. No wildcards. if its start matches the filter text. No wildcards.
.TP .TP
? \fB\-status_history_max\fR number \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 .TP
\fB\-options_from_file\fR fileaddress \fB\-options_from_file\fR fileaddress
@ -800,6 +807,7 @@ to read and execute lines from the following files:
/etc/opt/xorriso/rc /etc/opt/xorriso/rc
/etc/xorriso/cdrskin.conf /etc/xorriso/cdrskin.conf
$HOME/.xorrisorc $HOME/.xorrisorc
.br
The files are read in the sequence given above, but none of them is required The files are read in the sequence given above, but none of them is required
for xorriso to function properly. for xorriso to function properly.
.br .br