1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
|
<!-- secret-ask.sgml - man page source for secret-ask -->
<!DOCTYPE RefEntry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY trailer SYSTEM "trailer.sgml">
]>
<refentry>
<refmeta>
<refentrytitle>secret-ask</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Quintuple Agent</refmiscinfo>
</refmeta>
<refnamediv>
<refname>secret-ask</refname>
<refpurpose>Ask a yes/no question in a window</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>secret-ask</command>
<arg choice="req">bool</arg>
<arg choice="req"><replaceable>QUESTION</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>A window will be popped up containing the <replaceable/QUESTION/,
plus <literal/Yes/ and <literal/No/ buttons. The action the user takes
is reflected in <command/secret-ask/'s exit code.</para>
<para>The <command/secret-ask/ program is used by
<command/q-agent/ for interaction with the user, but can be used
for other purposes (scripts, etc.) as well.</para>
<para>A positive answer generates an exit code of <returnvalue/2/.</para>
<para>A negative answer generates an exit code of <returnvalue/3/.</para>
<para>Failure to get an answer is signaled by code <returnvalue/1/.</para>
<refsect1>
<title>See Also</title>
<simplelist>
<member><citerefentry>
<refentrytitle>q-agent<manvolnum/1/
</citerefentry></member>
</simplelist>
</refsect1>
&trailer;
</refentry>
|