Changed the parameter rules for new command -launch_frontend

This commit is contained in:
2012-12-25 17:56:24 +00:00
parent cbb658991b
commit 88b4584ab2
10 changed files with 82 additions and 141 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 "Version 1.2.5, Dec 20, 2012"
.TH XORRISO 1 "Version 1.2.5, Dec 25, 2012"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@ -4588,11 +4588,9 @@ Print to the result channel a blank separated list of all severity names.
Sorted from low to high severity.
.br
.TP
\fB\-launch_frontend\fR program_with_args command_pipe reply_pipe
.br
Start the program that is given as first word in parameter
program_with_args. Submit the other words from that parameter as
program arguments. Enable xorriso dialog mode.
\fB\-launch_frontend\fR program [arguments ...] --
Start the program that is given as first parameter. Submit the other
parameters as program arguments. Enable xorriso dialog mode.
.br
xorriso will abort when the started program ends or if it cannot
be started at all. In both cases it will return a non\-zero exit value.
@ -4604,22 +4602,17 @@ by default if xorriso runs under setuid permissions.
.br
The program name will not be searched in the $PATH directories.
To make this clear, it must contain at least one /\-character.
Best is an absolute path. Like: /usr/bin/wish
.br
If one of command_pipe and reply_pipe is empty, then two nameless pipe
objects are created. xorriso standard input gets connected to the
standard output of the started program. xorriso standard output and
standard error get connected to the standard input of that program.
Best is an absolute path.
.br
The frontend program should first send via its standard output:
.br
\-mark 0 \-pkt_output on \-msg_op start_sieve \-
\-mark 0 \-pkt_output on \-msg_op start_sieve \- \-reassure off
.br
It should be ready to decode \-pkt_output and to react on \-mark messages.
Best is to increment the \-mark number after each sent command sequence
and then to wait for the new number to show up in a mark message:
.br
some ... commands \-mark <incremented_number>
...some...commands... \-mark <incremented_number>
.br
Further are advised:
.br
@ -4630,23 +4623,10 @@ Further are advised:
A check of the xorriso version should be done, in order to make sure
that all desired features are present.
.br
If command_pipe and reply_pipe are not empty, then
create named pipes with these names and use them for the connection to
the standard input and standard output of the started program.
It is not an error if the named pipes already exist.
.br
With named pipes it is important that the frontend program opens the
command_pipe first. This is because xorriso will block at this pipe
until the frontend opens it. If the frontend would try to open reply_pipe
first, then it would block there and create a deadlock situation.
.br
Command \-launch_frontend will only work once per xorriso run.
If all three command parameters are submitted as empty texts, then
no program will be started but nevertheless \-launch_frontend will
If no command parameters are submitted or if program is an empty text,
then no program will be started but nevertheless \-launch_frontend will
be irrevocably disabled.
If parameter program_with_args is submitted as empty text and both
pipe parameters are non\-empty, then no program will be started but
the standard i/o channels of xorriso will get connected to named pipes.
.TP
\fB\-prog\fR text
Use text as name of this program in subsequent messages