xref: /titanic_52/usr/src/man/man3lib/libtecla.3lib (revision 5963c4f9d1eb33d95ac319791aa1d0b9ea17f154)
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 "1 Jun 2004" "SunOS 5.11" "Interface Libraries"
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_startcfc_literal_escapes
cfc_set_check_fncpl_add_completion
cpl_check_execpl_complete_word
cpl_file_completionscpl_last_error
cpl_list_completionscpl_recall_matches
cpl_record_errordel_CplFileConf
del_ExpandFiledel_GetLine
del_PathCachedel_PcaPathConf
del_WordCompletionef_expand_file
ef_last_erroref_list_expansions
gl_abandon_linegl_append_history
gl_automatic_historygl_bind_keyseq
gl_catch_blockedgl_change_terminal
gl_clear_historygl_completion_action
gl_configure_getlinegl_customize_completion
gl_display_textgl_echo_mode
gl_erase_terminalgl_error_message
gl_get_linegl_group_history
gl_handle_signalgl_ignore_signal
gl_inactivity_timeoutgl_io_mode
gl_last_signalgl_limit_history
gl_list_signalsgl_load_history
gl_lookup_historygl_normal_io
gl_pending_iogl_prompt_style
gl_query_chargl_range_of_history
gl_raw_iogl_read_char
gl_register_actiongl_replace_prompt
gl_resize_historygl_return_status
gl_save_historygl_set_term_size
gl_show_historygl_size_of_history
gl_state_of_historygl_terminal_size
gl_toggle_historygl_trap_signal
gl_tty_signalsgl_watch_fd
libtecla_versionnew_CplFileConf
new_ExpandFilenew_GetLine
new_PathCachenew_PcaPathConf
new_WordCompletionpca_last_error
pca_lookup_filepca_path_completions
pca_scan_pathpca_set_check_fn
ppc_file_startppc_literal_escapes
FILES

/usr/lib/libtecla.so.1

shared object

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

64-bit shared object

ATTRIBUTES

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

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-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(5), tecla(5)