.\" -*-nroff-*-
-.TH xgetline 1 "15 November 1998" "Edgeware tools"
+.TH xgetline 1 "15 November 1998" "Straylight/Edgeware" "xtoys"
.SH NAME
xgetline \- request a line of text in an X dialogue box
.SH SYNOPSIS
.B xgetline
-.RB [ -in ]
-.RB [ \-t
-.IR title ]
-.RB [ \-p
-.IR prompt ]
+.RI [ gtk-options ...]
+.RB [ -Hin ]
+.RB [ \- M
+.IR max ]
.RB [ \-d
.IR default ]
-.RB [ \-l | \-H
+.RB [ \-l
.IR file ]
-.RB [ \- m
-.IR max ]
+.RB [ \-p
+.IR prompt ]
+.RB [ \-t
+.IR title ]
.SH DESCRIPTION
The
.B xgetline
.RS 5
.ft B
.nf
-cmd=`xgetline -t "Shell command in window" -p "Command:"` &&
+cmd=$(xgetline -t "Shell command in window" -p "_Command:") &&
xterm -T "$cmd" -e sh -c "$cmd"
.ft R
.fi
.SS Options
.TP 5
-.B \-i, \-\-invisible
-Don't echo characters to the screen when they're typed. Useful when
-requesting passwords and similar secrets.
+.B "\-H, \-\-history"
+With
+.BR \-l ,
+update the file with the newly entered line at the top. Other lines
+matching the newly entered string are not written. No effect without
+.BR \-l .
.TP 5
-.BI "\-t, \-\-title " title
-Sets the title of the dialogue box to
-.IR title .
-The default title is
-.RB ` "Input request" '.
-.TP 5
-.BI "\-p, \-\-prompt " prompt
-Sets the prompt string in the dialogue box to
-.IR prompt .
-The default is to have no prompt string.
+.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.
.TP 5
.BI "\-d, \-\-default " default
Sets the default text in the entry field to
sets the default to be the first item in the history list, if one is
supplied.
.TP 5
+.B \-i, \-\-invisible
+Don't echo characters to the screen when they're typed. Useful when
+requesting passwords and similar secrets.
+.TP 5
.BI "\-l, \-\-list " file
Reads a list of alternatives from
.I file
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.
+.BI "\-p, \-\-prompt " prompt
+Sets the prompt string in the dialogue box to
+.IR prompt .
+If the prompt string contains an underscore character
+.RB ` _ ',
+then the following character appears underlined; pressing Alt and the
+leftmost underlined character (the `mnemonic') moves the input focus to
+the entry widget. If you want a literal underscore, type two
+consecutive underscores. The default is to have no prompt string.
.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).
+.BI "\-t, \-\-title " title
+Sets the title of the dialogue box to
+.IR title .
+The default title is
+.RB ` "Input request" '.
.SH BUGS
Hopefully none.
+.SH SEE ALSO
+.BR gtk-options (7).
+.SH AUTHOR
+Mark Wooding (mdw@distorted.org.uk).