[xtoys] / xgetline.1

.TH xgetline 1 "15 November 1998" "Edgeware tools"
.SH NAME
xgetline \- request a line of text in an X dialogue box
.SH SYNOPSIS
.B xgetline
.RB [ -i ]
.RB [ \-t
.IR title ]
.RB [ \-p
.IR prompt ]
.RB [ \-d
.IR default ]
.SH DESCRIPTION
The
.B xgetline
program reads a line of text from the user via a pretty GTK dialogue
box.  The title bar contents, prompt string, and default text are all
configurable.  If the user enters a string and clicks the
.B OK
button (or
presses
.IR enter ),
the string is echoed to standard output and
.B xgetline
returns an exit status of zero.  If the user cancels the dialogue box
(by closing it, or pressing
.IR escape ),
.B xgetline
echoes nothing and returns an exit status of one.
.PP
The
.B xgetline
program is intended to be used in window manager configuration files, to
allow users to fill in bits of text (e.g., hostnames or shell commands)
in generally useful places.  For example, the author has the following
shell command attached to a hotkey:
.PP
.RS 5
.ft B
.nf
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.
.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.
.TP 5
.BI "\-d, \-\-default " default
Sets the default text in the entry field to
.IR default .
The default default is the empty string.
.SH AUTHOR
Mark Wooding (mdw@nsict.org).
.SH BUGS
Hopefully none.
Commit	Line	Data
90b2c5d4	1	.TH xgetline 1 "15 November 1998" "Edgeware tools"
	2	.SH NAME
	3	xgetline \- request a line of text in an X dialogue box
	4	.SH SYNOPSIS
	5	.B xgetline
f3b35b6b	6	.RB [ -i ]
90b2c5d4	7	.RB [ \-t
	8	.IR title ]
	9	.RB [ \-p
	10	.IR prompt ]
	11	.RB [ \-d
	12	.IR default ]
	13	.SH DESCRIPTION
	14	The
	15	.B xgetline
	16	program reads a line of text from the user via a pretty GTK dialogue
	17	box. The title bar contents, prompt string, and default text are all
	18	configurable. If the user enters a string and clicks the
	19	.B OK
	20	button (or
	21	presses
	22	.IR enter ),
	23	the string is echoed to standard output and
	24	.B xgetline
	25	returns an exit status of zero. If the user cancels the dialogue box
	26	(by closing it, or pressing
	27	.IR escape ),
	28	.B xgetline
	29	echoes nothing and returns an exit status of one.
	30	.PP
	31	The
	32	.B xgetline
	33	program is intended to be used in window manager configuration files, to
	34	allow users to fill in bits of text (e.g., hostnames or shell commands)
	35	in generally useful places. For example, the author has the following
	36	shell command attached to a hotkey:
	37	.PP
	38	.RS 5
	39	.ft B
	40	.nf
	41	cmd=`xgetline -t "Shell command in window" -p "Command:"` &&
	42	xterm -T "$cmd" -e sh -c "$cmd"
	43	.ft R
	44	.fi
	45	.SS OPTIONS
	46	.TP 5
f3b35b6b	47	.B \-i, \-\-invisible
	48	Don't echo characters to the screen when they're typed. Useful when
	49	requesting passwords and similar secrets.
	50	.TP 5
90b2c5d4	51	.BI "\-t, \-\-title " title
	52	Sets the title of the dialogue box to
	53	.IR title .
	54	The default title is
	55	.RB ` "Input request" '.
	56	.TP 5
	57	.BI "\-p, \-\-prompt " prompt
	58	Sets the prompt string in the dialogue box to
	59	.IR prompt .
	60	The default is to have no prompt string.
	61	.TP 5
	62	.BI "\-d, \-\-default " default
	63	Sets the default text in the entry field to
	64	.IR default .
	65	The default default is the empty string.
	66	.SH AUTHOR
	67	Mark Wooding (mdw@nsict.org).
	68	.SH BUGS
	69	Hopefully none.