<html> <head> <title>Xdialog documentation - Transient options</title> </head> <body bgcolor="#102050" text="#F0E0A0" link="#00E000" vlink="#FF00B0" alink="#FF0000"> <table border=0 width="100%"><tr> <td align="left"><a href="box.html">previous</a><a name="TOP"> </a> <a href="special.html">next</a> <a href="index.html">contents</a></td> <td align="right"><a href="#BOTTOM">bottom</a></td> </tr></table> <hr> <center> <h1>Xdialog documentation - Transient options</h1> <hr width=30%> </center> <p> <p align="justify">The <b>transient options</b> only apply to the next <a href="box.html">box option</a> into the Xdialog command line. <h2>Available transient options and parameters:</h2> <pre><ul> <li> <a href="#FIXEDFONT">--fixed-font</a> <li> <a href="#PASSWORD">--password</a> | <a href="#PASSWORD">--password=1|2</a> <li> <a href="#EDITABLE">--editable</a> <li> <a href="#TIMESTAMP">--time-stamp</a> | <a href="#TIMESTAMP">--date-stamp</a> <li> <a href="#REVERSE">--reverse</a> <li> <a href="#KEEPCOLORS">--keep-colors</a> <li> <a href="#INTERVAL">--interval</a> <timeout> <li> <a href="#TIMEOUT">--timeout</a> <timeout> <li> <a href="#NOTAGS">--no-tags</a> <li> <a href="#ITEMHELP">--item-help</a> <li> <a href="#DEFAULTITEM">--default-item</a> <tag> <li> <a href="#ICON">--icon</a> <xpm filename> <li> <a href="#NOOK">--no-ok</a> <li> <a href="#NOCANCEL">--no-cancel</a> <li> <a href="#NOBUTTONS">--no-buttons</a> <li> <a href="#DEFAULTNO">--default-no</a> <li> <a href="#WIZARD">--wizard</a> <li> <a href="#HELP">--help</a> <help> <li> <a href="#PRINT">--print</a> <printer> <li> <a href="#CHECK">--check</a> <label> [<status>] <li> <a href="#BUTTONSLABEL">--ok-label</a> <label> <li> <a href="#BUTTONSLABEL">--cancel-label</a> <label> <li> <a href="#BEEP">--beep</a> <li> <a href="#BEEP">--beep-after</a> <li> <a href="#BEGIN">--begin</a> <Yorg> <Xorg> <li> <a href="#IGNOREEOF">--ignore-eof</a> <li> <a href="#SMOOTH">--smooth</a> </ul> </pre> <hr> <ul> <p><li><a name="FIXEDFONT"><b>--fixed-font</b></a> <p align="justify">This option allows to use a monospacing font in the text area of <a href="box.html#TAILBOX">tailbox</a>, <a href="box.html#TEXTBOX">textbox</a> and <a href="box.html#EDITBOX">editbox</a> widgets. <p><img src="fixedfont.png" width=222 height=124> <img src="nofixedfont.png" width=222 height=124> <p><li><a name="PASSWORD"><b>--password | --password=1|2</b></a> <p align="justify">This option is for use with input(s) box widgets (<a href="box.html#INPUTBOX">--inputbox</a>, <a href="box.html#INPUTBOX">--2inputsbox</a> and <a href="box.html#INPUTBOX">--3inputsbox</a> box options). Its effect is to turn the last input field of an inputbox widget into a password entry field (in which every character typed is displayed as a "*"). It is possible to repeat this option twice or three times before --2inputsbox and --3inputsbox so that the last two or the three input fields are turned into password input fields. The --password=1 (respectively, --password=2) syntax allows to set the first (respectively, second) field of a --2inputsbox or --3inputsbox as a password field (but then all the other fields are not password fields). As of Xdialog v2.0.6, a check button (<i>Hide typing</i>) is also setup when this option is in use: it allows to toggle the hiding of the password fields (hiding being on by default). <p><img src="password.png" width=288 height=242> <p><li><a name="EDITABLE"><b>--editable</b></a> <p align="justify">This option is for use with the <a href="box.html#COMBOBOX">combobox</a> widget. Its effect is to allow the user to edit the entry field of the combo box (by default it is not allowed to do so: only one of the items into the combo box pull-down list may be choosed). <p><li><a name="TIMESTAMP"><b>--time-stamp</b></a> | <b>--date-stamp</b> <p align="justify">These options make a second column to appear on the left of the messages displayed by the <a href="box.html#LOGBOX">logbox</a> widget. This column is used to display the time (with <b>--time-stamp</b>) or date plus time (with <b>--date-stamp</b>) at which each message is received by the <a href="box.html#LOGBOX">logbox</a>. If either of these two options is used, then the column titles ("Time stamp" or "Date - Time", and "Log messages") also appear at the top of the <a href="box.html#LOGBOX">logbox</a>. <p><li><a name="REVERSE"><b>--reverse</b></a> <p align="justify">This option makes the messages displayed in the <a href="box.html#LOGBOX">logbox</a> widget to appear in reverse order (the last received message being displayed at the top of the messages list). <p><li><a name="KEEPCOLORS"><b>--keep-colors</b></a> <p align="justify">This option is for use with the <a href="box.html#LOGBOX">logbox</a> widget and instructs Xdialog to remember the last foreground and background colours message line setting so to use it in the next lines until a new colour specification (escape sequence) is received. <p><li><a name="INTERVAL"><b>--interval</b></a> <timeout> <p align="justify">This option will make most Xdialog widgets that return results (<a href="box.html#INPUTBOX">input(s) boxes</a>, <a href="box.html#COMBOBOX">combo box</a>, <a href="box.html#RANGEBOX">range(s) boxes</a>, <a href="box.html#SPINBOX">spin(s) boxes</a>, <a href="box.html#CHECKLIST">list boxes</a>, <a href="box.html#MENUBOX">menu box</a>, <a href="box.html#TREEVIEW">treeview</a>, <a href="box.html#CALENDAR">calendar</a>, <a href="box.html#TIMEBOX">timebox</a>) to report regularly these results on Xdialog output stream until the user chooses/enters the definitive result or the widget is closed. As an example, a rangebox can be made to report its current cursor position every 2s. The timeout parameter is in milli-seconds (it must be positive; a zero timeout will make this option to be ignored). <p><li><a name="TIMEOUT"><b>--timeout</b></a> <timeout> <p align="justify">This option will make most Xdialog widgets (all but <a href="box.html#INFOBOX">infobox</a>, <a href="box.html#GAUGE">gauge</a> and <a href="box.html#PROGRESS">progress</a>) to close automatically (returning 255 as an exit code) after a given timeout, unless the user already closed the box by clicking a button. The timeout parameter is in seconds (it must be positive; a zero timeout will make this option to be ignored). <p><li><a name="NOTAGS"><b>--no-tags</b></a> <p align="justify">This option is for use with <a href="box.html#MENUBOX">menubox</a>, <a href="box.html#CHECKLIST">checklist</a> and <a href="box.html#RADIOLIST">radiolist</a> widgets. Each menu/list item in these widgets is normally preceeded with its <tag>; when using this option, the tags are not displayed. <p><img src="withtags.png" width=288 height=172> <img src="notags.png" width=288 height=172> <p><li><a name="ITEMHELP"><b>--item-help</b></a> <p align="justify">This option is for use with the <a href="box.html#MENUBOX">menubox</a>, <a href="box.html#CHECKLIST">checklist</a>, <a href="box.html#RADIOLIST">radiolist</a>, <a href="box.html#BUILDLIST">buildlist</a> and <a href="box.html#TREEVIEW">treeview</a> widgets. It makes these widgets to accept an additional <help> parameter for each item; this parameter is a text string that will be displayed as a tooltip (for <a href="box.html#CHECKLIST">checklist</a>, <a href="box.html#RADIOLIST">radiolist</a>, <a href="box.html#BUILDLIST">buildlist</a> and <a href="box.html#TREEVIEW">treeview</a> widgets) when the mouse pointers stays for some time (usaually 0.5s) over an item, or into a status bar (below the menu window of the <a href="box.html#MENUBOX">menubox</a> widget) when an item is selected. <p><li><a name="DEFAULTITEM"><b>--default-item</b></a> <tag> <p align="justify">This option is for use with the <a href="box.html#MENUBOX">menubox</a> and allows to select (and move to) a given default row (which tag is <tag>). <p><li><a name="ICON"><b>--icon</b></a> <xpm filename> <p align="justify">This option must be followed by the filename of an icon (in XPM format only). This icon will be displayed on the left of the <text> (provided the following box option accepts such a <text> parameter, which is <b>not</b> the case of the <a href="box.html#TEXTBOX">textbox</a>, <a href="box.html#EDITBOX">editbox</a>, <a href="box.html#TAILBOX">tailbox</a>, <a href="box.html#LOGBOX">logbox</a>, <a href="box.html#FSELECT">fselect</a> and <a href="box.html#DSELECT">dselect</a> widgets). If the filename does not correspond to a XPM image, the option will be ignored. <p><img src="icon.png" width=163 height=132> <p><li><a name="NOOK"><b>--no-ok</b></a> <p align="justify">This option allows to suppress the <i>OK</i> button from the <a href="box.html#TAILBOX">tailbox</a> and <a href="box.html#LOGBOX">logbox</a> widgets. <p><li><a name="NOCANCEL"><b>--no-cancel</b></a> <p align="justify">This option allows to suppress the <i>Cancel</i> button from all but the <a href="box.html#INFOBOX">infobox</a>, <a href="box.html#GAUGE">gauge</a> and <a href="box.html#PROGRESS">progress</a> widgets. <p><li><a name="NOBUTTONS"><b>--no-buttons</b></a> <p align="justify">This option allows to suppress all the <i>OK</i>, the <i>Cancel</i>, the <i>Help</i> and the <i>Print</i> buttons from the <a href="box.html#TEXTBOX">textbox</a>, <a href="box.html#TAILBOX">tailbox</a>, <a href="box.html#LOGBOX">logbox</a>, <a href="box.html#INFOBOX">infobox</a> widgets, as well as the <i>New directory</i>, <i>Delete file</i> and <i>Rename file</i> buttons from the <a href="box.html#FSELECT">fselect</a> and <a href="box.html#DSELECT">dselect</a> widgets. <p><li><a name="DEFAULTNO"><b>--default-no</b></a> <p align="justify">Sets the <i>No</i> or <i>Cancel</i> button to be the default (pre-selected) one. This option has no effect when used with the <a href="#WIZARD">--wizard</a> option. <p align="justify">See also the <a href="compatibility.html#FEATURES">(c)dialog compatibility notes</a>. <p><li><a name="WIZARD"><b>--wizard</b></a> <p align="justify">This option turns Xdialog widgets into "installation wizard" widgets by replacing the <i>Yes</i> or <i>OK</i> button with <i>Next</i>, the <i>No</i> button with <i>Cancel</i> (the <i>Cancel</i> button is not displayed if the <a href="#NOCANCEL">--no-cancel</a> option is in force), and by adding a <i>Previous</i> button (which makes the widget to return an exit code of 3 when pressed). This option may apply to all widgets but the <a href="box.html#MSGBOX">msgbox</a>, <a href="box.html#INFOBOX">infobox</a>, <a href="box.html#GAUGE">gauge</a> and <a href="box.html#PROGRESS">progress</a> widgets. <p><img src="yesno-wizard.png" width=322 height=118> <p><li><a name="HELP"><b>--help</b></a> <help> <p align="justify">This option makes a <i>Help</i> button to appear in all but the <a href="box.html#INFOBOX">infobox</a>, <a href="box.html#GAUGE">gauge</a> and <a href="box.html#PROGRESS">progress</a> widgets, and is to be followed by the help text that will be displayed (in a <a href="box.html#MSGBOX">msgbox</a>) when the <i>Help</i> button is chosen. The help box is set to the same size as the widget from which it was invoked (it is auto-sized if this widget was itself auto-sized). The <help> text may hold "\n" (as for the <<a href="box.html#TEXT">text</a>> parameter) so to force help text line splitting. If the help text is an empty string then, when the <i>Help</i> button is pressed, the widget is closed and an exit code of 2 is returned. <p><li><a name="PRINT"><b>--print</b></a> <printer> <p align="justify">Makes a <i>Print</i> button to appear in <a href="box.html#TEXTBOX">textbox</a>, <a href="box.html#EDITBOX">editbox</a> and <a href="box.html#TAILBOX">tailbox</a> widgets (provided that the --no-button option was not specified). Hitting the button will make Xdialog to issue a printing command defined at compile time, defaulting to: <pre>lpr -P<printer></pre><p align="justify">If the <printer> parameter is an empty string, then the -P option is not used and the issued command is: <pre>lpr</pre><p align="justify">The <printer> parameter (that must follow the --print option) gives the name of the printer to use. As of v2.0.7, Xdialog uses a pipe to send the text to the print command. To see what printing command is used by your version of Xdialog, just type: <pre>Xdialog</pre><p align="justify">(without parameter) and look at the last lines in the displayed usage. <p>Example of a widget with a <i>Print</i> button: <img src="editbox.png" width=380 height=353 align="absmiddle"> <p><li><a name="CHECK"><b>--check</b></a> <label> [<status>] <p align="justify">This option applies to all but the <a href="box.html#INFOBOX">infobox</a>, <a href="box.html#GAUGE">gauge</a> and <a href="box.html#PROGRESS">progress</a> widgets. It adds a check button (on the left) and a label (on the right) at the bottom of the widget and makes Xdialog to report either "checked" or "unchecked" on its output stream (as the last string for widgets that return strings by themselves) when the <i>OK</i> button is pressed. <p align="justify">The <label> may contain "\n" characters sequences so to force line breaks (it is not possible to auto-wrap this label) and its text justification is not affected by any Xdialog <a href="common.html#JUSTIFICATION">justification option</a> in force. <p align="justify">The <status> parameter is optional and, if "on" (case insensitive), the button will be checked by default. If anything else but "on", or if absent, the button is unchecked by default. <p><img src="check.png" width=288 height=269> <p><li><a name="BUTTONSLABEL"><b>--ok-label</b></a> <label> <li><b>--cancel-label</b></a> <label> <p align="justify">These options allow to change the labels of (respectively) <i>OK</i> or <i>Yes</i> buttons, and <i>Cancel</i> or <i>No</i> buttons in any Xdialog widget using these buttons. These options are ignored if the <a href="#WIZARD">--wizard</a> transient option is in force. <p><li><a name="BEEP"><b>--beep</b></a> <li><b>--beep-after</b> <p align="justify">These options instruct Xdialog to emit a short beep either just before displaying the next widget (<b>--beep</b>) or just after closing it (<b>--beep-after</b>). Both options may be used together and apply to any widget. <p><li><a name="BEGIN"><b>--begin</b></a> <Yorg> <Xorg> <p align="justify">This option asks Xdialog to open its widget at an absolute position (in characters) on the screen. It will work only if your window manager does take the application requested window position into account (many ignore it or may be configured so to ignore it). This option is for use when the widget size is given in characters as well (if you give it in pixels, then the <b>--begin</b> option is ignored; give a "-geometry"-like size/position specification instead. E.g.: 400x200+20-30). This option may be used with any widget. <p><li><a name="IGNOREEOF"><b>--ignore-eof</b></a> <p align="justify">This option is for use with the <a href="box.html#INFOBOX">infobox</a> and <a href="box.html#GAUGE">gauge</a> widgets. It prevents Xdialog to close its widget when its input stream is put at EOF (use with care as you must ensure that a way remains to close the Xdialog widget !). This may be useful when piping data to Xdialog through a FIFO. <p><li><a name="SMOOTH"><b>--smooth</b></a> <p align="justify">Will give a smooth, flicker free (but significantly slower) scrolling in <a href="box.html#TAILBOX">tailbox</a> and <a href="box.html#LOGBOX">logbox</a> widget. For use in big windows displaying a slowly updated log... <p align="justify">Note: from Xdialog v2.0.4 onwards, the <a href="box.html#TAILBOX">tailbox</a> and <a href="box.html#LOGBOX">logbox</a> are, when passed the name of an actual file as parameter, loading all the current file contents in one go at startup before displaying it; while this is quite fast with the <a href="box.html#TAILBOX">tailbox</a>, it may take quite some time with the <a href="box.html#LOGBOX">logbox</a> (for which many more processing is performed for each line of text). The use of <b>--smooth</b> with the <a href="box.html#LOGBOX">logbox</a> therefore disables this feature (so that a display update is done each time a new line of text is loaded), thus reverting to the pre-v2.0.4 Xdialog versions behaviour. </ul> <hr> <table border=0 width="100%"><tr> <td align="left"><a href="box.html">previous</a><a name="BOTTOM"> </a> <a href="special.html">next</a> <a href="index.html">contents</a></td> <td align="right"><a href="#TOP">top</a></td> </tr></table> <br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br> </body> </html>
