From 0a47c22241556270540d5c3666de41cc93318edd Mon Sep 17 00:00:00 2001 From: mdw Date: Fri, 11 Dec 1998 09:52:07 +0000 Subject: [PATCH] Documentation updates for history support. --- xgetline.1 | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/xgetline.1 b/xgetline.1 index 2cc2079..0f6f23e 100644 --- a/xgetline.1 +++ b/xgetline.1 @@ -3,13 +3,17 @@ xgetline \- request a line of text in an X dialogue box .SH SYNOPSIS .B xgetline -.RB [ -i ] +.RB [ -in ] .RB [ \-t .IR title ] .RB [ \-p .IR prompt ] .RB [ \-d .IR default ] +.RB [ \-l | \-H +.IR file ] +.RB [ \- m +.IR max ] .SH DESCRIPTION The .B xgetline @@ -62,7 +66,38 @@ The default is to have no prompt string. .BI "\-d, \-\-default " default Sets the default text in the entry field to .IR default . -The default default is the empty string. +The default default is the first item in the empty string. The special +default string +.RB ` @ ' +sets the default to be the first item in the history list, if one is +supplied. +.TP 5 +.BI "\-l, \-\-list " file +Reads a list of alternatives from +.I file +and displays them in a drop-down list box. The user can rapidly select +an item from the drop-down list using the mouse or cursor keys. The +file is not modified (but see the +.B \-\-history +option below). +.TP 5 +.B "\-n, \-\-no-choice" +One of the items from the selection list must be chosen; the user may +not type an entry in directly. +.TP 5 +.BI "\-H, \-\-history " file +Reads a file and displays the contents in a drop-down list, as for +.B \-\-list +above. Once the user has entered a string, a new list written to +.I file +containing the newly entered string as the first item; other lines +matching the newly entered string are not written. +.TP 5 +.BI "\-m, \-\-histmax " max +When writing an updated history file, do not write more than +.I max +lines. The default is 20; a value of 0 disables a length limit on the +history file. .SH AUTHOR Mark Wooding (mdw@nsict.org). .SH BUGS -- 2.11.0