| blob | 682838e3e7d03f1d302b35fe3e49c41c165f18fb |
1 '\" te
2 .\" Copyright (c) 2000, 2001, 2002, 2003, 2004 by Martin C. Shepherd. All Rights Reserved.
3 .\" Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the
4 .\" "Software"), to deal in the Software without restriction, including
5 .\" without limitation the rights to use, copy, modify, merge, publish,
6 .\" distribute, and/or sell copies of the Software, and to permit persons
7 .\" to whom the Software is furnished to do so, provided that the above
8 .\" copyright notice(s) and this permission notice appear in all copies of
9 .\" the Software and that both the above copyright notice(s) and this
10 .\" permission notice appear in supporting documentation.
11 .\"
12 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
13 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
14 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
15 .\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
16 .\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
17 .\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
18 .\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
19 .\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
20 .\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 .\"
22 .\" Except as contained in this notice, the name of a copyright holder
23 .\" shall not be used in advertising or otherwise to promote the sale, use
24 .\" or other dealings in this Software without prior written authorization
25 .\" of the copyright holder.
26 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
27 .TH LIBTECLA 3LIB "Jun 1, 2004"
28 .SH NAME
29 libtecla \- interactive command line input library
30 .SH SYNOPSIS
31 .LP
32 .nf
33 cc [ \fIflag\fR... ] \fIfile\fR... \fB-ltecla\fR [ \fIlibrary\fR... ]
34 #include <\fBlibtecla.h\fR>
35 .fi
37 .SH DESCRIPTION
38 .sp
39 .LP
40 This library provides programs with interactive command line editing
41 facilities, similar to those of the UNIX \fBtcsh\fR shell. In addition to
42 simple command-line editing, it supports recall of previously entered command
43 lines, TAB completion of file names or other tokens, and in-line wildcard
44 expansion of filenames. The internal functions that perform file-name
45 completion and wild-card expansion are also available externally for optional
46 use by the calling program.
47 .SS "Thread Safety"
48 .sp
49 .LP
50 The \fBterminfo\fR functions \fBsetupterm\fR(3CURSES), \fBtigetstr\fR(3CURSES),
51 \fBtigetnum\fR(3CURSES), and \fBtputs\fR(3CURSES) are not reentrant. This
52 condition, however, should not prevent use of this library in threaded
53 applications, since few applications will want to interact with multiple
54 terminals.
55 .SH INTERFACES
56 .sp
57 .LP
58 The shared object \fBlibtecla.so.1\fR provides the public interfaces defined
59 below. See \fBIntro\fR(3) for additional information on shared object
60 interfaces.
61 .sp
63 .sp
64 .TS
65 l l
66 l l .
67 \fBcfc_file_start\fR \fBcfc_literal_escapes\fR
68 \fBcfc_set_check_fn\fR \fBcpl_add_completion\fR
69 \fBcpl_check_exe\fR \fBcpl_complete_word\fR
70 \fBcpl_file_completions\fR \fBcpl_last_error\fR
71 \fBcpl_list_completions\fR \fBcpl_recall_matches\fR
72 \fBcpl_record_error\fR \fBdel_CplFileConf\fR
73 \fBdel_ExpandFile\fR \fBdel_GetLine\fR
74 \fBdel_PathCache\fR \fBdel_PcaPathConf\fR
75 \fBdel_WordCompletion\fR \fBef_expand_file\fR
76 \fBef_last_error\fR \fBef_list_expansions\fR
77 \fBgl_abandon_line\fR \fBgl_append_history\fR
78 \fBgl_automatic_history\fR \fBgl_bind_keyseq\fR
79 \fBgl_catch_blocked\fR \fBgl_change_terminal\fR
80 \fBgl_clear_history\fR \fBgl_completion_action\fR
81 \fBgl_configure_getline\fR \fBgl_customize_completion\fR
82 \fBgl_display_text\fR \fBgl_echo_mode\fR
83 \fBgl_erase_terminal\fR \fBgl_error_message\fR
84 \fBgl_get_line\fR \fBgl_group_history\fR
85 \fBgl_handle_signal\fR \fBgl_ignore_signal\fR
86 \fBgl_inactivity_timeout\fR \fBgl_io_mode\fR
87 \fBgl_last_signal\fR \fBgl_limit_history\fR
88 \fBgl_list_signals\fR \fBgl_load_history\fR
89 \fBgl_lookup_history\fR \fBgl_normal_io\fR
90 \fBgl_pending_io\fR \fBgl_prompt_style\fR
91 \fBgl_query_char\fR \fBgl_range_of_history\fR
92 \fBgl_raw_io\fR \fBgl_read_char\fR
93 \fBgl_register_action\fR \fBgl_replace_prompt\fR
94 \fBgl_resize_history\fR \fBgl_return_status\fR
95 \fBgl_save_history\fR \fBgl_set_term_size\fR
96 \fBgl_show_history\fR \fBgl_size_of_history\fR
97 \fBgl_state_of_history\fR \fBgl_terminal_size\fR
98 \fBgl_toggle_history\fR \fBgl_trap_signal\fR
99 \fBgl_tty_signals\fR \fBgl_watch_fd\fR
100 \fBlibtecla_version\fR \fBnew_CplFileConf\fR
101 \fBnew_ExpandFile\fR \fBnew_GetLine\fR
102 \fBnew_PathCache\fR \fBnew_PcaPathConf\fR
103 \fBnew_WordCompletion\fR \fBpca_last_error\fR
104 \fBpca_lookup_file\fR \fBpca_path_completions\fR
105 \fBpca_scan_path\fR \fBpca_set_check_fn\fR
106 \fBppc_file_start\fR \fBppc_literal_escapes\fR
107 .TE
109 .SH FILES
110 .sp
111 .ne 2
112 .na
113 \fB\fB/usr/lib/libtecla.so.1\fR\fR
114 .ad
115 .RS 29n
116 shared object
117 .RE
119 .sp
120 .ne 2
121 .na
122 \fB\fB/usr/lib/64/libtecla.so.1\fR\fR
123 .ad
124 .RS 29n
125 64-bit shared object
126 .RE
128 .SH ATTRIBUTES
129 .sp
130 .LP
131 See \fBattributes\fR(5) for descriptions of the following attributes:
132 .sp
134 .sp
135 .TS
136 box;
137 c | c
138 l | l .
139 ATTRIBUTE TYPE ATTRIBUTE VALUE
140 Interface Stability Evolving
141 _
142 MT-Level MT-Safe
143 .TE
145 .SH SEE ALSO
146 .sp
147 .LP
148 \fBenhance\fR(1), \fBIntro\fR(3), \fBcpl_complete_word\fR(3TECLA),
149 \fBef_expand_file\fR(3TECLA), \fBgl_get_line\fR(3TECLA),
150 \fBgl_io_mode\fR(3TECLA), \fBpca_lookup_file\fR(3TECLA), \fBattributes\fR(5),
151 \fBtecla\fR(5)