Polished man page

This commit is contained in:
Thomas Schmitt 2008-02-14 21:23:02 +00:00
parent 53e662d9f1
commit eb07c358d6

View File

@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps .\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1) .\" other parameters are allowed: see man(7), man(1)
.TH XORRISO 1 "February 10, 2008" .TH XORRISO 1 "February 14, 2008"
.\" Please adjust this date whenever revising the manpage. .\" Please adjust this date whenever revising the manpage.
.\" .\"
.\" Some roff macros, for reference: .\" Some roff macros, for reference:
@ -56,6 +56,8 @@ Scans for optical drives, blanks re-useable optical media.
Reads its instructions from command line arguments, dialog, and batch files. Reads its instructions from command line arguments, dialog, and batch files.
.br .br
Provides navigation commands for interactive ISO image manipulation. Provides navigation commands for interactive ISO image manipulation.
.br
Adjustable thresholds for abort, exit value, and problem reporting.
.SS .SS
.B General information paragraphs: .B General information paragraphs:
.br .br
@ -1010,27 +1012,26 @@ or an important resource failed unexpectedly.
"DEBUG" A message which would only interest the program developers. "DEBUG" A message which would only interest the program developers.
.br .br
"ALL" The lower end of the severity spectrum. "ALL" The lower end of the severity spectrum.
.PP
.TP .TP
\fB\-abort_on\fR severity \fB\-abort_on\fR severity
Set the severity threshold for events to abort the program. Set the severity threshold for events to abort the program.
.br .br
Useful: "NEVER", "ABORT", "FATAL", "FAILURE" , "SORRY" Useful: "NEVER", "ABORT", "FATAL", "FAILURE" , "MISHAP", "SORRY"
.br .br
It may become necessary to abort the program anyway, despite It may become necessary to abort the program anyway, despite
the setting by this option. Expect not many "ABORT" events to the setting by this option. Expect not many "ABORT" events to
be ignorable. be ignorable.
.br .br
A special property of this option is that it works preemtive if given as 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 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 .TP
\fB\-return_with\fR severity exit_value \fB\-return_with\fR severity exit_value
Set the threshhold and exit_value to be returned at program end if no abort 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 has happened. This is to allow xorriso to go on after problems but to get
a failure indicating exit value from the program, nevertheless. a failure indicating exit value from the program, nevertheless.
Useful are the same values as with -abort_on, plus "WARNING". Useful is a value lower than the -abort_on threshold, down to "WARNING".
.br .br
exit_value may be either 0 (indicating success to the starter of the program) 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 or a number between 32 and 63. Some other exit_values are used by xorriso if
@ -1052,6 +1053,7 @@ it decides to abort the program run:
Set the threshold for events to be reported. Set the threshold for events to be reported.
.br .br
Useful: "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG", "ALL" Useful: "SORRY", "WARNING", "HINT", "NOTE", "UPDATE", "DEBUG", "ALL"
.br
Regardless what is set by -report_about, messages get always reported if they Regardless what is set by -report_about, messages get always reported if they
reach the severity threshold of -abort_on . reach the severity threshold of -abort_on .
.br .br
@ -1459,6 +1461,21 @@ first and only session to the output drive.
-outdev /dev/sr0 -blank fast \\ -outdev /dev/sr0 -blank fast \\
-commit -eject all -commit -eject all
.SS .SS
.B Write a ISO image into a pipe (single-session only)
\fB$\fR xorriso -outdev - \\
...
| gzip >image.iso.gz
.SS
.B Adjust thresholds for verbosity, exit value and program abort
Be quite verbous, exit 32 if severity "FAILURE" was encountered,
do not abort prematurely but forcibly go on until the end of commands.
.br
\fB$\fR xorriso ... \\
-report_about UPDATE \\
-return_with FAILURE 32 \\
-abort_on NEVER \\
...
.SS
.B Examples of input timestrings .B Examples of input timestrings
.br .br
As printed by program date: As printed by program date:
@ -1506,6 +1523,9 @@ For mounting xorriso generated ISO 9660 images
.br .br
.BR mount(8) .BR mount(8)
.TP .TP
Libreadline, a comfortable input line facility
.BR readline(3)
.TP
Other programs which produce ISO 9660 images Other programs which produce ISO 9660 images
.br .br
.BR mkisofs(8), .BR mkisofs(8),
@ -1521,3 +1541,11 @@ Other programs which burn sessions to optical media
Thomas Schmitt <scdbackup@gmx.net> Thomas Schmitt <scdbackup@gmx.net>
.br .br
for libburnia-project.org for libburnia-project.org
.SH CREDITS
xorriso is also based on work by Vreixo Formoso who provides libisofs,
Mario Danic who leads the libburnia team,
Andy Polyakov who invented emulated growing,
Derek Foreman and Ben Jansens who once founded libburn.
.br
Compliments towards Joerg Schilling whose cdrtools served me for ten years.