xref: /illumos-gate/usr/src/man/man3lib/libtecla.3lib (revision 5d9d9091f564c198a760790b0bfa72c44e17912b)
te
Copyright (c) 2000, 2001, 2002, 2003, 2004 by Martin C. Shepherd. All Rights Reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, provided that the above
copyright notice(s) and this permission notice appear in all copies of
the Software and that both the above copyright notice(s) and this
permission notice appear in supporting documentation.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Except as contained in this notice, the name of a copyright holder
shall not be used in advertising or otherwise to promote the sale, use
or other dealings in this Software without prior written authorization
of the copyright holder.
Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
LIBTECLA 3LIB "Jun 1, 2004"
NAME
libtecla - interactive command line input library
SYNOPSIS

cc [ flag... ] file... -ltecla [ library... ]
#include <libtecla.h>
DESCRIPTION

This library provides programs with interactive command line editing facilities, similar to those of the UNIX tcsh shell. In addition to simple command-line editing, it supports recall of previously entered command lines, TAB completion of file names or other tokens, and in-line wildcard expansion of filenames. The internal functions that perform file-name completion and wild-card expansion are also available externally for optional use by the calling program.

"Thread Safety"

The terminfo functions setupterm(3CURSES), tigetstr(3CURSES), tigetnum(3CURSES), and tputs(3CURSES) are not reentrant. This condition, however, should not prevent use of this library in threaded applications, since few applications will want to interact with multiple terminals.

INTERFACES

The shared object libtecla.so.1 provides the public interfaces defined below. See Intro(3) for additional information on shared object interfaces.

cfc_file_start cfc_literal_escapes
cfc_set_check_fn cpl_add_completion
cpl_check_exe cpl_complete_word
cpl_file_completions cpl_last_error
cpl_list_completions cpl_recall_matches
cpl_record_error del_CplFileConf
del_ExpandFile del_GetLine
del_PathCache del_PcaPathConf
del_WordCompletion ef_expand_file
ef_last_error ef_list_expansions
gl_abandon_line gl_append_history
gl_automatic_history gl_bind_keyseq
gl_catch_blocked gl_change_terminal
gl_clear_history gl_completion_action
gl_configure_getline gl_customize_completion
gl_display_text gl_echo_mode
gl_erase_terminal gl_error_message
gl_get_line gl_group_history
gl_handle_signal gl_ignore_signal
gl_inactivity_timeout gl_io_mode
gl_last_signal gl_limit_history
gl_list_signals gl_load_history
gl_lookup_history gl_normal_io
gl_pending_io gl_prompt_style
gl_query_char gl_range_of_history
gl_raw_io gl_read_char
gl_register_action gl_replace_prompt
gl_resize_history gl_return_status
gl_save_history gl_set_term_size
gl_show_history gl_size_of_history
gl_state_of_history gl_terminal_size
gl_toggle_history gl_trap_signal
gl_tty_signals gl_watch_fd
libtecla_version new_CplFileConf
new_ExpandFile new_GetLine
new_PathCache new_PcaPathConf
new_WordCompletion pca_last_error
pca_lookup_file pca_path_completions
pca_scan_path pca_set_check_fn
ppc_file_start ppc_literal_escapes
FILES
/usr/lib/libtecla.so.1

shared object

/usr/lib/64/libtecla.so.1

64-bit shared object

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level MT-Safe
SEE ALSO

enhance (1), Intro (3), cpl_complete_word (3TECLA), ef_expand_file (3TECLA), gl_get_line (3TECLA), gl_io_mode (3TECLA), pca_lookup_file (3TECLA), attributes (7), tecla (7)