8 .\" to whom the Software is furnished to do so, provided that the above
9 .\" copyright notice(s) and this permission notice appear in all copies of
10 .\" the Software and that both the above copyright notice(s) and this
11 .\" permission notice appear in supporting documentation.
12 .\"
13 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
14 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
15 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
16 .\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
17 .\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
18 .\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
19 .\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
20 .\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
21 .\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 .\"
23 .\" Except as contained in this notice, the name of a copyright holder
24 .\" shall not be used in advertising or otherwise to promote the sale, use
25 .\" or other dealings in this Software without prior written authorization
26 .\" of the copyright holder.
27 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
28 .TH GL_GET_LINE 3TECLA "Nov 28, 2007"
29 .SH NAME
30 gl_get_line, new_GetLine, del_GetLine, gl_customize_completion,
31 gl_change_terminal, gl_configure_getline, gl_load_history, gl_save_history,
32 gl_group_history, gl_show_history, gl_watch_fd, gl_inactivity_timeout,
33 gl_terminal_size, gl_set_term_size, gl_resize_history, gl_limit_history,
34 gl_clear_history, gl_toggle_history, gl_lookup_history, gl_state_of_history,
35 gl_range_of_history, gl_size_of_history, gl_echo_mode, gl_replace_prompt,
36 gl_prompt_style, gl_ignore_signal, gl_trap_signal, gl_last_signal,
37 gl_completion_action, gl_register_action, gl_display_text, gl_return_status,
38 gl_error_message, gl_catch_blocked, gl_list_signals, gl_bind_keyseq,
39 gl_erase_terminal, gl_automatic_history, gl_append_history, gl_query_char,
40 gl_read_char \- allow the user to compose an input line
41 .SH SYNOPSIS
42 .LP
43 .nf
44 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ltecla\fR [ \fIlibrary\fR\&.\|.\|. ]
45 #include <stdio.h>
46 #include <libtecla.h>
47
48 \fBGetLine *\fR\fBnew_GetLine\fR(\fBsize_t\fR \fIlinelen\fR, \fBsize_t\fR \fIhistlen\fR);
656 The \fBgl_configure_getline()\fR function allows the configuration commands
657 that would normally be read from a user's \fB~/.teclarc\fR file, to be read
658 from any or none of, a string, an application specific configuration file,
659 and/or a user-specific configuration file. If this function is called before
660 the first call to \fBgl_get_line()\fR, the default behavior of reading
661 \fB~/.teclarc\fR on the first call to \fBgl_get_line()\fR is disabled, so all
662 configurations must be achieved using the configuration sources specified with
663 this function.
664 .sp
665 .LP
666 If \fIapp_string\fR != \fINULL\fR, then it is interpreted as a string
667 containing one or more configuration commands, separated from each other in the
668 string by embedded newline characters. If \fIapp_file\fR != \fINULL\fR then it
669 is interpreted as the full pathname of an application-specific configuration
670 file. If user_file != \fINULL\fR then it is interpreted as the full path name
671 of a user-specific configuration file, such as \fB~/.teclarc\fR. For example,
672 in the call
673 .sp
674 .in +2
675 .nf
676 gl_configure_getline(gl, "edit-mode vi \n nobeep",
677 "/usr/share/myapp/teclarc", "~/.teclarc");
678 .fi
679 .in -2
680
681 .sp
682 .LP
683 The \fIapp_string\fR argument causes the calling application to start in
684 \fBvi\fR(1) edit-mode, instead of the default \fBemacs\fR mode, and turns off
685 the use of the terminal bell by the library. It then attempts to read
686 system-wide configuration commands from an optional file called
687 \fB/usr/share/myapp/teclarc\fR, then finally reads user-specific configuration
688 commands from an optional \fB\&.teclarc\fR file in the user's home directory.
689 Note that the arguments are listed in ascending order of priority, with the
690 contents of \fIapp_string\fR being potentially over riden by commands in
691 \fIapp_file\fR, and commands in \fIapp_file\fR potentially being overriden by
692 commands in \fIuser_file\fR.
693 .sp
694 .LP
695 You can call this function as many times as needed, the results being
696 cumulative, but note that copies of any file names specified with the
|
8 .\" to whom the Software is furnished to do so, provided that the above
9 .\" copyright notice(s) and this permission notice appear in all copies of
10 .\" the Software and that both the above copyright notice(s) and this
11 .\" permission notice appear in supporting documentation.
12 .\"
13 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
14 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
15 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
16 .\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
17 .\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
18 .\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
19 .\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
20 .\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
21 .\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 .\"
23 .\" Except as contained in this notice, the name of a copyright holder
24 .\" shall not be used in advertising or otherwise to promote the sale, use
25 .\" or other dealings in this Software without prior written authorization
26 .\" of the copyright holder.
27 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
28 .TH GL_GET_LINE 3TECLA "Sep 10, 2013"
29 .SH NAME
30 gl_get_line, new_GetLine, del_GetLine, gl_customize_completion,
31 gl_change_terminal, gl_configure_getline, gl_load_history, gl_save_history,
32 gl_group_history, gl_show_history, gl_watch_fd, gl_inactivity_timeout,
33 gl_terminal_size, gl_set_term_size, gl_resize_history, gl_limit_history,
34 gl_clear_history, gl_toggle_history, gl_lookup_history, gl_state_of_history,
35 gl_range_of_history, gl_size_of_history, gl_echo_mode, gl_replace_prompt,
36 gl_prompt_style, gl_ignore_signal, gl_trap_signal, gl_last_signal,
37 gl_completion_action, gl_register_action, gl_display_text, gl_return_status,
38 gl_error_message, gl_catch_blocked, gl_list_signals, gl_bind_keyseq,
39 gl_erase_terminal, gl_automatic_history, gl_append_history, gl_query_char,
40 gl_read_char \- allow the user to compose an input line
41 .SH SYNOPSIS
42 .LP
43 .nf
44 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ltecla\fR [ \fIlibrary\fR\&.\|.\|. ]
45 #include <stdio.h>
46 #include <libtecla.h>
47
48 \fBGetLine *\fR\fBnew_GetLine\fR(\fBsize_t\fR \fIlinelen\fR, \fBsize_t\fR \fIhistlen\fR);
656 The \fBgl_configure_getline()\fR function allows the configuration commands
657 that would normally be read from a user's \fB~/.teclarc\fR file, to be read
658 from any or none of, a string, an application specific configuration file,
659 and/or a user-specific configuration file. If this function is called before
660 the first call to \fBgl_get_line()\fR, the default behavior of reading
661 \fB~/.teclarc\fR on the first call to \fBgl_get_line()\fR is disabled, so all
662 configurations must be achieved using the configuration sources specified with
663 this function.
664 .sp
665 .LP
666 If \fIapp_string\fR != \fINULL\fR, then it is interpreted as a string
667 containing one or more configuration commands, separated from each other in the
668 string by embedded newline characters. If \fIapp_file\fR != \fINULL\fR then it
669 is interpreted as the full pathname of an application-specific configuration
670 file. If user_file != \fINULL\fR then it is interpreted as the full path name
671 of a user-specific configuration file, such as \fB~/.teclarc\fR. For example,
672 in the call
673 .sp
674 .in +2
675 .nf
676 gl_configure_getline(gl, "edit-mode vi \en nobeep",
677 "/usr/share/myapp/teclarc", "~/.teclarc");
678 .fi
679 .in -2
680
681 .sp
682 .LP
683 The \fIapp_string\fR argument causes the calling application to start in
684 \fBvi\fR(1) edit-mode, instead of the default \fBemacs\fR mode, and turns off
685 the use of the terminal bell by the library. It then attempts to read
686 system-wide configuration commands from an optional file called
687 \fB/usr/share/myapp/teclarc\fR, then finally reads user-specific configuration
688 commands from an optional \fB\&.teclarc\fR file in the user's home directory.
689 Note that the arguments are listed in ascending order of priority, with the
690 contents of \fIapp_string\fR being potentially over riden by commands in
691 \fIapp_file\fR, and commands in \fIapp_file\fR potentially being overriden by
692 commands in \fIuser_file\fR.
693 .sp
694 .LP
695 You can call this function as many times as needed, the results being
696 cumulative, but note that copies of any file names specified with the
|